Control-ElementControl element

Definiert eine JavaScript-Funktion, die eine Aktion ausführt oder einen Aufgabenbereich startet. Ein Control-Element kann entweder eine Schaltfläche oder eine Menüoption sein. Mindestens ein Control-Element muss im Group-Element enthalten sein.Defines a JavaScript function that executes an action or launches a task pane. A Control element can be either a button or a menu option. At least one Control must be included in a Group element.

AttributeAttributes

AttributAttribute ErforderlichRequired BeschreibungDescription
xsi:typexsi:type JaYes Der Typ des Steuerelements, das definiert wird. Kann Button, Menu oder MobileButton sein.The type of control being defined. Can be either Button, Menu, or MobileButton.
idid NeinNo Die ID des Steuerelements. Darf maximal 125 Zeichen lang sein.The ID of the control element. Can be a maximum of 125 characters.

Hinweis

Der MobileButton-Wert für xsi:type ist im VersionOverrides-Schema 1.1 definiert.The MobileButton value for xsi:type is defined in VersionOverrides schema 1.1. Gilt nur für die Control-Elemente, die im MobileFormFactor-Element enthalten sind.It only applies to the Control elements contained within a MobileFormFactor element.

SchaltflächensteuerelementButton control

Eine Schaltfläche führt bei Auswahl durch den Benutzer eine einzelne Aktion aus. Sie kann eine Funktion ausführen oder einen Aufgabenbereich anzeigen. Jedes Schaltflächen-Steuerelement muss eine für das Manifest eindeutige id aufweisen.A button performs a single action when the user selects it. It can either execute a function or show a task pane. Each button control must have an id unique to the manifest.

Untergeordnete ElementeChild elements

ElementElement ErforderlichRequired BeschreibungDescription
LabelLabel JaYes Der Text für die Schaltfläche. Das Attribut resid muss auf den Wert des Attributs id eines String-Elements im ShortStrings-Element im Resources-Element festgelegt werden.The text for the button. The resid attribute must be set to the value of the id attribute of a String element in the ShortStrings element in the Resources element.
ToolTipToolTip NeinNo Die QuickInfo für die Schaltfläche. Das Attribut resid muss auf den Wert des Attributs id eines String-Elements festgelegt sein. Das Element String ist ein untergeordnetes Element des Elements LongStrings, und dieses ist ein untergeordnetes Element des Elements Resources.The tooltip for the button. The resid attribute must be set to the value of the id attribute of a String element. The String element is a child of the LongStrings element, which is a child of the Resources element.
SupertipSupertip JaYes Die Multiinfo für die Schaltfläche.The supertip for the button.
IconIcon JaYes Ein Bild für die Schaltfläche.An image for the button.
ActionAction JaYes Gibt die auszuführende Aktion an.Specifies the action to perform.

Beispiel für ExecuteFunction-SchaltflächeExecuteFunction button example

<Control xsi:type="Button" id="msgReadFunctionButton">
  <Label resid="funcReadButtonLabel" />
  <Supertip>
    <Title resid="funcReadSuperTipTitle" />
    <Description resid="funcReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="blue-icon-16" />
    <bt:Image size="32" resid="blue-icon-32" />
    <bt:Image size="80" resid="blue-icon-80" />
  </Icon>
  <Action xsi:type="ExecuteFunction">
    <FunctionName>getSubject</FunctionName>
  </Action>
</Control>

Beispiel für ShowTaskpane-SchaltflächeShowTaskpane button example

<Control xsi:type="Button" id="msgReadOpenPaneButton">
  <Label resid="paneReadButtonLabel" />
  <Supertip>
    <Title resid="paneReadSuperTipTitle" />
    <Description resid="paneReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="green-icon-16" />
    <bt:Image size="32" resid="green-icon-32" />
    <bt:Image size="80" resid="green-icon-80" />
  </Icon>
  <Action xsi:type="ShowTaskpane">
    <SourceLocation resid="readTaskPaneUrl" />
  </Action>
</Control>

Ein Menü definiert eine statische Liste mit Optionen. Jedes Menüelement führt eine Funktion aus oder zeigt einen Aufgabenbereich an. Untermenüs werden nicht unterstützt.A menu defines a static list of options. Each menu item either executes a function or shows a task pane. Submenus are not supported.

Bei Verwendung mit einem PrimaryCommandSurface- oder ContextMenu-Erweiterungspunkt definiert das Steuerelement Folgendes:When used with a PrimaryCommandSurface or ContextMenu extension point, the menu control defines:

  • Ein Menüelement auf der Stammebene.A root-level menu item.

  • Eine Liste von Untermenüelementen.A list of submenu items.

