MultilanguageString Class

Represents immutable store for multiple strings, one per language

Inheritance Hierarchy

SystemObject
Aloe.EnterpriseOne.ModelMultilanguageString

Namespace: Aloe.EnterpriseOne.Model
Assembly: Aloe.EnterpriseOne.Model (in Aloe.EnterpriseOne.Model.dll) Version: 20.1.3.5

Syntax

C++

Copy

public class MultilanguageString : IEquatable<MultilanguageString>, 
	IComparable<MultilanguageString>, IComparable, IFormattable

Public Class MultilanguageString
	Implements IEquatable(Of MultilanguageString), IComparable(Of MultilanguageString), 
	IComparable, IFormattable

public ref class MultilanguageString : IEquatable<MultilanguageString^>, 
	IComparable<MultilanguageString^>, IComparable, IFormattable

type MultilanguageString =  
    class
        interface IEquatable<MultilanguageString>
        interface IComparable<MultilanguageString>
        interface IComparable
        interface IFormattable
    end

The MultilanguageString type exposes the following members.

Constructors

	Name	Description
	MultilanguageString(IEnumerableKeyValuePairString, String)	Initializes a new instance of the MultilanguageString class.
	MultilanguageString(String)	Initializes a new instance of the MultilanguageString class.
	MultilanguageString(String)	Initializes a new instance of the MultilanguageString class with unlimited number of language key - language string pairs.

Top

Properties

	Name	Description
	AnyString	Gets any language string, that has a value. The method checks the current string first, but if it is empty, returns any string.
	Contents	Gets a string representation of all language strings in the form <key>='<value>' for each language pair.
	CurrentLanguage	Gets the two letter code of the current thread language.
	CurrentString	Gets the string for the language of the current UI culture.
	Item	Gets the language String with the specified language key.
	LanguagePairs	Gets all the language keys and values, comprising the MultilanguageString.

Top

Methods

	Name	Description
	CompareTo(Object)	Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
	CompareTo(MultilanguageString)	Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
	Concat(String, MultilanguageString)	Concatenates a MultilanguageString and a normal string, by concatenating each language string with the normal string.
	Concat(MultilanguageString, MultilanguageString)	Concatenates the specified MultilanguageString instances.
	Concat(MultilanguageString, String)	Concatenates a MultilanguageString and a normal string, by concatenating each language string with the normal string.
	ContainsLanguageString	Determines whether the MultilanguageString contains language string with the specified key.
	CreateFromContents	Creates a new MultilanguageString from a string, containing contents. For more information, see Contents.
	CreateFromCurrentLanguageString	Creates a new MultilanguageString from current language string.
	CreateFromLanguagePairs	Creates a new MultilanguageString from language pairs.
	CreateFromStringLanguagePairs	Creates a new MultilanguageString from language key - value string pairs.
	CreteFromPatchString	Creates a new MultilanguageString from previous patch string and previous value, respecting format.
	Equals(Object)	Determines whether the specified Object, is equal to this instance. (Overrides ObjectEquals(Object).)
	Equals(MultilanguageString)	Indicates whether the current object is equal to another object of the same type.
	Format	Returns a new MultilanguageString with each language string formatted according to format and arguments.
	FormatIntersect	Returns a new MultilanguageString containing language strings formatted according to format and argument. The result contains only languages, which occur in both the format and the argument.
	GetHashCode	Returns a hash code for this instance. (Overrides ObjectGetHashCode.)
	GetLanguageString	Returns the string for the specified language or null if it is not found.
	IsNullOrEmpty	Determines whether the specified string is null or empty.
	Join	Concatenates all the elements of a string array, using the specified separator between each element.
	RemoveLanguageString	Returns a new MultilanguageString without the language string with the specified key.
	ReplaceLanguageString	Returns new MultilanguageString with the specified language string replaced.
	ToString	Returns a String that represents this instance. (Overrides ObjectToString.)
	ToString(String)	Returns a String that represents this instance.
	ToString(String, IFormatProvider)	Returns a String that represents this instance.
	ValidateAndFormatLanguageKey	Validates the and formats the specified language key.

Top

Operators

	Name	Description
	Addition(String, MultilanguageString)	Implements the operator +.
	Addition(MultilanguageString, MultilanguageString)	Implements the operator +.
	Addition(MultilanguageString, String)	Implements the operator +.
	Equality	Implements the operator ==.
	(String to MultilanguageString)	Performs an explicit conversion from String to MultilanguageString.
	(MultilanguageString to String)	Performs an explicit conversion from MultilanguageString to String. It gets only the current language string.
	Inequality	Implements the operator !=.

Top

Fields

	Name	Description
	Empty	Gets the empty MultilanguageString.

Top

Extension Methods

	Name	Description
	Contains	Returns a value indicating whether a specified substring occurs within this MultilanguageString. (Defined by MultilanguageStringExtensions.)
	GetCurrentLanguageStringOrDefault	Gets the current language string. When from is null or there is no string for the current language, returns the language string of the default language. (Defined by MultilanguageStringExtensions.)
	GetCurrentOrAny(String)	Overloaded. Gets current language string. If not available - the second preference. If also not available - any. (Defined by MultilanguageStringExtensions.)
	GetCurrentOrAny(String, String)	Overloaded. Gets current language string. If not available - the second preference. If also not available - any. (Defined by MultilanguageStringExtensions.)
	GetCurrentOrTransliterated	Gets the current language string or transliterates another language string to the current language. (Defined by MultilanguageStringExtensions.)
	GetLanguageStringOrAny	Gets specified language string. If not available - any. (Defined by MultilanguageStringExtensions.)
	GetLanguageStringOrDefault	Returns the string for the specified language. If the MultilanguageString instance is null or the language string is not found, a null is returned. (Defined by MultilanguageStringExtensions.)
	Like	Compares a string against pattern. (Defined by MultilanguageStringExtensions.)
	Normalize	Removes empty strings. (Defined by MultilanguageStringExtensions.)

Top

Remarks

The multi-language string can store many language strings, indexing them by language key. The language key is a CultureInfo two letter ISO language name, like "en", "de", etc. The multi-language string can be encoded or decoded to/from normal string, which is particularly useful for serialization and persistence.

Reference

Aloe.EnterpriseOne.Model Namespace