API Help
Eplan.EplApi.Base Namespace / MultiLangString Class
Members

In This Topic
    MultiLangString Class
    In This Topic
    This class can save strings in various languages at the same time. Each string can be added, queried, and deleted individually.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.Base.MultiLangString

    Syntax
    public class MultiLangString 
    public ref class MultiLangString
    Remarks
    When adding a new language string, language-independant string is removed. When adding a language-independant string, other languages are removed.
    Public Constructors
     NameDescription
    Public ConstructorMultiLangString ConstructorDefault constructor  
    Top
    Public Properties
     NameDescription
    Public PropertyInternalStringSets internal string representation with format validation.  
    Top
    Public Methods
     NameDescription
    Public MethodAddStringAdds a string in the requested language.  
    Public MethodClearRemoves the contents.  
    Public MethodContainsDataReturns whether strings are saved in the MultiLanguageString.  
    Public MethodDeleteAllStringsExceptForRemoves unused translations.  
    Public MethodDeleteStringDeletes the language setting.  
    Public MethodDisposeDestructor for deterministic finalization of MultiLangString object.  
    Public MethodGetAsStringConverts an MultiLangString to a string. The languages are appended to one another, all having the same format.  
    Public MethodGetLanguageListReturns the list of the languages currently saved in this MultiLangString.  
    Public MethodGetStringReturns the string in the requested language  
    Public MethodGetStringToDisplayReturns the string that is to be displayed in accordance with the passed language. This may be the string saved for this language or, if there is no such string, a language-independent string.  
    Public MethodIsEqualCompares every string in every language. If a string is different in one language, then == returns FALSE. If an language string exists in one of the MultiLangStrings but not in the others, this function returns FALSE even if the language string is empty.  
    Public MethodSetAsStringSets the contents of a MultiLangString with a string passed as argument using language marker if necessary. If argument is in MultiLangString form, it will be parsed and saved under given languages. Otherwise '??_??@' prefix is added which means that the object is visible the same in every language.  
    Public MethodToStringReturns a string that represents the current object.  
    Public MethodTranslatableIndicates whether the MultiLanguageString can be translated.  
    Top
    Public Operators
    public Operator Equality Equality operator
    Top
    See Also

    Reference

    MultiLangString Members
    Eplan.EplApi.Base Namespace

     

     

    EPLAN API , 21.05.2020, © by EPLAN Software and Service GmbH and Co. KG. All rights reserved.

    Send Feedback