Bei Verwendung mit PrimaryCommandSurface zeigt das Menüelement auf der Stammebene eine Schaltfläche auf dem Menüband an. Wenn die Schaltfläche ausgewählt wird, wird das Untermenü als eine Dropdownliste angezeigt. Bei Verwendung mit ContextMenu wird ein Menüelement mit einem Untermenü im Kontextmenü eingefügt. In beiden Fällen können einzelne Untermenüelemente entweder eine JavaScript-Funktion ausführen oder einen Aufgabenbereich anzeigen. Derzeit wird nur eine Ebene von Untermenüs unterstützt.When used with PrimaryCommandSurface, the root menu item displays as a button on the ribbon. When the button is selected, the submenu displays as a drop-down list. When used with ContextMenu, a menu item with a submenu is inserted on the context menu. In both cases, individual submenu items can either execute a JavaScript function or show a task pane. Only one level of submenus is supported at this time.

Das folgende Beispiel zeigt, wie ein Menüelement mit zwei Untermenüelementen definiert wird. Das erste Untermenüelement zeigt einen Aufgabenbereich an, das zweite Untermenüelement führt eine JavaScript-Funktion aus.The following example shows how to define a menu item with two submenu items. The first submenu item shows a task pane, and the second submenu item runs a JavaScript function.

<Control xsi:type="Menu" id="TestMenu2">
  <Label resid="residLabel3" />
  <Tooltip resid="residToolTip" />
  <Supertip>
    <Title resid="residLabel" />
    <Description resid="residToolTip" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="icon1_32x32" />
    <bt:Image size="32" resid="icon1_32x32" />
    <bt:Image size="80" resid="icon1_32x32" />
  </Icon>
  <Items>
    <Item id="showGallery2">
      <Label resid="residLabel3"/>
      <Supertip>
        <Title resid="residLabel" />
        <Description resid="residToolTip" />
      </Supertip>
      <Icon>
        <bt:Image size="16" resid="icon1_32x32" />
        <bt:Image size="32" resid="icon1_32x32" />
        <bt:Image size="80" resid="icon1_32x32" />
      </Icon>
      <Action xsi:type="ShowTaskpane">
        <TaskpaneId>MyTaskPaneID1</TaskpaneId>
        <SourceLocation resid="residUnitConverterUrl" />
      </Action>
    </Item>
    <Item id="showGallery3">
      <Label resid="residLabel5"/>
      <Supertip>
        <Title resid="residLabel" />
        <Description resid="residToolTip" />
      </Supertip>
      <Icon>
        <bt:Image size="16" resid="icon4_32x32" />
        <bt:Image size="32" resid="icon4_32x32" />
        <bt:Image size="80" resid="icon4_32x32" />
      </Icon>
      <Action xsi:type="ExecuteFunction">
        <FunctionName>getButton</FunctionName>
      </Action>
    </Item>
  </Items>
</Control>

Untergeordnete ElementeChild elements

ElementElement ErforderlichRequired BeschreibungDescription
LabelLabel JaYes Der Text für die Schaltfläche. Das Attribut resid muss auf den Wert des Attributs id eines String-Elements im ShortStrings-Element im Resources-Element festgelegt werden.The text for the button. The resid attribute must be set to the value of the id attribute of a String element in the ShortStrings element in the Resources element.
ToolTipToolTip NeinNo Die QuickInfo für die Schaltfläche. Das Attribut resid muss auf den Wert des Attributs id eines String-Elements festgelegt sein. Das Element String ist ein untergeordnetes Element des Elements LongStrings, und dieses ist ein untergeordnetes Element des Elements Resources.The tooltip for the button. The resid attribute must be set to the value of the id attribute of a String element. The String element is a child of the LongStrings element, which is a child of the Resources element.
SupertipSupertip JaYes Die Multiinfo für diese Schaltfläche.The supertip for this button.
SymbolIcon JaYes Ein Bild für die Schaltfläche.An image for the button.
ItemsItems JaYes Eine Auflistung von Schaltflächen, die innerhalb des Menüs angezeigt werden sollen. Enthält die Item-Elemente für jedes Untermenüelement. Jedes Item-Element enthält die untergeordneten Elemente eines Schaltflächensteuerelements.A collection of Buttons to display within the menu. Contains the Item elements for each submenu item. Each Item element contains the child elements of the Button control.
<Control xsi:type="Menu" id="TestMenu2">
  <Label resid="residLabel3" />
  <Tooltip resid="residToolTip" />
  <Supertip>
    <Title resid="residLabel" />
    <Description resid="residToolTip" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="icon1_32x32" />
    <bt:Image size="32" resid="icon1_32x32" />
    <bt:Image size="80" resid="icon1_32x32" />
  </Icon>
  <Items>
    <Item id="showGallery2">
      <Label resid="residLabel3"/>
      <Supertip>
        <Title resid="residLabel" />
        <Description resid="residToolTip" />
      </Supertip>
      <Icon>
        <bt:Image size="16" resid="icon1_32x32" />
        <bt:Image size="32" resid="icon1_32x32" />
        <bt:Image size="80" resid="icon1_32x32" />
      </Icon>
      <Action xsi:type="ShowTaskpane">
        <TaskpaneId>MyTaskPaneID1</TaskpaneId>
        <SourceLocation resid="residUnitConverterUrl" />
      </Action>
    </Item>
    <Item id="showGallery3">
      <Label resid="residLabel5"/>
      <Supertip>
        <Title resid="residLabel" />
        <Description resid="residToolTip" />
      </Supertip>
      <Icon>
        <bt:Image size="16" resid="icon4_32x32" />
        <bt:Image size="32" resid="icon4_32x32" />
        <bt:Image size="80" resid="icon4_32x32" />
      </Icon>
      <Action xsi:type="ExecuteFunction">
        <FunctionName>getButton</FunctionName>
      </Action>
    </Item>
  </Items>
