Class I18NInternal

String handle. Provides a wrapper around an Unicode string, primarily for localization purposes.

Actual value for this string is looked up in a global string table based on the provided identifier string and currently active language. If such value doesn't exist then the identifier is used as is.

Use {0}, {1}, etc. in the string value for values that might change dynamically.

Hierarchy

  • FrameworkObject
    • I18NInternal

Constructors

Methods

Constructors

  • Parameters

    • OptionalisInternalConstructor: boolean

    Returns I18NInternal

Methods

  • Creates a new localized string with the specified identifier. If the identifier doesn't previously exist in the string table, identifier value will also be used for initializing the default language version of the string.

    Parameters

    • options: {
          identifier: string;
          parameters: readonly string[];
          stringTableId?: number;
      } | {
          defaultString: string;
          identifier: string;
          parameters: readonly string[];
          stringTableId?: number;
      }

      Options object for the function call.

    Returns string