A button on a toolbar or menu.

Namespace: http://schemas.esri.com/Desktop/AddInsSchema: DesktopAddIns_ElementOnly.xsd

Parents

 Commands

Children

Name Occurrences Description
 Help

The command's help displayed when using the "What's This?" tool on the command.

Attributes

Name Type Required Description
 caption  string Yes

The caption for the type.

 category  string Yes

The name of the category with which this command is associated.

 class  string Yes

The class associated with the type. This class is the active portion of the type and resides in the specified library. If this class is not in the default library namespace specified on the root AddIn element, the class name must be the full name (namespace.className).

 id  ID Yes

The ID for this custom type. IDs must be unique across all customizations.

 image  string

The image that is used as the icon on this command.

 message  string

The status bar message for this type.

 onDemand  boolean

Indicates if it is a delay loading command. By default, the assemblies associated with Add-In buttons and tools are not loaded until the corresponding item on a toolbar or menu is clicked by the user. This behavior helps conserve application memory and other resources. Since the enabled state of an Add-In button or tool is controlled by the OnUpdate method within code, they will initially appear enabled. If you need tighter control over the initial enabled state of a button or tool, you will need to override the default behavior and force the item to load at startup by setting the attribute equal to false.

 tip  string

The screen tip for the type. The tip appears when you hover over the item on the toolbar or menu.

Syntax

CopyXML
<xs:element name="Button" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:all>
      <xs:element name="Help" />
    </xs:all>
    <xs:attribute name="id" type="xs:ID" use="required" />
    <xs:attribute name="caption" type="xs:string" use="required" />
    <xs:attribute name="class" type="xs:string" use="required" />
    <xs:attribute name="category" type="xs:string" use="required" />
    <xs:attribute name="image" type="xs:string" use="optional" />
    <xs:attribute name="tip" type="xs:string" use="optional" />
    <xs:attribute name="message" type="xs:string" use="optional" />
    <xs:attribute default="true" name="onDemand" type="xs:boolean" use="optional" />
  </xs:complexType>
</xs:element>

See Also