UnifiedAutomation.UaBase.LocalizedText Class Reference

Stores a localized text value. More...

Inherits IComparable, IFormattable, and ICloneable.

Public Member Functions
	LocalizedText ()
	Initializes a new instance of the LocalizedText class.
	LocalizedText (string text)
	Initializes a new instance of the LocalizedText class.
	LocalizedText (string locale, string text)
	Initializes a new instance of the LocalizedText class.
	LocalizedText (string key, string locale, string text, params object[] args)
	Initializes a new instance of the LocalizedText class.
object	Clone ()
	Creates a deep copy of the object.
override bool	Equals (object obj)
	Returns true if the object is equal to the instance.
override int	GetHashCode ()
	Returns a hash code for the instance.
int	CompareTo (object obj)
	Compares the instance to another object.
override string	ToString ()
	Formats the object as a string.
string	ToString (string format, IFormatProvider formatProvider)
	Formats the object as a string.
string	Format ()
	Formats a node id as a string.
void	Format (StringBuilder buffer)
	Formats the node ids as string and adds it to the buffer.

Static Public Member Functions
static bool	IsNullOrEmpty (LocalizedText text)
	Determines whether the object is a null or empty value.
static LocalizedText	Parse (string text)
	Parses the specified text (with the format [xx-XX]:[text] where the locale prefix is optional).
static implicit	operator LocalizedText (string text)
	Performs an implicit conversion from System.String to UnifiedAutomation.UaBase.LocalizedText.
static bool	operator== (LocalizedText text1, LocalizedText text2)
	Implements the operator ==.
static bool	operator!= (LocalizedText text1, LocalizedText text2)
	Implements the operator !=.

Static Public Attributes
static readonly LocalizedText	Null = new LocalizedText()
	A constant representing a Null value.

Properties
string	Locale [get, set]
	Gets the locale.
string	Text [get, set]
	Gets the text.
string	Key [get, set]
	Gets the key used to local up a translation.
object[]	Args [get, set]
	Gets the argument used to format a string during translation.

Detailed Description

Stores a localized text value.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.LocalizedText.LocalizedText

(

)

Initializes a new instance of the LocalizedText class.

UnifiedAutomation.UaBase.LocalizedText.LocalizedText

(

string

text

)

Initializes a new instance of the LocalizedText class.

Parameters

text

The text.

UnifiedAutomation.UaBase.LocalizedText.LocalizedText	(	string	locale,
		string	text
	)

Initializes a new instance of the LocalizedText class.

Parameters

locale	The locale.
text	The text.

UnifiedAutomation.UaBase.LocalizedText.LocalizedText	(	string	key,
		string	locale,
		string	text,
		params object[]	args
	)

Initializes a new instance of the LocalizedText class.

Parameters

key	The key.
locale	The locale.
text	The text.
args	The args.

Member Function Documentation

object UnifiedAutomation.UaBase.LocalizedText.Clone

(

)

Creates a deep copy of the object.

int UnifiedAutomation.UaBase.LocalizedText.CompareTo

(

object

obj

)

Compares the instance to another object.

Parameters

obj	The object to compare to this object

override bool UnifiedAutomation.UaBase.LocalizedText.Equals

(

object

obj

)

Returns true if the object is equal to the instance.

string UnifiedAutomation.UaBase.LocalizedText.Format

(

)

Formats a node id as a string.

void UnifiedAutomation.UaBase.LocalizedText.Format

(

StringBuilder

buffer

)

Formats the node ids as string and adds it to the buffer.

override int UnifiedAutomation.UaBase.LocalizedText.GetHashCode

(

)

Returns a hash code for the instance.

static bool UnifiedAutomation.UaBase.LocalizedText.IsNullOrEmpty ( LocalizedText  text )

static

Determines whether the object is a null or empty value.

Parameters

text

The text.

Returns

true if the text is a null or empty value; otherwise, false.

static implicit UnifiedAutomation.UaBase.LocalizedText.operator LocalizedText ( string  text )

static

Performs an implicit conversion from System.String to UnifiedAutomation.UaBase.LocalizedText.

Parameters

text

The text.

Returns

The result of the conversion.

static bool UnifiedAutomation.UaBase.LocalizedText.operator!= ( LocalizedText  text1, LocalizedText  text2  )

static

Implements the operator !=.

Parameters

text1	The text1.
text2	The text2.

Returns

The result of the operator.

static bool UnifiedAutomation.UaBase.LocalizedText.operator== ( LocalizedText  text1, LocalizedText  text2  )

static

Implements the operator ==.

Parameters

text1	The text1.
text2	The text2.

Returns

The result of the operator.

static LocalizedText UnifiedAutomation.UaBase.LocalizedText.Parse ( string  text )

static

Parses the specified text (with the format [xx-XX]:[text] where the locale prefix is optional).

Parameters

text

The text.

Returns

override string UnifiedAutomation.UaBase.LocalizedText.ToString

(

)

Formats the object as a string.

string UnifiedAutomation.UaBase.LocalizedText.ToString	(	string	format,
		IFormatProvider	formatProvider
	)

Formats the object as a string.

Member Data Documentation

readonly LocalizedText UnifiedAutomation.UaBase.LocalizedText.Null = new LocalizedText()

static

A constant representing a Null value.

Property Documentation

object [] UnifiedAutomation.UaBase.LocalizedText.Args

getset

Gets the argument used to format a string during translation.

string UnifiedAutomation.UaBase.LocalizedText.Key

getset

Gets the key used to local up a translation.

string UnifiedAutomation.UaBase.LocalizedText.Locale

getset

Gets the locale.

string UnifiedAutomation.UaBase.LocalizedText.Text

getset

Gets the text.

---

The documentation for this class was generated from the following file:

• C:/work/uasdknet/src/UaBase/BuiltIn/LocalizedText.cs