</Control>

<Control xsi:type="Menu" id="msgReadMenuButton">
  <Label resid="menuReadButtonLabel" />
  <Supertip>
    <Title resid="menuReadSuperTipTitle" />
    <Description resid="menuReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="red-icon-16" />
    <bt:Image size="32" resid="red-icon-32" />
    <bt:Image size="80" resid="red-icon-80" />
  </Icon>
  <Items>
    <Item id="msgReadMenuItem1">
      <Label resid="menuItem1ReadLabel" />
      <Supertip>
        <Title resid="menuItem1ReadLabel" />
        <Description resid="menuItem1ReadTip" />
      </Supertip>
      <Icon>
        <bt:Image size="16" resid="red-icon-16" />
        <bt:Image size="32" resid="red-icon-32" />
        <bt:Image size="80" resid="red-icon-80" />
      </Icon>
      <Action xsi:type="ExecuteFunction">
        <FunctionName>getItemClass</FunctionName>
      </Action>
    </Item>
  </Items>
</Control>

MobileButton-SteuerelementMobileButton control

Eine mobile Schaltfläche führt bei Auswahl durch den Benutzer eine einzelne Aktion aus. Sie kann eine Funktion ausführen oder einen Aufgabenbereich anzeigen. Jedes mobile Schaltflächensteuerelement muss eine für das Manifest eindeutige id aufweisen.A mobile button performs a single action when the user selects it. It can either execute a function or show a task pane. Each mobile button control must have an id unique to the manifest.

Der MobileButton-Wert für xsi:type ist im VersionOverrides-Schema 1.1 definiert. Das enthaltende VersionOverrides-Element muss einen xsi:type-Attributwert von VersionOverridesV1_1 aufweisen.The MobileButton value for xsi:type is defined in VersionOverrides schema 1.1. The containing VersionOverrides element must have an xsi:type attribute value of VersionOverridesV1_1.

Untergeordnete ElementeChild elements

ElementElement ErforderlichRequired BeschreibungDescription
LabelLabel JaYes Der Text für die Schaltfläche. Das Attribut resid muss auf den Wert des Attributs id eines String-Elements im ShortStrings-Element im Resources-Element festgelegt werden.The text for the button. The resid attribute must be set to the value of the id attribute of a String element in the ShortStrings element in the Resources element.
IconIcon JaYes Ein Bild für die Schaltfläche.An image for the button.
ActionAction JaYes Gibt die auszuführende Aktion an.Specifies the action to perform.

Beispiel für mobile ExecuteFunction-SchaltflächeExecuteFunction mobile button example

<Control xsi:type="MobileButton" id="msgReadFunctionButton">
  <Label resid="funcReadButtonLabel" />
  <Icon>
    <bt:Image resid="blue-icon-16-1" size="25" scale="1" />
    <bt:Image resid="blue-icon-16-2" size="25" scale="2" />
    <bt:Image resid="blue-icon-16-3" size="25" scale="3" />
    <bt:Image resid="blue-icon-32-1" size="32" scale="1" />
    <bt:Image resid="blue-icon-32-2" size="32" scale="2" />
    <bt:Image resid="blue-icon-32-3" size="32" scale="3" />
    <bt:Image resid="blue-icon-80-1" size="48" scale="1" />
    <bt:Image resid="blue-icon-80-2" size="48" scale="2" />
    <bt:Image resid="blue-icon-80-3" size="48" scale="3" />
  </Icon>
  <Action xsi:type="ExecuteFunction">
    <FunctionName>getSubject</FunctionName>
  </Action>
</Control>

Beispiel für mobile ShowTaskpane-SchaltflächeShowTaskpane mobile button example

<Control xsi:type="MobileButton" id="msgReadOpenPaneButton">
  <Label resid="paneReadButtonLabel" />
  <Icon>
    <bt:Image resid="blue-icon-16-1" size="25" scale="1" />
    <bt:Image resid="blue-icon-16-2" size="25" scale="2" />
    <bt:Image resid="blue-icon-16-3" size="25" scale="3" />
    <bt:Image resid="blue-icon-32-1" size="32" scale="1" />
    <bt:Image resid="blue-icon-32-2" size="32" scale="2" />
    <bt:Image resid="blue-icon-32-3" size="32" scale="3" />
    <bt:Image resid="blue-icon-80-1" size="48" scale="1" />
    <bt:Image resid="blue-icon-80-2" size="48" scale="2" />
    <bt:Image resid="blue-icon-80-3" size="48" scale="3" />
  </Icon>
  <Action xsi:type="ShowTaskpane">
    <SourceLocation resid="readTaskPaneUrl" />
  </Action>
</Control>