Complete identifier of texts from the language switcher

VisiWin contains various options for accessing texts from the language switch. This is specified,

  • from which project file in the client or (multi-)server project the text is to be read,
  • from which text category (user texts or system texts) the text is to be read,
  • in which text group the text is located (as text groups can be nested within each other, the complete group hierarchy is expected),
  • what name the text has.

The full identifier, which is expected in some functions of the system, contains all these components.

Syntax of the complete identifier

@[ServerAlias:][TextType].TextGroups.TextName

with:

@ Fixed prefix for specifying a text from the language switch. If no @ is specified at the beginning, the language switching functions return the complete identifier themselves.
ServerAlias:

Alias of a project on another computer from the project configuration. The alias must end with a colon (:).

If no server alias is specified, the current project is used by default.

Note: Specifying a server alias only makes sense in projects that have been configured for a multi-server architecture.
TextType

Optional specification of one of the following values (enclosed in square brackets):

  • [ClientApplication]: A text from the client project in the User texts node.
  • [ServerApplication]: A text from the server project in the User texts node.
  • [ClientSystem]: A text from the client project that is located in one of the Components/Dialogues nodes or one of the system branches.
  • [ServerSystem]: A text from the server project that is located in one of the Components/Dialoguesnodes or one of the system branches.
TextGroups Specification of the text group hierarchy. The text groups below each other are specified one after the other from top to bottom, separated by a dot (.).
TextName Name of the localizable text, separated from the text group hierarchy specification by a dot (.).

Examples:

  1. @View1.txtOk

    or

    @[ClientApplication].View1.txtOk

    Returns the text txtOk from the UserText.View1 group in the current project language. The text type [ClientApplication] is optional.

  2. @[ClientSystem].Components.AlarmList.FileName

    Returns the text FileName from the Components.AlarmList group in the current project language.

  3. @[ServerSystem].AlarmSystem.Groups.AlarmGroup1.AlaOverflow

    Returns the text of the Overflow alarm from the AlarmGroup1 alarm group in the current project language.

    Remark:

    The fixed prefix Ala in AlaOverflow results from the automatic assignment of a name for an alarm text when the alarm is created via the editors.

    The fixed group prefix AlarmSystem.Groups is system-specific and specifies the group hierarchy Alarms.Alarmgroups.

  4. @RedundancyServer:[ServerApplication].CommonErrorTexts.MissingConnection

    Returns the text MissingConnection from the text group UserText.CommonErrorTexts from the project specified via the server alias RedundancyServerin the current project language.

    Note: When specifying a server alias, the text types [ClientApplication] and [ClientSystem] cannot be used because, as the term server aliassuggests, this is access to a server project file.