### Page Setup Methods Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/word-desktop-1_3.md This section details the methods available for performing actions on the Word page setup. ```APIDOC ## Page Setup Methods ### Description Provides methods for manipulating the page setup of a Word document. ### Methods - **setAsTemplateDefault()** ### Description Sets the specified page setup formatting as the default for the active document and all new documents based on the active template. ### Method POST ### Endpoint /api/word/pagesetup/setAsTemplateDefault - **togglePortrait()** ### Description Switches between portrait and landscape page orientations for a document or section. ### Method POST ### Endpoint /api/word/pagesetup/togglePortrait ``` -------------------------------- ### Page Setup API Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/word-desktop-1_3.md API endpoints for configuring page setup in Word documents. ```APIDOC ## GET /api/word/page/breaks ### Description Gets a `BreakCollection` object that represents the breaks on the page. ### Method GET ### Endpoint /api/word/page/breaks ### Response #### Success Response (200) - **breaks** (Word.BreakCollection) - The collection of breaks on the page. ## GET /api/word/pagesetup/bookFoldPrinting ### Description Specifies whether Microsoft Word prints the document as a booklet. ### Method GET ### Endpoint /api/word/pagesetup/bookFoldPrinting ### Response #### Success Response (200) - **bookFoldPrinting** (boolean) - True if booklet printing is enabled, false otherwise. ## PUT /api/word/pagesetup/bookFoldPrinting ### Description Sets whether Microsoft Word prints the document as a booklet. ### Method PUT ### Endpoint /api/word/pagesetup/bookFoldPrinting ### Parameters #### Request Body - **bookFoldPrinting** (boolean) - Required - Whether to enable booklet printing. ### Response #### Success Response (200) - **status** (string) - Indicates success. ``` -------------------------------- ### EquivalentAddins with Effect Example Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/equivalentaddins.md This example demonstrates how to configure the EquivalentAddins element, including specifying an EquivalentAddin with its ProgId and Type, and setting the Effect to UserOptionToDisable. The Effect element must appear after all EquivalentAddin elements. ```XML ... ContosoAddin COM UserOptionToDisable ``` -------------------------------- ### Page Setup Properties Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/word-desktop-1_3.md This section details the properties available for configuring the page setup of a Word document. ```APIDOC ## Page Setup Properties ### Description Provides access to properties that control the page setup of a Word document. ### Properties - **bookFoldPrintingSheets** (number) - Specifies the number of pages for each booklet. - **bookFoldReversePrinting** (boolean) - Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. - **bottomMargin** (number) - Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. - **charsLine** (number) - Specifies the number of characters per line in the document grid. - **differentFirstPageHeaderFooter** (boolean) - Specifies whether the first page has a different header and footer. - **footerDistance** (number) - Specifies the distance between the footer and the bottom of the page in points. - **gutter** (number) - Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. - **gutterPosition** (string) - Specifies on which side the gutter appears in a document. - **gutterStyle** (string) - Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. - **headerDistance** (number) - Specifies the distance between the header and the top of the page in points. - **layoutMode** (string) - Specifies the layout mode for the current document. - **leftMargin** (number) - Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. - **lineNumbering** (object) - Represents the line numbers for the `PageSetup` object. - **linesPage** (number) - Specifies the number of lines per page in the document grid. - **mirrorMargins** (boolean) - Specifies if the inside and outside margins of facing pages are the same width. - **oddAndEvenPagesHeaderFooter** (boolean) - Specifies whether odd and even pages have different headers and footers. - **orientation** (string) - Specifies the orientation of the page. - **pageHeight** (number) - Specifies the page height in points. - **pageWidth** (number) - Specifies the page width in points. - **paperSize** (string) - Specifies the paper size of the page. - **rightMargin** (number) - Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. - **sectionDirection** (string) - Specifies the reading order and alignment for the specified sections. - **sectionStart** (string) - Specifies the type of section break for the specified object. - **showGrid** (boolean) - Specifies whether to show the grid. - **suppressEndnotes** (boolean) - Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. - **textColumns** (object) - Represents the set of text columns for the `PageSetup` object. ``` -------------------------------- ### ExtendedOverrides Example Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/override.md An example demonstrating the use of ExtendedOverrides with Tokens, including LocaleToken overrides. ```APIDOC ### Example with ExtendedOverrides and Tokens ```xml ``` ``` -------------------------------- ### Group Element Example Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/group.md An example of how to define a Group element within an Office add-in manifest, including its ID, Label, Icon, and a sample Button control. ```APIDOC ### Request Example ```xml ``` ``` -------------------------------- ### PowerPoint.PageSetup Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/powerpoint-1_10.md Defines the page setup properties for a presentation. ```APIDOC ## PowerPoint.PageSetup ### Description Represents the page setup properties for a presentation. ### Fields - **slideHeight** (number) - Specifies the height of the slides in the presentation, in points. - **slideWidth** (number) - Specifies the width of the slides in the presentation, in points. ``` -------------------------------- ### VersionOverrides 1.0 element example Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/versionoverrides-1-0-content.md This XML snippet shows a basic example of the VersionOverrides 1.0 element for a content add-in, including the WebApplicationInfo child element. The WebApplicationInfo element must be the last child of VersionOverrides. ```xml ... $application_GUID here$ api://localhost:44355/$application_GUID here$ Files.Read.All profile ... ``` -------------------------------- ### Override element for Runtime example Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/override.md This example shows how to use the Override element to specify the 'resid' for a runtime based on its type. This is particularly relevant for event-based activation features. ```xml ``` -------------------------------- ### Override element for RequirementToken example Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/override.md This example demonstrates how to use the Override element to specify different values for the 'requirements' token based on the supported Office versions and requirement sets. Use this when you need to conditionally set a token's value. ```xml ``` ```xml ``` -------------------------------- ### Time.getAsync Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_1.md Gets the start or end time of an appointment. ```APIDOC ## getAsync(callback: (asyncResult: Office.AsyncResult) => void) ### Description Gets the start or end time of an appointment. ### Method getAsync ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **callback** ((asyncResult: Office.AsyncResult) => void) - Required - A function that is invoked when the call is complete. ### Response #### Success Response (200) - **asyncResult** (Office.AsyncResult) - The result object, containing the Date object representing the time. ``` -------------------------------- ### Excel.DocumentTaskSchedule.startDateTime Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/excel-preview.md Gets the date and time that the task should start. ```APIDOC ## Excel.DocumentTaskSchedule.startDateTime ### Description Gets the date and time that the task should start. ### Property - **startDateTime** (Date) - The start date and time of the task. ``` -------------------------------- ### getAsync Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_1.md Gets the start or end time of an appointment. This method is asynchronous and returns a promise. ```APIDOC ## getAsync ### Description Gets the start or end time of an appointment. ### Method getAsync ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters * **options** (Office.AsyncContextOptions) - Optional. An object that contains an identifier for the asynchronous operation. * **callback** ((asyncResult: Office.AsyncResult) => void) - Required. A callback function that is invoked when the call is complete. The callback receives an `AsyncResult` object that contains the date/time. ### Request Example ```javascript // Example of how to call getAsync myTime.getAsync(function (asyncResult) { if (asyncResult.status === Office.AsyncResultStatus.Succeeded) { var startTime = asyncResult.value; console.log("Appointment start time: " + startTime); } else { console.error("Error getting appointment time: " + asyncResult.error.message); } }); ``` ### Response #### Success Response (200) - **value** (Date) - The start or end time of the appointment. #### Response Example ```json { "value": "2023-10-27T10:00:00.000Z" } ``` ``` -------------------------------- ### Diagnostics.hostVersion Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_1.md Gets a string that represents the version of either the Outlook client or the Exchange Server (for example, "15.0.468.0"). ```APIDOC ## hostVersion ### Description Gets a string that represents the version of either the Outlook client or the Exchange Server (for example, "15.0.468.0"). ### Method Not specified (likely a property getter on a Diagnostics object) ``` -------------------------------- ### Define Resources with Placeholder URLs and Locale Overrides Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/resources.md This example shows a Resources element with placeholder URLs for images and functions, and includes a locale override for Arabic in a short string. ```XML ``` -------------------------------- ### Clone Repository and Set Upstream Source: https://github.com/officedev/office-js-docs-reference/blob/main/Contributing.md Clone your fork of the repository and add a reference to the root repository. This is a one-time setup. ```bash git clone https://github.com//office-js-docs-reference.git cd office-js-docs-reference git remote add upstream https://github.com/OfficeDev/office-js-docs-reference.git git fetch upstream ``` -------------------------------- ### PowerPoint.TextRange.start Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/powerpoint-1_5.md Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this TextRange represents. ```APIDOC ## GET/PUT /officedev/office-js-docs-reference/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-start-member ### Description Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents. ### Method GET/PUT ### Endpoint /officedev/office-js-docs-reference/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-start-member ### Parameters #### Query Parameters - **start** (integer) - Required/Optional - The zero-based index for the starting position of the range. ### Response #### Success Response (200) - **start** (integer) - The starting position of the text range. ``` -------------------------------- ### Get custom properties of a mail item Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/requirement-sets/outlook/outlook-requirement-set-1-9.md Retrieves all custom properties of a mail item in a mailbox. This method is available starting with requirement set 1.9. ```javascript Office.context.mailbox.item.loadCustomPropertiesAsync(callback); ``` -------------------------------- ### WebApplicationInfo element example Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/webapplicationinfo.md This XML snippet shows the structure of the WebApplicationInfo element within an Office Add-in manifest. It includes the Id, Resource, and Scopes for enabling single sign-on. ```xml ... ... 12345678-abcd-1234-efab-123456789abc api://contoso.com/12345678-abcd-1234-efab-123456789abc Files.Read.All offline_access openid profile ... ``` -------------------------------- ### Checkout New Branch Source: https://github.com/officedev/office-js-docs-reference/blob/main/Contributing.md Switch your working directory to the newly created branch (X2) to verify content and begin making further updates. ```bash git checkout X2 ``` -------------------------------- ### Define LaunchEvents in Manifest Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/launchevents.md Configure your add-in to activate based on supported events like new message composition or appointment organization. Ensure the SourceLocation resid matches your Runtime element. ```XML ``` -------------------------------- ### WebApplicationInfo Element Configuration Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/webapplicationinfo.md This snippet demonstrates the structure and usage of the WebApplicationInfo element within the Office Add-ins manifest file, including its child elements Id, Resource, and Scopes. ```APIDOC ## WebApplicationInfo Element ### Description Supports single sign-on (SSO) in Office Add-ins. This element contains information for the add-in as both an OAuth 2.0 resource and an OAuth 2.0 client. ### Method Not Applicable (Manifest Configuration) ### Endpoint Not Applicable (Manifest Configuration) ### Parameters #### Child Elements of WebApplicationInfo - **Id** (string) - Required - The Application Id of the add-in's associated service as registered in the Azure Active Directory v 2.0 endpoint. - **Resource** (string) - Required - Specifies the Application ID URI of the add-in as registered in the Azure Active Directory v 2.0 endpoint. - **Scopes** (object) - Required - Specifies the permissions that the add-in needs to a resource, such as Microsoft Graph. Contains child elements of type Scope. - **Scope** (string) - Required - A specific permission scope required by the add-in. ### Request Example ```xml 12345678-abcd-1234-efab-123456789abc api://contoso.com/12345678-abcd-1234-efab-123456789abc Files.Read.All offline_access openid profile ``` ### Response #### Success Response (200) Not Applicable (Manifest Configuration) #### Response Example Not Applicable (Manifest Configuration) ``` -------------------------------- ### MessageCompose BCC Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_1.md Gets an object that provides methods to get or update the recipients on the Bcc line of a message. ```APIDOC ## BCC ### Description Gets an object that provides methods to get or update the recipients on the Bcc (blind carbon copy) line of a message. ### Method GET (Implicit) ### Endpoint Not applicable (property access) ### Parameters None ### Request Example None ### Response An object providing methods to interact with Bcc recipients. ``` -------------------------------- ### DesktopFormFactor Example in Manifest Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/desktopformfactor.md This XML snippet shows how to define the DesktopFormFactor element within the Hosts section of an Office add-in manifest file. It includes a FunctionFile, GetStarted, and an ExtensionPoint. ```xml ... ... ``` -------------------------------- ### JavaScript: Initialize Office.js and define command function Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/functionfile.md This JavaScript code demonstrates how to initialize Office.js and define a command function that executes custom logic, such as highlighting a range in Excel. It includes error handling and calls event.completed to signal completion. The function must be registered using Office.actions.associate. ```javascript // Initialize the Office Add-in. Office.onReady(() => { // If needed, Office.js is ready to be called }); // The command function. async function highlightSelection(event) { // Implement your custom code here. The following code is a simple Excel example. try { await Excel.run(async (context) => { const range = context.workbook.getSelectedRange(); range.format.fill.color = "yellow"; await context.sync(); }); } catch (error) { // Note: In a production add-in, notify the user through your add-in's UI. console.error(error); } // Calling event.completed is required. event.completed lets the platform know that processing has completed. event.completed(); } // You must register the function with the following line. Office.actions.associate("highlightSelection", highlightSelection); ``` -------------------------------- ### ExtendedPermissions Example Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/extendedpermissions.md This XML snippet shows how to define the ExtendedPermissions element within the manifest file for a mail add-in. It includes an example of the AppendOnSend extended permission. ```XML ... true ... AppendOnSend ``` -------------------------------- ### MobileButton with ShowTaskpane Action Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/control-mobilebutton.md Example of a MobileButton that launches a task pane when selected. ```APIDOC ## Example: MobileButton showing a task pane ### Description This example illustrates how to configure a `MobileButton` to open a task pane when the user interacts with it. ### XML Structure ```xml ``` ### Key Components - **Control xsi:type="MobileButton"**: Identifies the element as a mobile button. - **id**: Unique identifier for the button. - **Label**: Text displayed on the button, referencing a resource ID. - **Icon**: Specifies the button's icon, including different sizes and scales. - **Action xsi:type="ShowTaskpane"**: Indicates that the button will open a task pane. - **SourceLocation**: Specifies the URL of the task pane, referencing a resource ID. ``` -------------------------------- ### getInitializationContextAsync Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_15.md Retrieves initialization data passed when the add-in is activated by an actionable message. ```APIDOC ## GET /api/outlook/getInitializationContextAsync ### Description Gets initialization data passed when the add-in is activated by an actionable message. ### Method GET ### Endpoint /api/outlook/getInitializationContextAsync ### Parameters #### Query Parameters - **options** (Office.AsyncContextOptions) - Optional - Options for the asynchronous operation. - **callback** (function) - Required - A callback function that receives an Office.AsyncResult object containing the initialization context string. ### Response #### Success Response (200) - **value** (string) - The initialization context data. #### Response Example ```json { "value": "initialization_data" } ``` ``` -------------------------------- ### Id Element Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/id.md The Id element specifies the unique ID of your Office Add-in as a GUID. This GUID must be hyphenated and should not contain any other punctuation. It is used to uniquely identify your add-in across all Office applications. ```APIDOC ## Id Element ### Description Specifies the unique ID of your Office Add-in as a GUID. Use a random GUID generating tool to get your GUID. The GUID should be hyphenated, but have no other punctuation. ### Add-in Type Content, Task pane, Mail ### Syntax ```XML string ``` ### Contained In - [OfficeApp](officeapp.md) ``` -------------------------------- ### LocationDetails.locationIdentifier Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_8.md Gets the `LocationIdentifier` of the location. ```APIDOC ## locationIdentifier ### Description The `LocationIdentifier` of the location. ### Type [LocationIdentifier](/javascript/api/outlook/office.locationidentifier) ``` -------------------------------- ### getInitializationContextAsync Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_15.md Retrieves initialization data passed when the add-in is activated by an actionable message. ```APIDOC ## GET /api/outlook/message/initialization-context ### Description Gets initialization data passed when the add-in is activated by an actionable message. ### Method GET ### Endpoint /api/outlook/message/initialization-context ### Parameters #### Query Parameters - **options** (Office.AsyncContextOptions) - Optional - Specifies options for the asynchronous operation. - **callback** (function) - Required - A callback function that is invoked when the operation completes. ### Response #### Success Response (200) - **asyncResult** (Office.AsyncResult) - An object containing the result of the asynchronous operation, with the initialization data as a string. #### Response Example ```json { "asyncResult": { "value": "(string) The initialization data." } } ``` ``` -------------------------------- ### LaunchEvents Configuration Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/launchevents.md This snippet shows how to configure the LaunchEvents element within an ExtensionPoint in your add-in's manifest file to enable event-based activation. ```APIDOC ## ExtensionPoint with LaunchEvents ### Description Configures your add-in to activate based on supported events. This is a child element of the `ExtensionPoint` element. ### Method Not Applicable (Manifest Configuration) ### Endpoint Not Applicable (Manifest Configuration) ### Parameters #### Child Elements - **LaunchEvents** (Element) - Required - Contains one or more `LaunchEvent` elements. ### Request Example ```xml ``` ### Response Not Applicable (Manifest Configuration) ### Child Elements of LaunchEvents #### LaunchEvent - **Type** (Attribute) - Required - Specifies the event type (e.g., `OnNewMessageCompose`, `OnNewAppointmentOrganizer`). - **FunctionName** (Attribute) - Required - The name of the JavaScript function to execute when the event is triggered. ``` -------------------------------- ### Location.getAsync Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_1.md Gets the location of an appointment. ```APIDOC ## getAsync(callback: (asyncResult: Office.AsyncResult) => void) ### Description Gets the location of an appointment. ### Method Not specified (likely a method call on a Location object) ### Parameters #### Path Parameters - **callback** ((asyncResult: Office.AsyncResult) => void) - Required - The callback function to execute when the get operation completes. ``` ```APIDOC ## getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void) ### Description Gets the location of an appointment. ### Method Not specified (likely a method call on a Location object) ### Parameters #### Path Parameters - **options** (Office.AsyncContextOptions) - Required - Options for the asynchronous operation. - **callback** ((asyncResult: Office.AsyncResult) => void) - Required - The callback function to execute when the get operation completes. ``` -------------------------------- ### location Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_1.md Gets the location of an appointment. ```APIDOC ## location ### Description Gets the location of an appointment. ### Method Not specified (assumed to be a property access within the Outlook JavaScript API) ### Endpoint Not applicable (SDK property) ``` -------------------------------- ### ExtendedOverrides with Tokens for localization Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/extendedoverrides.md This example shows how to use URL templates with tokens, such as 'locale', within the ExtendedOverrides element. This allows for dynamic loading of override files based on locale, with specific overrides for different regions. ```XML ``` -------------------------------- ### AppointmentRead.enhancedLocation Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_8.md Gets the locations of an appointment. ```APIDOC ## AppointmentRead.enhancedLocation ### Description Gets the locations of an appointment. ### Method `enhancedLocation` ### Return Value An `Office.EnhancedLocation` object. ``` -------------------------------- ### OfficeThemeChangedEventArgs.type Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_14.md Gets the type of the event. ```APIDOC ## OfficeThemeChangedEventArgs.type ### Description Gets the type of the event. ### Parameters This property does not have parameters. ### Response #### Success Response - **type** (string) - The type of the event. ``` -------------------------------- ### POST /api/createPresentation Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/powerpoint-1_1.md Creates and opens a new presentation. This method can optionally accept a base64 encoded file string to create the presentation from an existing file. ```APIDOC ## POST /api/createPresentation ### Description Creates and opens a new presentation. If a base64 encoded file string is provided, the presentation will be created from that file. ### Method POST ### Endpoint /api/createPresentation ### Parameters #### Query Parameters - **base64File** (string) - Optional - A base64 encoded string of the file to create the presentation from. ### Request Example ```json { "base64File": "JVBERi0xLjQKJcfsj6IKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PgplbmRvYmoKCjIgMCBvYmoKPDwvVHlwZS9QYWdlcy9Db3VudCAxL0tpZHNbMyAwIFJdPj4KZW5kb2JqCgozIDAgb2JqCjw8L1R5cGUvUGFnZS9NZWRpYV JleFsvMC8wLzU5NS84NDJdL1JvdGF0ZSAwL1R5cGUvUGFnZT4+CmVuZG9iagoKeiB4cmVmCjAgNwo4MDAwMDAwMDAwIDY1NTM1IGYKMDAwMDAwMDAxMCAwMDAwMCBuCjAwMDAwMDAwNTMgMDAwMDAgbiAKMDAwMDAwMDE1MyAwMDAwMCBuIAowMDAwMDAwMjQ1IDAwMDAwIG4KZW5kb2JqCgp0cmFpbGVyCjw8L1NpemUvNy9Sb290IDEgMCBSPj4Kc3RhcnR4cmVmCjQ1NQolJUVPRg==" } ``` ### Response #### Success Response (200) - **presentationId** (string) - The ID of the newly created presentation. #### Response Example ```json { "presentationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef" } ``` ``` -------------------------------- ### Excel.DocumentTask.id Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/excel-preview.md Gets the ID of the task. ```APIDOC ## Excel.DocumentTask.id ### Description Gets the ID of the task. ### Fields - **id** (string) - Required/Optional - Description ``` -------------------------------- ### GoToOptions Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/word-preview.md Options for navigating to a specific location in the document. ```APIDOC ## GoToOptions ### Description Options for navigating to a specific location in the document. ### Properties #### count - **count** (any) - Optional - If provided, specifies the number of the item in the document. #### direction - **direction** (any) - Optional - If provided, specifies the direction the range or selection is moved to. #### item - **item** (any) - Optional - If provided, specifies the kind of item the range or selection is moved to. #### name - **name** (any) - Optional - If provided, specifies the name if the `item` property is set to Word.GoToItem type `bookmark`, `comment`, `field`, or `object`. ``` -------------------------------- ### AppointmentCompose.getInitializationContextAsync Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_8.md Gets initialization data passed when the add-in is activated by an actionable message. This method has two overloads, one basic and one that accepts options. ```APIDOC ## AppointmentCompose.getInitializationContextAsync ### Description Gets initialization data passed when the add-in is activated by an actionable message. ### Method `getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)` `getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)` ### Parameters #### Parameters for basic overload: - **callback** ((asyncResult: Office.AsyncResult) => void) - Required - The callback function that is called when the operation completes. #### Parameters for overload with options: - **options** (Office.AsyncContextOptions) - Required - An object that provides options for the asynchronous operation. - **callback** ((asyncResult: Office.AsyncResult) => void) - Required - The callback function that is called when the operation completes. ### Response #### Success Response The callback receives an `Office.AsyncResult` object. The `value` property of the `asyncResult` contains the initialization data as a string. ``` -------------------------------- ### Subject.getAsync Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_1.md Gets the subject of an appointment or message. ```APIDOC ## getAsync(callback: (asyncResult: Office.AsyncResult) => void) ### Description Gets the subject of an appointment or message. ### Method getAsync ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **callback** ((asyncResult: Office.AsyncResult) => void) - Required - A function that is invoked when the call is complete. ### Response #### Success Response (200) - **asyncResult** (Office.AsyncResult) - The result object, containing the subject string. ``` ```APIDOC ## getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void) ### Description Gets the subject of an appointment or message. ### Method getAsync ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **options** (Office.AsyncContextOptions) - Optional - An object literal that contains the `asyncContext` property. - **callback** ((asyncResult: Office.AsyncResult) => void) - Required - A function that is invoked when the call is complete. ### Response #### Success Response (200) - **asyncResult** (Office.AsyncResult) - The result object, containing the subject string. ``` -------------------------------- ### LocationIdentifier.type Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_8.md Gets the location's type. ```APIDOC ## type ### Description The location's type. ### Type string ``` -------------------------------- ### Basic Manifest Host Element Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/host.md Use this syntax in the basic manifest to specify the Office application for your add-in. The 'Name' attribute determines the host type. ```xml ``` -------------------------------- ### ExtensionPoint: LaunchEvent Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/extensionpoint.md Defines an extension point for event-based activation, allowing add-ins to run in response to specific application events. ```APIDOC ## ExtensionPoint: LaunchEvent ### Description This extension point enables an add-in to activate based on supported events in both the desktop and mobile form factors. It is used for event-based activation. ### Method N/A (Manifest configuration) ### Endpoint N/A (Manifest configuration) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Child Elements - **LaunchEvents** (Element): List of LaunchEvent elements for event-based activation. - **SourceLocation** (Element): The location of the source JavaScript file. The `resid` value must match the `resid` value of the `Runtime` element. ### Request Example ```xml ``` ### Response N/A (Manifest configuration) #### Success Response (200) N/A #### Response Example N/A ``` -------------------------------- ### AppointmentCompose.enhancedLocation Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/includes/outlook-1_8.md Gets or sets the locations of the appointment. ```APIDOC ## AppointmentCompose.enhancedLocation ### Description Gets or sets the locations of the appointment. ### Method `enhancedLocation` ### Return Value An `Office.EnhancedLocation` object. ``` -------------------------------- ### Define a Menu with Task Pane and Function Actions Source: https://github.com/officedev/office-js-docs-reference/blob/main/docs/manifest/control-menu.md Use this XML to define a menu with two items: one that displays a task pane and another that executes a function. The menu is configured to be hidden on platforms that support contextual tabs. ```xml true