Office.AddinCommands.Source interface
Инкапсулирует исходные данные для событий надстройки.
Комментарии
Сведения о поддержке в Excel, Word и PowerPoint см. в разделе Наборы обязательных наборов команд надстройки.
Ниже приведены сведения о поддержке Outlook.
[ Набор API: Почтовый ящик 1.3 ]
Дополнительные сведения о поддержке см. в разделе Наборы требований к командам надстроек .
Минимальный уровень разрешений (Outlook):ограниченный
Применимый режим Outlook: создание или чтение
Свойства
id | Идентификатор элемента управления, который активировал вызов этой функции. Идентификатор исходит из манифеста. |
Сведения о свойстве
id
Идентификатор элемента управления, который активировал вызов этой функции. Идентификатор исходит из манифеста.
id: string;
Значение свойства
string
Комментарии
Ниже приведены сведения о поддержке Outlook.
[ Набор API: Почтовый ящик 1.3 ]
Дополнительные сведения о поддержке см. в разделе Наборы требований к командам надстроек .
Минимальный уровень разрешений (Outlook):ограниченный
Применимый режим Outlook: создание или чтение
Примеры
// In this example, consider a button defined in an add-in manifest.
// The following is the XML manifest definition. Below it is the Teams
// manifest (preview) definition.
//
//<Control xsi:type="Button" id="eventTestButton">
// <Label resid="eventButtonLabel" />
// <Tooltip resid="eventButtonTooltip" />
// <Supertip>
// <Title resid="eventSuperTipTitle" />
// <Description resid="eventSuperTipDescription" />
// </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>testEventObject</FunctionName>
// </Action>
//</Control>
//
// The Teams manifest (preview) definition is the following.
// Ellipses("...") indicate omitted properties.
//
// "extensions": [
// {
// ...
// "runtimes": [
// {
// "id": "CommandsRuntime",
// "type": "general",
// "code": {
// "page": "https://localhost:3000/commands.html",
// "script": "https://localhost:3000/commands.js"
// },
// "lifetime": "short",
// "actions": [
// {
// "id": "testEventObject",
// "type": "executeFunction",
// "displayName": "testEventObject"
// }
// ]
// }
// ],
// "ribbons": [
// {
// ...
// "tabs": [
// ...
// "groups": [
// ...
// "controls": [
// {
// "id": "eventTestButton",
// "type": "button",
// "label": "Perform an action",
// "icons": [
// {
// "size": 16,
// "file": "https://localhost:3000/assets/blue-icon-16.png"
// },
// {
// "size": 32,
// "file": "https://localhost:3000/assets/blue-icon-32.png"
// },
// {
// "size": 80,
// "file": "https://localhost:3000/assets/blue-icon-80.png"
// }
// ],
// "supertip": {
// "title": "Perform an action",
// "description": "Perform an action when clicked."
// },
// "actionId": "testEventObject"
// }
// ]
// ]
// ]
// }
// ]
// }
// ]
// The button has an id set to "eventTestButton", and will invoke
// the testEventObject function defined in the add-in.
// That function looks like this:
function testEventObject(event) {
// The event object implements the Event interface.
// This value will be "eventTestButton".
const buttonId = event.source.id;
// Signal to the host app that processing is complete.
event.completed();
}
// Function is used by two buttons:
// button1 and button2
function multiButton (event) {
// Check which button was clicked.
const buttonId = event.source.id;
if (buttonId === 'button1') {
doButton1Action();
} else {
doButton2Action();
}
event.completed();
}
Office Add-ins