.NET Based OPC UA Client/Server SDK  3.3.3.537
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. More...
 
 LocalizedText (string text)
 Initializes a new instance of the LocalizedText class. More...
 
 LocalizedText (string locale, string text)
 Initializes a new instance of the LocalizedText class. More...
 
 LocalizedText (string key, string locale, string text, params object[] args)
 Initializes a new instance of the LocalizedText class. More...
 
object Clone ()
 Creates a deep copy of the object. More...
 
override bool Equals (object obj)
 Returns true if the object is equal to the instance. More...
 
override int GetHashCode ()
 Returns a hash code for the instance. More...
 
int CompareTo (object obj)
 Compares the instance to another object. More...
 
override string ToString ()
 Formats the object as a string. More...
 
string ToString (string format, IFormatProvider formatProvider)
 Formats the object as a string. More...
 
string Format ()
 Formats a node id as a string. More...
 
void Format (StringBuilder buffer)
 Formats the node ids as string and adds it to the buffer. More...
 

Static Public Member Functions

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

Static Public Attributes

static readonly LocalizedText Null = new LocalizedText()
 A constant representing a Null value. More...
 

Properties

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

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
textThe text.
UnifiedAutomation.UaBase.LocalizedText.LocalizedText ( string  locale,
string  text 
)

Initializes a new instance of the LocalizedText class.

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

Initializes a new instance of the LocalizedText class.

Parameters
keyThe key.
localeThe locale.
textThe text.
argsThe 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
objThe 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
textThe 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
textThe text.
Returns
The result of the conversion.
static bool UnifiedAutomation.UaBase.LocalizedText.operator!= ( LocalizedText  text1,
LocalizedText  text2 
)
static

Implements the operator !=.

Parameters
text1The text1.
text2The text2.
Returns
The result of the operator.
static bool UnifiedAutomation.UaBase.LocalizedText.operator== ( LocalizedText  text1,
LocalizedText  text2 
)
static

Implements the operator ==.

Parameters
text1The text1.
text2The 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
textThe 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: