String element

Article
08/20/2021

Represents a string resource.

Usage

<String
  Content = "xs:string"
  Id = "xs:positiveInteger or xs:string"
  Symbol = "xs:string">
  child elements
</String>

Attributes

Attribute	Type	Required	Description
Content	xs:string	No	(xs:string) A string composed of any sequence of characters, including white space and line-break characters.
Id	xs:positiveInteger or xs:string	No	The unique resource ID. (xs:positiveInteger or xs:string) 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	xs:string	No	The resource symbol for the string. (xs:string) A letter or underscore followed by any sequence of letters, digits, or underscores. The maximum length is 100 characters.

Child elements

Element	Description
String.Content	May occur at most once
String.Id	May occur at most once
String.Symbol	May occur at most once

Parent elements

Element
Command.Keytip
Command.LabelDescription
Command.LabelTitle
Command.TooltipDescription
Command.TooltipTitle

Remarks

Optional.

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

The string definition is added to the Ribbon header file, for example, #define strSave 59999.

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.

Examples

The following example demonstrates the markup for a Command.LabelTitle element with a String declaration.

<Command.LabelTitle>
  <String>
    <String.Content>Label for Save</String.Content>
    <String.Id>59999</String.Id>
    <String.Symbol>strSave</String.Symbol>
  </String>
</Command.LabelTitle>

Element information

Minimum supported system: Windows 7
Can be empty: No

Share via