HelpButton element

  • Article

Represents the Help Button control.

Usage

<HelpButton
  CommandName = "xs:positiveInteger or xs:string"/>

Attributes

Attribute Type Required Description
CommandName
 xs:positiveInteger or xs:string
 No
 Associates the element with a Command.

(xs:positiveInteger or xs:string)
A string, an integer value between 2 and 59999, inclusive, or a hexadecimal value between 0x2 and 0xea5f, inclusive.
The value must be unique within the Ribbon XML document.
Maximum length: 100 characters.

Child elements

There are no child elements.

Parent elements

Element
Ribbon.HelpButton

Remarks

Optional.

May occur at most once for each Ribbon.HelpButton.

Launches an application help dialog box when clicked.

Examples

The following example demonstrates the basic markup that is required to implement a Ribbon Help Button control.

This section of code shows the HelpButton Command declaration.

<Command Name="cmdHelp"
         Symbol="IDR_CMD_HELP">      
</Command>

This section of code shows the HelpButton control declaration.

<Ribbon.HelpButton>
  <HelpButton CommandName="cmdHelp"/>
</Ribbon.HelpButton>

Element information

  • Minimum supported system: Windows 7
  • Can be empty: Yes

See also

Help Button control