StringDef Element

Note: This documentation is preliminary and is subject to change.

Represents a string resource.

Syntax

<StringDef
    Content = "xs:string"
    Id = "xs:positiveInteger_or_xs:string"
    Symbol = "xs:string"
>
<!-- child elements -->
</StringDef>

Attributes

  • Content
    Optional.
    [.]*

    A string composed of any sequence of characters, including white space and line break characters.

  • Id
    Optional. The resource ID for the string. Note  This value must be unique for each Ribbon instance.
    [0-9]* | 0[xX]0*([2-9a-fA-F]|[1-9a-fA-F][0-9a-fA-F]{1}|[1-9a-fA-F][0-9a-fA-F]{2}|[1-9a-dA-D][0-9a-fA-F]{3}|[eE]([0-9][0-9a-fA-F]{2}|[aA][0-5][0-9a-fA-F]))

    An integer value between 2 and 59999, inclusive, or 0x2 and 0xea5f in hexadecimal, inclusive.

    The maximum length is 10 characters including optional leading zeros.

  • Symbol
    Optional. The resource symbol for the string.
    [_A-Za-z][_A-Za-z0-9]*

    A letter or underscore followed by any sequence of letters, digits, or underscores.

    The maximum length is 100 characters.

Element Information

Parent elements Command.LabelTitle, Command.LabelDescription, Command.Keytip, Command.TooltipTitle, Command.TooltipDescription
Child elements

Remarks

Optional.

May occur at most once for each Command.LabelTitle, Command.LabelDescription, Command.Keytip, Command.TooltipTitle, or Command.TooltipDescription element.

The string is added to a string table in the Ribbon resource file where a name and ID are generated by the Ribbon framework if none are declared.

All child elements of the StringDef element are optional, but must occur in the specified order if declared:

  1. StringDef.Content
  2. StringDef.Id
  3. StringDef.Symbol