diff --git a/types/gimloader/gimloader-tests.ts b/types/gimloader/gimloader-tests.ts index 381fa2f717018f..9529121f53dc0c 100644 --- a/types/gimloader/gimloader-tests.ts +++ b/types/gimloader/gimloader-tests.ts @@ -12,6 +12,7 @@ api.patcher; // $ExpectType Readonly api.plugins; // $ExpectType Readonly api.rewriter; // $ExpectType Readonly api.storage; // $ExpectType Readonly +api.commands; // $ExpectType Readonly GL.React; // $ExpectType typeof React GL.UI; // $ExpectType Readonly @@ -22,6 +23,7 @@ GL.patcher; // $ExpectType Readonly GL.plugins; // $ExpectType Readonly GL.rewriter; // $ExpectType Readonly GL.storage; // $ExpectType Readonly +GL.commands; // $ExpectType Readonly // @ts-expect-error GL.onStop; @@ -48,6 +50,38 @@ api.net.modifyFetchRequest("/path/*/thing", (options) => null); api.net.modifyFetchRequest("/path/*/thing", (options) => options); api.net.modifyFetchResponse("/path/*/thing", (response) => response); +api.commands.addCommand({ + text: "test", + hidden: () => false, + keywords: ["thing", "thing"], +}, async (context) => { + await context.number({ + title: "Number", + decimal: false, + max: 6, + min: 1, + }); + await context.select({ + title: "Select", + options: [ + { + label: "Option 1", + value: "option1", + }, + { + label: "Option 2", + value: "option2", + }, + ], + }); + await context.string({ + title: "String", + maxLength: 10, + }); +}); + +api.commands.addCommand({ text: () => "something" }, () => {}); + GL.stores.phaser; // $ExpectType Phaser window.stores.phaser; // $ExpectType Phaser let worldManagerInstance!: Gimloader.Stores.WorldManager; diff --git a/types/gimloader/index.d.ts b/types/gimloader/index.d.ts index 3c19ae8a0bb881..ef11cdf4493855 100644 --- a/types/gimloader/index.d.ts +++ b/types/gimloader/index.d.ts @@ -421,7 +421,7 @@ declare global { onChange(value: RotatedRect): void; } - interface VisualEditing { + interface DeviceVisualEditing { add: { box(options: VisualEditingBox): void; circle(options: VisualEditingCircle): void; @@ -969,7 +969,8 @@ declare global { } interface Jump { - actuallyJumped: boolean; + /** Optional in top-down, required in platformer */ + actuallyJumped?: boolean; isJumping: boolean; jumpCounter: number; jumpTicks: number; @@ -1150,7 +1151,7 @@ declare global { id: string; scene: Scene; deviceOption: DeviceOption; - visualEditing: VisualEditing; + visualEditing: DeviceVisualEditing; shadows: Shadows; input: DeviceInput; parts: any; @@ -1276,7 +1277,7 @@ declare global { } interface Keyboard { - heldKeys: Set; + heldKeys: Set; scene: Scene; state: KeyboardState; createListeners(): void; @@ -1391,7 +1392,10 @@ declare global { } interface EditingStore { - accessPoints: Map; + accessPoints: Map; gridSnap: number; showMemoryBarAtAllTimes: boolean; } @@ -1638,7 +1642,7 @@ declare global { id: string; position: string; text: string; - trackedItemId: any; + trackedItemId: string | null; showTrackedItemMaximumAmount: boolean; type: string; priority: number; @@ -1687,13 +1691,38 @@ declare global { removing: boolean; } + interface Widget { + type: string; + id: string; + y: number; + placement: string; + statName: string; + statValue: number; + } + + interface CallToActionItem { + id: string; + category: string; + name: string; + url: string; + } + + interface CallToActionCategory { + id: string; + name: string; + plural: string; + } + interface GameSession { - callToAction: any; + callToAction: { + categories: CallToActionCategory[]; + items: CallToActionItem[]; + }; countdownEnd: number; phase: string; resultsEnd: number; widgets: { - widgets: any[]; + widgets: Widget[]; }; } @@ -1847,6 +1876,26 @@ declare global { topDownControlsActive: boolean; } + interface VisualEditing { + active: boolean; + cursor: string; + id: string; + instruction: string; + keyboardHelpers: { + trigger: string; + action: string; + }[]; + } + + interface SortingState { + depth: number; + deviceId: string; + deviceName: string; + globalDepth: number; + layer: string; + y: number; + } + interface CurrentlyEditedDevice { deviceOptionId: string; id: string; @@ -1857,9 +1906,9 @@ declare global { currentlyEditedGridId: string; currentlySortedDeviceId: string; screen: string; - sortingState: any[]; + sortingState: SortingState[]; usingMultiselect: boolean; - visualEditing: any; + visualEditing: VisualEditing; } interface Editing { @@ -1873,7 +1922,7 @@ declare global { interface MeDeviceUI { current: { deviceId: string; - props: any; + props: Record; }; desiredOpenDeviceId?: string; serverVersionOpenDeviceId: string; @@ -2026,6 +2075,11 @@ declare global { items: Map; } + interface WireConnection { + id: string; + name: string; + } + interface CodeGridSchema { allowChannelGrids: boolean; customBlocks: any[]; @@ -2034,12 +2088,28 @@ declare global { interface DeviceOption { codeGridSchema: CodeGridSchema; - defaultState: any; + defaultState: Record; + description?: string; id: string; + initialMemoryCost?: number; + maxOnMap?: number; + maximumRoleLevel?: number; + minimumRoleLevel?: number; + name?: string; optionSchema: { options: any[]; }; - wireConfig: any; + seasonTicketRequired?: boolean; + subsequentMemoryCost?: number; + supportedMapStyles?: string[]; + wireConfig: { + in: { + connections: WireConnection[]; + }; + out: { + connections: WireConnection[]; + }; + }; } interface DeviceData { @@ -2121,23 +2191,19 @@ declare global { type SettingsChangeCallback = (value: any, remote: boolean) => void; - interface CustomSection { + interface CustomSection { type: "customsection"; id: string; - default?: any; - onChange?: (value: any, remote: boolean) => void; - render: ( - container: HTMLElement, - currentValue: any, - onChange: (newValue: any) => void, - // eslint-disable-next-line @typescript-eslint/no-invalid-void-type - ) => (() => void) | void; + default?: T; + onChange?: (value: T, remote: boolean) => void; + // eslint-disable-next-line @typescript-eslint/no-invalid-void-type + render: (container: HTMLElement, currentValue: T, onChange: (newValue: T) => void) => (() => void) | void; } - interface CustomSetting extends BaseSetting { + interface CustomSetting extends BaseSetting { type: "custom"; // eslint-disable-next-line @typescript-eslint/no-invalid-void-type - render: (container: HTMLElement, currentValue: any, update: (newValue: any) => void) => (() => void) | void; + render: (container: HTMLElement, currentValue: T, update: (newValue: T) => void) => (() => void) | void; } interface ColorSetting extends BaseSetting { @@ -2226,7 +2292,7 @@ declare global { interface SettingsMethods { create: (description: PluginSettingsDescription) => void; - listen: (key: string, callback: SettingsChangeCallback) => () => void; + listen: (key: string, callback: SettingsChangeCallback, immediate?: boolean) => () => void; } type PluginSettings = SettingsMethods & Record; @@ -2237,22 +2303,7 @@ declare global { /** Whether a plugin exists and is enabled */ isEnabled(name: string): boolean; /** Gets the headers of a plugin, such as version, author, and description */ - getHeaders(name: string): { - name: string; - description: string; - author: string; - version: string | null; - reloadRequired: string; - isLibrary: string; - downloadUrl: string | null; - webpage: string | null; - needsLib: string[]; - optionalLib: string[]; - deprecated: string | null; - gamemode: string[]; - changelog: string[]; - hasSettings: string; - }; + getHeaders(name: string): ScriptHeaders; /** Gets the exported values of a plugin, if it has been enabled */ get(name: string): any; /** @@ -2264,32 +2315,85 @@ declare global { }; } + interface ScriptHeaders { + name: string; + description: string; + author: string; + version: string | null; + reloadRequired: string; + isLibrary: string; + downloadUrl: string | null; + webpage: string | null; + needsLib: string[]; + optionalLib: string[]; + deprecated: string | null; + gamemode: string[]; + changelog: string[]; + /** Only available for plugins */ + needsPlugin: string[]; + hasSettings: string; + } + class LibsApi { /** A list of all the libraries installed */ get list(): string[]; /** Gets whether or not a plugin is installed and enabled */ isEnabled(name: string): boolean; /** Gets the headers of a library, such as version, author, and description */ - getHeaders(name: string): { - name: string; - description: string; - author: string; - version: string | null; - reloadRequired: string; - isLibrary: string; - downloadUrl: string | null; - webpage: string | null; - needsLib: string[]; - optionalLib: string[]; - deprecated: string | null; - gamemode: string[]; - changelog: string[]; - hasSettings: string; - }; + getHeaders(name: string): ScriptHeaders; /** Gets the exported values of a library */ get(name: string): any; } + class ScopedCommandsApi { + private readonly id; + constructor(id: string); + /** Adds a command to the user's command palette. Can request additional input within the callback. */ + addCommand(options: CommandOptions, callback: CommandCallback): () => void; + } + + interface CommandStringOptions extends BaseCommandOptions { + maxLength?: number; + } + + interface CommandNumberOptions extends BaseCommandOptions { + min?: number; + max?: number; + decimal?: boolean; + } + + interface BaseCommandOptions { + title: string; + } + + interface CommandSelectOptions extends BaseCommandOptions { + options: { + label: string; + value: string; + }[]; + } + + interface CommandContext { + select(options: CommandSelectOptions): Promise; + number(options: CommandNumberOptions): Promise; + string(options: CommandStringOptions): Promise; + } + + type CommandCallback = (context: CommandContext) => void | Promise; + + interface CommandOptions { + text: string | (() => string); + keywords?: string[]; + hidden?: () => boolean; + } + + class CommandsApi { + /** Adds a command to the user's command palette. Can request additional input within the callback. */ + addCommand(id: string, options: CommandOptions, callback: CommandCallback): () => void; + /** Removes all commands that were added with the same id */ + removeCommands(id: string): void; + } + class ScopedRewriterApi { private readonly id; constructor(id: string); @@ -2442,18 +2546,18 @@ declare global { } interface ModalOptions { - id: string; - title: string; - style: string; - className: string; - closeOnBackgroundClick: boolean; - buttons: ModalButton[]; - onClosed: () => void; + id?: string; + title?: string; + style?: string; + className?: string; + closeOnBackgroundClick?: boolean; + buttons?: ModalButton[]; + onClosed?: () => void; } class BaseUIApi { /** Shows a customizable modal to the user */ - showModal(element: HTMLElement | import("react").ReactElement, options?: Partial): void; + showModal(element: HTMLElement | import("react").ReactElement, options?: ModalOptions): void; } class UIApi extends BaseUIApi { @@ -2496,7 +2600,7 @@ declare global { /** Whether the user is the one hosting the current game */ get isHost(): boolean; /** Sends a message to the server on a specific channel */ - send(channel: string, message: any): void; + send(channel: string, message?: any): void; } interface RequesterOptions { @@ -2554,8 +2658,6 @@ declare global { } class ScopedParcelApi extends BaseParcelApi { - private readonly id; - constructor(id: string); /** * Waits for a module to be loaded, then runs a callback * @returns A function to cancel waiting for the module @@ -2729,6 +2831,8 @@ declare global { static storage: Readonly; /** Functions for intercepting the arguments and return values of functions */ static patcher: Readonly; + /** Functions for adding commands to the command palette */ + static commands: Readonly; /** Methods for getting info on libraries */ static libs: Readonly; /** Gets the exported values of a library */ @@ -2798,6 +2902,8 @@ declare global { storage: Readonly; /** Functions for intercepting the arguments and return values of functions */ patcher: Readonly; + /** Functions for adding commands to the command palette */ + commands: Readonly; /** A utility for creating persistent settings menus, only available to plugins */ settings: PluginSettings; /** Methods for getting info on libraries */ diff --git a/types/gimloader/package.json b/types/gimloader/package.json index f2484b2f6f1c5b..6c5de4a71ecf6c 100644 --- a/types/gimloader/package.json +++ b/types/gimloader/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/gimloader", - "version": "1.9.9999", + "version": "1.10.9999", "nonNpm": "conflict", "nonNpmDescription": "Types for the Gimloader global variables", "projects": [ diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index c8c50c1188cb5e..4560004d91b810 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -186959,9 +186959,9 @@ declare namespace PowerPoint { */ static newObject(context: OfficeExtension.ClientRequestContext): PowerPoint.Application; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): { [key: string]: string; }; @@ -186995,8 +186995,7 @@ declare namespace PowerPoint { * Returns the page setup information whose properties control slide setup attributes for the presentation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly pageSetup: PowerPoint.PageSetup; /** @@ -187126,9 +187125,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.Presentation; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Presentation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PresentationData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Presentation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PresentationData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.PresentationData; } /** @@ -187162,8 +187161,7 @@ declare namespace PowerPoint { * Represents the adjustment values for a shape. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ class Adjustments extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -187172,8 +187170,7 @@ declare namespace PowerPoint { * Specifies the number of adjustment points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly count: number; /** @@ -187181,8 +187178,7 @@ declare namespace PowerPoint { Throws an `InvalidArgument` exception when the index is out of range. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param index The index of the adjustment to retrieve. * @returns The adjustment value at the given index. @@ -187193,8 +187189,7 @@ declare namespace PowerPoint { Throws an `InvalidArgument` exception when the index is out of range. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param index The index of the adjustment to set. * @param value The adjustment value to set. @@ -187222,9 +187217,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.Adjustments; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Adjustments` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.AdjustmentsData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Adjustments` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.AdjustmentsData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.AdjustmentsData; } /** @@ -187309,9 +187304,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.CustomXmlPart; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.CustomXmlPartData; } /** @@ -187349,8 +187344,7 @@ declare namespace PowerPoint { Throws an `InvalidArgument` exception when the index is out of range. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param index The index of the custom XML part in the collection. * @returns The custom XML part at the given index. @@ -187402,9 +187396,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartScopedCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.CustomXmlPartScopedCollectionData; } /** @@ -187458,8 +187452,7 @@ declare namespace PowerPoint { Throws an `InvalidArgument` exception when the index is out of range. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param index The index of the custom XML part in the collection. * @returns The custom XML part at the given index. @@ -187495,33 +187488,30 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData; } /** * Represents the available options when adding a {@link PowerPoint.Hyperlink}. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface HyperlinkAddOptions { /** * Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ address?: string; /** * Specifies the string displayed when hovering over the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ screenTip?: string; } @@ -187529,8 +187519,7 @@ declare namespace PowerPoint { * Represents a scoped collection of hyperlinks. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ class HyperlinkScopedCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -187541,8 +187530,7 @@ declare namespace PowerPoint { * Gets the number of hyperlinks in the collection. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * @returns The number of hyperlinks in the collection. */ getCount(): OfficeExtension.ClientResult; @@ -187551,8 +187539,7 @@ declare namespace PowerPoint { Throws an `InvalidArgument` exception when the index is out of range. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param index The index of the hyperlink in the collection. * @returns The hyperlink at the given index. @@ -187577,9 +187564,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkScopedCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.HyperlinkScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.HyperlinkScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.HyperlinkScopedCollectionData; } /** @@ -187636,302 +187623,259 @@ declare namespace PowerPoint { * Specifies the style of a bullet. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ enum BulletStyle { /** * Style is unsupported. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ unsupported = "Unsupported", /** * Lowercase alphabetical characters with a period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ alphabetLowercasePeriod = "AlphabetLowercasePeriod", /** * Uppercase alphabetical characters with a period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ alphabetUppercasePeriod = "AlphabetUppercasePeriod", /** * Arabic numerals with closing parenthesis. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ arabicNumeralParenthesisRight = "ArabicNumeralParenthesisRight", /** * Arabic numerals with a period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ arabicNumeralPeriod = "ArabicNumeralPeriod", /** * Lowercase Roman numerals with both parentheses. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ romanLowercaseParenthesesBoth = "RomanLowercaseParenthesesBoth", /** * Lowercase Roman numerals with closing parenthesis. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ romanLowercaseParenthesisRight = "RomanLowercaseParenthesisRight", /** * Lowercase Roman numerals with period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ romanLowercasePeriod = "RomanLowercasePeriod", /** * Uppercase Roman numerals with period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ romanUppercasePeriod = "RomanUppercasePeriod", /** * Lowercase alphabetical characters with both parentheses. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ alphabetLowercaseParenthesesBoth = "AlphabetLowercaseParenthesesBoth", /** * Lowercase alphabetical characters with closing parenthesis. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ alphabetLowercaseParenthesisRight = "AlphabetLowercaseParenthesisRight", /** * Uppercase alphabetical characters with both parentheses. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ alphabetUppercaseParenthesesBoth = "AlphabetUppercaseParenthesesBoth", /** * Uppercase alphabetical characters with closing parenthesis. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ alphabetUppercaseParenthesisRight = "AlphabetUppercaseParenthesisRight", /** * Arabic numerals with both parentheses. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ arabicNumeralParenthesesBoth = "ArabicNumeralParenthesesBoth", /** * Arabic numerals. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ arabicNumeralPlain = "ArabicNumeralPlain", /** * Uppercase Roman numerals with both parentheses. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ romanUppercaseParenthesesBoth = "RomanUppercaseParenthesesBoth", /** * Uppercase Roman numerals with closing parenthesis. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ romanUppercaseParenthesisRight = "RomanUppercaseParenthesisRight", /** * Simplified Chinese without a period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ simplifiedChinesePlain = "SimplifiedChinesePlain", /** * Simplified Chinese with a period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ simplifiedChinesePeriod = "SimplifiedChinesePeriod", /** * Double-byte circled number for values up to 10. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ circleNumberDoubleBytePlain = "CircleNumberDoubleBytePlain", /** * Text colored number with same color circle drawn around it. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ circleNumberWideDoubleByteWhitePlain = "CircleNumberWideDoubleByteWhitePlain", /** * Shadow color number with circular background of normal text color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ circleNumberWideDoubleByteBlackPlain = "CircleNumberWideDoubleByteBlackPlain", /** * Traditional Chinese without a period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ traditionalChinesePlain = "TraditionalChinesePlain", /** * Traditional Chinese with a period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ traditionalChinesePeriod = "TraditionalChinesePeriod", /** * Arabic alphabet with a dash. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ arabicAlphabetDash = "ArabicAlphabetDash", /** * Arabic Abjad alphabet with a dash. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ arabicAbjadDash = "ArabicAbjadDash", /** * Hebrew alphabet with a dash. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ hebrewAlphabetDash = "HebrewAlphabetDash", /** * Japanese/Korean numbers without a period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ kanjiKoreanPlain = "KanjiKoreanPlain", /** * Japanese/Korean numbers with a period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ kanjiKoreanPeriod = "KanjiKoreanPeriod", /** * Double-byte Arabic numbering scheme (no punctuation). * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ arabicDoubleBytePlain = "ArabicDoubleBytePlain", /** * Double-byte Arabic numbering scheme with double-byte period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ arabicDoubleBytePeriod = "ArabicDoubleBytePeriod", /** * Thai alphabet with a period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ thaiAlphabetPeriod = "ThaiAlphabetPeriod", /** * Thai alphabet with closing parenthesis. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ thaiAlphabetParenthesisRight = "ThaiAlphabetParenthesisRight", /** * Thai alphabet with both parentheses. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ thaiAlphabetParenthesesBoth = "ThaiAlphabetParenthesesBoth", /** * Thai numerals with a period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ thaiNumeralPeriod = "ThaiNumeralPeriod", /** * Thai numerals with closing parenthesis. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ thaiNumeralParenthesisRight = "ThaiNumeralParenthesisRight", /** * Thai numerals with both parentheses. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ thaiNumeralParenthesesBoth = "ThaiNumeralParenthesesBoth", /** * Hindi alphabet (vowels) with a period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ hindiAlphabetPeriod = "HindiAlphabetPeriod", /** * Hindi numerals with a period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ hindiNumeralPeriod = "HindiNumeralPeriod", /** * Kanji Simplified Chinese with double-byte period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ kanjiSimplifiedChineseDoubleBytePeriod = "KanjiSimplifiedChineseDoubleBytePeriod", /** * Hindi numerals with closing parenthesis. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ hindiNumeralParenthesisRight = "HindiNumeralParenthesisRight", /** * Hindi alphabet (consonants) with a period. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ hindiAlphabet1Period = "HindiAlphabet1Period", } @@ -187939,36 +187883,31 @@ declare namespace PowerPoint { * Specifies the type of a bullet. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ enum BulletType { /** * Type is unsupported. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ unsupported = "Unsupported", /** * No bullets. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ none = "None", /** * Numbered bullet (e.g., 1, 2, 3 or a, b, c). * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ numbered = "Numbered", /** * Symbol-based bullet (e.g., disc, circle, square). * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ unnumbered = "Unnumbered", } @@ -187986,8 +187925,7 @@ declare namespace PowerPoint { Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ style: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null; /** @@ -187995,8 +187933,7 @@ declare namespace PowerPoint { Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null; /** @@ -188028,9 +187965,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.BulletFormat; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.BulletFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.BulletFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.BulletFormatData; } /** @@ -188060,8 +187997,7 @@ declare namespace PowerPoint { * Represents the indent level of the paragraph. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ indentLevel: number; /** @@ -188086,9 +188022,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.ParagraphFormat; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.ParagraphFormatData; } /** @@ -188364,9 +188300,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.ShapeFont; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.ShapeFont` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFontData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ShapeFont` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFontData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.ShapeFontData; } /** @@ -188555,9 +188491,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.TextFrame; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.TextFrameData; } /** @@ -188580,8 +188516,7 @@ declare namespace PowerPoint { * Returns a collection of hyperlinks that exist on this `TextRange`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly hyperlinks: PowerPoint.HyperlinkScopedCollection; /** @@ -188635,8 +188570,7 @@ declare namespace PowerPoint { * Sets a hyperlink on this `TextRange` with the specified options. This will delete all existing hyperlinks on this `TextRange`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param options Optional. The options for the hyperlink. * @returns The newly created {@link PowerPoint.Hyperlink} object. @@ -188671,31 +188605,28 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.TextRange; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TextRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextRangeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TextRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextRangeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.TextRangeData; } /** * Specifies the type of object that a hyperlink is applied to. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ enum HyperlinkType { /** * Specifies that the hyperlink is applied to a TextRange. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ textRange = "TextRange", /** * Specifies that the hyperlink is applied to a Shape. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ shape = "Shape", } @@ -188726,16 +188657,14 @@ declare namespace PowerPoint { * Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly type: PowerPoint.HyperlinkType | "TextRange" | "Shape"; /** * Deletes the hyperlink. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ delete(): void; /** @@ -188744,8 +188673,7 @@ declare namespace PowerPoint { For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ getLinkedShapeOrNullObject(): PowerPoint.Shape; /** @@ -188754,8 +188682,7 @@ declare namespace PowerPoint { For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ getLinkedTextRangeOrNullObject(): PowerPoint.TextRange; /** @@ -188780,9 +188707,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.Hyperlink; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.HyperlinkData; } /** @@ -189081,9 +189008,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.PlaceholderFormat; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.PlaceholderFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PlaceholderFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.PlaceholderFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PlaceholderFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.PlaceholderFormatData; } /** @@ -189102,8 +189029,7 @@ declare namespace PowerPoint { The new hyperlink may appear anywhere in the collection and is not guaranteed to be added at the end. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param target The target to add the hyperlink to. Can be a {@link PowerPoint.TextRange} or a {@link PowerPoint.Shape}. * @param options Optional. The options for the hyperlink. @@ -189148,9 +189074,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.HyperlinkCollectionData; } /** @@ -190508,9 +190434,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.Borders; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.BordersData; } /** @@ -190572,9 +190498,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.Margins; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.MarginsData; } /** @@ -190965,9 +190891,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.TableCell; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.TableCellData; } /** @@ -191019,9 +190945,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableCellCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.TableCellCollectionData; } /** @@ -191076,9 +191002,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.TableColumn; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.TableColumnData; } /** @@ -191149,9 +191075,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableColumnCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.TableColumnCollectionData; } /** @@ -191242,9 +191168,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.TableRow; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.TableRowData; } /** @@ -191315,9 +191241,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableRowCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.TableRowCollectionData; } /** @@ -191852,9 +191778,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.TableStyleSettings; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TableStyleSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleSettingsData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableStyleSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleSettingsData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.TableStyleSettingsData; } /** @@ -191977,9 +191903,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.Table; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.TableData; } /** @@ -192544,59 +192470,52 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.ShapeCollectionData; } /** * Specifies the gradient fill type for a {@link PowerPoint.SlideBackgroundGradientFill}. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ enum SlideBackgroundGradientFillType { /** * Unsupported gradient fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ unsupported = "Unsupported", /** * Linear gradient fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ linear = "Linear", /** * Radial gradient fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ radial = "Radial", /** * Rectangular gradient fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ rectangular = "Rectangular", /** * Path gradient fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ path = "Path", /** * Shade from title gradient fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ shadeFromTitle = "ShadeFromTitle", } @@ -192604,8 +192523,7 @@ declare namespace PowerPoint { * Represents {@link PowerPoint.SlideBackground} gradient fill properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ class SlideBackgroundGradientFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -192614,8 +192532,7 @@ declare namespace PowerPoint { * Specifies the type of gradient fill. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle"; /** @@ -192640,25 +192557,23 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.SlideBackgroundGradientFill; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideBackgroundGradientFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundGradientFillData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideBackgroundGradientFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundGradientFillData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.SlideBackgroundGradientFillData; } /** * Represents the available options for setting a {@link PowerPoint.SlideBackground} gradient fill. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface SlideBackgroundGradientFillOptions { /** * If provided, specifies the type of gradient fill. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle"; } @@ -192666,393 +192581,337 @@ declare namespace PowerPoint { * Specifies the pattern fill type for a {@link PowerPoint.SlideBackgroundPatternFill}. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ enum SlideBackgroundPatternFillType { /** * Unsupported pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ unsupported = "Unsupported", /** * 5 percent pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ percent5 = "Percent5", /** * 10 percent pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ percent10 = "Percent10", /** * 20 percent pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ percent20 = "Percent20", /** * 25 percent pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ percent25 = "Percent25", /** * 30 percent pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ percent30 = "Percent30", /** * 40 percent pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ percent40 = "Percent40", /** * 50 percent pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ percent50 = "Percent50", /** * 60 percent pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ percent60 = "Percent60", /** * 70 percent pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ percent70 = "Percent70", /** * 75 percent pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ percent75 = "Percent75", /** * 80 percent pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ percent80 = "Percent80", /** * 90 percent pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ percent90 = "Percent90", /** * Horizontal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ horizontal = "Horizontal", /** * Vertical pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ vertical = "Vertical", /** * Light horizontal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ lightHorizontal = "LightHorizontal", /** * Light vertical pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ lightVertical = "LightVertical", /** * Dark horizontal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ darkHorizontal = "DarkHorizontal", /** * Dark vertical pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ darkVertical = "DarkVertical", /** * Narrow horizontal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ narrowHorizontal = "NarrowHorizontal", /** * Narrow vertical pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ narrowVertical = "NarrowVertical", /** * Dashed horizontal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ dashedHorizontal = "DashedHorizontal", /** * Dashed vertical pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ dashedVertical = "DashedVertical", /** * Cross pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ cross = "Cross", /** * Downward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ downwardDiagonal = "DownwardDiagonal", /** * Upward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ upwardDiagonal = "UpwardDiagonal", /** * Light downward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ lightDownwardDiagonal = "LightDownwardDiagonal", /** * Light upward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ lightUpwardDiagonal = "LightUpwardDiagonal", /** * Dark downward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ darkDownwardDiagonal = "DarkDownwardDiagonal", /** * Dark upward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ darkUpwardDiagonal = "DarkUpwardDiagonal", /** * Wide downward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ wideDownwardDiagonal = "WideDownwardDiagonal", /** * Wide upward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ wideUpwardDiagonal = "WideUpwardDiagonal", /** * Dashed downward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ dashedDownwardDiagonal = "DashedDownwardDiagonal", /** * Dashed upward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ dashedUpwardDiagonal = "DashedUpwardDiagonal", /** * Diagonal cross pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ diagonalCross = "DiagonalCross", /** * Small checker board pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ smallCheckerBoard = "SmallCheckerBoard", /** * Large checker board pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ largeCheckerBoard = "LargeCheckerBoard", /** * Small grid pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ smallGrid = "SmallGrid", /** * Large grid pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ largeGrid = "LargeGrid", /** * Dotted grid pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ dottedGrid = "DottedGrid", /** * Small confetti pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ smallConfetti = "SmallConfetti", /** * Large confetti pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ largeConfetti = "LargeConfetti", /** * Horizontal brick pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ horizontalBrick = "HorizontalBrick", /** * Diagonal brick pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ diagonalBrick = "DiagonalBrick", /** * Solid diamond pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ solidDiamond = "SolidDiamond", /** * Outlined diamond pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ outlinedDiamond = "OutlinedDiamond", /** * Dotted diamond pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ dottedDiamond = "DottedDiamond", /** * Plaid pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ plaid = "Plaid", /** * Sphere pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ sphere = "Sphere", /** * Weave pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ weave = "Weave", /** * Divot pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ divot = "Divot", /** * Shingle pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ shingle = "Shingle", /** * Wave pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ wave = "Wave", /** * Trellis pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ trellis = "Trellis", /** * Zig zag pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ zigZag = "ZigZag", } @@ -193060,8 +192919,7 @@ declare namespace PowerPoint { * Represents {@link PowerPoint.SlideBackground} pattern fill properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ class SlideBackgroundPatternFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -193070,24 +192928,21 @@ declare namespace PowerPoint { * Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ backgroundColor: string; /** * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ foregroundColor: string; /** * Specifies the pattern type. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ pattern: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag"; /** @@ -193112,41 +192967,37 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.SlideBackgroundPatternFill; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideBackgroundPatternFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPatternFillData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideBackgroundPatternFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPatternFillData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.SlideBackgroundPatternFillData; } /** * Represents the available options for setting a {@link PowerPoint.SlideBackground} pattern fill. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface SlideBackgroundPatternFillOptions { /** * If provided, specifies the background color in HTML color format (e.g., "#FFFFFF" or "white"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ backgroundColor?: string; /** * If provided, specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ foregroundColor?: string; /** * If provided, specifies the pattern type. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag"; } @@ -193154,8 +193005,7 @@ declare namespace PowerPoint { * Represents {@link PowerPoint.SlideBackground} picture or texture fill properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ class SlideBackgroundPictureOrTextureFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -193164,16 +193014,14 @@ declare namespace PowerPoint { * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ transparency: number; /** * Sets the image used to fill. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param base64EncodedImage A string that is a Base64 encoding of the image data. */ @@ -193200,33 +193048,30 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.SlideBackgroundPictureOrTextureFill; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideBackgroundPictureOrTextureFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideBackgroundPictureOrTextureFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData; } /** * Represents {@link PowerPoint.SlideBackground} picture or texture fill options. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface SlideBackgroundPictureOrTextureFillOptions { /** * If provided, specifies the Base64-encoded image data for the fill. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ imageBase64?: string; /** * If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ transparency: number; } @@ -193234,43 +193079,37 @@ declare namespace PowerPoint { * Specifies the fill type for a {@link PowerPoint.SlideBackground}. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ enum SlideBackgroundFillType { /** * Unsupported slide background fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ unsupported = "Unsupported", /** * Specifies that the slide background should have regular solid fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ solid = "Solid", /** * Specifies that the slide background should have gradient fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ gradient = "Gradient", /** * Specifies that the slide background should have picture or texture fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ pictureOrTexture = "PictureOrTexture", /** * Specifies that the slide background should have pattern fill. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ pattern = "Pattern", } @@ -193278,8 +193117,7 @@ declare namespace PowerPoint { * Represents {@link PowerPoint.SlideBackground} solid fill properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ class SlideBackgroundSolidFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -193288,16 +193126,14 @@ declare namespace PowerPoint { * Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ color: string; /** * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ transparency: number; /** @@ -193322,33 +193158,30 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.SlideBackgroundSolidFill; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideBackgroundSolidFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundSolidFillData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideBackgroundSolidFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundSolidFillData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.SlideBackgroundSolidFillData; } /** * Represents the available options for setting a {@link PowerPoint.SlideBackground} solid fill. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface SlideBackgroundSolidFillOptions { /** * If provided, specifies the fill color in HTML color format (e.g., "#FFA500" or "orange"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ color?: string; /** * If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ transparency?: number; } @@ -193356,8 +193189,7 @@ declare namespace PowerPoint { * Represents the fill formatting of a slide background object. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ class SlideBackgroundFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -193366,8 +193198,7 @@ declare namespace PowerPoint { * Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly type: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern"; /** @@ -193375,8 +193206,7 @@ declare namespace PowerPoint { For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ getGradientFillOrNullObject(): PowerPoint.SlideBackgroundGradientFill; /** @@ -193384,8 +193214,7 @@ declare namespace PowerPoint { For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ getPatternFillOrNullObject(): PowerPoint.SlideBackgroundPatternFill; /** @@ -193393,8 +193222,7 @@ declare namespace PowerPoint { For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ getPictureOrTextureFillOrNullObject(): PowerPoint.SlideBackgroundPictureOrTextureFill; /** @@ -193402,16 +193230,14 @@ declare namespace PowerPoint { For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ getSolidFillOrNullObject(): PowerPoint.SlideBackgroundSolidFill; /** * Sets the fill formatting of the slide background to a gradient fill. This changes the fill type to `gradient`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param options Options for the gradient fill. */ @@ -193420,8 +193246,7 @@ declare namespace PowerPoint { * Sets the fill formatting of the slide background to a pattern fill. This changes the fill type to `pattern`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param options Options for the pattern fill. */ @@ -193430,8 +193255,7 @@ declare namespace PowerPoint { * Sets the fill formatting of the slide background to a picture or texture fill. This changes the fill type to `pictureOrTexture`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param options Options for the picture or texture fill. */ @@ -193440,8 +193264,7 @@ declare namespace PowerPoint { * Sets the fill formatting of the slide background to a solid fill. This changes the fill type to `solid`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param options Options for the solid fill. */ @@ -193468,17 +193291,16 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.SlideBackgroundFill; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideBackgroundFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundFillData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideBackgroundFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundFillData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.SlideBackgroundFillData; } /** * Represents a background of a slide. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ class SlideBackground extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -193487,32 +193309,28 @@ declare namespace PowerPoint { * Returns the fill formatting of the background. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly fill: PowerPoint.SlideBackgroundFill; /** * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ areBackgroundGraphicsHidden: boolean; /** * Specifies if the slide background follows the slide master background. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ isMasterBackgroundFollowed: boolean; /** * Resets the fill formatting of the slide background. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ reset(): void; /** @@ -193537,9 +193355,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.SlideBackground; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.SlideBackgroundData; } /** @@ -193568,8 +193386,7 @@ declare namespace PowerPoint { * Represents the background of a slide layout. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ class SlideLayoutBackground extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -193578,32 +193395,28 @@ declare namespace PowerPoint { * Returns the fill formatting of the background. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly fill: PowerPoint.SlideBackgroundFill; /** * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ areBackgroundGraphicsHidden: boolean; /** * Specifies if the slide layout background follows the slide master background. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ isMasterBackgroundFollowed: boolean; /** * Resets the fill formatting of the slide layout background. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ reset(): void; /** @@ -193628,9 +193441,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.SlideLayoutBackground; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideLayoutBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutBackgroundData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideLayoutBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutBackgroundData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.SlideLayoutBackgroundData; } /** @@ -193867,106 +193680,91 @@ declare namespace PowerPoint { * Specifies the theme colors used in PowerPoint. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ enum ThemeColor { /** * Specifies a mixed theme color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ mixed = "Mixed", /** * Specifies no theme color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ none = "None", /** * Specifies the Accent 1 theme color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ accent1 = "Accent1", /** * Specifies the Accent 2 theme color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ accent2 = "Accent2", /** * Specifies the Accent 3 theme color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ accent3 = "Accent3", /** * Specifies the Accent 4 theme color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ accent4 = "Accent4", /** * Specifies the Accent 5 theme color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ accent5 = "Accent5", /** * Specifies the Accent 6 theme color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ accent6 = "Accent6", /** * Specifies the Dark 1 theme color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ dark1 = "Dark1", /** * Specifies the Dark 2 theme color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ dark2 = "Dark2", /** * Specifies the clicked hyperlink theme color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ followedHyperlink = "FollowedHyperlink", /** * Specifies the hyperlink theme color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ hyperlink = "Hyperlink", /** * Specifies the Light 1 theme color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ light1 = "Light1", /** * Specifies the Light 2 theme color. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ light2 = "Light2", } @@ -193974,8 +193772,7 @@ declare namespace PowerPoint { * Represents a theme color scheme. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ class ThemeColorScheme extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -193984,8 +193781,7 @@ declare namespace PowerPoint { * Gets the color value for the specified `ThemeColor`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param color The theme color. * @returns The color value in #RRGGBB format (e.g., "FFA500"). @@ -193995,8 +193791,7 @@ declare namespace PowerPoint { * Gets the color value for the specified `ThemeColor`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param color The theme color. * @returns The color value in #RRGGBB format (e.g., "FFA500"). @@ -194006,8 +193801,7 @@ declare namespace PowerPoint { * Sets the color value for the specified `ThemeColor`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param color The theme color. * @param rgbColor The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange"). @@ -194017,17 +193811,16 @@ declare namespace PowerPoint { * Sets the color value for the specified `ThemeColor`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param color The theme color. * @param rgbColor The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange"). */ setThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2", rgbColor: string): void; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.ThemeColorScheme` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ThemeColorSchemeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ThemeColorScheme` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ThemeColorSchemeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): { [key: string]: string; }; @@ -194045,8 +193838,7 @@ declare namespace PowerPoint { * Gets the background of the slide layout. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly background: PowerPoint.SlideLayoutBackground; /** @@ -194067,8 +193859,7 @@ declare namespace PowerPoint { * Returns the `ThemeColorScheme` of the slide layout. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly themeColorScheme: PowerPoint.ThemeColorScheme; /** @@ -194114,9 +193905,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.SlideLayout; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideLayout` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideLayout` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.SlideLayoutData; } /** @@ -194188,17 +193979,16 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideLayoutCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideLayoutCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData; } /** * Represents the background of a slide master. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ class SlideMasterBackground extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -194207,8 +193997,7 @@ declare namespace PowerPoint { * Returns the fill formatting of the background. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly fill: PowerPoint.SlideBackgroundFill; /** @@ -194233,9 +194022,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.SlideMasterBackground; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideMasterBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterBackgroundData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideMasterBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterBackgroundData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.SlideMasterBackgroundData; } /** @@ -194251,8 +194040,7 @@ declare namespace PowerPoint { * Gets the background of the Slide Master. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly background: PowerPoint.SlideMasterBackground; /** @@ -194280,8 +194068,7 @@ declare namespace PowerPoint { * Returns the `ThemeColorScheme` of the Slide Master. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly themeColorScheme: PowerPoint.ThemeColorScheme; /** @@ -194320,9 +194107,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.SlideMaster; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideMaster` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideMaster` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.SlideMasterData; } /** @@ -194370,9 +194157,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.Tag; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Tag` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Tag` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.TagData; } /** @@ -194462,9 +194249,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TagCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TagCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TagCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.TagCollectionData; } /** @@ -194480,8 +194267,7 @@ declare namespace PowerPoint { * Gets the background of the slide. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly background: PowerPoint.SlideBackground; /** @@ -194530,8 +194316,7 @@ declare namespace PowerPoint { * Returns the `ThemeColorScheme` of the slide. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly themeColorScheme: PowerPoint.ThemeColorScheme; /** @@ -194625,24 +194410,22 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.Slide; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Slide` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Slide` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.SlideData; } /** * Represents the format of an image. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ enum ShapeGetImageFormatType { /** * The picture is in PNG format. * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ png = "Png", } @@ -194653,16 +194436,14 @@ declare namespace PowerPoint { The resulting dimensions will automatically be clamped to the maximum supported size if too large. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface ShapeGetImageOptions { /** * The desired format of the resulting image. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ format?: PowerPoint.ShapeGetImageFormatType | "Png"; /** @@ -194670,8 +194451,7 @@ declare namespace PowerPoint { Throws an `InvalidArgument` exception when set with a non-positive integer. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ height?: number; /** @@ -194679,8 +194459,7 @@ declare namespace PowerPoint { Throws an `InvalidArgument` exception when set with a non-positive integer. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ width?: number; } @@ -194761,9 +194540,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeScopedCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.ShapeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ShapeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData; } /** @@ -194793,8 +194572,7 @@ declare namespace PowerPoint { * Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly creationId: string | null; /** @@ -194833,9 +194611,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.ShapeGroup; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.ShapeGroupData; } /** @@ -194949,9 +194727,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.ShapeLineFormat; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.ShapeLineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeLineFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ShapeLineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeLineFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.ShapeLineFormatData; } /** @@ -194999,8 +194777,7 @@ declare namespace PowerPoint { * Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly adjustments: PowerPoint.Adjustments; /** @@ -195069,8 +194846,7 @@ declare namespace PowerPoint { This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ altTextDescription: string; /** @@ -195081,16 +194857,14 @@ declare namespace PowerPoint { A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ altTextTitle: string; /** * Gets the creation ID of the shape. Returns `null` if the shape has no creation ID. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ readonly creationId: string | null; /** @@ -195114,8 +194888,7 @@ declare namespace PowerPoint { People using screen readers will hear these are decorative so they know they aren't missing any important information. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ isDecorative: boolean; /** @@ -195150,8 +194923,7 @@ declare namespace PowerPoint { A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ rotation: number; /** @@ -195172,8 +194944,7 @@ declare namespace PowerPoint { * Specifies if the shape is visible. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ visible: boolean; /** @@ -195202,8 +194973,7 @@ declare namespace PowerPoint { * Renders an image of the shape. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param options Optional. Options to specify the desired output image properties. * @returns A Base64-encoded string of the shape image in the specified format. @@ -195263,16 +195033,14 @@ declare namespace PowerPoint { For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ getTextFrameOrNullObject(): PowerPoint.TextFrame; /** * Sets a hyperlink on this `Shape` with the specified options. This will delete any existing hyperlink on this `Shape`. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param options Optional. The options for the hyperlink. * @returns The newly created {@link PowerPoint.Hyperlink} object. @@ -195318,9 +195086,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.Shape; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.ShapeData; } /** @@ -195382,9 +195150,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.Binding; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Binding` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BindingData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Binding` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BindingData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.BindingData; } /** @@ -195496,9 +195264,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.BindingCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.BindingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BindingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.BindingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BindingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.BindingCollectionData; } /** @@ -195593,9 +195361,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.CustomProperty; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.CustomPropertyData; } /** @@ -195651,8 +195419,7 @@ declare namespace PowerPoint { Throws an `InvalidArgument` exception when the index is out of range. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param index The index of the custom property in the collection. * @returns The custom property at the given index. @@ -195689,9 +195456,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomPropertyCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData; } /** @@ -195809,9 +195576,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.DocumentProperties; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.DocumentPropertiesData; } /** @@ -195873,8 +195640,7 @@ declare namespace PowerPoint { * Represents the page setup information for the presentation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ class PageSetup extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -195883,16 +195649,14 @@ declare namespace PowerPoint { * Specifies the height of the slides in the presentation, in points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ slideHeight: number; /** * Specifies the width of the slides in the presentation, in points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ slideWidth: number; /** @@ -195917,9 +195681,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.PageSetup; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.PageSetupData; } /** @@ -195947,8 +195711,7 @@ declare namespace PowerPoint { Throws an `InvalidArgument` exception if provided slide IDs or `Slide` objects are not found in this collection. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * * @param values An array of slide IDs or `Slide` objects. * @returns A Base64-encoded string. @@ -196013,9 +195776,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.SlideCollectionData; } /** @@ -196033,8 +195796,7 @@ declare namespace PowerPoint { * Exports all slides in this collection to their own presentation file, returned as Base64-encoded data. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] * @returns A Base64-encoded string. */ exportAsBase64Presentation(): OfficeExtension.ClientResult; @@ -196096,9 +195858,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideScopedCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.SlideScopedCollectionData; } /** @@ -196170,9 +195932,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideMasterCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideMasterCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideMasterCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.SlideMasterCollectionData; } enum ErrorCodes { @@ -196211,8 +195973,7 @@ declare namespace PowerPoint { Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null; /** @@ -196220,8 +195981,7 @@ declare namespace PowerPoint { Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null; /** @@ -196245,8 +196005,7 @@ declare namespace PowerPoint { * Represents the indent level of the paragraph. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ indentLevel?: number; } @@ -196255,11 +196014,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - `true`: All the text has the **All Caps** attribute. + - `true`: All the text has the **All Caps** attribute. - - `false`: None of the text has the **All Caps** attribute. + - `false`: None of the text has the **All Caps** attribute. - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -196268,11 +196027,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: - - `true`: All the text is bold. + - `true`: All the text is bold. - - `false`: None of the text is bold. + - `false`: None of the text is bold. - - `null`: Returned if some, but not all, of the text is bold. + - `null`: Returned if some, but not all, of the text is bold. * * @remarks * [Api set: PowerPointApi 1.4] @@ -196288,11 +196047,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows: - - `true`: All the text has the **Double strikethrough** attribute. + - `true`: All the text has the **Double strikethrough** attribute. - - `false`: None of the text has the **Double strikethrough** attribute. + - `false`: None of the text has the **Double strikethrough** attribute. - - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. + - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -196301,11 +196060,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: - - `true`: All the text is italicized. + - `true`: All the text is italicized. - - `false`: None of the text is italicized. + - `false`: None of the text is italicized. - - `null`: Returned if some, but not all, of the text is italicized. + - `null`: Returned if some, but not all, of the text is italicized. * * @remarks * [Api set: PowerPointApi 1.4] @@ -196328,11 +196087,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - `true`: All the text has the **Small Caps** attribute. + - `true`: All the text has the **Small Caps** attribute. - - `false`: None of the text has the **Small Caps** attribute. + - `false`: None of the text has the **Small Caps** attribute. - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -196341,11 +196100,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows: - - `true`: All the text has the **Strikethrough** attribute. + - `true`: All the text has the **Strikethrough** attribute. - - `false`: None of the text has the **Strikethrough** attribute. + - `false`: None of the text has the **Strikethrough** attribute. - - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. + - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -196354,11 +196113,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows: - - `true`: All the text has the **Subscript** attribute. + - `true`: All the text has the **Subscript** attribute. - - `false`: None of the text has the **Subscript** attribute. + - `false`: None of the text has the **Subscript** attribute. - - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. + - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -196367,11 +196126,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows: - - `true`: All the text has the **Superscript** attribute. + - `true`: All the text has the **Superscript** attribute. - - `false`: None of the text has the **Superscript** attribute. + - `false`: None of the text has the **Superscript** attribute. - - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. + - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -196696,8 +196455,7 @@ declare namespace PowerPoint { * Specifies the type of gradient fill. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle"; } @@ -196707,24 +196465,21 @@ declare namespace PowerPoint { * Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ backgroundColor?: string; /** * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ foregroundColor?: string; /** * Specifies the pattern type. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag"; } @@ -196734,8 +196489,7 @@ declare namespace PowerPoint { * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ transparency?: number; } @@ -196745,16 +196499,14 @@ declare namespace PowerPoint { * Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ color?: string; /** * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ transparency?: number; } @@ -196764,16 +196516,14 @@ declare namespace PowerPoint { * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ areBackgroundGraphicsHidden?: boolean; /** * Specifies if the slide background follows the slide master background. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ isMasterBackgroundFollowed?: boolean; } @@ -196783,16 +196533,14 @@ declare namespace PowerPoint { * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ areBackgroundGraphicsHidden?: boolean; /** * Specifies if the slide layout background follows the slide master background. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ isMasterBackgroundFollowed?: boolean; } @@ -196872,8 +196620,7 @@ declare namespace PowerPoint { This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ altTextDescription?: string; /** @@ -196884,8 +196631,7 @@ declare namespace PowerPoint { A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ altTextTitle?: string; /** @@ -196902,8 +196648,7 @@ declare namespace PowerPoint { People using screen readers will hear these are decorative so they know they aren't missing any important information. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ isDecorative?: boolean; /** @@ -196925,8 +196670,7 @@ declare namespace PowerPoint { A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ rotation?: number; /** @@ -196940,8 +196684,7 @@ declare namespace PowerPoint { * Specifies if the shape is visible. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ visible?: boolean; /** @@ -197043,16 +196786,14 @@ declare namespace PowerPoint { * Specifies the height of the slides in the presentation, in points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ slideHeight?: number; /** * Specifies the width of the slides in the presentation, in points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ slideWidth?: number; } @@ -197091,8 +196832,7 @@ declare namespace PowerPoint { * Specifies the number of adjustment points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ count?: number; } @@ -197132,8 +196872,7 @@ declare namespace PowerPoint { Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null; /** @@ -197141,8 +196880,7 @@ declare namespace PowerPoint { Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null; /** @@ -197166,8 +196904,7 @@ declare namespace PowerPoint { * Represents the indent level of the paragraph. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ indentLevel?: number; } @@ -197176,11 +196913,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - `true`: All the text has the **All Caps** attribute. + - `true`: All the text has the **All Caps** attribute. - - `false`: None of the text has the **All Caps** attribute. + - `false`: None of the text has the **All Caps** attribute. - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -197189,11 +196926,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: - - `true`: All the text is bold. + - `true`: All the text is bold. - - `false`: None of the text is bold. + - `false`: None of the text is bold. - - `null`: Returned if some, but not all, of the text is bold. + - `null`: Returned if some, but not all, of the text is bold. * * @remarks * [Api set: PowerPointApi 1.4] @@ -197209,11 +196946,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows: - - `true`: All the text has the **Double strikethrough** attribute. + - `true`: All the text has the **Double strikethrough** attribute. - - `false`: None of the text has the **Double strikethrough** attribute. + - `false`: None of the text has the **Double strikethrough** attribute. - - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. + - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -197222,11 +196959,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: - - `true`: All the text is italicized. + - `true`: All the text is italicized. - - `false`: None of the text is italicized. + - `false`: None of the text is italicized. - - `null`: Returned if some, but not all, of the text is italicized. + - `null`: Returned if some, but not all, of the text is italicized. * * @remarks * [Api set: PowerPointApi 1.4] @@ -197249,11 +196986,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - `true`: All the text has the **Small Caps** attribute. + - `true`: All the text has the **Small Caps** attribute. - - `false`: None of the text has the **Small Caps** attribute. + - `false`: None of the text has the **Small Caps** attribute. - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -197262,11 +196999,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows: - - `true`: All the text has the **Strikethrough** attribute. + - `true`: All the text has the **Strikethrough** attribute. - - `false`: None of the text has the **Strikethrough** attribute. + - `false`: None of the text has the **Strikethrough** attribute. - - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. + - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -197275,11 +197012,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows: - - `true`: All the text has the **Subscript** attribute. + - `true`: All the text has the **Subscript** attribute. - - `false`: None of the text has the **Subscript** attribute. + - `false`: None of the text has the **Subscript** attribute. - - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. + - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -197288,11 +197025,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows: - - `true`: All the text has the **Superscript** attribute. + - `true`: All the text has the **Superscript** attribute. - - `false`: None of the text has the **Superscript** attribute. + - `false`: None of the text has the **Superscript** attribute. - - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. + - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -197411,8 +197148,7 @@ declare namespace PowerPoint { * Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type?: PowerPoint.HyperlinkType | "TextRange" | "Shape"; } @@ -197735,8 +197471,7 @@ declare namespace PowerPoint { * Specifies the type of gradient fill. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle"; } @@ -197746,24 +197481,21 @@ declare namespace PowerPoint { * Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ backgroundColor?: string; /** * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ foregroundColor?: string; /** * Specifies the pattern type. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag"; } @@ -197773,8 +197505,7 @@ declare namespace PowerPoint { * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ transparency?: number; } @@ -197784,16 +197515,14 @@ declare namespace PowerPoint { * Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ color?: string; /** * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ transparency?: number; } @@ -197803,8 +197532,7 @@ declare namespace PowerPoint { * Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type?: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern"; } @@ -197814,16 +197542,14 @@ declare namespace PowerPoint { * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ areBackgroundGraphicsHidden?: boolean; /** * Specifies if the slide background follows the slide master background. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ isMasterBackgroundFollowed?: boolean; } @@ -197833,16 +197559,14 @@ declare namespace PowerPoint { * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ areBackgroundGraphicsHidden?: boolean; /** * Specifies if the slide layout background follows the slide master background. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ isMasterBackgroundFollowed?: boolean; } @@ -197942,8 +197666,7 @@ declare namespace PowerPoint { * Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ creationId?: string | null; /** @@ -198008,8 +197731,7 @@ declare namespace PowerPoint { This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ altTextDescription?: string; /** @@ -198020,16 +197742,14 @@ declare namespace PowerPoint { A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ altTextTitle?: string; /** * Gets the creation ID of the shape. Returns `null` if the shape has no creation ID. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ creationId?: string | null; /** @@ -198053,8 +197773,7 @@ declare namespace PowerPoint { People using screen readers will hear these are decorative so they know they aren't missing any important information. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ isDecorative?: boolean; /** @@ -198089,8 +197808,7 @@ declare namespace PowerPoint { A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ rotation?: number; /** @@ -198111,8 +197829,7 @@ declare namespace PowerPoint { * Specifies if the shape is visible. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ visible?: boolean; /** @@ -198267,16 +197984,14 @@ declare namespace PowerPoint { * Specifies the height of the slides in the presentation, in points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ slideHeight?: number; /** * Specifies the width of the slides in the presentation, in points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ slideWidth?: number; } @@ -198306,19 +198021,18 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Returns the page setup information whose properties control slide setup attributes for the presentation. - * - * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns the page setup information whose properties control slide setup attributes for the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ pageSetup?: PowerPoint.Interfaces.PageSetupLoadOptions; /** - * Gets the properties of the presentation. - * - * @remarks - * [Api set: PowerPointApi 1.7] - */ + * Gets the properties of the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.7] + */ properties?: PowerPoint.Interfaces.DocumentPropertiesLoadOptions; /** * Gets the ID of the presentation. @@ -198339,8 +198053,7 @@ declare namespace PowerPoint { * Represents the adjustment values for a shape. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface AdjustmentsLoadOptions { /** @@ -198351,8 +198064,7 @@ declare namespace PowerPoint { * Specifies the number of adjustment points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ count?: boolean; } @@ -198440,8 +198152,7 @@ declare namespace PowerPoint { * Represents a scoped collection of hyperlinks. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface HyperlinkScopedCollectionLoadOptions { /** @@ -198466,8 +198177,7 @@ declare namespace PowerPoint { * For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type?: boolean; } @@ -198487,8 +198197,7 @@ declare namespace PowerPoint { Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ style?: boolean; /** @@ -198496,8 +198205,7 @@ declare namespace PowerPoint { Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type?: boolean; /** @@ -198537,8 +198245,7 @@ declare namespace PowerPoint { * Represents the indent level of the paragraph. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ indentLevel?: boolean; } @@ -198839,8 +198546,7 @@ declare namespace PowerPoint { * Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type?: boolean; } @@ -198900,8 +198606,7 @@ declare namespace PowerPoint { * For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type?: boolean; } @@ -198957,46 +198662,46 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Gets the bottom border. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the bottom border. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ bottom?: PowerPoint.Interfaces.BorderLoadOptions; /** - * Gets the diagonal border (top-left to bottom-right). - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the diagonal border (top-left to bottom-right). + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ diagonalDown?: PowerPoint.Interfaces.BorderLoadOptions; /** - * Gets the diagonal border (bottom-left to top-right). - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the diagonal border (bottom-left to top-right). + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ diagonalUp?: PowerPoint.Interfaces.BorderLoadOptions; /** - * Gets the left border. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the left border. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ left?: PowerPoint.Interfaces.BorderLoadOptions; /** - * Gets the right border. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the right border. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ right?: PowerPoint.Interfaces.BorderLoadOptions; /** - * Gets the top border. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the top border. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ top?: PowerPoint.Interfaces.BorderLoadOptions; } /** @@ -199084,32 +198789,32 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Gets the collection of borders for the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the collection of borders for the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ borders?: PowerPoint.Interfaces.BordersLoadOptions; /** - * Gets the fill color of the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the fill color of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; /** - * Gets the font of the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the font of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ font?: PowerPoint.Interfaces.ShapeFontLoadOptions; /** - * Gets the set of margins in the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the set of margins in the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ margins?: PowerPoint.Interfaces.MarginsLoadOptions; /** * Gets the number of table columns this cell spans across. @@ -199190,32 +198895,32 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the collection of borders for the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * For EACH ITEM in the collection: Gets the collection of borders for the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ borders?: PowerPoint.Interfaces.BordersLoadOptions; /** - * For EACH ITEM in the collection: Gets the fill color of the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * For EACH ITEM in the collection: Gets the fill color of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; /** - * For EACH ITEM in the collection: Gets the font of the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * For EACH ITEM in the collection: Gets the font of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ font?: PowerPoint.Interfaces.ShapeFontLoadOptions; /** - * For EACH ITEM in the collection: Gets the set of margins in the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * For EACH ITEM in the collection: Gets the set of margins in the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ margins?: PowerPoint.Interfaces.MarginsLoadOptions; /** * For EACH ITEM in the collection: Gets the number of table columns this cell spans across. @@ -199475,11 +199180,11 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Gets the table style settings. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the table style settings. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ styleSettings?: PowerPoint.Interfaces.TableStyleSettingsLoadOptions; /** * Gets the number of columns in the table. @@ -199515,57 +199220,56 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape. - * - * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions; /** - * For EACH ITEM in the collection: Returns the fill formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * For EACH ITEM in the collection: Returns the fill formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; /** - * For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape. + * For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape. If the shape type isn't `group`, then this method returns the `GeneralException` error. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions; /** - * For EACH ITEM in the collection: Returns the line formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * For EACH ITEM in the collection: Returns the line formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; /** - * For EACH ITEM in the collection: Returns the parent group of this shape. + * For EACH ITEM in the collection: Returns the parent group of this shape. If the shape isn't part of a group, then this method returns the `GeneralException` error. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions; /** - * For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder. + * For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder. If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions; /** * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; /** * For EACH ITEM in the collection: The alt text description of the Shape. @@ -199574,8 +199278,7 @@ declare namespace PowerPoint { This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ altTextDescription?: boolean; /** @@ -199586,16 +199289,14 @@ declare namespace PowerPoint { A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ altTextTitle?: boolean; /** * For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ creationId?: boolean; /** @@ -199619,8 +199320,7 @@ declare namespace PowerPoint { People using screen readers will hear these are decorative so they know they aren't missing any important information. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ isDecorative?: boolean; /** @@ -199655,8 +199355,7 @@ declare namespace PowerPoint { A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ rotation?: boolean; /** @@ -199677,8 +199376,7 @@ declare namespace PowerPoint { * For EACH ITEM in the collection: Specifies if the shape is visible. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ visible?: boolean; /** @@ -199701,8 +199399,7 @@ declare namespace PowerPoint { * Represents {@link PowerPoint.SlideBackground} gradient fill properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface SlideBackgroundGradientFillLoadOptions { /** @@ -199713,8 +199410,7 @@ declare namespace PowerPoint { * Specifies the type of gradient fill. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type?: boolean; } @@ -199722,8 +199418,7 @@ declare namespace PowerPoint { * Represents {@link PowerPoint.SlideBackground} pattern fill properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface SlideBackgroundPatternFillLoadOptions { /** @@ -199734,24 +199429,21 @@ declare namespace PowerPoint { * Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ backgroundColor?: boolean; /** * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ foregroundColor?: boolean; /** * Specifies the pattern type. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ pattern?: boolean; } @@ -199759,8 +199451,7 @@ declare namespace PowerPoint { * Represents {@link PowerPoint.SlideBackground} picture or texture fill properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface SlideBackgroundPictureOrTextureFillLoadOptions { /** @@ -199771,8 +199462,7 @@ declare namespace PowerPoint { * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ transparency?: boolean; } @@ -199780,8 +199470,7 @@ declare namespace PowerPoint { * Represents {@link PowerPoint.SlideBackground} solid fill properties. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface SlideBackgroundSolidFillLoadOptions { /** @@ -199792,16 +199481,14 @@ declare namespace PowerPoint { * Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange"). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ color?: boolean; /** * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ transparency?: boolean; } @@ -199809,8 +199496,7 @@ declare namespace PowerPoint { * Represents the fill formatting of a slide background object. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface SlideBackgroundFillLoadOptions { /** @@ -199821,8 +199507,7 @@ declare namespace PowerPoint { * Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ type?: boolean; } @@ -199830,8 +199515,7 @@ declare namespace PowerPoint { * Represents a background of a slide. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface SlideBackgroundLoadOptions { /** @@ -199839,27 +199523,24 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Returns the fill formatting of the background. - * - * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns the fill formatting of the background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions; /** * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ areBackgroundGraphicsHidden?: boolean; /** * Specifies if the slide background follows the slide master background. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ isMasterBackgroundFollowed?: boolean; } @@ -199867,8 +199548,7 @@ declare namespace PowerPoint { * Represents the background of a slide layout. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface SlideLayoutBackgroundLoadOptions { /** @@ -199876,27 +199556,24 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Returns the fill formatting of the background. - * - * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns the fill formatting of the background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions; /** * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ areBackgroundGraphicsHidden?: boolean; /** * Specifies if the slide layout background follows the slide master background. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ isMasterBackgroundFollowed?: boolean; } @@ -199912,12 +199589,11 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Gets the background of the slide layout. - * - * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the background of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions; /** * Gets the unique ID of the slide layout. @@ -199953,12 +199629,11 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the background of the slide layout. - * - * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the background of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions; /** * For EACH ITEM in the collection: Gets the unique ID of the slide layout. @@ -199986,8 +199661,7 @@ declare namespace PowerPoint { * Represents the background of a slide master. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface SlideMasterBackgroundLoadOptions { /** @@ -199995,12 +199669,11 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Returns the fill formatting of the background. - * - * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns the fill formatting of the background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions; } /** @@ -200015,12 +199688,11 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Gets the background of the Slide Master. - * - * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the background of the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions; /** * Gets the unique ID of the Slide Master. @@ -200101,12 +199773,11 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Gets the background of the slide. - * - * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the background of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions; /** * Gets the layout of the slide. @@ -200149,57 +199820,56 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape. - * - * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions; /** - * For EACH ITEM in the collection: Returns the fill formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.5] - */ + * For EACH ITEM in the collection: Returns the fill formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; /** - * For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape. - If the shape type isn't `group`, then this method returns the `GeneralException` error. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ + * For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape. + If the shape type isn't `group`, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions; /** - * For EACH ITEM in the collection: Returns the line formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.5] - */ + * For EACH ITEM in the collection: Returns the line formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; /** - * For EACH ITEM in the collection: Returns the parent group of this shape. + * For EACH ITEM in the collection: Returns the parent group of this shape. If the shape isn't part of a group, then this method returns the `GeneralException` error. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions; /** - * For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder. - If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ + * For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder. + If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions; /** - * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`. - * - * @remarks - * [Api set: PowerPointApi 1.5] - */ + * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; /** * For EACH ITEM in the collection: The alt text description of the Shape. @@ -200208,8 +199878,7 @@ declare namespace PowerPoint { This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ altTextDescription?: boolean; /** @@ -200220,16 +199889,14 @@ declare namespace PowerPoint { A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ altTextTitle?: boolean; /** * For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ creationId?: boolean; /** @@ -200253,8 +199920,7 @@ declare namespace PowerPoint { People using screen readers will hear these are decorative so they know they aren't missing any important information. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ isDecorative?: boolean; /** @@ -200289,8 +199955,7 @@ declare namespace PowerPoint { A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ rotation?: boolean; /** @@ -200311,8 +199976,7 @@ declare namespace PowerPoint { * For EACH ITEM in the collection: Specifies if the shape is visible. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ visible?: boolean; /** @@ -200353,8 +200017,7 @@ declare namespace PowerPoint { * Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ creationId?: boolean; /** @@ -200434,54 +200097,53 @@ declare namespace PowerPoint { * Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions; /** - * Returns the fill formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * Returns the fill formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; /** - * Returns the `ShapeGroup` associated with the shape. + * Returns the `ShapeGroup` associated with the shape. If the shape type isn't `group`, then this method returns the `GeneralException` error. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions; /** - * Returns the line formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * Returns the line formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; /** - * Returns the parent group of this shape. + * Returns the parent group of this shape. If the shape isn't part of a group, then this method returns the `GeneralException` error. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions; /** - * Returns the properties that apply specifically to this placeholder. + * Returns the properties that apply specifically to this placeholder. If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions; /** - * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; /** * The alt text description of the Shape. @@ -200490,8 +200152,7 @@ declare namespace PowerPoint { This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ altTextDescription?: boolean; /** @@ -200502,16 +200163,14 @@ declare namespace PowerPoint { A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ altTextTitle?: boolean; /** * Gets the creation ID of the shape. Returns `null` if the shape has no creation ID. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ creationId?: boolean; /** @@ -200535,8 +200194,7 @@ declare namespace PowerPoint { People using screen readers will hear these are decorative so they know they aren't missing any important information. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ isDecorative?: boolean; /** @@ -200571,8 +200229,7 @@ declare namespace PowerPoint { A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ rotation?: boolean; /** @@ -200593,8 +200250,7 @@ declare namespace PowerPoint { * Specifies if the shape is visible. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ visible?: boolean; /** @@ -200826,8 +200482,7 @@ declare namespace PowerPoint { * Represents the page setup information for the presentation. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ interface PageSetupLoadOptions { /** @@ -200838,16 +200493,14 @@ declare namespace PowerPoint { * Specifies the height of the slides in the presentation, in points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ slideHeight?: boolean; /** * Specifies the width of the slides in the presentation, in points. * * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: PowerPointApi 1.10] */ slideWidth?: boolean; } @@ -200863,26 +200516,25 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the background of the slide. - * - * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the background of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions; /** - * For EACH ITEM in the collection: Gets the layout of the slide. - * - * @remarks - * [Api set: PowerPointApi 1.3] - */ + * For EACH ITEM in the collection: Gets the layout of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions; /** - * For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content. - * - * @remarks - * [Api set: PowerPointApi 1.3] - */ + * For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions; /** * For EACH ITEM in the collection: Gets the unique ID of the slide. @@ -200911,26 +200563,25 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the background of the slide. - * - * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the background of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions; /** - * For EACH ITEM in the collection: Gets the layout of the slide. - * - * @remarks - * [Api set: PowerPointApi 1.5] - */ + * For EACH ITEM in the collection: Gets the layout of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions; /** - * For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content. - * - * @remarks - * [Api set: PowerPointApi 1.5] - */ + * For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions; /** * For EACH ITEM in the collection: Gets the unique ID of the slide. @@ -200959,12 +200610,11 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the background of the Slide Master. - * - * @remarks - * [Api set: PowerPointApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the background of the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions; /** * For EACH ITEM in the collection: Gets the unique ID of the Slide Master. diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 1f0845eb108cd2..993d3dcb1089a4 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -177883,9 +177883,9 @@ declare namespace PowerPoint { */ static newObject(context: OfficeExtension.ClientRequestContext): PowerPoint.Application; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): { [key: string]: string; }; @@ -177915,6 +177915,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.7] */ readonly customXmlParts: PowerPoint.CustomXmlPartCollection; + /** + * Returns the page setup information whose properties control slide setup attributes for the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + readonly pageSetup: PowerPoint.PageSetup; /** * Gets the properties of the presentation. * @@ -178032,9 +178039,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.Presentation; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Presentation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PresentationData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Presentation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PresentationData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.PresentationData; } /** @@ -178064,6 +178071,71 @@ declare namespace PowerPoint { */ slideMasterId?: string; } + /** + * Represents the adjustment values for a shape. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + class Adjustments extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the number of adjustment points. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + readonly count: number; + /** + * Gets the adjustment value at the specified zero-based index. + Throws an `InvalidArgument` exception when the index is out of range. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * + * @param index The index of the adjustment to retrieve. + * @returns The adjustment value at the given index. + */ + get(index: number): OfficeExtension.ClientResult; + /** + * Sets the adjustment value at the specified zero-based index. + Throws an `InvalidArgument` exception when the index is out of range. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * + * @param index The index of the adjustment to set. + * @param value The adjustment value to set. + */ + set(index: number, value: number): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.AdjustmentsLoadOptions): PowerPoint.Adjustments; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.Adjustments; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.Adjustments; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Adjustments` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.AdjustmentsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.AdjustmentsData; + } /** * Represents the possible binding types. * @@ -178146,9 +178218,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.CustomXmlPart; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.CustomXmlPartData; } /** @@ -178181,6 +178253,17 @@ declare namespace PowerPoint { * @param id ID of the object to be retrieved. */ getItem(id: string): PowerPoint.CustomXmlPart; + /** + * Gets a `CustomXmlPart` by its zero-based index in the collection. + Throws an `InvalidArgument` exception when the index is out of range. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * + * @param index The index of the custom XML part in the collection. + * @returns The custom XML part at the given index. + */ + getItemAt(index: number): PowerPoint.CustomXmlPart; /** * Gets a `CustomXmlPart` based on its ID. If the `CustomXmlPart` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. @@ -178227,9 +178310,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartScopedCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.CustomXmlPartScopedCollectionData; } /** @@ -178278,6 +178361,17 @@ declare namespace PowerPoint { * @param id ID of the object to be retrieved. */ getItem(id: string): PowerPoint.CustomXmlPart; + /** + * Gets a `CustomXmlPart` by its zero-based index in the collection. + Throws an `InvalidArgument` exception when the index is out of range. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * + * @param index The index of the custom XML part in the collection. + * @returns The custom XML part at the given index. + */ + getItemAt(index: number): PowerPoint.CustomXmlPart; /** * Gets a `CustomXmlPart` based on its ID. If the `CustomXmlPart` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. @@ -178308,11 +178402,87 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData; } + /** + * Represents the available options when adding a {@link PowerPoint.Hyperlink}. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface HyperlinkAddOptions { + /** + * Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + address?: string; + /** + * Specifies the string displayed when hovering over the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + screenTip?: string; + } + /** + * Represents a scoped collection of hyperlinks. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + class HyperlinkScopedCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.Hyperlink[]; + /** + * Gets the number of hyperlinks in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * @returns The number of hyperlinks in the collection. + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a hyperlink using its zero-based index in the collection. + Throws an `InvalidArgument` exception when the index is out of range. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * + * @param index The index of the hyperlink in the collection. + * @returns The hyperlink at the given index. + */ + getItemAt(index: number): PowerPoint.Hyperlink; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.HyperlinkScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.HyperlinkScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkScopedCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.HyperlinkScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.HyperlinkScopedCollectionData; + } /** * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}. * @@ -178364,1000 +178534,981 @@ declare namespace PowerPoint { thaiDistributed = "ThaiDistributed", } /** - * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}. + * Specifies the style of a bullet. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - class BulletFormat extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + enum BulletStyle { /** - * Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values. - * + * Style is unsupported. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - visible: boolean | null; + unsupported = "Unsupported", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Lowercase alphabetical characters with a period. + * @remarks + * [Api set: PowerPointApi 1.10] */ - load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat; + alphabetLowercasePeriod = "AlphabetLowercasePeriod", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Uppercase alphabetical characters with a period. + * @remarks + * [Api set: PowerPointApi 1.10] */ - load(propertyNames?: string | string[]): PowerPoint.BulletFormat; + alphabetUppercasePeriod = "AlphabetUppercasePeriod", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Arabic numerals with closing parenthesis. + * @remarks + * [Api set: PowerPointApi 1.10] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.BulletFormat; + arabicNumeralParenthesisRight = "ArabicNumeralParenthesisRight", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.BulletFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Arabic numerals with a period. + * @remarks + * [Api set: PowerPointApi 1.10] */ - toJSON(): PowerPoint.Interfaces.BulletFormatData; - } - /** - * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ - class ParagraphFormat extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + arabicNumeralPeriod = "ArabicNumeralPeriod", /** - * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details. - * + * Lowercase Roman numerals with both parentheses. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - readonly bulletFormat: PowerPoint.BulletFormat; + romanLowercaseParenthesesBoth = "RomanLowercaseParenthesesBoth", /** - * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details. - * + * Lowercase Roman numerals with closing parenthesis. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null; + romanLowercaseParenthesisRight = "RomanLowercaseParenthesisRight", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Lowercase Roman numerals with period. + * @remarks + * [Api set: PowerPointApi 1.10] */ - load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat; + romanLowercasePeriod = "RomanLowercasePeriod", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Uppercase Roman numerals with period. + * @remarks + * [Api set: PowerPointApi 1.10] */ - load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat; + romanUppercasePeriod = "RomanUppercasePeriod", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Lowercase alphabetical characters with both parentheses. + * @remarks + * [Api set: PowerPointApi 1.10] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.ParagraphFormat; + alphabetLowercaseParenthesesBoth = "AlphabetLowercaseParenthesesBoth", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Lowercase alphabetical characters with closing parenthesis. + * @remarks + * [Api set: PowerPointApi 1.10] */ - toJSON(): PowerPoint.Interfaces.ParagraphFormatData; - } - /** - * The type of underline applied to a font. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ - enum ShapeFontUnderlineStyle { + alphabetLowercaseParenthesisRight = "AlphabetLowercaseParenthesisRight", /** - * No underlining. + * Uppercase alphabetical characters with both parentheses. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - none = "None", + alphabetUppercaseParenthesesBoth = "AlphabetUppercaseParenthesesBoth", /** - * Regular single line underlining. + * Uppercase alphabetical characters with closing parenthesis. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - single = "Single", + alphabetUppercaseParenthesisRight = "AlphabetUppercaseParenthesisRight", /** - * Underlining of text with double lines. + * Arabic numerals with both parentheses. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - double = "Double", + arabicNumeralParenthesesBoth = "ArabicNumeralParenthesesBoth", /** - * Underlining of text with a thick line. + * Arabic numerals. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - heavy = "Heavy", + arabicNumeralPlain = "ArabicNumeralPlain", /** - * Underlining of text with a dotted line. + * Uppercase Roman numerals with both parentheses. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - dotted = "Dotted", + romanUppercaseParenthesesBoth = "RomanUppercaseParenthesesBoth", /** - * Underlining of text with a thick, dotted line. + * Uppercase Roman numerals with closing parenthesis. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - dottedHeavy = "DottedHeavy", + romanUppercaseParenthesisRight = "RomanUppercaseParenthesisRight", /** - * Underlining of text with a line containing dashes. + * Simplified Chinese without a period. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - dash = "Dash", + simplifiedChinesePlain = "SimplifiedChinesePlain", /** - * Underlining of text with a thick line containing dashes. + * Simplified Chinese with a period. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - dashHeavy = "DashHeavy", + simplifiedChinesePeriod = "SimplifiedChinesePeriod", /** - * Underlining of text with a line containing long dashes. + * Double-byte circled number for values up to 10. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - dashLong = "DashLong", + circleNumberDoubleBytePlain = "CircleNumberDoubleBytePlain", /** - * Underlining of text with a thick line containing long dashes. + * Text colored number with same color circle drawn around it. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - dashLongHeavy = "DashLongHeavy", + circleNumberWideDoubleByteWhitePlain = "CircleNumberWideDoubleByteWhitePlain", /** - * Underlining of text with a line containing dots and dashes. + * Shadow color number with circular background of normal text color. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - dotDash = "DotDash", + circleNumberWideDoubleByteBlackPlain = "CircleNumberWideDoubleByteBlackPlain", /** - * Underlining of text with a thick line containing dots and dashes. + * Traditional Chinese without a period. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - dotDashHeavy = "DotDashHeavy", + traditionalChinesePlain = "TraditionalChinesePlain", /** - * Underlining of text with a line containing double dots and dashes. + * Traditional Chinese with a period. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - dotDotDash = "DotDotDash", + traditionalChinesePeriod = "TraditionalChinesePeriod", /** - * Underlining of text with a thick line containing double dots and dashes. + * Arabic alphabet with a dash. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - dotDotDashHeavy = "DotDotDashHeavy", + arabicAlphabetDash = "ArabicAlphabetDash", /** - * Underlining of text with a wavy line. + * Arabic Abjad alphabet with a dash. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - wavy = "Wavy", + arabicAbjadDash = "ArabicAbjadDash", /** - * Underlining of text with a thick, wavy line. + * Hebrew alphabet with a dash. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - wavyHeavy = "WavyHeavy", + hebrewAlphabetDash = "HebrewAlphabetDash", /** - * Underlining of text with double wavy lines. + * Japanese/Korean numbers without a period. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - wavyDouble = "WavyDouble", - } - /** - * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ - class ShapeFont extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + kanjiKoreanPlain = "KanjiKoreanPlain", /** - * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - - `true`: All the text has the **All Caps** attribute. - - - `false`: None of the text has the **All Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. - * + * Japanese/Korean numbers with a period. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - allCaps: boolean | null; + kanjiKoreanPeriod = "KanjiKoreanPeriod", /** - * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: - - - `true`: All the text is bold. - - - `false`: None of the text is bold. - - - `null`: Returned if some, but not all, of the text is bold. - * + * Double-byte Arabic numbering scheme (no punctuation). * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - bold: boolean | null; + arabicDoubleBytePlain = "ArabicDoubleBytePlain", /** - * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors. - * + * Double-byte Arabic numbering scheme with double-byte period. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - color: string | null; + arabicDoubleBytePeriod = "ArabicDoubleBytePeriod", /** - * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows: - - - `true`: All the text has the **Double strikethrough** attribute. - - - `false`: None of the text has the **Double strikethrough** attribute. - - - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. - * + * Thai alphabet with a period. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - doubleStrikethrough: boolean | null; + thaiAlphabetPeriod = "ThaiAlphabetPeriod", /** - * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: - - - `true`: All the text is italicized. - - - `false`: None of the text is italicized. - - - `null`: Returned if some, but not all, of the text is italicized. - * + * Thai alphabet with closing parenthesis. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - italic: boolean | null; + thaiAlphabetParenthesisRight = "ThaiAlphabetParenthesisRight", /** - * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names. - * + * Thai alphabet with both parentheses. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - name: string | null; + thaiAlphabetParenthesesBoth = "ThaiAlphabetParenthesesBoth", /** - * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes. - * + * Thai numerals with a period. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - size: number | null; + thaiNumeralPeriod = "ThaiNumeralPeriod", /** - * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - - `true`: All the text has the **Small Caps** attribute. - - - `false`: None of the text has the **Small Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. - * + * Thai numerals with closing parenthesis. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - smallCaps: boolean | null; + thaiNumeralParenthesisRight = "ThaiNumeralParenthesisRight", /** - * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows: - - - `true`: All the text has the **Strikethrough** attribute. - - - `false`: None of the text has the **Strikethrough** attribute. - - - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. - * + * Thai numerals with both parentheses. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - strikethrough: boolean | null; + thaiNumeralParenthesesBoth = "ThaiNumeralParenthesesBoth", /** - * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows: - - - `true`: All the text has the **Subscript** attribute. - - - `false`: None of the text has the **Subscript** attribute. - - - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. - * + * Hindi alphabet (vowels) with a period. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - subscript: boolean | null; + hindiAlphabetPeriod = "HindiAlphabetPeriod", /** - * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows: - - - `true`: All the text has the **Superscript** attribute. - - - `false`: None of the text has the **Superscript** attribute. - - - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. - * + * Hindi numerals with a period. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - superscript: boolean | null; + hindiNumeralPeriod = "HindiNumeralPeriod", /** - * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. - * + * Kanji Simplified Chinese with double-byte period. * @remarks - * [Api set: PowerPointApi 1.4] - */ - underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. - */ - load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * [Api set: PowerPointApi 1.10] */ - load(propertyNames?: string | string[]): PowerPoint.ShapeFont; + kanjiSimplifiedChineseDoubleBytePeriod = "KanjiSimplifiedChineseDoubleBytePeriod", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Hindi numerals with closing parenthesis. + * @remarks + * [Api set: PowerPointApi 1.10] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.ShapeFont; + hindiNumeralParenthesisRight = "HindiNumeralParenthesisRight", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.ShapeFont` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFontData`) that contains shallow copies of any loaded child properties from the original object. + * Hindi alphabet (consonants) with a period. + * @remarks + * [Api set: PowerPointApi 1.10] */ - toJSON(): PowerPoint.Interfaces.ShapeFontData; + hindiAlphabet1Period = "HindiAlphabet1Period", } /** - * Determines the type of automatic sizing allowed. + * Specifies the type of a bullet. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - enum ShapeAutoSize { + enum BulletType { /** - * No autosizing. + * Type is unsupported. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - autoSizeNone = "AutoSizeNone", + unsupported = "Unsupported", /** - * The text is adjusted to fit the shape. + * No bullets. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - autoSizeTextToFitShape = "AutoSizeTextToFitShape", + none = "None", /** - * The shape is adjusted to fit the text. + * Numbered bullet (e.g., 1, 2, 3 or a, b, c). * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - autoSizeShapeToFitText = "AutoSizeShapeToFitText", + numbered = "Numbered", /** - * A combination of automatic sizing schemes are used. + * Symbol-based bullet (e.g., disc, circle, square). * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - autoSizeMixed = "AutoSizeMixed", + unnumbered = "Unnumbered", } /** - * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}. - If one of the centered options is selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group. - To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment}. + * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}. * * @remarks * [Api set: PowerPointApi 1.4] */ - enum TextVerticalAlignment { + class BulletFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Specifies that the `TextFrame` should be top aligned to the `Shape`. + * Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details. + Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. + * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - top = "Top", + style: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null; /** - * Specifies that the `TextFrame` should be center aligned to the `Shape`. + * Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details. + Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. + * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - middle = "Middle", + type: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null; /** - * Specifies that the `TextFrame` should be bottom aligned to the `Shape`. + * Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values. + * * @remarks * [Api set: PowerPointApi 1.4] */ - bottom = "Bottom", + visible: boolean | null; /** - * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`. - * @remarks - * [Api set: PowerPointApi 1.4] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - topCentered = "TopCentered", + load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat; /** - * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`. - * @remarks - * [Api set: PowerPointApi 1.4] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - middleCentered = "MiddleCentered", + load(propertyNames?: string | string[]): PowerPoint.BulletFormat; /** - * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`. - * @remarks - * [Api set: PowerPointApi 1.4] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - bottomCentered = "BottomCentered", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.BulletFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.BulletFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.BulletFormatData; } /** - * Represents the text frame of a shape object. + * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}. * * @remarks * [Api set: PowerPointApi 1.4] */ - class TextFrame extends OfficeExtension.ClientObject { + class ParagraphFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See {@link PowerPoint.TextRange} for details. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ - readonly textRange: PowerPoint.TextRange; - /** - * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details. * * @remarks * [Api set: PowerPointApi 1.4] */ - autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"; + readonly bulletFormat: PowerPoint.BulletFormat; /** - * Represents the bottom margin, in points, of the text frame. + * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details. * * @remarks * [Api set: PowerPointApi 1.4] */ - bottomMargin: number; + horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null; /** - * Specifies if the text frame contains text. + * Represents the indent level of the paragraph. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - readonly hasText: boolean; + indentLevel: number; /** - * Represents the left margin, in points, of the text frame. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.4] + * @param options Provides options for which properties of the object to load. */ - leftMargin: number; + load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat; /** - * Represents the right margin, in points, of the text frame. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.4] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - rightMargin: number; + load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat; /** - * Represents the top margin, in points, of the text frame. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.4] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - topMargin: number; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.ParagraphFormat; /** - * Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details. - * + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.ParagraphFormatData; + } + /** + * The type of underline applied to a font. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum ShapeFontUnderlineStyle { + /** + * No underlining. * @remarks * [Api set: PowerPointApi 1.4] */ - verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered"; + none = "None", /** - * Determines whether lines break automatically to fit text inside the shape. - * + * Regular single line underlining. * @remarks * [Api set: PowerPointApi 1.4] */ - wordWrap: boolean; + single = "Single", /** - * Deletes all the text in the text frame. - * + * Underlining of text with double lines. * @remarks * [Api set: PowerPointApi 1.4] */ - deleteText(): void; + double = "Double", /** - * Returns the parent {@link PowerPoint.Shape} object that holds this `TextFrame`. - * + * Underlining of text with a thick line. * @remarks - * [Api set: PowerPointApi 1.5] - */ - getParentShape(): PowerPoint.Shape; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. - */ - load(options?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): PowerPoint.TextFrame; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * [Api set: PowerPointApi 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.TextFrame; + heavy = "Heavy", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + * Underlining of text with a dotted line. + * @remarks + * [Api set: PowerPointApi 1.4] */ - toJSON(): PowerPoint.Interfaces.TextFrameData; - } - /** - * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ - class TextRange extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + dotted = "Dotted", /** - * Returns a `ShapeFont` object that represents the font attributes for the text range. - * + * Underlining of text with a thick, dotted line. * @remarks * [Api set: PowerPointApi 1.4] */ - readonly font: PowerPoint.ShapeFont; + dottedHeavy = "DottedHeavy", /** - * Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details. - * + * Underlining of text with a line containing dashes. * @remarks * [Api set: PowerPointApi 1.4] */ - readonly paragraphFormat: PowerPoint.ParagraphFormat; + dash = "Dash", /** - * Gets or sets the length of the range that this `TextRange` represents. - Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point. - * + * Underlining of text with a thick line containing dashes. * @remarks - * [Api set: PowerPointApi 1.5] + * [Api set: PowerPointApi 1.4] */ - length: number; + dashHeavy = "DashHeavy", /** - * Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents. - Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text. - * + * Underlining of text with a line containing long dashes. * @remarks - * [Api set: PowerPointApi 1.5] + * [Api set: PowerPointApi 1.4] */ - start: number; + dashLong = "DashLong", /** - * Represents the plain text content of the text range. - * + * Underlining of text with a thick line containing long dashes. * @remarks * [Api set: PowerPointApi 1.4] */ - text: string; + dashLongHeavy = "DashLongHeavy", /** - * Returns the parent {@link PowerPoint.TextFrame} object that holds this `TextRange`. - * + * Underlining of text with a line containing dots and dashes. * @remarks - * [Api set: PowerPointApi 1.5] + * [Api set: PowerPointApi 1.4] */ - getParentTextFrame(): PowerPoint.TextFrame; + dotDash = "DotDash", /** - * Returns a `TextRange` object for the substring in the given range. - * + * Underlining of text with a thick line containing dots and dashes. * @remarks * [Api set: PowerPointApi 1.4] - * - * @param start The zero-based index of the first character to get from the text range. - * @param length Optional. The number of characters to be returned in the new text range. If length is omitted, all the characters from start to the end of the text range's last paragraph will be returned. */ - getSubstring(start: number, length?: number): PowerPoint.TextRange; + dotDashHeavy = "DotDashHeavy", /** - * Selects this `TextRange` in the current view. - * + * Underlining of text with a line containing double dots and dashes. * @remarks - * [Api set: PowerPointApi 1.5] + * [Api set: PowerPointApi 1.4] */ - setSelected(): void; + dotDotDash = "DotDotDash", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Underlining of text with a thick line containing double dots and dashes. + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(options?: PowerPoint.Interfaces.TextRangeLoadOptions): PowerPoint.TextRange; + dotDotDashHeavy = "DotDotDashHeavy", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Underlining of text with a wavy line. + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(propertyNames?: string | string[]): PowerPoint.TextRange; + wavy = "Wavy", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Underlining of text with a thick, wavy line. + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.TextRange; + wavyHeavy = "WavyHeavy", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TextRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextRangeData`) that contains shallow copies of any loaded child properties from the original object. + * Underlining of text with double wavy lines. + * @remarks + * [Api set: PowerPointApi 1.4] */ - toJSON(): PowerPoint.Interfaces.TextRangeData; + wavyDouble = "WavyDouble", } /** - * Represents a single hyperlink. + * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object. * * @remarks - * [Api set: PowerPointApi 1.6] + * [Api set: PowerPointApi 1.4] */ - class Hyperlink extends OfficeExtension.ClientObject { + class ShapeFont extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme. + * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows: + + - `true`: All the text has the **All Caps** attribute. + + - `false`: None of the text has the **All Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. * * @remarks - * [Api set: PowerPointApi 1.6] + * [Api set: PowerPointApi 1.8] */ - address: string; + allCaps: boolean | null; /** - * Specifies the string displayed when hovering over the hyperlink. + * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: + + - `true`: All the text is bold. + + - `false`: None of the text is bold. + + - `null`: Returned if some, but not all, of the text is bold. * * @remarks - * [Api set: PowerPointApi 1.6] + * [Api set: PowerPointApi 1.4] */ - screenTip: string; + bold: boolean | null; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(options?: PowerPoint.Interfaces.HyperlinkLoadOptions): PowerPoint.Hyperlink; + color: string | null; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows: + + - `true`: All the text has the **Double strikethrough** attribute. + + - `false`: None of the text has the **Double strikethrough** attribute. + + - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: PowerPointApi 1.8] */ - load(propertyNames?: string | string[]): PowerPoint.Hyperlink; + doubleStrikethrough: boolean | null; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: + + - `true`: All the text is italicized. + + - `false`: None of the text is italicized. + + - `null`: Returned if some, but not all, of the text is italicized. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.Hyperlink; + italic: boolean | null; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names. + * + * @remarks + * [Api set: PowerPointApi 1.4] */ - toJSON(): PowerPoint.Interfaces.HyperlinkData; - } - /** - * Specifies the type of a placeholder. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ - enum PlaceholderType { + name: string | null; /** - * The placeholder is unsupported. + * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes. + * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - unsupported = "Unsupported", + size: number | null; /** - * The placeholder is for a date. + * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + + - `true`: All the text has the **Small Caps** attribute. + + - `false`: None of the text has the **Small Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * * @remarks * [Api set: PowerPointApi 1.8] */ - date = "Date", + smallCaps: boolean | null; /** - * The placeholder is for a slide number. - * @remarks - * [Api set: PowerPointApi 1.8] - */ - slideNumber = "SlideNumber", - /** - * The placeholder is for a footer. - * @remarks - * [Api set: PowerPointApi 1.8] - */ - footer = "Footer", - /** - * The placeholder is for a header. - * @remarks - * [Api set: PowerPointApi 1.8] - */ - header = "Header", - /** - * The placeholder is for a title. - * @remarks - * [Api set: PowerPointApi 1.8] - */ - title = "Title", - /** - * The placeholder is for a body. - * @remarks - * [Api set: PowerPointApi 1.8] - */ - body = "Body", - /** - * The placeholder is for a center title. - * @remarks - * [Api set: PowerPointApi 1.8] - */ - centerTitle = "CenterTitle", - /** - * The placeholder is for a subtitle. + * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows: + + - `true`: All the text has the **Strikethrough** attribute. + + - `false`: None of the text has the **Strikethrough** attribute. + + - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. + * * @remarks * [Api set: PowerPointApi 1.8] */ - subtitle = "Subtitle", + strikethrough: boolean | null; /** - * The placeholder is for a vertical title. + * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows: + + - `true`: All the text has the **Subscript** attribute. + + - `false`: None of the text has the **Subscript** attribute. + + - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. + * * @remarks * [Api set: PowerPointApi 1.8] */ - verticalTitle = "VerticalTitle", + subscript: boolean | null; /** - * The placeholder is for a vertical body. + * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows: + + - `true`: All the text has the **Superscript** attribute. + + - `false`: None of the text has the **Superscript** attribute. + + - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. + * * @remarks * [Api set: PowerPointApi 1.8] */ - verticalBody = "VerticalBody", + superscript: boolean | null; /** - * The placeholder is for generic content. + * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. + * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - content = "Content", + underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null; /** - * The placeholder is for a chart. - * @remarks - * [Api set: PowerPointApi 1.8] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - chart = "Chart", + load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont; /** - * The placeholder is for a table. - * @remarks - * [Api set: PowerPointApi 1.8] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - table = "Table", + load(propertyNames?: string | string[]): PowerPoint.ShapeFont; /** - * The placeholder is for an online picture. - * @remarks - * [Api set: PowerPointApi 1.8] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - onlinePicture = "OnlinePicture", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.ShapeFont; /** - * The placeholder is for a SmartArt. - * @remarks - * [Api set: PowerPointApi 1.8] - */ - smartArt = "SmartArt", + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ShapeFont` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFontData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.ShapeFontData; + } + /** + * Determines the type of automatic sizing allowed. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum ShapeAutoSize { /** - * The placeholder is for media. + * No autosizing. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - media = "Media", + autoSizeNone = "AutoSizeNone", /** - * The placeholder is for generic vertical content. + * The text is adjusted to fit the shape. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - verticalContent = "VerticalContent", + autoSizeTextToFitShape = "AutoSizeTextToFitShape", /** - * The placeholder is for a picture. + * The shape is adjusted to fit the text. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - picture = "Picture", + autoSizeShapeToFitText = "AutoSizeShapeToFitText", /** - * The placeholder is for a cameo. + * A combination of automatic sizing schemes are used. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - cameo = "Cameo", + autoSizeMixed = "AutoSizeMixed", } /** - * Specifies the type of a shape. + * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}. + If one of the centered options is selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group. + To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment}. * * @remarks * [Api set: PowerPointApi 1.4] */ - enum ShapeType { + enum TextVerticalAlignment { /** - * The given shape's type is unsupported. + * Specifies that the `TextFrame` should be top aligned to the `Shape`. * @remarks * [Api set: PowerPointApi 1.4] */ - unsupported = "Unsupported", + top = "Top", /** - * The shape is an image. + * Specifies that the `TextFrame` should be center aligned to the `Shape`. * @remarks * [Api set: PowerPointApi 1.4] */ - image = "Image", + middle = "Middle", /** - * The shape is a geometric shape such as rectangle. + * Specifies that the `TextFrame` should be bottom aligned to the `Shape`. * @remarks * [Api set: PowerPointApi 1.4] */ - geometricShape = "GeometricShape", + bottom = "Bottom", /** - * The shape is a group shape which contains sub-shapes. + * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`. * @remarks * [Api set: PowerPointApi 1.4] */ - group = "Group", + topCentered = "TopCentered", /** - * The shape is a line. + * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`. * @remarks * [Api set: PowerPointApi 1.4] */ - line = "Line", + middleCentered = "MiddleCentered", /** - * The shape is a table. + * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`. * @remarks * [Api set: PowerPointApi 1.4] */ - table = "Table", + bottomCentered = "BottomCentered", + } + /** + * Represents the text frame of a shape object. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + class TextFrame extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * The shape is a callout. + * Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See {@link PowerPoint.TextRange} for details. + * * @remarks * [Api set: PowerPointApi 1.4] */ - callout = "Callout", + readonly textRange: PowerPoint.TextRange; /** - * The shape is a chart. + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * * @remarks * [Api set: PowerPointApi 1.4] */ - chart = "Chart", + autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"; /** - * The shape is a content Office Add-in. + * Represents the bottom margin, in points, of the text frame. + * * @remarks * [Api set: PowerPointApi 1.4] */ - contentApp = "ContentApp", + bottomMargin: number; /** - * The shape is a diagram. + * Specifies if the text frame contains text. + * * @remarks * [Api set: PowerPointApi 1.4] */ - diagram = "Diagram", + readonly hasText: boolean; /** - * The shape is a freeform object. + * Represents the left margin, in points, of the text frame. + * * @remarks * [Api set: PowerPointApi 1.4] */ - freeform = "Freeform", + leftMargin: number; /** - * The shape is a graphic. + * Represents the right margin, in points, of the text frame. + * * @remarks * [Api set: PowerPointApi 1.4] */ - graphic = "Graphic", + rightMargin: number; /** - * The shape is an ink object. + * Represents the top margin, in points, of the text frame. + * * @remarks * [Api set: PowerPointApi 1.4] */ - ink = "Ink", + topMargin: number; /** - * The shape is a media object. + * Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details. + * * @remarks * [Api set: PowerPointApi 1.4] */ - media = "Media", + verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered"; /** - * The shape is a 3D model. + * Determines whether lines break automatically to fit text inside the shape. + * * @remarks * [Api set: PowerPointApi 1.4] */ - model3D = "Model3D", + wordWrap: boolean; /** - * The shape is an OLE (Object Linking and Embedding) object. + * Deletes all the text in the text frame. + * * @remarks * [Api set: PowerPointApi 1.4] */ - ole = "Ole", + deleteText(): void; /** - * The shape is a placeholder. + * Returns the parent {@link PowerPoint.Shape} object that holds this `TextFrame`. + * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.5] */ - placeholder = "Placeholder", + getParentShape(): PowerPoint.Shape; /** - * The shape is a SmartArt graphic. - * @remarks - * [Api set: PowerPointApi 1.4] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - smartArt = "SmartArt", + load(options?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame; /** - * The shape is a text box. - * @remarks - * [Api set: PowerPointApi 1.4] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - textBox = "TextBox", - } + load(propertyNames?: string | string[]): PowerPoint.TextFrame; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.TextFrame; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.TextFrameData; + } /** - * Represents the properties of a `placeholder` shape. + * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - class PlaceholderFormat extends OfficeExtension.ClientObject { + class TextRange extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details. - Returns `null` if the placeholder is empty. + * Returns a `ShapeFont` object that represents the font attributes for the text range. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null; + readonly font: PowerPoint.ShapeFont; /** - * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details. + * Returns a collection of hyperlinks that exist on this `TextRange`. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - readonly type: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo"; + readonly hyperlinks: PowerPoint.HyperlinkScopedCollection; + /** + * Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + readonly paragraphFormat: PowerPoint.ParagraphFormat; + /** + * Gets or sets the length of the range that this `TextRange` represents. + Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + length: number; + /** + * Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents. + Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + start: number; + /** + * Represents the plain text content of the text range. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + text: string; + /** + * Returns the parent {@link PowerPoint.TextFrame} object that holds this `TextRange`. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + getParentTextFrame(): PowerPoint.TextFrame; + /** + * Returns a `TextRange` object for the substring in the given range. + * + * @remarks + * [Api set: PowerPointApi 1.4] + * + * @param start The zero-based index of the first character to get from the text range. + * @param length Optional. The number of characters to be returned in the new text range. If length is omitted, all the characters from start to the end of the text range's last paragraph will be returned. + */ + getSubstring(start: number, length?: number): PowerPoint.TextRange; + /** + * Sets a hyperlink on this `TextRange` with the specified options. This will delete all existing hyperlinks on this `TextRange`. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * + * @param options Optional. The options for the hyperlink. + * @returns The newly created {@link PowerPoint.Hyperlink} object. + */ + setHyperlink(options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink; + /** + * Selects this `TextRange` in the current view. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + setSelected(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions): PowerPoint.PlaceholderFormat; + load(options?: PowerPoint.Interfaces.TextRangeLoadOptions): PowerPoint.TextRange; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): PowerPoint.PlaceholderFormat; + load(propertyNames?: string | string[]): PowerPoint.TextRange; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -179366,1869 +179517,1827 @@ declare namespace PowerPoint { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): PowerPoint.PlaceholderFormat; + }): PowerPoint.TextRange; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.PlaceholderFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PlaceholderFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `PowerPoint.TextRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextRangeData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): PowerPoint.Interfaces.PlaceholderFormatData; + toJSON(): PowerPoint.Interfaces.TextRangeData; } /** - * Represents a collection of hyperlinks. + * Specifies the type of object that a hyperlink is applied to. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + enum HyperlinkType { + /** + * Specifies that the hyperlink is applied to a TextRange. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + textRange = "TextRange", + /** + * Specifies that the hyperlink is applied to a Shape. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + shape = "Shape", + } + /** + * Represents a single hyperlink. * * @remarks * [Api set: PowerPointApi 1.6] */ - class HyperlinkCollection extends OfficeExtension.ClientObject { + class Hyperlink extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: PowerPoint.Hyperlink[]; /** - * Gets the number of hyperlinks in the collection. + * Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme. * * @remarks * [Api set: PowerPointApi 1.6] - * @returns The number of hyperlinks in the collection. */ - getCount(): OfficeExtension.ClientResult; + address: string; /** - * Gets a hyperlink using its zero-based index in the collection. - Throws an `InvalidArgument` exception if the index is out of range. + * Specifies the string displayed when hovering over the hyperlink. * * @remarks * [Api set: PowerPointApi 1.6] + */ + screenTip: string; + /** + * Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details. * - * @param index The index of the hyperlink in the collection. - * @returns The hyperlink at the given index. + * @remarks + * [Api set: PowerPointApi 1.10] */ - getItemAt(index: number): PowerPoint.Hyperlink; + readonly type: PowerPoint.HyperlinkType | "TextRange" | "Shape"; + /** + * Deletes the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + delete(): void; + /** + * Returns the {@link PowerPoint.Shape} object that the hyperlink is applied to. + If the hyperlink is not of type `shape`, or it is within a domain that does not currently support a {@link PowerPoint.Shape}, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + getLinkedShapeOrNullObject(): PowerPoint.Shape; + /** + * Returns the {@link PowerPoint.TextRange} object that the hyperlink is applied to. + If the hyperlink is not of type `textRange`, or it is within a domain that does not currently support a {@link PowerPoint.TextRange}, then this method returns an object with its `isNullObject` property set to `true`. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + getLinkedTextRangeOrNullObject(): PowerPoint.TextRange; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: PowerPoint.Interfaces.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkCollection; + load(options?: PowerPoint.Interfaces.HyperlinkLoadOptions): PowerPoint.Hyperlink; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): PowerPoint.HyperlinkCollection; + load(propertyNames?: string | string[]): PowerPoint.Hyperlink; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.Hyperlink; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): PowerPoint.Interfaces.HyperlinkCollectionData; + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.HyperlinkData; } /** - * Specifies the connector type for line shapes. + * Specifies the type of a placeholder. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - enum ConnectorType { + enum PlaceholderType { /** - * Straight connector type + * The placeholder is unsupported. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - straight = "Straight", + unsupported = "Unsupported", /** - * Elbow connector type + * The placeholder is for a date. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - elbow = "Elbow", + date = "Date", /** - * Curve connector type + * The placeholder is for a slide number. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - curve = "Curve", - } - /** - * Specifies the shape type for a `GeometricShape` object. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ - enum GeometricShapeType { + slideNumber = "SlideNumber", /** - * Straight Line from Top-Right Corner to Bottom-Left Corner of the Shape + * The placeholder is for a footer. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - lineInverse = "LineInverse", + footer = "Footer", /** - * Isosceles Triangle + * The placeholder is for a header. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - triangle = "Triangle", + header = "Header", /** - * Right Triangle + * The placeholder is for a title. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - rightTriangle = "RightTriangle", + title = "Title", /** - * Rectangle + * The placeholder is for a body. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - rectangle = "Rectangle", + body = "Body", /** - * Diamond + * The placeholder is for a center title. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - diamond = "Diamond", + centerTitle = "CenterTitle", /** - * Parallelogram + * The placeholder is for a subtitle. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - parallelogram = "Parallelogram", + subtitle = "Subtitle", /** - * Trapezoid + * The placeholder is for a vertical title. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - trapezoid = "Trapezoid", + verticalTitle = "VerticalTitle", /** - * Trapezoid which may have Non-Equal Sides + * The placeholder is for a vertical body. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", + verticalBody = "VerticalBody", /** - * Pentagon + * The placeholder is for generic content. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - pentagon = "Pentagon", + content = "Content", /** - * Hexagon + * The placeholder is for a chart. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - hexagon = "Hexagon", + chart = "Chart", /** - * Heptagon - * @remarks - * [Api set: PowerPointApi 1.4] - */ - heptagon = "Heptagon", - /** - * Octagon + * The placeholder is for a table. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - octagon = "Octagon", + table = "Table", /** - * Decagon + * The placeholder is for an online picture. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - decagon = "Decagon", + onlinePicture = "OnlinePicture", /** - * Dodecagon + * The placeholder is for a SmartArt. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - dodecagon = "Dodecagon", + smartArt = "SmartArt", /** - * Star: 4 Points + * The placeholder is for media. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - star4 = "Star4", + media = "Media", /** - * Star: 5 Points + * The placeholder is for generic vertical content. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - star5 = "Star5", + verticalContent = "VerticalContent", /** - * Star: 6 Points + * The placeholder is for a picture. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - star6 = "Star6", + picture = "Picture", /** - * Star: 7 Points + * The placeholder is for a cameo. * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - star7 = "Star7", + cameo = "Cameo", + } + /** + * Specifies the type of a shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum ShapeType { /** - * Star: 8 Points + * The given shape's type is unsupported. * @remarks * [Api set: PowerPointApi 1.4] */ - star8 = "Star8", + unsupported = "Unsupported", /** - * Star: 10 Points + * The shape is an image. * @remarks * [Api set: PowerPointApi 1.4] */ - star10 = "Star10", + image = "Image", /** - * Star: 12 Points + * The shape is a geometric shape such as rectangle. * @remarks * [Api set: PowerPointApi 1.4] */ - star12 = "Star12", + geometricShape = "GeometricShape", /** - * Star: 16 Points + * The shape is a group shape which contains sub-shapes. * @remarks * [Api set: PowerPointApi 1.4] */ - star16 = "Star16", + group = "Group", /** - * Star: 24 Points + * The shape is a line. * @remarks * [Api set: PowerPointApi 1.4] */ - star24 = "Star24", + line = "Line", /** - * Star: 32 Points + * The shape is a table. * @remarks * [Api set: PowerPointApi 1.4] */ - star32 = "Star32", + table = "Table", /** - * Rectangle: Rounded Corners + * The shape is a callout. * @remarks * [Api set: PowerPointApi 1.4] */ - roundRectangle = "RoundRectangle", + callout = "Callout", /** - * Rectangle: Single Corner Rounded + * The shape is a chart. * @remarks * [Api set: PowerPointApi 1.4] */ - round1Rectangle = "Round1Rectangle", + chart = "Chart", /** - * Rectangle: Top Corners Rounded + * The shape is a content Office Add-in. * @remarks * [Api set: PowerPointApi 1.4] */ - round2SameRectangle = "Round2SameRectangle", + contentApp = "ContentApp", /** - * Rectangle: Diagonal Corners Rounded + * The shape is a diagram. * @remarks * [Api set: PowerPointApi 1.4] */ - round2DiagonalRectangle = "Round2DiagonalRectangle", + diagram = "Diagram", /** - * Rectangle: Top Corners One Rounded and One Snipped + * The shape is a freeform object. * @remarks * [Api set: PowerPointApi 1.4] */ - snipRoundRectangle = "SnipRoundRectangle", + freeform = "Freeform", /** - * Rectangle: Single Corner Snipped + * The shape is a graphic. * @remarks * [Api set: PowerPointApi 1.4] */ - snip1Rectangle = "Snip1Rectangle", + graphic = "Graphic", /** - * Rectangle: Top Corners Snipped + * The shape is an ink object. * @remarks * [Api set: PowerPointApi 1.4] */ - snip2SameRectangle = "Snip2SameRectangle", + ink = "Ink", /** - * Rectangle: Diagonal Corners Snipped + * The shape is a media object. * @remarks * [Api set: PowerPointApi 1.4] */ - snip2DiagonalRectangle = "Snip2DiagonalRectangle", + media = "Media", /** - * Plaque + * The shape is a 3D model. * @remarks * [Api set: PowerPointApi 1.4] */ - plaque = "Plaque", + model3D = "Model3D", /** - * Oval + * The shape is an OLE (Object Linking and Embedding) object. * @remarks * [Api set: PowerPointApi 1.4] */ - ellipse = "Ellipse", + ole = "Ole", /** - * Teardrop + * The shape is a placeholder. * @remarks * [Api set: PowerPointApi 1.4] */ - teardrop = "Teardrop", + placeholder = "Placeholder", /** - * Arrow: Pentagon + * The shape is a SmartArt graphic. * @remarks * [Api set: PowerPointApi 1.4] */ - homePlate = "HomePlate", + smartArt = "SmartArt", /** - * Arrow: Chevron + * The shape is a text box. * @remarks * [Api set: PowerPointApi 1.4] */ - chevron = "Chevron", + textBox = "TextBox", + } + /** + * Represents the properties of a `placeholder` shape. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + class PlaceholderFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Partial Circle + * Gets the type of the shape contained within the placeholder. See {@link PowerPoint.ShapeType} for details. + Returns `null` if the placeholder is empty. + * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - pieWedge = "PieWedge", + readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null; /** - * Partial Circle with Adjustable Spanning Area + * Returns the type of this placeholder. See {@link PowerPoint.PlaceholderType} for details. + * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.8] */ - pie = "Pie", + readonly type: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo"; /** - * Block Arc - * @remarks - * [Api set: PowerPointApi 1.4] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - blockArc = "BlockArc", + load(options?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions): PowerPoint.PlaceholderFormat; /** - * Circle: Hollow - * @remarks - * [Api set: PowerPointApi 1.4] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - donut = "Donut", + load(propertyNames?: string | string[]): PowerPoint.PlaceholderFormat; /** - * "Not Allowed" Symbol - * @remarks - * [Api set: PowerPointApi 1.4] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - noSmoking = "NoSmoking", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.PlaceholderFormat; /** - * Arrow: Right - * @remarks - * [Api set: PowerPointApi 1.4] - */ - rightArrow = "RightArrow", + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.PlaceholderFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PlaceholderFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.PlaceholderFormatData; + } + /** + * Represents a collection of hyperlinks. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + class HyperlinkCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.Hyperlink[]; /** - * Arrow: Left + * Adds a hyperlink to the specified target with the given options. If the target already contains any hyperlinks, they will be deleted. + The new hyperlink may appear anywhere in the collection and is not guaranteed to be added at the end. + * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] + * + * @param target The target to add the hyperlink to. Can be a {@link PowerPoint.TextRange} or a {@link PowerPoint.Shape}. + * @param options Optional. The options for the hyperlink. + * @returns The newly created {@link PowerPoint.Hyperlink} object. */ - leftArrow = "LeftArrow", + add(target: TextRange | Shape, options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink; /** - * Arrow: Up + * Gets the number of hyperlinks in the collection. + * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.6] + * @returns The number of hyperlinks in the collection. */ - upArrow = "UpArrow", + getCount(): OfficeExtension.ClientResult; /** - * Arrow: Down + * Gets a hyperlink using its zero-based index in the collection. + Throws an `InvalidArgument` exception if the index is out of range. + * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.6] + * + * @param index The index of the hyperlink in the collection. + * @returns The hyperlink at the given index. */ - downArrow = "DownArrow", + getItemAt(index: number): PowerPoint.Hyperlink; /** - * Arrow: Striped Right - * @remarks - * [Api set: PowerPointApi 1.4] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - stripedRightArrow = "StripedRightArrow", + load(options?: PowerPoint.Interfaces.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkCollection; /** - * Arrow: Notched Right - * @remarks - * [Api set: PowerPointApi 1.4] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - notchedRightArrow = "NotchedRightArrow", + load(propertyNames?: string | string[]): PowerPoint.HyperlinkCollection; /** - * Arrow: Bent-Up - * @remarks - * [Api set: PowerPointApi 1.4] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - bentUpArrow = "BentUpArrow", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection; /** - * Arrow: Left-Right - * @remarks - * [Api set: PowerPointApi 1.4] - */ - leftRightArrow = "LeftRightArrow", + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.HyperlinkCollectionData; + } + /** + * Specifies the connector type for line shapes. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum ConnectorType { /** - * Arrow: Up-Down + * Straight connector type * @remarks * [Api set: PowerPointApi 1.4] */ - upDownArrow = "UpDownArrow", + straight = "Straight", /** - * Arrow: Left-Up + * Elbow connector type * @remarks * [Api set: PowerPointApi 1.4] */ - leftUpArrow = "LeftUpArrow", + elbow = "Elbow", /** - * Arrow: Left-Right-Up + * Curve connector type * @remarks * [Api set: PowerPointApi 1.4] */ - leftRightUpArrow = "LeftRightUpArrow", + curve = "Curve", + } + /** + * Specifies the shape type for a `GeometricShape` object. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + enum GeometricShapeType { /** - * Arrow: Quad + * Straight Line from Top-Right Corner to Bottom-Left Corner of the Shape * @remarks * [Api set: PowerPointApi 1.4] */ - quadArrow = "QuadArrow", + lineInverse = "LineInverse", /** - * Callout: Left Arrow + * Isosceles Triangle * @remarks * [Api set: PowerPointApi 1.4] */ - leftArrowCallout = "LeftArrowCallout", + triangle = "Triangle", /** - * Callout: Right Arrow + * Right Triangle * @remarks * [Api set: PowerPointApi 1.4] */ - rightArrowCallout = "RightArrowCallout", + rightTriangle = "RightTriangle", /** - * Callout: Up Arrow + * Rectangle * @remarks * [Api set: PowerPointApi 1.4] */ - upArrowCallout = "UpArrowCallout", + rectangle = "Rectangle", /** - * Callout: Down Arrow + * Diamond * @remarks * [Api set: PowerPointApi 1.4] */ - downArrowCallout = "DownArrowCallout", + diamond = "Diamond", /** - * Callout: Left-Right Arrow + * Parallelogram * @remarks * [Api set: PowerPointApi 1.4] */ - leftRightArrowCallout = "LeftRightArrowCallout", + parallelogram = "Parallelogram", /** - * Callout: Up-Down Arrow + * Trapezoid * @remarks * [Api set: PowerPointApi 1.4] */ - upDownArrowCallout = "UpDownArrowCallout", + trapezoid = "Trapezoid", /** - * Callout: Quad Arrow + * Trapezoid which may have Non-Equal Sides * @remarks * [Api set: PowerPointApi 1.4] */ - quadArrowCallout = "QuadArrowCallout", + nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", /** - * Arrow: Bent + * Pentagon * @remarks * [Api set: PowerPointApi 1.4] */ - bentArrow = "BentArrow", + pentagon = "Pentagon", /** - * Arrow: U-Turn + * Hexagon * @remarks * [Api set: PowerPointApi 1.4] */ - uturnArrow = "UturnArrow", + hexagon = "Hexagon", /** - * Arrow: Circular + * Heptagon * @remarks * [Api set: PowerPointApi 1.4] */ - circularArrow = "CircularArrow", + heptagon = "Heptagon", /** - * Arrow: Circular with Opposite Arrow Direction + * Octagon * @remarks * [Api set: PowerPointApi 1.4] */ - leftCircularArrow = "LeftCircularArrow", + octagon = "Octagon", /** - * Arrow: Circular with Two Arrows in Both Directions + * Decagon * @remarks * [Api set: PowerPointApi 1.4] */ - leftRightCircularArrow = "LeftRightCircularArrow", + decagon = "Decagon", /** - * Arrow: Curved Right + * Dodecagon * @remarks * [Api set: PowerPointApi 1.4] */ - curvedRightArrow = "CurvedRightArrow", + dodecagon = "Dodecagon", /** - * Arrow: Curved Left + * Star: 4 Points * @remarks * [Api set: PowerPointApi 1.4] */ - curvedLeftArrow = "CurvedLeftArrow", + star4 = "Star4", /** - * Arrow: Curved Up + * Star: 5 Points * @remarks * [Api set: PowerPointApi 1.4] */ - curvedUpArrow = "CurvedUpArrow", + star5 = "Star5", /** - * Arrow: Curved Down + * Star: 6 Points * @remarks * [Api set: PowerPointApi 1.4] */ - curvedDownArrow = "CurvedDownArrow", + star6 = "Star6", /** - * Arrow: Curved Right Arrow with Varying Width + * Star: 7 Points * @remarks * [Api set: PowerPointApi 1.4] */ - swooshArrow = "SwooshArrow", + star7 = "Star7", /** - * Cube + * Star: 8 Points * @remarks * [Api set: PowerPointApi 1.4] */ - cube = "Cube", + star8 = "Star8", /** - * Cylinder + * Star: 10 Points * @remarks * [Api set: PowerPointApi 1.4] */ - can = "Can", + star10 = "Star10", /** - * Lightning Bolt + * Star: 12 Points * @remarks * [Api set: PowerPointApi 1.4] */ - lightningBolt = "LightningBolt", + star12 = "Star12", /** - * Heart + * Star: 16 Points * @remarks * [Api set: PowerPointApi 1.4] */ - heart = "Heart", + star16 = "Star16", /** - * Sun + * Star: 24 Points * @remarks * [Api set: PowerPointApi 1.4] */ - sun = "Sun", + star24 = "Star24", /** - * Moon + * Star: 32 Points * @remarks * [Api set: PowerPointApi 1.4] */ - moon = "Moon", + star32 = "Star32", /** - * Smiley Face + * Rectangle: Rounded Corners * @remarks * [Api set: PowerPointApi 1.4] */ - smileyFace = "SmileyFace", + roundRectangle = "RoundRectangle", /** - * Explosion: 8 Points + * Rectangle: Single Corner Rounded * @remarks * [Api set: PowerPointApi 1.4] */ - irregularSeal1 = "IrregularSeal1", + round1Rectangle = "Round1Rectangle", /** - * Explosion: 14 Points + * Rectangle: Top Corners Rounded * @remarks * [Api set: PowerPointApi 1.4] */ - irregularSeal2 = "IrregularSeal2", + round2SameRectangle = "Round2SameRectangle", /** - * Rectangle: Folded Corner + * Rectangle: Diagonal Corners Rounded * @remarks * [Api set: PowerPointApi 1.4] */ - foldedCorner = "FoldedCorner", + round2DiagonalRectangle = "Round2DiagonalRectangle", /** - * Rectangle: Beveled + * Rectangle: Top Corners One Rounded and One Snipped * @remarks * [Api set: PowerPointApi 1.4] */ - bevel = "Bevel", + snipRoundRectangle = "SnipRoundRectangle", /** - * Frame + * Rectangle: Single Corner Snipped * @remarks * [Api set: PowerPointApi 1.4] */ - frame = "Frame", + snip1Rectangle = "Snip1Rectangle", /** - * Half Frame + * Rectangle: Top Corners Snipped * @remarks * [Api set: PowerPointApi 1.4] */ - halfFrame = "HalfFrame", + snip2SameRectangle = "Snip2SameRectangle", /** - * L-Shape + * Rectangle: Diagonal Corners Snipped * @remarks * [Api set: PowerPointApi 1.4] */ - corner = "Corner", + snip2DiagonalRectangle = "Snip2DiagonalRectangle", /** - * Diagonal Stripe + * Plaque * @remarks * [Api set: PowerPointApi 1.4] */ - diagonalStripe = "DiagonalStripe", + plaque = "Plaque", /** - * Chord + * Oval * @remarks * [Api set: PowerPointApi 1.4] */ - chord = "Chord", + ellipse = "Ellipse", /** - * Arc + * Teardrop * @remarks * [Api set: PowerPointApi 1.4] */ - arc = "Arc", + teardrop = "Teardrop", /** - * Left Bracket + * Arrow: Pentagon * @remarks * [Api set: PowerPointApi 1.4] */ - leftBracket = "LeftBracket", + homePlate = "HomePlate", /** - * Right Bracket + * Arrow: Chevron * @remarks * [Api set: PowerPointApi 1.4] */ - rightBracket = "RightBracket", + chevron = "Chevron", /** - * Left Brace + * Partial Circle * @remarks * [Api set: PowerPointApi 1.4] */ - leftBrace = "LeftBrace", + pieWedge = "PieWedge", /** - * Right Brace + * Partial Circle with Adjustable Spanning Area * @remarks * [Api set: PowerPointApi 1.4] */ - rightBrace = "RightBrace", + pie = "Pie", /** - * Double Bracket + * Block Arc * @remarks * [Api set: PowerPointApi 1.4] */ - bracketPair = "BracketPair", + blockArc = "BlockArc", /** - * Double Brace + * Circle: Hollow * @remarks * [Api set: PowerPointApi 1.4] */ - bracePair = "BracePair", + donut = "Donut", /** - * Callout: Line with No Border + * "Not Allowed" Symbol * @remarks * [Api set: PowerPointApi 1.4] */ - callout1 = "Callout1", + noSmoking = "NoSmoking", /** - * Callout: Bent Line with No Border + * Arrow: Right * @remarks * [Api set: PowerPointApi 1.4] */ - callout2 = "Callout2", + rightArrow = "RightArrow", /** - * Callout: Double Bent Line with No Border + * Arrow: Left * @remarks * [Api set: PowerPointApi 1.4] */ - callout3 = "Callout3", + leftArrow = "LeftArrow", /** - * Callout: Line with Accent Bar + * Arrow: Up * @remarks * [Api set: PowerPointApi 1.4] */ - accentCallout1 = "AccentCallout1", + upArrow = "UpArrow", /** - * Callout: Bent Line with Accent Bar + * Arrow: Down * @remarks * [Api set: PowerPointApi 1.4] */ - accentCallout2 = "AccentCallout2", + downArrow = "DownArrow", /** - * Callout: Double Bent Line with Accent Bar + * Arrow: Striped Right * @remarks * [Api set: PowerPointApi 1.4] */ - accentCallout3 = "AccentCallout3", + stripedRightArrow = "StripedRightArrow", /** - * Callout: Line + * Arrow: Notched Right * @remarks * [Api set: PowerPointApi 1.4] */ - borderCallout1 = "BorderCallout1", + notchedRightArrow = "NotchedRightArrow", /** - * Callout: Bent Line + * Arrow: Bent-Up * @remarks * [Api set: PowerPointApi 1.4] */ - borderCallout2 = "BorderCallout2", + bentUpArrow = "BentUpArrow", /** - * Callout: Double Bent Line + * Arrow: Left-Right * @remarks * [Api set: PowerPointApi 1.4] */ - borderCallout3 = "BorderCallout3", + leftRightArrow = "LeftRightArrow", /** - * Callout: Line with Border and Accent Bar + * Arrow: Up-Down * @remarks * [Api set: PowerPointApi 1.4] */ - accentBorderCallout1 = "AccentBorderCallout1", + upDownArrow = "UpDownArrow", /** - * Callout: Bent Line with Border and Accent Bar + * Arrow: Left-Up * @remarks * [Api set: PowerPointApi 1.4] */ - accentBorderCallout2 = "AccentBorderCallout2", + leftUpArrow = "LeftUpArrow", /** - * Callout: Double Bent Line with Border and Accent Bar + * Arrow: Left-Right-Up * @remarks * [Api set: PowerPointApi 1.4] */ - accentBorderCallout3 = "AccentBorderCallout3", + leftRightUpArrow = "LeftRightUpArrow", /** - * Speech Bubble: Rectangle + * Arrow: Quad * @remarks * [Api set: PowerPointApi 1.4] */ - wedgeRectCallout = "WedgeRectCallout", + quadArrow = "QuadArrow", /** - * Speech Bubble: Rectangle with Corners Rounded + * Callout: Left Arrow * @remarks * [Api set: PowerPointApi 1.4] */ - wedgeRRectCallout = "WedgeRRectCallout", + leftArrowCallout = "LeftArrowCallout", /** - * Speech Bubble: Oval + * Callout: Right Arrow * @remarks * [Api set: PowerPointApi 1.4] */ - wedgeEllipseCallout = "WedgeEllipseCallout", + rightArrowCallout = "RightArrowCallout", /** - * Thought Bubble: Cloud + * Callout: Up Arrow * @remarks * [Api set: PowerPointApi 1.4] */ - cloudCallout = "CloudCallout", + upArrowCallout = "UpArrowCallout", /** - * Cloud + * Callout: Down Arrow * @remarks * [Api set: PowerPointApi 1.4] */ - cloud = "Cloud", + downArrowCallout = "DownArrowCallout", /** - * Ribbon: Tilted Down + * Callout: Left-Right Arrow * @remarks * [Api set: PowerPointApi 1.4] */ - ribbon = "Ribbon", + leftRightArrowCallout = "LeftRightArrowCallout", /** - * Ribbon: Tilted Up + * Callout: Up-Down Arrow * @remarks * [Api set: PowerPointApi 1.4] */ - ribbon2 = "Ribbon2", + upDownArrowCallout = "UpDownArrowCallout", /** - * Ribbon: Curved and Tilted Down + * Callout: Quad Arrow * @remarks * [Api set: PowerPointApi 1.4] */ - ellipseRibbon = "EllipseRibbon", + quadArrowCallout = "QuadArrowCallout", /** - * Ribbon: Curved and Tilted Up + * Arrow: Bent * @remarks * [Api set: PowerPointApi 1.4] */ - ellipseRibbon2 = "EllipseRibbon2", + bentArrow = "BentArrow", /** - * Ribbon: Straight with Both Left and Right Arrows + * Arrow: U-Turn * @remarks * [Api set: PowerPointApi 1.4] */ - leftRightRibbon = "LeftRightRibbon", + uturnArrow = "UturnArrow", /** - * Scroll: Vertical + * Arrow: Circular * @remarks * [Api set: PowerPointApi 1.4] */ - verticalScroll = "VerticalScroll", + circularArrow = "CircularArrow", /** - * Scroll: Horizontal + * Arrow: Circular with Opposite Arrow Direction * @remarks * [Api set: PowerPointApi 1.4] */ - horizontalScroll = "HorizontalScroll", + leftCircularArrow = "LeftCircularArrow", /** - * Wave + * Arrow: Circular with Two Arrows in Both Directions * @remarks * [Api set: PowerPointApi 1.4] */ - wave = "Wave", + leftRightCircularArrow = "LeftRightCircularArrow", /** - * Double Wave + * Arrow: Curved Right * @remarks * [Api set: PowerPointApi 1.4] */ - doubleWave = "DoubleWave", + curvedRightArrow = "CurvedRightArrow", /** - * Cross + * Arrow: Curved Left * @remarks * [Api set: PowerPointApi 1.4] */ - plus = "Plus", + curvedLeftArrow = "CurvedLeftArrow", /** - * Flowchart: Process + * Arrow: Curved Up * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartProcess = "FlowChartProcess", + curvedUpArrow = "CurvedUpArrow", /** - * Flowchart: Decision + * Arrow: Curved Down * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartDecision = "FlowChartDecision", + curvedDownArrow = "CurvedDownArrow", /** - * Flowchart: Data + * Arrow: Curved Right Arrow with Varying Width * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartInputOutput = "FlowChartInputOutput", + swooshArrow = "SwooshArrow", /** - * Flowchart: Predefined Process + * Cube * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartPredefinedProcess = "FlowChartPredefinedProcess", + cube = "Cube", /** - * Flowchart: Internal Storage + * Cylinder * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartInternalStorage = "FlowChartInternalStorage", + can = "Can", /** - * Flowchart: Document + * Lightning Bolt * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartDocument = "FlowChartDocument", + lightningBolt = "LightningBolt", /** - * Flowchart: Multidocument + * Heart * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartMultidocument = "FlowChartMultidocument", + heart = "Heart", /** - * Flowchart: Terminator + * Sun * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartTerminator = "FlowChartTerminator", + sun = "Sun", /** - * Flowchart: Preparation + * Moon * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartPreparation = "FlowChartPreparation", + moon = "Moon", /** - * Flowchart: Manual Input + * Smiley Face * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartManualInput = "FlowChartManualInput", + smileyFace = "SmileyFace", /** - * Flowchart: Manual Operation + * Explosion: 8 Points * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartManualOperation = "FlowChartManualOperation", + irregularSeal1 = "IrregularSeal1", /** - * Flowchart: Connector + * Explosion: 14 Points * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartConnector = "FlowChartConnector", + irregularSeal2 = "IrregularSeal2", /** - * Flowchart: Card + * Rectangle: Folded Corner * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartPunchedCard = "FlowChartPunchedCard", + foldedCorner = "FoldedCorner", /** - * Flowchart: Punched Tape + * Rectangle: Beveled * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartPunchedTape = "FlowChartPunchedTape", + bevel = "Bevel", /** - * Flowchart: Summing Junction + * Frame * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartSummingJunction = "FlowChartSummingJunction", + frame = "Frame", /** - * Flowchart: Or + * Half Frame * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartOr = "FlowChartOr", + halfFrame = "HalfFrame", /** - * Flowchart: Collate + * L-Shape * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartCollate = "FlowChartCollate", + corner = "Corner", /** - * Flowchart: Sort + * Diagonal Stripe * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartSort = "FlowChartSort", + diagonalStripe = "DiagonalStripe", /** - * Flowchart: Extract + * Chord * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartExtract = "FlowChartExtract", + chord = "Chord", /** - * Flowchart: Merge + * Arc * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartMerge = "FlowChartMerge", + arc = "Arc", /** - * FlowChart: Offline Storage + * Left Bracket * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartOfflineStorage = "FlowChartOfflineStorage", + leftBracket = "LeftBracket", /** - * Flowchart: Stored Data + * Right Bracket * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartOnlineStorage = "FlowChartOnlineStorage", + rightBracket = "RightBracket", /** - * Flowchart: Sequential Access Storage + * Left Brace * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartMagneticTape = "FlowChartMagneticTape", + leftBrace = "LeftBrace", /** - * Flowchart: Magnetic Disk + * Right Brace * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartMagneticDisk = "FlowChartMagneticDisk", + rightBrace = "RightBrace", /** - * Flowchart: Direct Access Storage + * Double Bracket * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartMagneticDrum = "FlowChartMagneticDrum", + bracketPair = "BracketPair", /** - * Flowchart: Display + * Double Brace * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartDisplay = "FlowChartDisplay", + bracePair = "BracePair", /** - * Flowchart: Delay + * Callout: Line with No Border * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartDelay = "FlowChartDelay", + callout1 = "Callout1", /** - * Flowchart: Alternate Process + * Callout: Bent Line with No Border * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartAlternateProcess = "FlowChartAlternateProcess", + callout2 = "Callout2", /** - * Flowchart: Off-page Connector + * Callout: Double Bent Line with No Border * @remarks * [Api set: PowerPointApi 1.4] */ - flowChartOffpageConnector = "FlowChartOffpageConnector", + callout3 = "Callout3", /** - * Action Button: Blank + * Callout: Line with Accent Bar * @remarks * [Api set: PowerPointApi 1.4] */ - actionButtonBlank = "ActionButtonBlank", + accentCallout1 = "AccentCallout1", /** - * Action Button: Go Home + * Callout: Bent Line with Accent Bar * @remarks * [Api set: PowerPointApi 1.4] */ - actionButtonHome = "ActionButtonHome", + accentCallout2 = "AccentCallout2", /** - * Action Button: Help + * Callout: Double Bent Line with Accent Bar * @remarks * [Api set: PowerPointApi 1.4] */ - actionButtonHelp = "ActionButtonHelp", + accentCallout3 = "AccentCallout3", /** - * Action Button: Get Information + * Callout: Line * @remarks * [Api set: PowerPointApi 1.4] */ - actionButtonInformation = "ActionButtonInformation", + borderCallout1 = "BorderCallout1", /** - * Action Button: Go Forward or Next + * Callout: Bent Line * @remarks * [Api set: PowerPointApi 1.4] */ - actionButtonForwardNext = "ActionButtonForwardNext", + borderCallout2 = "BorderCallout2", /** - * Action Button: Go Back or Previous + * Callout: Double Bent Line * @remarks * [Api set: PowerPointApi 1.4] */ - actionButtonBackPrevious = "ActionButtonBackPrevious", + borderCallout3 = "BorderCallout3", /** - * Action Button: Go to End + * Callout: Line with Border and Accent Bar * @remarks * [Api set: PowerPointApi 1.4] */ - actionButtonEnd = "ActionButtonEnd", + accentBorderCallout1 = "AccentBorderCallout1", /** - * Action Button: Go to Beginning + * Callout: Bent Line with Border and Accent Bar * @remarks * [Api set: PowerPointApi 1.4] */ - actionButtonBeginning = "ActionButtonBeginning", + accentBorderCallout2 = "AccentBorderCallout2", /** - * Action Button: Return + * Callout: Double Bent Line with Border and Accent Bar * @remarks * [Api set: PowerPointApi 1.4] */ - actionButtonReturn = "ActionButtonReturn", + accentBorderCallout3 = "AccentBorderCallout3", /** - * Action Button: Document + * Speech Bubble: Rectangle * @remarks * [Api set: PowerPointApi 1.4] */ - actionButtonDocument = "ActionButtonDocument", + wedgeRectCallout = "WedgeRectCallout", /** - * Action Button: Sound + * Speech Bubble: Rectangle with Corners Rounded * @remarks * [Api set: PowerPointApi 1.4] */ - actionButtonSound = "ActionButtonSound", + wedgeRRectCallout = "WedgeRRectCallout", /** - * Action Button: Video + * Speech Bubble: Oval * @remarks * [Api set: PowerPointApi 1.4] */ - actionButtonMovie = "ActionButtonMovie", + wedgeEllipseCallout = "WedgeEllipseCallout", /** - * Gear: A Gear with Six Teeth + * Thought Bubble: Cloud * @remarks * [Api set: PowerPointApi 1.4] */ - gear6 = "Gear6", + cloudCallout = "CloudCallout", /** - * Gear: A Gear with Nine Teeth + * Cloud * @remarks * [Api set: PowerPointApi 1.4] */ - gear9 = "Gear9", + cloud = "Cloud", /** - * Funnel + * Ribbon: Tilted Down * @remarks * [Api set: PowerPointApi 1.4] */ - funnel = "Funnel", + ribbon = "Ribbon", /** - * Plus Sign + * Ribbon: Tilted Up * @remarks * [Api set: PowerPointApi 1.4] */ - mathPlus = "MathPlus", + ribbon2 = "Ribbon2", /** - * Minus Sign + * Ribbon: Curved and Tilted Down * @remarks * [Api set: PowerPointApi 1.4] */ - mathMinus = "MathMinus", + ellipseRibbon = "EllipseRibbon", /** - * Multiplication Sign + * Ribbon: Curved and Tilted Up * @remarks * [Api set: PowerPointApi 1.4] */ - mathMultiply = "MathMultiply", + ellipseRibbon2 = "EllipseRibbon2", /** - * Division Sign + * Ribbon: Straight with Both Left and Right Arrows * @remarks * [Api set: PowerPointApi 1.4] */ - mathDivide = "MathDivide", + leftRightRibbon = "LeftRightRibbon", /** - * Equals + * Scroll: Vertical * @remarks * [Api set: PowerPointApi 1.4] */ - mathEqual = "MathEqual", + verticalScroll = "VerticalScroll", /** - * Not Equal + * Scroll: Horizontal * @remarks * [Api set: PowerPointApi 1.4] */ - mathNotEqual = "MathNotEqual", + horizontalScroll = "HorizontalScroll", /** - * Four Right Triangles that Define a Rectangular Shape + * Wave * @remarks * [Api set: PowerPointApi 1.4] */ - cornerTabs = "CornerTabs", + wave = "Wave", /** - * Four Small Squares that Define a Rectangular Shape. + * Double Wave * @remarks * [Api set: PowerPointApi 1.4] */ - squareTabs = "SquareTabs", + doubleWave = "DoubleWave", /** - * Four Quarter Circles that Define a Rectangular Shape. + * Cross * @remarks * [Api set: PowerPointApi 1.4] */ - plaqueTabs = "PlaqueTabs", + plus = "Plus", /** - * A Rectangle Divided into Four Parts Along Diagonal Lines. + * Flowchart: Process * @remarks * [Api set: PowerPointApi 1.4] */ - chartX = "ChartX", + flowChartProcess = "FlowChartProcess", /** - * A Rectangle Divided into Six Parts Along a Vertical Line and Diagonal Lines. + * Flowchart: Decision * @remarks * [Api set: PowerPointApi 1.4] */ - chartStar = "ChartStar", + flowChartDecision = "FlowChartDecision", /** - * A Rectangle Divided Vertically and Horizontally into Four Quarters. + * Flowchart: Data * @remarks * [Api set: PowerPointApi 1.4] */ - chartPlus = "ChartPlus", - } - /** - * Represents the available options when adding shapes. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ - interface ShapeAddOptions { + flowChartInputOutput = "FlowChartInputOutput", /** - * Specifies the height, in points, of the shape. - When not provided, a default value will be used. - Throws an `InvalidArgument` exception when set with a negative value. - * + * Flowchart: Predefined Process * @remarks * [Api set: PowerPointApi 1.4] */ - height?: number; + flowChartPredefinedProcess = "FlowChartPredefinedProcess", /** - * Specifies the distance, in points, from the left side of the shape to the left side of the slide. - When not provided, a default value will be used. - * + * Flowchart: Internal Storage * @remarks * [Api set: PowerPointApi 1.4] */ - left?: number; + flowChartInternalStorage = "FlowChartInternalStorage", /** - * Specifies the distance, in points, from the top edge of the shape to the top edge of the slide. - When not provided, a default value will be used. - * + * Flowchart: Document * @remarks * [Api set: PowerPointApi 1.4] */ - top?: number; + flowChartDocument = "FlowChartDocument", /** - * Specifies the width, in points, of the shape. - When not provided, a default value will be used. - Throws an `InvalidArgument` exception when set with a negative value. - * + * Flowchart: Multidocument * @remarks * [Api set: PowerPointApi 1.4] */ - width?: number; - } - /** - * Specifies the dash style for a line. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ - enum ShapeLineDashStyle { + flowChartMultidocument = "FlowChartMultidocument", /** - * The dash line pattern. + * Flowchart: Terminator * @remarks * [Api set: PowerPointApi 1.4] */ - dash = "Dash", + flowChartTerminator = "FlowChartTerminator", /** - * The dash-dot line pattern. + * Flowchart: Preparation * @remarks * [Api set: PowerPointApi 1.4] */ - dashDot = "DashDot", + flowChartPreparation = "FlowChartPreparation", /** - * The dash-dot-dot line pattern. + * Flowchart: Manual Input * @remarks * [Api set: PowerPointApi 1.4] */ - dashDotDot = "DashDotDot", + flowChartManualInput = "FlowChartManualInput", /** - * The long dash line pattern. + * Flowchart: Manual Operation * @remarks * [Api set: PowerPointApi 1.4] */ - longDash = "LongDash", + flowChartManualOperation = "FlowChartManualOperation", /** - * The long dash-dot line pattern. + * Flowchart: Connector * @remarks * [Api set: PowerPointApi 1.4] */ - longDashDot = "LongDashDot", + flowChartConnector = "FlowChartConnector", /** - * The round dot line pattern. + * Flowchart: Card * @remarks * [Api set: PowerPointApi 1.4] */ - roundDot = "RoundDot", + flowChartPunchedCard = "FlowChartPunchedCard", /** - * The solid line pattern. + * Flowchart: Punched Tape * @remarks * [Api set: PowerPointApi 1.4] */ - solid = "Solid", + flowChartPunchedTape = "FlowChartPunchedTape", /** - * The square dot line pattern. + * Flowchart: Summing Junction * @remarks * [Api set: PowerPointApi 1.4] */ - squareDot = "SquareDot", + flowChartSummingJunction = "FlowChartSummingJunction", /** - * The long dash-dot-dot line pattern. + * Flowchart: Or * @remarks * [Api set: PowerPointApi 1.4] */ - longDashDotDot = "LongDashDotDot", + flowChartOr = "FlowChartOr", /** - * The system dash line pattern. + * Flowchart: Collate * @remarks * [Api set: PowerPointApi 1.4] */ - systemDash = "SystemDash", + flowChartCollate = "FlowChartCollate", /** - * The system dot line pattern. + * Flowchart: Sort * @remarks * [Api set: PowerPointApi 1.4] */ - systemDot = "SystemDot", + flowChartSort = "FlowChartSort", /** - * The system dash-dot line pattern. + * Flowchart: Extract * @remarks * [Api set: PowerPointApi 1.4] */ - systemDashDot = "SystemDashDot", - } - /** - * Represents the properties for a table cell border. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ - class Border extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + flowChartExtract = "FlowChartExtract", /** - * Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange"). - * + * Flowchart: Merge * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - color: string | undefined; + flowChartMerge = "FlowChartMerge", /** - * Represents the dash style of the line. - * + * FlowChart: Offline Storage * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined; + flowChartOfflineStorage = "FlowChartOfflineStorage", /** - * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). - * + * Flowchart: Stored Data * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - transparency: number | undefined; + flowChartOnlineStorage = "FlowChartOnlineStorage", /** - * Represents the weight of the line, in points. - * + * Flowchart: Sequential Access Storage * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - weight: number | undefined; + flowChartMagneticTape = "FlowChartMagneticTape", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Flowchart: Magnetic Disk + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(options?: PowerPoint.Interfaces.BorderLoadOptions): PowerPoint.Border; + flowChartMagneticDisk = "FlowChartMagneticDisk", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Flowchart: Direct Access Storage + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(propertyNames?: string | string[]): PowerPoint.Border; + flowChartMagneticDrum = "FlowChartMagneticDrum", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Flowchart: Display + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.Border; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Border` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BorderData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): PowerPoint.Interfaces.BorderData; - } - /** - * Represents the borders for a table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ - class Borders extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + flowChartDisplay = "FlowChartDisplay", /** - * Gets the bottom border. - * + * Flowchart: Delay * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - readonly bottom: PowerPoint.Border; + flowChartDelay = "FlowChartDelay", /** - * Gets the diagonal border (top-left to bottom-right). - * + * Flowchart: Alternate Process * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - readonly diagonalDown: PowerPoint.Border; + flowChartAlternateProcess = "FlowChartAlternateProcess", /** - * Gets the diagonal border (bottom-left to top-right). - * + * Flowchart: Off-page Connector * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - readonly diagonalUp: PowerPoint.Border; + flowChartOffpageConnector = "FlowChartOffpageConnector", /** - * Gets the left border. - * + * Action Button: Blank * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - readonly left: PowerPoint.Border; + actionButtonBlank = "ActionButtonBlank", /** - * Gets the right border. - * + * Action Button: Go Home * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - readonly right: PowerPoint.Border; + actionButtonHome = "ActionButtonHome", /** - * Gets the top border. - * + * Action Button: Help * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - readonly top: PowerPoint.Border; + actionButtonHelp = "ActionButtonHelp", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Action Button: Get Information + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(options?: PowerPoint.Interfaces.BordersLoadOptions): PowerPoint.Borders; + actionButtonInformation = "ActionButtonInformation", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Action Button: Go Forward or Next + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(propertyNames?: string | string[]): PowerPoint.Borders; + actionButtonForwardNext = "ActionButtonForwardNext", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Action Button: Go Back or Previous + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.Borders; + actionButtonBackPrevious = "ActionButtonBackPrevious", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object. + * Action Button: Go to End + * @remarks + * [Api set: PowerPointApi 1.4] */ - toJSON(): PowerPoint.Interfaces.BordersData; - } - /** - * Represents the margins of a table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ - class Margins extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + actionButtonEnd = "ActionButtonEnd", /** - * Specifies the bottom margin in points. - * + * Action Button: Go to Beginning * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - bottom: number | undefined; + actionButtonBeginning = "ActionButtonBeginning", /** - * Specifies the left margin in points. - * + * Action Button: Return * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - left: number | undefined; + actionButtonReturn = "ActionButtonReturn", /** - * Specifies the right margin in points. - * + * Action Button: Document * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - right: number | undefined; + actionButtonDocument = "ActionButtonDocument", /** - * Specifies the top margin in points. - * + * Action Button: Sound * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - top: number | undefined; + actionButtonSound = "ActionButtonSound", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Action Button: Video + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(options?: PowerPoint.Interfaces.MarginsLoadOptions): PowerPoint.Margins; + actionButtonMovie = "ActionButtonMovie", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Gear: A Gear with Six Teeth + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(propertyNames?: string | string[]): PowerPoint.Margins; + gear6 = "Gear6", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Gear: A Gear with Nine Teeth + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.Margins; + gear9 = "Gear9", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object. + * Funnel + * @remarks + * [Api set: PowerPointApi 1.4] */ - toJSON(): PowerPoint.Interfaces.MarginsData; - } - /** - * Specifies a shape's fill type. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ - enum ShapeFillType { + funnel = "Funnel", /** - * Specifies that the shape should have no fill. + * Plus Sign * @remarks * [Api set: PowerPointApi 1.4] */ - noFill = "NoFill", + mathPlus = "MathPlus", /** - * Specifies that the shape should have regular solid fill. + * Minus Sign * @remarks * [Api set: PowerPointApi 1.4] */ - solid = "Solid", + mathMinus = "MathMinus", /** - * Specifies that the shape should have gradient fill. + * Multiplication Sign * @remarks * [Api set: PowerPointApi 1.4] */ - gradient = "Gradient", + mathMultiply = "MathMultiply", /** - * Specifies that the shape should have pattern fill. + * Division Sign * @remarks * [Api set: PowerPointApi 1.4] */ - pattern = "Pattern", + mathDivide = "MathDivide", /** - * Specifies that the shape should have picture or texture fill. + * Equals * @remarks * [Api set: PowerPointApi 1.4] */ - pictureAndTexture = "PictureAndTexture", + mathEqual = "MathEqual", /** - * Specifies that the shape should have slide background fill. + * Not Equal * @remarks * [Api set: PowerPointApi 1.4] */ - slideBackground = "SlideBackground", - } - /** - * Represents the fill formatting of a shape object. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ - class ShapeFill extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + mathNotEqual = "MathNotEqual", /** - * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). - * + * Four Right Triangles that Define a Rectangular Shape * @remarks * [Api set: PowerPointApi 1.4] */ - foregroundColor: string; + cornerTabs = "CornerTabs", /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type doesn't support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. - * + * Four Small Squares that Define a Rectangular Shape. * @remarks * [Api set: PowerPointApi 1.4] */ - transparency: number; + squareTabs = "SquareTabs", /** - * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details. - * + * Four Quarter Circles that Define a Rectangular Shape. * @remarks * [Api set: PowerPointApi 1.4] */ - readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground"; + plaqueTabs = "PlaqueTabs", /** - * Clears the fill formatting of this shape. - * + * A Rectangle Divided into Four Parts Along Diagonal Lines. * @remarks * [Api set: PowerPointApi 1.4] */ - clear(): void; + chartX = "ChartX", /** - * Sets the fill formatting of the shape to an image. This changes the fill type to `PictureAndTexture`. - * + * A Rectangle Divided into Six Parts Along a Vertical Line and Diagonal Lines. * @remarks - * [Api set: PowerPointApi 1.8] - * - * @param base64EncodedImage A string that is a Base64 encoding of the image data. + * [Api set: PowerPointApi 1.4] */ - setImage(base64EncodedImage: string): void; + chartStar = "ChartStar", /** - * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`. - * + * A Rectangle Divided Vertically and Horizontally into Four Quarters. * @remarks * [Api set: PowerPointApi 1.4] - * - * @param color A string that specifies the fill color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). */ - setSolidColor(color: string): void; + chartPlus = "ChartPlus", + } + /** + * Represents the available options when adding shapes. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + interface ShapeAddOptions { /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the height, in points, of the shape. + When not provided, a default value will be used. + Throws an `InvalidArgument` exception when set with a negative value. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill; + height?: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the distance, in points, from the left side of the shape to the left side of the slide. + When not provided, a default value will be used. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(propertyNames?: string | string[]): PowerPoint.ShapeFill; + left?: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the distance, in points, from the top edge of the shape to the top edge of the slide. + When not provided, a default value will be used. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.ShapeFill; + top?: number; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): PowerPoint.Interfaces.ShapeFillData; + * Specifies the width, in points, of the shape. + When not provided, a default value will be used. + Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + width?: number; } /** - * Represents the font attributes, such as font name, size, and color. + * Specifies the dash style for a line. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - interface FontProperties { + enum ShapeLineDashStyle { /** - * Represents whether the font uses all caps, where lowercase letters are shown as capital letters. - * + * The dash line pattern. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - allCaps?: boolean | undefined; + dash = "Dash", /** - * Represents the bold status of font. - * + * The dash-dot line pattern. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - bold?: boolean | undefined; + dashDot = "DashDot", /** - * Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red"). - * + * The dash-dot-dot line pattern. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - color?: string | undefined; + dashDotDot = "DashDotDot", /** - * Represents the double-strikethrough status of the font. - * + * The long dash line pattern. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - doubleStrikethrough?: boolean | undefined; + longDash = "LongDash", /** - * Represents the italic status of font. - * + * The long dash-dot line pattern. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - italic?: boolean | undefined; + longDashDot = "LongDashDot", /** - * Represents the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name. - * + * The round dot line pattern. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - name?: string | undefined; + roundDot = "RoundDot", /** - * Represents the font size in points (e.g., 11). - * + * The solid line pattern. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - size?: number | undefined; - /** - * Represents whether the text uses small caps, where lowercase letters are shown as small capital letters. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ - smallCaps?: boolean | undefined; - /** - * Represents the strikethrough status of the font. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ - strikethrough?: boolean | undefined; + solid = "Solid", /** - * Represents the subscript status of the font. - * + * The square dot line pattern. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - subscript?: boolean | undefined; + squareDot = "SquareDot", /** - * Represents the superscript status of the font. - * + * The long dash-dot-dot line pattern. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - superscript?: boolean | undefined; + longDashDotDot = "LongDashDotDot", /** - * Type of underline applied to the font. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. - * + * The system dash line pattern. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | undefined; - } - /** - * Represents a sequence of one or more characters with the same font attributes. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ - interface TextRun { + systemDash = "SystemDash", /** - * The font attributes (such as font name, font size, and color) applied to this text run. - * + * The system dot line pattern. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - font?: PowerPoint.FontProperties; + systemDot = "SystemDot", /** - * The text of this text run. - * + * The system dash-dot line pattern. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.4] */ - text: string; + systemDashDot = "SystemDashDot", } /** - * Represents a table. + * Represents the properties for a table cell border. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.9] */ - class TableCell extends OfficeExtension.ClientObject { + class Border extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the collection of borders for the table cell. + * Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange"). * * @remarks * [Api set: PowerPointApi 1.9] */ - readonly borders: PowerPoint.Borders; + color: string | undefined; /** - * Gets the fill color of the table cell. + * Represents the dash style of the line. * * @remarks * [Api set: PowerPointApi 1.9] */ - readonly fill: PowerPoint.ShapeFill; + dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined; /** - * Gets the font of the table cell. + * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks * [Api set: PowerPointApi 1.9] */ - readonly font: PowerPoint.ShapeFont; + transparency: number | undefined; /** - * Gets the set of margins in the table cell. + * Represents the weight of the line, in points. * * @remarks * [Api set: PowerPointApi 1.9] */ - readonly margins: PowerPoint.Margins; - /** - * Gets the number of table columns this cell spans across. - Will be greater than or equal to 1. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ - readonly columnCount: number; + weight: number | undefined; /** - * Gets the zero-based column index of the cell within the table. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.8] + * @param options Provides options for which properties of the object to load. */ - readonly columnIndex: number; + load(options?: PowerPoint.Interfaces.BorderLoadOptions): PowerPoint.Border; /** - * Specifies the horizontal alignment of the text in the table cell. Returns `null` if the cell text contains different alignments. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.9] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null; + load(propertyNames?: string | string[]): PowerPoint.Border; /** - * Specifies the indent level of the text in the table cell. Returns `null` if the cell text contains different indent levels. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.9] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - indentLevel: number | null; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.Border; /** - * Gets the number of table rows this cell spans across. - Will be greater than or equal to 1. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ - readonly rowCount: number; + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Border` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BorderData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.BorderData; + } + /** + * Represents the borders for a table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + class Borders extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Gets the zero-based row index of the cell within the table. + * Gets the bottom border. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.9] */ - readonly rowIndex: number; + readonly bottom: PowerPoint.Border; /** - * Specifies the text content of the table cell. + * Gets the diagonal border (top-left to bottom-right). * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.9] */ - text: string; + readonly diagonalDown: PowerPoint.Border; /** - * Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects. - Each `TextRun` object represents a sequence of one or more characters that share the same font attributes. + * Gets the diagonal border (bottom-left to top-right). * * @remarks * [Api set: PowerPointApi 1.9] */ - textRuns: PowerPoint.TextRun[]; + readonly diagonalUp: PowerPoint.Border; /** - * Specifies the vertical alignment of the text in the table cell. + * Gets the left border. * * @remarks * [Api set: PowerPointApi 1.9] */ - verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered"; + readonly left: PowerPoint.Border; /** - * Resizes the table cell to span across a specified number of rows and columns. - If rowCount or columnCount are greater than 1, the cell will become a merged area. If the cell - is already a merged area and rowCount and columnCount are set to 1, the cell will no longer be - a merged area. + * Gets the right border. * * @remarks * [Api set: PowerPointApi 1.9] - * - * @param rowCount The number of rows the cell will span across. Must be greater than 0. - * @param columnCount The number of columns the cell will span across. Must be greater than 0. */ - resize(rowCount: number, columnCount: number): void; + readonly right: PowerPoint.Border; /** - * Splits the cell into the specified number of rows and columns. + * Gets the top border. * * @remarks * [Api set: PowerPointApi 1.9] - * - * @param rowCount The number of rows to split into. Must be greater than 0. - * @param columnCount The number of columns to split into. Must be greater than 0. */ - split(rowCount: number, columnCount: number): void; + readonly top: PowerPoint.Border; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: PowerPoint.Interfaces.TableCellLoadOptions): PowerPoint.TableCell; + load(options?: PowerPoint.Interfaces.BordersLoadOptions): PowerPoint.Borders; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): PowerPoint.TableCell; + load(propertyNames?: string | string[]): PowerPoint.Borders; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -181237,1591 +181346,2933 @@ declare namespace PowerPoint { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): PowerPoint.TableCell; + }): PowerPoint.Borders; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): PowerPoint.Interfaces.TableCellData; + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.BordersData; } /** - * Represents a collection of table cells. + * Represents the margins of a table cell. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.9] */ - class TableCellCollection extends OfficeExtension.ClientObject { + class Margins extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: PowerPoint.TableCell[]; /** - * Gets the number of table cells in the collection. + * Specifies the bottom margin in points. * * @remarks - * [Api set: PowerPointApi 1.8] - * @returns The number of table cells in the collection. + * [Api set: PowerPointApi 1.9] */ - getCount(): OfficeExtension.ClientResult; + bottom: number | undefined; /** - * Gets the table cell using its zero-based index in the collection. If the `TableCell` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Specifies the left margin in points. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.9] + */ + left: number | undefined; + /** + * Specifies the right margin in points. * - * @param row Row index value of the table cell to be retrieved, as a zero-based index. - * @param column Column index value of the table cell to be retrieved, as a zero-based index. - * @returns The `TableCell` object. + * @remarks + * [Api set: PowerPointApi 1.9] */ - getItemAtOrNullObject(row: number, column: number): PowerPoint.TableCell; + right: number | undefined; + /** + * Specifies the top margin in points. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + top: number | undefined; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: PowerPoint.Interfaces.TableCellCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableCellCollection; + load(options?: PowerPoint.Interfaces.MarginsLoadOptions): PowerPoint.Margins; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): PowerPoint.TableCellCollection; + load(propertyNames?: string | string[]): PowerPoint.Margins; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableCellCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.Margins; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): PowerPoint.Interfaces.TableCellCollectionData; + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.MarginsData; } /** - * Represents a column in a table. + * Specifies a shape's fill type. * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - class TableColumn extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + enum ShapeFillType { /** - * Returns the index number of the column within the column collection of the table. Zero-indexed. - * + * Specifies that the shape should have no fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - readonly columnIndex: number; + noFill = "NoFill", /** - * Retrieves the width of the column in points. If the set column width is less than the minimum width, the column width will be increased to the minimum width. - * + * Specifies that the shape should have regular solid fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - width: number; + solid = "Solid", /** - * Deletes the column. - * + * Specifies that the shape should have gradient fill. * @remarks - * [Api set: PowerPointApi 1.9] - */ - delete(): void; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * [Api set: PowerPointApi 1.4] */ - load(options?: PowerPoint.Interfaces.TableColumnLoadOptions): PowerPoint.TableColumn; + gradient = "Gradient", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Specifies that the shape should have pattern fill. + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(propertyNames?: string | string[]): PowerPoint.TableColumn; + pattern = "Pattern", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Specifies that the shape should have picture or texture fill. + * @remarks + * [Api set: PowerPointApi 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.TableColumn; + pictureAndTexture = "PictureAndTexture", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies that the shape should have slide background fill. + * @remarks + * [Api set: PowerPointApi 1.4] */ - toJSON(): PowerPoint.Interfaces.TableColumnData; + slideBackground = "SlideBackground", } /** - * Represents a collection of table columns. + * Represents the fill formatting of a shape object. * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] */ - class TableColumnCollection extends OfficeExtension.ClientObject { + class ShapeFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: PowerPoint.TableColumn[]; /** - * Adds one or more columns to the table. + * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] + */ + foregroundColor: string; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type doesn't support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. * - * @param index Optional. Specifies the zero-based index where the new columns are added. Existing columns starting at the index location are shifted right. If the index value is undefined, null, -1, or greater than the number of columns in the table, the new columns are added at the end of the table. - * @param count Optional. The number of columns to add. If the value is undefined or 0, only one column is added. + * @remarks + * [Api set: PowerPointApi 1.4] */ - // eslint-disable-next-line @definitelytyped/redundant-undefined - add(index?: number | null | undefined, count?: number | undefined): void; + transparency: number; /** - * Deletes the specified columns from the collection. + * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details. * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] + */ + readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground"; + /** + * Clears the fill formatting of this shape. * - * @param columns An array of `TableColumn` objects representing the columns to be deleted. + * @remarks + * [Api set: PowerPointApi 1.4] */ - deleteColumns(columns: PowerPoint.TableColumn[]): void; + clear(): void; /** - * Gets the number of columns in the collection. + * Sets the fill formatting of the shape to an image. This changes the fill type to `PictureAndTexture`. * * @remarks - * [Api set: PowerPointApi 1.9] - * @returns The number of columns in the collection. + * [Api set: PowerPointApi 1.8] + * + * @param base64EncodedImage A string that is a Base64 encoding of the image data. */ - getCount(): OfficeExtension.ClientResult; + setImage(base64EncodedImage: string): void; /** - * Gets the column using its zero-based index in the collection. + * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`. * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.4] * - * @param index Index value of the column to be retrieved, as a zero-based index. - * @returns The column object. + * @param color A string that specifies the fill color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange"). */ - getItemAt(index: number): PowerPoint.TableColumn; + setSolidColor(color: string): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: PowerPoint.Interfaces.TableColumnCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableColumnCollection; + load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): PowerPoint.TableColumnCollection; + load(propertyNames?: string | string[]): PowerPoint.ShapeFill; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableColumnCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.ShapeFill; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): PowerPoint.Interfaces.TableColumnCollectionData; + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.ShapeFillData; } /** - * Represents the available options when clearing a table. + * Represents the font attributes, such as font name, size, and color. * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] */ - interface TableClearOptions { + interface FontProperties { /** - * Specifies if both values and formatting of the table should be cleared. + * Represents whether the font uses all caps, where lowercase letters are shown as capital letters. * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] */ - all?: boolean; + allCaps?: boolean | undefined; /** - * Specifies if the formatting of the table should be cleared. + * Represents the bold status of font. * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] */ - format?: boolean; + bold?: boolean | undefined; /** - * Specifies if the values of the table should be cleared. + * Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red"). * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] */ - text?: boolean; - } - /** - * Represents a row in a table. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ - class TableRow extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + color?: string | undefined; /** - * Retrieves the current height of the row in points. + * Represents the double-strikethrough status of the font. * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] */ - readonly currentHeight: number; + doubleStrikethrough?: boolean | undefined; /** - * Specifies the height of the row in points. If the set row height is less than the minimum height, the row height will be increased to the minimum height. + * Represents the italic status of font. * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] */ - height: number; + italic?: boolean | undefined; /** - * Returns the index number of the row within the rows collection of the table. Zero-indexed. + * Represents the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name. * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] */ - readonly rowIndex: number; + name?: string | undefined; /** - * Deletes the row. + * Represents the font size in points (e.g., 11). * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] */ - delete(): void; + size?: number | undefined; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Represents whether the text uses small caps, where lowercase letters are shown as small capital letters. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: PowerPointApi 1.8] */ - load(options?: PowerPoint.Interfaces.TableRowLoadOptions): PowerPoint.TableRow; + smallCaps?: boolean | undefined; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Represents the strikethrough status of the font. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: PowerPointApi 1.8] */ - load(propertyNames?: string | string[]): PowerPoint.TableRow; + strikethrough?: boolean | undefined; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Represents the subscript status of the font. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: PowerPointApi 1.8] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.TableRow; + subscript?: boolean | undefined; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. + * Represents the superscript status of the font. + * + * @remarks + * [Api set: PowerPointApi 1.8] */ - toJSON(): PowerPoint.Interfaces.TableRowData; + superscript?: boolean | undefined; + /** + * Type of underline applied to the font. See {@link PowerPoint.ShapeFontUnderlineStyle} for details. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | undefined; } /** - * Represents a collection of table rows. + * Represents a sequence of one or more characters with the same font attributes. * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] */ - class TableRowCollection extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: PowerPoint.TableRow[]; + interface TextRun { /** - * Adds one or more rows to the table. + * The font attributes (such as font name, font size, and color) applied to this text run. * * @remarks - * [Api set: PowerPointApi 1.9] - * - * @param index Optional. Specifies the zero-based index where the new rows are added. Existing rows starting at the index location are shifted down. If the index value is undefined, null, -1, or greater than the number of rows in the table, the new rows are added at the end of the table. - * @param count Optional. The number of rows to add. If the value is undefined or 0, only one row is added. + * [Api set: PowerPointApi 1.8] */ - // eslint-disable-next-line @definitelytyped/redundant-undefined - add(index?: number | null | undefined, count?: number | undefined): void; + font?: PowerPoint.FontProperties; /** - * Deletes the specified rows from the collection. + * The text of this text run. * * @remarks - * [Api set: PowerPointApi 1.9] - * - * @param rows An array of `TableRow` objects representing the rows to be deleted. + * [Api set: PowerPointApi 1.8] */ - deleteRows(rows: PowerPoint.TableRow[]): void; + text: string; + } + /** + * Represents a table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + class TableCell extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Gets the number of rows in the collection. + * Gets the collection of borders for the table cell. * * @remarks * [Api set: PowerPointApi 1.9] - * @returns The number of rows in the collection. */ - getCount(): OfficeExtension.ClientResult; + readonly borders: PowerPoint.Borders; /** - * Gets the row using its zero-based index in the collection. + * Gets the fill color of the table cell. * * @remarks * [Api set: PowerPointApi 1.9] - * - * @param index Index value of the row to be retrieved, as a zero-based index. - * @returns The row object. */ - getItemAt(index: number): PowerPoint.TableRow; + readonly fill: PowerPoint.ShapeFill; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. - */ - load(options?: PowerPoint.Interfaces.TableRowCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableRowCollection; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): PowerPoint.TableRowCollection; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the font of the table cell. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. - */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableRowCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): PowerPoint.Interfaces.TableRowCollectionData; - } - /** - * Represents the available built-in table styles. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ - enum TableStyle { - /** - * Specifies the style "No style, No grid" in UI. * @remarks * [Api set: PowerPointApi 1.9] */ - noStyleNoGrid = "NoStyleNoGrid", + readonly font: PowerPoint.ShapeFont; /** - * Specifies the style "Themed style 1 - Accent 1" in UI. + * Gets the set of margins in the table cell. + * * @remarks * [Api set: PowerPointApi 1.9] */ - themedStyle1Accent1 = "ThemedStyle1Accent1", + readonly margins: PowerPoint.Margins; /** - * Specifies the style "Themed style 1 - Accent 2" in UI. + * Gets the number of table columns this cell spans across. + Will be greater than or equal to 1. + * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] */ - themedStyle1Accent2 = "ThemedStyle1Accent2", + readonly columnCount: number; /** - * Specifies the style "Themed style 1 - Accent 3" in UI. + * Gets the zero-based column index of the cell within the table. + * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] */ - themedStyle1Accent3 = "ThemedStyle1Accent3", + readonly columnIndex: number; /** - * Specifies the style "Themed style 1 - Accent 4" in UI. + * Specifies the horizontal alignment of the text in the table cell. Returns `null` if the cell text contains different alignments. + * * @remarks * [Api set: PowerPointApi 1.9] */ - themedStyle1Accent4 = "ThemedStyle1Accent4", + horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null; /** - * Specifies the style "Themed style 1 - Accent 5" in UI. + * Specifies the indent level of the text in the table cell. Returns `null` if the cell text contains different indent levels. + * * @remarks * [Api set: PowerPointApi 1.9] */ - themedStyle1Accent5 = "ThemedStyle1Accent5", + indentLevel: number | null; /** - * Specifies the style "Themed style 1 - Accent 6" in UI. + * Gets the number of table rows this cell spans across. + Will be greater than or equal to 1. + * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] */ - themedStyle1Accent6 = "ThemedStyle1Accent6", + readonly rowCount: number; /** - * Specifies the style "No style, Table grid" in UI. + * Gets the zero-based row index of the cell within the table. + * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] */ - noStyleTableGrid = "NoStyleTableGrid", + readonly rowIndex: number; /** - * Specifies the style "Themed style 2 - Accent 1" in UI. + * Specifies the text content of the table cell. + * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] */ - themedStyle2Accent1 = "ThemedStyle2Accent1", + text: string; /** - * Specifies the style "Themed style 2 - Accent 2" in UI. + * Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects. + Each `TextRun` object represents a sequence of one or more characters that share the same font attributes. + * * @remarks * [Api set: PowerPointApi 1.9] */ - themedStyle2Accent2 = "ThemedStyle2Accent2", + textRuns: PowerPoint.TextRun[]; /** - * Specifies the style "Themed style 2 - Accent 3" in UI. + * Specifies the vertical alignment of the text in the table cell. + * * @remarks * [Api set: PowerPointApi 1.9] */ - themedStyle2Accent3 = "ThemedStyle2Accent3", + verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered"; /** - * Specifies the style "Themed style 2 - Accent 4" in UI. + * Resizes the table cell to span across a specified number of rows and columns. + If rowCount or columnCount are greater than 1, the cell will become a merged area. If the cell + is already a merged area and rowCount and columnCount are set to 1, the cell will no longer be + a merged area. + * * @remarks * [Api set: PowerPointApi 1.9] + * + * @param rowCount The number of rows the cell will span across. Must be greater than 0. + * @param columnCount The number of columns the cell will span across. Must be greater than 0. */ - themedStyle2Accent4 = "ThemedStyle2Accent4", + resize(rowCount: number, columnCount: number): void; /** - * Specifies the style "Themed style 2 - Accent 5" in UI. + * Splits the cell into the specified number of rows and columns. + * * @remarks * [Api set: PowerPointApi 1.9] + * + * @param rowCount The number of rows to split into. Must be greater than 0. + * @param columnCount The number of columns to split into. Must be greater than 0. */ - themedStyle2Accent5 = "ThemedStyle2Accent5", + split(rowCount: number, columnCount: number): void; /** - * Specifies the style "Themed style 2 - Accent 6" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - themedStyle2Accent6 = "ThemedStyle2Accent6", + load(options?: PowerPoint.Interfaces.TableCellLoadOptions): PowerPoint.TableCell; /** - * Specifies the style "Light Style 1" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - lightStyle1 = "LightStyle1", + load(propertyNames?: string | string[]): PowerPoint.TableCell; /** - * Specifies the style "Light style 1 - Accent 1" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - lightStyle1Accent1 = "LightStyle1Accent1", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.TableCell; /** - * Specifies the style "Light style 1 - Accent 2" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] - */ - lightStyle1Accent2 = "LightStyle1Accent2", + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.TableCellData; + } + /** + * Represents a collection of table cells. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + class TableCellCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.TableCell[]; /** - * Specifies the style "Light style 1 - Accent 3" in UI. + * Gets the number of table cells in the collection. + * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] + * @returns The number of table cells in the collection. */ - lightStyle1Accent3 = "LightStyle1Accent3", + getCount(): OfficeExtension.ClientResult; /** - * Specifies the style "Light style 1 - Accent 4" in UI. + * Gets the table cell using its zero-based index in the collection. If the `TableCell` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.8] + * + * @param row Row index value of the table cell to be retrieved, as a zero-based index. + * @param column Column index value of the table cell to be retrieved, as a zero-based index. + * @returns The `TableCell` object. */ - lightStyle1Accent4 = "LightStyle1Accent4", + getItemAtOrNullObject(row: number, column: number): PowerPoint.TableCell; /** - * Specifies the style "Light style 1 - Accent 5" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - lightStyle1Accent5 = "LightStyle1Accent5", + load(options?: PowerPoint.Interfaces.TableCellCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableCellCollection; /** - * Specifies the style "Light style 1 - Accent 6" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - lightStyle1Accent6 = "LightStyle1Accent6", + load(propertyNames?: string | string[]): PowerPoint.TableCellCollection; /** - * Specifies the style "Light Style 2" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - lightStyle2 = "LightStyle2", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableCellCollection; /** - * Specifies the style "Light style 2 - Accent 1" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] - */ - lightStyle2Accent1 = "LightStyle2Accent1", + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.TableCellCollectionData; + } + /** + * Represents a column in a table. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + class TableColumn extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Specifies the style "Light style 2 - Accent 2" in UI. + * Returns the index number of the column within the column collection of the table. Zero-indexed. + * * @remarks * [Api set: PowerPointApi 1.9] */ - lightStyle2Accent2 = "LightStyle2Accent2", + readonly columnIndex: number; /** - * Specifies the style "Light style 2 - Accent 3" in UI. + * Retrieves the width of the column in points. If the set column width is less than the minimum width, the column width will be increased to the minimum width. + * * @remarks * [Api set: PowerPointApi 1.9] */ - lightStyle2Accent3 = "LightStyle2Accent3", + width: number; /** - * Specifies the style "Light style 2 - Accent 4" in UI. + * Deletes the column. + * * @remarks * [Api set: PowerPointApi 1.9] */ - lightStyle2Accent4 = "LightStyle2Accent4", + delete(): void; /** - * Specifies the style "Light style 2 - Accent 5" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - lightStyle2Accent5 = "LightStyle2Accent5", + load(options?: PowerPoint.Interfaces.TableColumnLoadOptions): PowerPoint.TableColumn; /** - * Specifies the style "Light style 2 - Accent 6" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - lightStyle2Accent6 = "LightStyle2Accent6", + load(propertyNames?: string | string[]): PowerPoint.TableColumn; /** - * Specifies the style "Light Style 3" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - lightStyle3 = "LightStyle3", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.TableColumn; /** - * Specifies the style "Light style 3 - Accent 1" in UI. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.TableColumnData; + } + /** + * Represents a collection of table columns. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + class TableColumnCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.TableColumn[]; + /** + * Adds one or more columns to the table. + * * @remarks * [Api set: PowerPointApi 1.9] + * + * @param index Optional. Specifies the zero-based index where the new columns are added. Existing columns starting at the index location are shifted right. If the index value is undefined, null, -1, or greater than the number of columns in the table, the new columns are added at the end of the table. + * @param count Optional. The number of columns to add. If the value is undefined or 0, only one column is added. */ - lightStyle3Accent1 = "LightStyle3Accent1", + // eslint-disable-next-line @definitelytyped/redundant-undefined + add(index?: number | null | undefined, count?: number | undefined): void; /** - * Specifies the style "Light style 3 - Accent 2" in UI. + * Deletes the specified columns from the collection. + * * @remarks * [Api set: PowerPointApi 1.9] + * + * @param columns An array of `TableColumn` objects representing the columns to be deleted. */ - lightStyle3Accent2 = "LightStyle3Accent2", + deleteColumns(columns: PowerPoint.TableColumn[]): void; /** - * Specifies the style "Light style 3 - Accent 3" in UI. + * Gets the number of columns in the collection. + * * @remarks * [Api set: PowerPointApi 1.9] + * @returns The number of columns in the collection. */ - lightStyle3Accent3 = "LightStyle3Accent3", + getCount(): OfficeExtension.ClientResult; /** - * Specifies the style "Light style 3 - Accent 4" in UI. + * Gets the column using its zero-based index in the collection. + * * @remarks * [Api set: PowerPointApi 1.9] + * + * @param index Index value of the column to be retrieved, as a zero-based index. + * @returns The column object. */ - lightStyle3Accent4 = "LightStyle3Accent4", + getItemAt(index: number): PowerPoint.TableColumn; /** - * Specifies the style "Light style 3 - Accent 5" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - lightStyle3Accent5 = "LightStyle3Accent5", + load(options?: PowerPoint.Interfaces.TableColumnCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableColumnCollection; /** - * Specifies the style "Light style 3 - Accent 6" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - lightStyle3Accent6 = "LightStyle3Accent6", + load(propertyNames?: string | string[]): PowerPoint.TableColumnCollection; /** - * Specifies the style "Medium Style 1" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - mediumStyle1 = "MediumStyle1", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableColumnCollection; /** - * Specifies the style "Medium style 1 - Accent 1" in UI. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.TableColumnCollectionData; + } + /** + * Represents the available options when clearing a table. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + interface TableClearOptions { + /** + * Specifies if both values and formatting of the table should be cleared. + * * @remarks * [Api set: PowerPointApi 1.9] */ - mediumStyle1Accent1 = "MediumStyle1Accent1", + all?: boolean; /** - * Specifies the style "Medium style 1 - Accent 2" in UI. + * Specifies if the formatting of the table should be cleared. + * * @remarks * [Api set: PowerPointApi 1.9] */ - mediumStyle1Accent2 = "MediumStyle1Accent2", + format?: boolean; /** - * Specifies the style "Medium style 1 - Accent 3" in UI. + * Specifies if the values of the table should be cleared. + * * @remarks * [Api set: PowerPointApi 1.9] */ - mediumStyle1Accent3 = "MediumStyle1Accent3", + text?: boolean; + } + /** + * Represents a row in a table. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + class TableRow extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Specifies the style "Medium style 1 - Accent 4" in UI. + * Retrieves the current height of the row in points. + * * @remarks * [Api set: PowerPointApi 1.9] */ - mediumStyle1Accent4 = "MediumStyle1Accent4", + readonly currentHeight: number; /** - * Specifies the style "Medium style 1 - Accent 5" in UI. + * Specifies the height of the row in points. If the set row height is less than the minimum height, the row height will be increased to the minimum height. + * * @remarks * [Api set: PowerPointApi 1.9] */ - mediumStyle1Accent5 = "MediumStyle1Accent5", + height: number; /** - * Specifies the style "Medium style 1 - Accent 6" in UI. + * Returns the index number of the row within the rows collection of the table. Zero-indexed. + * * @remarks * [Api set: PowerPointApi 1.9] */ - mediumStyle1Accent6 = "MediumStyle1Accent6", + readonly rowIndex: number; /** - * Specifies the style "Medium Style 2" in UI. + * Deletes the row. + * * @remarks * [Api set: PowerPointApi 1.9] */ - mediumStyle2 = "MediumStyle2", + delete(): void; /** - * Specifies the style "Medium style 2 - Accent 1" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - mediumStyle2Accent1 = "MediumStyle2Accent1", + load(options?: PowerPoint.Interfaces.TableRowLoadOptions): PowerPoint.TableRow; /** - * Specifies the style "Medium style 2 - Accent 2" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - mediumStyle2Accent2 = "MediumStyle2Accent2", + load(propertyNames?: string | string[]): PowerPoint.TableRow; /** - * Specifies the style "Medium style 2 - Accent 3" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - mediumStyle2Accent3 = "MediumStyle2Accent3", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.TableRow; /** - * Specifies the style "Medium style 2 - Accent 4" in UI. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.TableRowData; + } + /** + * Represents a collection of table rows. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + class TableRowCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.TableRow[]; + /** + * Adds one or more rows to the table. + * * @remarks * [Api set: PowerPointApi 1.9] + * + * @param index Optional. Specifies the zero-based index where the new rows are added. Existing rows starting at the index location are shifted down. If the index value is undefined, null, -1, or greater than the number of rows in the table, the new rows are added at the end of the table. + * @param count Optional. The number of rows to add. If the value is undefined or 0, only one row is added. */ - mediumStyle2Accent4 = "MediumStyle2Accent4", + // eslint-disable-next-line @definitelytyped/redundant-undefined + add(index?: number | null | undefined, count?: number | undefined): void; /** - * Specifies the style "Medium style 2 - Accent 5" in UI. + * Deletes the specified rows from the collection. + * * @remarks * [Api set: PowerPointApi 1.9] + * + * @param rows An array of `TableRow` objects representing the rows to be deleted. */ - mediumStyle2Accent5 = "MediumStyle2Accent5", + deleteRows(rows: PowerPoint.TableRow[]): void; /** - * Specifies the style "Medium style 2 - Accent 6" in UI. + * Gets the number of rows in the collection. + * * @remarks * [Api set: PowerPointApi 1.9] + * @returns The number of rows in the collection. */ - mediumStyle2Accent6 = "MediumStyle2Accent6", + getCount(): OfficeExtension.ClientResult; /** - * Specifies the style "Medium Style 3" in UI. + * Gets the row using its zero-based index in the collection. + * * @remarks * [Api set: PowerPointApi 1.9] + * + * @param index Index value of the row to be retrieved, as a zero-based index. + * @returns The row object. */ - mediumStyle3 = "MediumStyle3", + getItemAt(index: number): PowerPoint.TableRow; /** - * Specifies the style "Medium style 3 - Accent 1" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - mediumStyle3Accent1 = "MediumStyle3Accent1", + load(options?: PowerPoint.Interfaces.TableRowCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableRowCollection; /** - * Specifies the style "Medium style 3 - Accent 2" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - mediumStyle3Accent2 = "MediumStyle3Accent2", + load(propertyNames?: string | string[]): PowerPoint.TableRowCollection; /** - * Specifies the style "Medium style 3 - Accent 3" in UI. - * @remarks - * [Api set: PowerPointApi 1.9] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - mediumStyle3Accent3 = "MediumStyle3Accent3", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableRowCollection; /** - * Specifies the style "Medium style 3 - Accent 4" in UI. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.TableRowCollectionData; + } + /** + * Represents the available built-in table styles. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + enum TableStyle { + /** + * Specifies the style "No style, No grid" in UI. * @remarks * [Api set: PowerPointApi 1.9] */ - mediumStyle3Accent4 = "MediumStyle3Accent4", + noStyleNoGrid = "NoStyleNoGrid", /** - * Specifies the style "Medium style 3 - Accent 5" in UI. + * Specifies the style "Themed style 1 - Accent 1" in UI. * @remarks * [Api set: PowerPointApi 1.9] */ - mediumStyle3Accent5 = "MediumStyle3Accent5", + themedStyle1Accent1 = "ThemedStyle1Accent1", /** - * Specifies the style "Medium style 3 - Accent 6" in UI. + * Specifies the style "Themed style 1 - Accent 2" in UI. * @remarks * [Api set: PowerPointApi 1.9] */ - mediumStyle3Accent6 = "MediumStyle3Accent6", + themedStyle1Accent2 = "ThemedStyle1Accent2", /** - * Specifies the style "Medium Style 4" in UI. + * Specifies the style "Themed style 1 - Accent 3" in UI. * @remarks * [Api set: PowerPointApi 1.9] */ - mediumStyle4 = "MediumStyle4", + themedStyle1Accent3 = "ThemedStyle1Accent3", + /** + * Specifies the style "Themed style 1 - Accent 4" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + themedStyle1Accent4 = "ThemedStyle1Accent4", + /** + * Specifies the style "Themed style 1 - Accent 5" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + themedStyle1Accent5 = "ThemedStyle1Accent5", + /** + * Specifies the style "Themed style 1 - Accent 6" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + themedStyle1Accent6 = "ThemedStyle1Accent6", + /** + * Specifies the style "No style, Table grid" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + noStyleTableGrid = "NoStyleTableGrid", + /** + * Specifies the style "Themed style 2 - Accent 1" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + themedStyle2Accent1 = "ThemedStyle2Accent1", + /** + * Specifies the style "Themed style 2 - Accent 2" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + themedStyle2Accent2 = "ThemedStyle2Accent2", + /** + * Specifies the style "Themed style 2 - Accent 3" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + themedStyle2Accent3 = "ThemedStyle2Accent3", + /** + * Specifies the style "Themed style 2 - Accent 4" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + themedStyle2Accent4 = "ThemedStyle2Accent4", + /** + * Specifies the style "Themed style 2 - Accent 5" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + themedStyle2Accent5 = "ThemedStyle2Accent5", + /** + * Specifies the style "Themed style 2 - Accent 6" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + themedStyle2Accent6 = "ThemedStyle2Accent6", + /** + * Specifies the style "Light Style 1" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle1 = "LightStyle1", + /** + * Specifies the style "Light style 1 - Accent 1" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle1Accent1 = "LightStyle1Accent1", + /** + * Specifies the style "Light style 1 - Accent 2" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle1Accent2 = "LightStyle1Accent2", + /** + * Specifies the style "Light style 1 - Accent 3" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle1Accent3 = "LightStyle1Accent3", + /** + * Specifies the style "Light style 1 - Accent 4" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle1Accent4 = "LightStyle1Accent4", + /** + * Specifies the style "Light style 1 - Accent 5" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle1Accent5 = "LightStyle1Accent5", + /** + * Specifies the style "Light style 1 - Accent 6" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle1Accent6 = "LightStyle1Accent6", + /** + * Specifies the style "Light Style 2" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle2 = "LightStyle2", + /** + * Specifies the style "Light style 2 - Accent 1" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle2Accent1 = "LightStyle2Accent1", + /** + * Specifies the style "Light style 2 - Accent 2" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle2Accent2 = "LightStyle2Accent2", + /** + * Specifies the style "Light style 2 - Accent 3" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle2Accent3 = "LightStyle2Accent3", + /** + * Specifies the style "Light style 2 - Accent 4" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle2Accent4 = "LightStyle2Accent4", + /** + * Specifies the style "Light style 2 - Accent 5" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle2Accent5 = "LightStyle2Accent5", + /** + * Specifies the style "Light style 2 - Accent 6" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle2Accent6 = "LightStyle2Accent6", + /** + * Specifies the style "Light Style 3" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle3 = "LightStyle3", + /** + * Specifies the style "Light style 3 - Accent 1" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle3Accent1 = "LightStyle3Accent1", + /** + * Specifies the style "Light style 3 - Accent 2" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle3Accent2 = "LightStyle3Accent2", + /** + * Specifies the style "Light style 3 - Accent 3" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle3Accent3 = "LightStyle3Accent3", + /** + * Specifies the style "Light style 3 - Accent 4" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle3Accent4 = "LightStyle3Accent4", + /** + * Specifies the style "Light style 3 - Accent 5" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle3Accent5 = "LightStyle3Accent5", + /** + * Specifies the style "Light style 3 - Accent 6" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + lightStyle3Accent6 = "LightStyle3Accent6", + /** + * Specifies the style "Medium Style 1" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle1 = "MediumStyle1", + /** + * Specifies the style "Medium style 1 - Accent 1" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle1Accent1 = "MediumStyle1Accent1", + /** + * Specifies the style "Medium style 1 - Accent 2" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle1Accent2 = "MediumStyle1Accent2", + /** + * Specifies the style "Medium style 1 - Accent 3" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle1Accent3 = "MediumStyle1Accent3", + /** + * Specifies the style "Medium style 1 - Accent 4" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle1Accent4 = "MediumStyle1Accent4", + /** + * Specifies the style "Medium style 1 - Accent 5" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle1Accent5 = "MediumStyle1Accent5", + /** + * Specifies the style "Medium style 1 - Accent 6" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle1Accent6 = "MediumStyle1Accent6", + /** + * Specifies the style "Medium Style 2" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle2 = "MediumStyle2", + /** + * Specifies the style "Medium style 2 - Accent 1" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle2Accent1 = "MediumStyle2Accent1", + /** + * Specifies the style "Medium style 2 - Accent 2" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle2Accent2 = "MediumStyle2Accent2", + /** + * Specifies the style "Medium style 2 - Accent 3" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle2Accent3 = "MediumStyle2Accent3", + /** + * Specifies the style "Medium style 2 - Accent 4" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle2Accent4 = "MediumStyle2Accent4", + /** + * Specifies the style "Medium style 2 - Accent 5" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle2Accent5 = "MediumStyle2Accent5", + /** + * Specifies the style "Medium style 2 - Accent 6" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle2Accent6 = "MediumStyle2Accent6", + /** + * Specifies the style "Medium Style 3" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle3 = "MediumStyle3", + /** + * Specifies the style "Medium style 3 - Accent 1" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle3Accent1 = "MediumStyle3Accent1", + /** + * Specifies the style "Medium style 3 - Accent 2" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle3Accent2 = "MediumStyle3Accent2", + /** + * Specifies the style "Medium style 3 - Accent 3" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle3Accent3 = "MediumStyle3Accent3", + /** + * Specifies the style "Medium style 3 - Accent 4" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle3Accent4 = "MediumStyle3Accent4", + /** + * Specifies the style "Medium style 3 - Accent 5" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle3Accent5 = "MediumStyle3Accent5", + /** + * Specifies the style "Medium style 3 - Accent 6" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle3Accent6 = "MediumStyle3Accent6", + /** + * Specifies the style "Medium Style 4" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle4 = "MediumStyle4", + /** + * Specifies the style "Medium style 4 - Accent 1" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle4Accent1 = "MediumStyle4Accent1", + /** + * Specifies the style "Medium style 4 - Accent 2" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle4Accent2 = "MediumStyle4Accent2", + /** + * Specifies the style "Medium style 4 - Accent 3" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle4Accent3 = "MediumStyle4Accent3", + /** + * Specifies the style "Medium style 4 - Accent 4" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle4Accent4 = "MediumStyle4Accent4", + /** + * Specifies the style "Medium style 4 - Accent 5" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle4Accent5 = "MediumStyle4Accent5", + /** + * Specifies the style "Medium style 4 - Accent 6" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + mediumStyle4Accent6 = "MediumStyle4Accent6", + /** + * Specifies the style "Dark Style 1" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + darkStyle1 = "DarkStyle1", + /** + * Specifies the style "Dark style 1 - Accent 1" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + darkStyle1Accent1 = "DarkStyle1Accent1", + /** + * Specifies the style "Dark style 1 - Accent 2" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + darkStyle1Accent2 = "DarkStyle1Accent2", + /** + * Specifies the style "Dark style 1 - Accent 3" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + darkStyle1Accent3 = "DarkStyle1Accent3", + /** + * Specifies the style "Dark style 1 - Accent 4" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + darkStyle1Accent4 = "DarkStyle1Accent4", + /** + * Specifies the style "Dark style 1 - Accent 5" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + darkStyle1Accent5 = "DarkStyle1Accent5", + /** + * Specifies the style "Dark style 1 - Accent 6" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + darkStyle1Accent6 = "DarkStyle1Accent6", + /** + * Specifies the style "Dark Style 2" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + darkStyle2 = "DarkStyle2", + /** + * Specifies the style "Dark style 2 - Accent 1/Accent 2" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + darkStyle2Accent1 = "DarkStyle2Accent1", + /** + * Specifies the style "Dark style 2 - Accent 3/Accent 4" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + darkStyle2Accent2 = "DarkStyle2Accent2", + /** + * Specifies the style "Dark style 2 - Accent 5/Accent 6" in UI. + * @remarks + * [Api set: PowerPointApi 1.9] + */ + darkStyle2Accent3 = "DarkStyle2Accent3", + } + /** + * Represents the available table style settings. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + class TableStyleSettings extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + areColumnsBanded: boolean; + /** + * Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + areRowsBanded: boolean; + /** + * Specifies if the first column contains special formatting. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + isFirstColumnHighlighted: boolean; + /** + * Specifies if the first row contains special formatting. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + isFirstRowHighlighted: boolean; + /** + * Specifies if the last column contains special formatting. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + isLastColumnHighlighted: boolean; + /** + * Specifies if the last row contains special formatting. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + isLastRowHighlighted: boolean; + /** + * Specifies the table style. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + style: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" | "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" | "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" | "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" | "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3"; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.TableStyleSettingsLoadOptions): PowerPoint.TableStyleSettings; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.TableStyleSettings; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.TableStyleSettings; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TableStyleSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleSettingsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.TableStyleSettingsData; + } + /** + * Represents a table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + class Table extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the collection of columns in the table. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + readonly columns: PowerPoint.TableColumnCollection; + /** + * Gets the collection of rows in the table. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + readonly rows: PowerPoint.TableRowCollection; + /** + * Gets the table style settings. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + readonly styleSettings: PowerPoint.TableStyleSettings; + /** + * Gets the number of columns in the table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly columnCount: number; + /** + * Gets the number of rows in the table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly rowCount: number; + /** + * Gets all of the values in the table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + readonly values: string[][]; + /** + * Clears table values and formatting. + * + * @remarks + * [Api set: PowerPointApi 1.9] + * + * @param options Provides options for clearing the table. + */ + clear(options?: PowerPoint.TableClearOptions): void; + /** + * Gets the cell at the specified `rowIndex` and `columnIndex`. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * + * @param rowIndex The zero-based row index of the cell. + * @param columnIndex The zero-based column index of the cell. + * @returns The cell at the specified row and column. If the cell is part of a merged area and not the top left cell of the merged area, an object with the `isNullObject` property set to `true` is returned. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + */ + getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell; + /** + * Gets a collection of cells that represent the merged areas of the table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * @returns a `TableCellCollection` with cells that represent the merged areas of the table. + */ + getMergedAreas(): PowerPoint.TableCellCollection; + /** + * Gets the shape object for the table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + getShape(): PowerPoint.Shape; + /** + * Creates a merged area starting at the cell specified by rowIndex and columnIndex. The merged area spans across a specified number of rows and columns. + * + * @remarks + * [Api set: PowerPointApi 1.9] + * + * @param rowIndex The zero-based row index of the cell to start the merged area. + * @param columnIndex The zero-based column index of the cell to start the merged area. + * @param rowCount The number of rows to merge with the starting cell. Must be greater than 0. + * @param columnCount The number of columns to merge with the starting cell. Must be greater than 0. + */ + mergeCells(rowIndex: number, columnIndex: number, rowCount: number, columnCount: number): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.TableLoadOptions): PowerPoint.Table; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.Table; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.Table; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.TableData; + } + /** + * Represents the fill formatting of a table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface FillProperties { + /** + * Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + color?: string | undefined; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + transparency?: number | undefined; + } + /** + * Represents the properties for a table cell border. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface BorderProperties { + /** + * Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + color?: string | undefined; + /** + * Represents the dash style of the line. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined; + /** + * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + transparency?: number | undefined; + /** + * Represents the weight of the line, in points. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + weight?: number | undefined; + } + /** + * Represents the borders of a table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableCellBorders { + /** + * Represents the bottom border. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + bottom?: PowerPoint.BorderProperties; + /** + * Represents the diagonal border (top-left to bottom-right). + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + diagonalDown?: PowerPoint.BorderProperties; + /** + * Represents the diagonal border (bottom-left to top-right). + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + diagonalUp?: PowerPoint.BorderProperties; + /** + * Represents the left border. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + left?: PowerPoint.BorderProperties; + /** + * Represents the right border. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + right?: PowerPoint.BorderProperties; + /** + * Represents the top border. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + top?: PowerPoint.BorderProperties; + } + /** + * Represents the margins of a table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableCellMargins { + /** + * Specifies the bottom margin in points. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + bottom?: number | undefined; + /** + * Specifies the left margin in points. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + left?: number | undefined; + /** + * Specifies the right margin in points. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + right?: number | undefined; + /** + * Specifies the top margin in points. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + top?: number | undefined; + } + /** + * Represents the table cell properties to update. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableCellProperties { + /** + * Specifies the border formatting of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + borders?: PowerPoint.TableCellBorders; + /** + * Specifies the fill formatting of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + fill?: PowerPoint.FillProperties; + /** + * Specifies the font formatting of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + font?: PowerPoint.FontProperties; + /** + * Specifies the horizontal alignment of the text in the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | undefined; + /** + * Specifies the indent level of the text in the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + indentLevel?: number | undefined; + /** + * Specifies the margin settings in the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + margins?: PowerPoint.TableCellMargins; + /** + * Specifies the text content of the table cell. + + If a portion of the text requires different formatting, use the `textRuns` property instead. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + text?: string; + /** + * Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects. + Each `TextRun` object represents a sequence of one or more characters that share the same font attributes. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + textRuns?: PowerPoint.TextRun[]; + /** + * Specifies the vertical alignment of the text in the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" | undefined; + } + /** + * Provides the table column properties. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableColumnProperties { + /** + * Represents the desired width of each column in points, or is undefined. + + When a table is being added, for columns whose width is undefined, + the column width will be calculated by evenly dividing the remaining width + of the table amongst those columns. If the table doesn't have a defined width, + a default column width will be used. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + columnWidth?: number | undefined; + } + /** + * Represents the properties of a merged area of cells in a table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableMergedAreaProperties { + /** + * Specifies the number of columns for the merged cells area. + Must be 1 or greater. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + columnCount: number; + /** + * Specifies the zero-based index of the column of the top left cell of the merged area. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + columnIndex: number; + /** + * Specifies the number of rows for the merged cells area. + Must be 1 or greater. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + rowCount: number; + /** + * Specifies the zero-based index of the row of the top left cell of the merged area. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + rowIndex: number; + } + /** + * Provides the table row properties. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableRowProperties { + /** + * Represents the desired height of each row in points, or is undefined. + + When a table is being added, for rows whose height is undefined, + the row height will be calculated by evenly dividing the remaining height + of the table amongst those rows. If the table doesn't have a defined height, + a default row height will be used. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + rowHeight?: number | undefined; + } + /** + * Represents the available options when adding a table. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + interface TableAddOptions { + /** + * If provided, specifies properties for each column in the table. + The array length must be equal to the number of columns in the table. + Specify an empty object for columns that should use the default formatting. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + columns?: PowerPoint.TableColumnProperties[]; + /** + * Specifies the height, in points, of the table. + A default value is used when this parameter isn't provided. + Throws an `InvalidArgument` exception when set with a negative value. + + Note: If the table height isn't evenly divisible by the number of rows, PowerPoint sets it to the nearest possible value. + For example, a height of 400 for 3 rows may result in an actual height of 399.9999. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + height?: number | undefined; + /** + * Specifies the distance, in points, from the left side of the table to the left side of the slide. + The table is centered horizontally when this parameter isn't provided. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + left?: number | undefined; + /** + * If specified, represents an rectangular area where multiple cells appear as a single cell. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + mergedAreas?: PowerPoint.TableMergedAreaProperties[]; + /** + * If provided, specifies properties for each row in the table. + The array length must be equal to the number of rows in the table. + Specify an empty object for rows that should use the default formatting. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + rows?: PowerPoint.TableRowProperties[]; + /** + * If provided, specifies properties for each cell in the table. + + This should be a 2D array with the same number of rows and columns as the table. + If a cell doesn't require specific formatting, specify an empty object for that cell. + Only the top left cell of a merged are can have properties specified, which will be applied + to the entire merged area. For the other cells in the merged area, an empty object should be provided. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + specificCellProperties?: PowerPoint.TableCellProperties[][]; + /** + * Specifies value that represents the table style. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + style?: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" | "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" | "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" | "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" | "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3"; + /** + * Specifies the distance, in points, from the top edge of the table to the top edge of the slide. + A default value is used when this parameter isn't provided. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + top?: number | undefined; + /** + * Specifies the formatting which applies uniformly to all of the table cells. + + To apply specific formatting to individual cells, use `specificCellProperties`. + + If both uniformCellProperties and specificCellProperties are undefined, the default formatting + will be used, and the default table style will be applied. The table will have the same + appearance as when the user adds a table through the PowerPoint UI. + + To provide a plain appearance for the table, set this property to an empty object + and don't specify `specificCellProperties`. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + uniformCellProperties?: PowerPoint.TableCellProperties; + /** + * If provided, specifies the values for the table. + + When the table contains areas of merged cells, + only the top left cell of each merged area can have a + non-empty string value. The other cells + in the merged area must be an empty string. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + values?: string[][]; + /** + * Specifies the width, in points, of the table. + A default value is used when this parameter isn't provided. + Throws an `InvalidArgument` exception when set with a negative value. + + Note: If the table width isn't evenly divisible by the number of columns, PowerPoint sets it to the nearest possible value. + For example, a width of 400 for 3 columns may result in an actual width of 399.9999. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + width?: number | undefined; + } + /** + * Represents the collection of shapes. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + class ShapeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: PowerPoint.Shape[]; + /** + * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + * + * @param geometricShapeType Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details. + * @param options An optional parameter to specify the additional options such as the position of the shape. + * @returns The newly inserted shape. + */ + addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + /** + * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + * + * @param geometricShapeType Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details. + * @param options An optional parameter to specify the additional options such as the position of the shape. + * @returns The newly inserted shape. + */ + addGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + /** + * Create a shape group for several shapes. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * + * @param values An array of shape IDs or `Shape` objects. + * @returns A `Shape` object that represents the shape group. Use the `Shape.group` property to access the `ShapeGroup` object for the group. + */ + addGroup(values: Array): PowerPoint.Shape; + /** + * Adds a line to the slide. Returns a `Shape` object that represents the new line. + * + * @remarks + * [Api set: PowerPointApi 1.4] + * + * @param connectorType Specifies the connector type of the line. If not provided, `straight` connector type will be used. See {@link PowerPoint.ConnectorType} for details. + * @param options An optional parameter to specify the additional options such as the position of the shape object that contains the line. + * @returns The newly inserted shape. + */ + addLine(connectorType?: PowerPoint.ConnectorType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + /** + * Adds a line to the slide. Returns a `Shape` object that represents the new line. + * + * @remarks + * [Api set: PowerPointApi 1.4] + * + * @param connectorType Specifies the connector type of the line. If not provided, `straight` connector type will be used. See {@link PowerPoint.ConnectorType} for details. + * @param options An optional parameter to specify the additional options such as the position of the shape object that contains the line. + * @returns The newly inserted shape. + */ + addLine(connectorType?: "Straight" | "Elbow" | "Curve", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + /** + * Adds a table to the slide. Returns a `Shape` object that represents the new table. + Use the `Shape.table` property to get the `Table` object for the shape. + * + * @remarks + * [Api set: PowerPointApi 1.8] + * + * @param rowCount Number of rows in the table. Must be 1 or greater. + * @param columnCount Number of columns in the table. Must be 1 or greater. + * @param options Provides options describing the new table. + * @returns The newly inserted shape. + */ + addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions): PowerPoint.Shape; + /** + * Adds a text box to the slide with the provided text as the content. Returns a `Shape` object that represents the new text box. + * + * @remarks + * [Api set: PowerPointApi 1.4] + * + * @param text Specifies the text that will be shown in the created text box. + * @param options An optional parameter to specify the additional options such as the position of the text box. + * @returns The newly inserted shape. + */ + addTextBox(text: string, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + /** + * Gets the number of shapes in the collection. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * @returns The number of shapes in the collection. + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a shape using its unique ID. An error is thrown if the shape doesn't exist. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param key The ID of the shape. + * @returns The shape with the unique ID. If such a shape doesn't exist, an error is thrown. + */ + getItem(key: string): PowerPoint.Shape; + /** + * Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param index The index of the shape in the collection. + * @returns The shape at the given index. An error is thrown if index is out of range. + */ + getItemAt(index: number): PowerPoint.Shape; + /** + * Gets a shape using its unique ID. If such a shape doesn't exist, an object with an `isNullObject` property set to true is returned. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: PowerPointApi 1.3] + * + * @param id The ID of the shape. + * @returns The shape with the unique ID. If such a shape doesn't exist, an object with an `isNullObject` property set to true is returned. + */ + getItemOrNullObject(id: string): PowerPoint.Shape; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.ShapeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): PowerPoint.Interfaces.ShapeCollectionData; + } + /** + * Specifies the gradient fill type for a {@link PowerPoint.SlideBackgroundGradientFill}. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + enum SlideBackgroundGradientFillType { + /** + * Unsupported gradient fill. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + unsupported = "Unsupported", + /** + * Linear gradient fill. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + linear = "Linear", + /** + * Radial gradient fill. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + radial = "Radial", + /** + * Rectangular gradient fill. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + rectangular = "Rectangular", + /** + * Path gradient fill. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + path = "Path", + /** + * Shade from title gradient fill. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + shadeFromTitle = "ShadeFromTitle", + } + /** + * Represents {@link PowerPoint.SlideBackground} gradient fill properties. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + class SlideBackgroundGradientFill extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the type of gradient fill. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + type: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle"; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.SlideBackgroundGradientFillLoadOptions): PowerPoint.SlideBackgroundGradientFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundGradientFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.SlideBackgroundGradientFill; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideBackgroundGradientFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundGradientFillData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.SlideBackgroundGradientFillData; + } + /** + * Represents the available options for setting a {@link PowerPoint.SlideBackground} gradient fill. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface SlideBackgroundGradientFillOptions { /** - * Specifies the style "Medium style 4 - Accent 1" in UI. + * If provided, specifies the type of gradient fill. + * * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - mediumStyle4Accent1 = "MediumStyle4Accent1", + type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle"; + } + /** + * Specifies the pattern fill type for a {@link PowerPoint.SlideBackgroundPatternFill}. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + enum SlideBackgroundPatternFillType { /** - * Specifies the style "Medium style 4 - Accent 2" in UI. + * Unsupported pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - mediumStyle4Accent2 = "MediumStyle4Accent2", + unsupported = "Unsupported", /** - * Specifies the style "Medium style 4 - Accent 3" in UI. + * 5 percent pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - mediumStyle4Accent3 = "MediumStyle4Accent3", + percent5 = "Percent5", /** - * Specifies the style "Medium style 4 - Accent 4" in UI. + * 10 percent pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - mediumStyle4Accent4 = "MediumStyle4Accent4", + percent10 = "Percent10", /** - * Specifies the style "Medium style 4 - Accent 5" in UI. + * 20 percent pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - mediumStyle4Accent5 = "MediumStyle4Accent5", + percent20 = "Percent20", /** - * Specifies the style "Medium style 4 - Accent 6" in UI. + * 25 percent pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - mediumStyle4Accent6 = "MediumStyle4Accent6", + percent25 = "Percent25", /** - * Specifies the style "Dark Style 1" in UI. + * 30 percent pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - darkStyle1 = "DarkStyle1", + percent30 = "Percent30", /** - * Specifies the style "Dark style 1 - Accent 1" in UI. + * 40 percent pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - darkStyle1Accent1 = "DarkStyle1Accent1", + percent40 = "Percent40", /** - * Specifies the style "Dark style 1 - Accent 2" in UI. + * 50 percent pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - darkStyle1Accent2 = "DarkStyle1Accent2", + percent50 = "Percent50", /** - * Specifies the style "Dark style 1 - Accent 3" in UI. + * 60 percent pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - darkStyle1Accent3 = "DarkStyle1Accent3", + percent60 = "Percent60", /** - * Specifies the style "Dark style 1 - Accent 4" in UI. + * 70 percent pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - darkStyle1Accent4 = "DarkStyle1Accent4", + percent70 = "Percent70", /** - * Specifies the style "Dark style 1 - Accent 5" in UI. + * 75 percent pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - darkStyle1Accent5 = "DarkStyle1Accent5", + percent75 = "Percent75", /** - * Specifies the style "Dark style 1 - Accent 6" in UI. + * 80 percent pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - darkStyle1Accent6 = "DarkStyle1Accent6", + percent80 = "Percent80", /** - * Specifies the style "Dark Style 2" in UI. + * 90 percent pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - darkStyle2 = "DarkStyle2", + percent90 = "Percent90", /** - * Specifies the style "Dark style 2 - Accent 1/Accent 2" in UI. + * Horizontal pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - darkStyle2Accent1 = "DarkStyle2Accent1", + horizontal = "Horizontal", /** - * Specifies the style "Dark style 2 - Accent 3/Accent 4" in UI. + * Vertical pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - darkStyle2Accent2 = "DarkStyle2Accent2", + vertical = "Vertical", /** - * Specifies the style "Dark style 2 - Accent 5/Accent 6" in UI. + * Light horizontal pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - darkStyle2Accent3 = "DarkStyle2Accent3", - } - /** - * Represents the available table style settings. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ - class TableStyleSettings extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + lightHorizontal = "LightHorizontal", /** - * Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier. - * + * Light vertical pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - areColumnsBanded: boolean; + lightVertical = "LightVertical", /** - * Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier. - * + * Dark horizontal pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - areRowsBanded: boolean; + darkHorizontal = "DarkHorizontal", /** - * Specifies if the first column contains special formatting. - * + * Dark vertical pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - isFirstColumnHighlighted: boolean; + darkVertical = "DarkVertical", /** - * Specifies if the first row contains special formatting. - * + * Narrow horizontal pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - isFirstRowHighlighted: boolean; + narrowHorizontal = "NarrowHorizontal", /** - * Specifies if the last column contains special formatting. - * + * Narrow vertical pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - isLastColumnHighlighted: boolean; + narrowVertical = "NarrowVertical", /** - * Specifies if the last row contains special formatting. - * + * Dashed horizontal pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - isLastRowHighlighted: boolean; + dashedHorizontal = "DashedHorizontal", /** - * Specifies the table style. - * + * Dashed vertical pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] - */ - style: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" | "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" | "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" | "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" | "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3"; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. - */ - load(options?: PowerPoint.Interfaces.TableStyleSettingsLoadOptions): PowerPoint.TableStyleSettings; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): PowerPoint.TableStyleSettings; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. - */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.TableStyleSettings; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TableStyleSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleSettingsData`) that contains shallow copies of any loaded child properties from the original object. + * [Api set: PowerPointApi 1.10] */ - toJSON(): PowerPoint.Interfaces.TableStyleSettingsData; - } - /** - * Represents a table. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ - class Table extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + dashedVertical = "DashedVertical", /** - * Gets the collection of columns in the table. - * + * Cross pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - readonly columns: PowerPoint.TableColumnCollection; + cross = "Cross", /** - * Gets the collection of rows in the table. - * + * Downward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - readonly rows: PowerPoint.TableRowCollection; + downwardDiagonal = "DownwardDiagonal", /** - * Gets the table style settings. - * + * Upward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] + * [Api set: PowerPointApi 1.10] */ - readonly styleSettings: PowerPoint.TableStyleSettings; + upwardDiagonal = "UpwardDiagonal", /** - * Gets the number of columns in the table. - * + * Light downward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - readonly columnCount: number; + lightDownwardDiagonal = "LightDownwardDiagonal", /** - * Gets the number of rows in the table. - * + * Light upward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - readonly rowCount: number; + lightUpwardDiagonal = "LightUpwardDiagonal", /** - * Gets all of the values in the table. - * + * Dark downward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - readonly values: string[][]; + darkDownwardDiagonal = "DarkDownwardDiagonal", /** - * Clears table values and formatting. - * + * Dark upward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] - * - * @param options Provides options for clearing the table. + * [Api set: PowerPointApi 1.10] */ - clear(options?: PowerPoint.TableClearOptions): void; + darkUpwardDiagonal = "DarkUpwardDiagonal", /** - * Gets the cell at the specified `rowIndex` and `columnIndex`. - * + * Wide downward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] - * - * @param rowIndex The zero-based row index of the cell. - * @param columnIndex The zero-based column index of the cell. - * @returns The cell at the specified row and column. If the cell is part of a merged area and not the top left cell of the merged area, an object with the `isNullObject` property set to `true` is returned. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * [Api set: PowerPointApi 1.10] */ - getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell; + wideDownwardDiagonal = "WideDownwardDiagonal", /** - * Gets a collection of cells that represent the merged areas of the table. - * + * Wide upward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] - * @returns a `TableCellCollection` with cells that represent the merged areas of the table. + * [Api set: PowerPointApi 1.10] */ - getMergedAreas(): PowerPoint.TableCellCollection; + wideUpwardDiagonal = "WideUpwardDiagonal", /** - * Gets the shape object for the table. - * + * Dashed downward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - getShape(): PowerPoint.Shape; + dashedDownwardDiagonal = "DashedDownwardDiagonal", /** - * Creates a merged area starting at the cell specified by rowIndex and columnIndex. The merged area spans across a specified number of rows and columns. - * + * Dashed upward diagonal pattern fill. * @remarks - * [Api set: PowerPointApi 1.9] - * - * @param rowIndex The zero-based row index of the cell to start the merged area. - * @param columnIndex The zero-based column index of the cell to start the merged area. - * @param rowCount The number of rows to merge with the starting cell. Must be greater than 0. - * @param columnCount The number of columns to merge with the starting cell. Must be greater than 0. + * [Api set: PowerPointApi 1.10] */ - mergeCells(rowIndex: number, columnIndex: number, rowCount: number, columnCount: number): void; + dashedUpwardDiagonal = "DashedUpwardDiagonal", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Diagonal cross pattern fill. + * @remarks + * [Api set: PowerPointApi 1.10] */ - load(options?: PowerPoint.Interfaces.TableLoadOptions): PowerPoint.Table; + diagonalCross = "DiagonalCross", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Small checker board pattern fill. + * @remarks + * [Api set: PowerPointApi 1.10] */ - load(propertyNames?: string | string[]): PowerPoint.Table; + smallCheckerBoard = "SmallCheckerBoard", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Large checker board pattern fill. + * @remarks + * [Api set: PowerPointApi 1.10] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): PowerPoint.Table; + largeCheckerBoard = "LargeCheckerBoard", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): PowerPoint.Interfaces.TableData; - } - /** - * Represents the fill formatting of a table cell. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ - interface FillProperties { + * Small grid pattern fill. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + smallGrid = "SmallGrid", /** - * Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange"). - * + * Large grid pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - color?: string | undefined; + largeGrid = "LargeGrid", /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). - * + * Dotted grid pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - transparency?: number | undefined; - } - /** - * Represents the properties for a table cell border. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ - interface BorderProperties { + dottedGrid = "DottedGrid", /** - * Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange"). - * + * Small confetti pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - color?: string | undefined; + smallConfetti = "SmallConfetti", /** - * Represents the dash style of the line. - * + * Large confetti pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined; + largeConfetti = "LargeConfetti", /** - * Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). - * + * Horizontal brick pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - transparency?: number | undefined; + horizontalBrick = "HorizontalBrick", /** - * Represents the weight of the line, in points. - * + * Diagonal brick pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - weight?: number | undefined; - } - /** - * Represents the borders of a table cell. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ - interface TableCellBorders { + diagonalBrick = "DiagonalBrick", /** - * Represents the bottom border. - * + * Solid diamond pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - bottom?: PowerPoint.BorderProperties; + solidDiamond = "SolidDiamond", /** - * Represents the diagonal border (top-left to bottom-right). - * + * Outlined diamond pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - diagonalDown?: PowerPoint.BorderProperties; + outlinedDiamond = "OutlinedDiamond", /** - * Represents the diagonal border (bottom-left to top-right). - * + * Dotted diamond pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - diagonalUp?: PowerPoint.BorderProperties; + dottedDiamond = "DottedDiamond", /** - * Represents the left border. - * + * Plaid pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - left?: PowerPoint.BorderProperties; + plaid = "Plaid", /** - * Represents the right border. - * + * Sphere pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - right?: PowerPoint.BorderProperties; + sphere = "Sphere", /** - * Represents the top border. - * + * Weave pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - top?: PowerPoint.BorderProperties; - } - /** - * Represents the margins of a table cell. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ - interface TableCellMargins { + weave = "Weave", /** - * Specifies the bottom margin in points. - * + * Divot pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - bottom?: number | undefined; + divot = "Divot", /** - * Specifies the left margin in points. - * + * Shingle pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - left?: number | undefined; + shingle = "Shingle", /** - * Specifies the right margin in points. - * + * Wave pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - right?: number | undefined; + wave = "Wave", /** - * Specifies the top margin in points. - * + * Trellis pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - top?: number | undefined; + trellis = "Trellis", + /** + * Zig zag pattern fill. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + zigZag = "ZigZag", } /** - * Represents the table cell properties to update. + * Represents {@link PowerPoint.SlideBackground} pattern fill properties. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - interface TableCellProperties { + class SlideBackgroundPatternFill extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Specifies the border formatting of the table cell. + * Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white"). * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - borders?: PowerPoint.TableCellBorders; + backgroundColor: string; /** - * Specifies the fill formatting of the table cell. + * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange"). * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - fill?: PowerPoint.FillProperties; + foregroundColor: string; /** - * Specifies the font formatting of the table cell. + * Specifies the pattern type. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - font?: PowerPoint.FontProperties; + pattern: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag"; /** - * Specifies the horizontal alignment of the text in the table cell. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.8] + * @param options Provides options for which properties of the object to load. */ - horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | undefined; + load(options?: PowerPoint.Interfaces.SlideBackgroundPatternFillLoadOptions): PowerPoint.SlideBackgroundPatternFill; /** - * Specifies the indent level of the text in the table cell. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.8] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - indentLevel?: number | undefined; + load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundPatternFill; /** - * Specifies the margin settings in the table cell. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.8] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - margins?: PowerPoint.TableCellMargins; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.SlideBackgroundPatternFill; /** - * Specifies the text content of the table cell. - - If a portion of the text requires different formatting, use the `textRuns` property instead. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideBackgroundPatternFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPatternFillData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.SlideBackgroundPatternFillData; + } + /** + * Represents the available options for setting a {@link PowerPoint.SlideBackground} pattern fill. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface SlideBackgroundPatternFillOptions { + /** + * If provided, specifies the background color in HTML color format (e.g., "#FFFFFF" or "white"). * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - text?: string; + backgroundColor?: string; /** - * Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects. - Each `TextRun` object represents a sequence of one or more characters that share the same font attributes. + * If provided, specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange"). * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - textRuns?: PowerPoint.TextRun[]; + foregroundColor?: string; /** - * Specifies the vertical alignment of the text in the table cell. + * If provided, specifies the pattern type. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" | undefined; + pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag"; } /** - * Provides the table column properties. + * Represents {@link PowerPoint.SlideBackground} picture or texture fill properties. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - interface TableColumnProperties { + class SlideBackgroundPictureOrTextureFill extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Represents the desired width of each column in points, or is undefined. - - When a table is being added, for columns whose width is undefined, - the column width will be calculated by evenly dividing the remaining width - of the table amongst those columns. If the table doesn't have a defined width, - a default column width will be used. + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - columnWidth?: number | undefined; - } - /** - * Represents the properties of a merged area of cells in a table. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ - interface TableMergedAreaProperties { + transparency: number; /** - * Specifies the number of columns for the merged cells area. - Must be 1 or greater. + * Sets the image used to fill. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] + * + * @param base64EncodedImage A string that is a Base64 encoding of the image data. */ - columnCount: number; + setImage(base64EncodedImage: string): void; /** - * Specifies the zero-based index of the column of the top left cell of the merged area. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.8] + * @param options Provides options for which properties of the object to load. */ - columnIndex: number; + load(options?: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillLoadOptions): PowerPoint.SlideBackgroundPictureOrTextureFill; /** - * Specifies the number of rows for the merged cells area. - Must be 1 or greater. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.8] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - rowCount: number; + load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundPictureOrTextureFill; /** - * Specifies the zero-based index of the row of the top left cell of the merged area. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.8] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - rowIndex: number; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.SlideBackgroundPictureOrTextureFill; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideBackgroundPictureOrTextureFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData; } /** - * Provides the table row properties. + * Represents {@link PowerPoint.SlideBackground} picture or texture fill options. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - interface TableRowProperties { + interface SlideBackgroundPictureOrTextureFillOptions { /** - * Represents the desired height of each row in points, or is undefined. - - When a table is being added, for rows whose height is undefined, - the row height will be calculated by evenly dividing the remaining height - of the table amongst those rows. If the table doesn't have a defined height, - a default row height will be used. + * If provided, specifies the Base64-encoded image data for the fill. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - rowHeight?: number | undefined; + imageBase64?: string; + /** + * If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + transparency: number; } /** - * Represents the available options when adding a table. + * Specifies the fill type for a {@link PowerPoint.SlideBackground}. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - interface TableAddOptions { + enum SlideBackgroundFillType { /** - * If provided, specifies properties for each column in the table. - The array length must be equal to the number of columns in the table. - Specify an empty object for columns that should use the default formatting. - * + * Unsupported slide background fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - columns?: PowerPoint.TableColumnProperties[]; + unsupported = "Unsupported", /** - * Specifies the height, in points, of the table. - A default value is used when this parameter isn't provided. - Throws an `InvalidArgument` exception when set with a negative value. - - Note: If the table height isn't evenly divisible by the number of rows, PowerPoint sets it to the nearest possible value. - For example, a height of 400 for 3 rows may result in an actual height of 399.9999. - * + * Specifies that the slide background should have regular solid fill. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + solid = "Solid", + /** + * Specifies that the slide background should have gradient fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - height?: number | undefined; + gradient = "Gradient", /** - * Specifies the distance, in points, from the left side of the table to the left side of the slide. - The table is centered horizontally when this parameter isn't provided. - * + * Specifies that the slide background should have picture or texture fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - left?: number | undefined; + pictureOrTexture = "PictureOrTexture", /** - * If specified, represents an rectangular area where multiple cells appear as a single cell. - * + * Specifies that the slide background should have pattern fill. * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - mergedAreas?: PowerPoint.TableMergedAreaProperties[]; + pattern = "Pattern", + } + /** + * Represents {@link PowerPoint.SlideBackground} solid fill properties. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + class SlideBackgroundSolidFill extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * If provided, specifies properties for each row in the table. - The array length must be equal to the number of rows in the table. - Specify an empty object for rows that should use the default formatting. + * Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange"). * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - rows?: PowerPoint.TableRowProperties[]; + color: string; /** - * If provided, specifies properties for each cell in the table. - - This should be a 2D array with the same number of rows and columns as the table. - If a cell doesn't require specific formatting, specify an empty object for that cell. - Only the top left cell of a merged are can have properties specified, which will be applied - to the entire merged area. For the other cells in the merged area, an empty object should be provided. + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - specificCellProperties?: PowerPoint.TableCellProperties[][]; + transparency: number; /** - * Specifies value that represents the table style. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.9] + * @param options Provides options for which properties of the object to load. */ - style?: PowerPoint.TableStyle | "NoStyleNoGrid" | "ThemedStyle1Accent1" | "ThemedStyle1Accent2" | "ThemedStyle1Accent3" | "ThemedStyle1Accent4" | "ThemedStyle1Accent5" | "ThemedStyle1Accent6" | "NoStyleTableGrid" | "ThemedStyle2Accent1" | "ThemedStyle2Accent2" | "ThemedStyle2Accent3" | "ThemedStyle2Accent4" | "ThemedStyle2Accent5" | "ThemedStyle2Accent6" | "LightStyle1" | "LightStyle1Accent1" | "LightStyle1Accent2" | "LightStyle1Accent3" | "LightStyle1Accent4" | "LightStyle1Accent5" | "LightStyle1Accent6" | "LightStyle2" | "LightStyle2Accent1" | "LightStyle2Accent2" | "LightStyle2Accent3" | "LightStyle2Accent4" | "LightStyle2Accent5" | "LightStyle2Accent6" | "LightStyle3" | "LightStyle3Accent1" | "LightStyle3Accent2" | "LightStyle3Accent3" | "LightStyle3Accent4" | "LightStyle3Accent5" | "LightStyle3Accent6" | "MediumStyle1" | "MediumStyle1Accent1" | "MediumStyle1Accent2" | "MediumStyle1Accent3" | "MediumStyle1Accent4" | "MediumStyle1Accent5" | "MediumStyle1Accent6" | "MediumStyle2" | "MediumStyle2Accent1" | "MediumStyle2Accent2" | "MediumStyle2Accent3" | "MediumStyle2Accent4" | "MediumStyle2Accent5" | "MediumStyle2Accent6" | "MediumStyle3" | "MediumStyle3Accent1" | "MediumStyle3Accent2" | "MediumStyle3Accent3" | "MediumStyle3Accent4" | "MediumStyle3Accent5" | "MediumStyle3Accent6" | "MediumStyle4" | "MediumStyle4Accent1" | "MediumStyle4Accent2" | "MediumStyle4Accent3" | "MediumStyle4Accent4" | "MediumStyle4Accent5" | "MediumStyle4Accent6" | "DarkStyle1" | "DarkStyle1Accent1" | "DarkStyle1Accent2" | "DarkStyle1Accent3" | "DarkStyle1Accent4" | "DarkStyle1Accent5" | "DarkStyle1Accent6" | "DarkStyle2" | "DarkStyle2Accent1" | "DarkStyle2Accent2" | "DarkStyle2Accent3"; + load(options?: PowerPoint.Interfaces.SlideBackgroundSolidFillLoadOptions): PowerPoint.SlideBackgroundSolidFill; /** - * Specifies the distance, in points, from the top edge of the table to the top edge of the slide. - A default value is used when this parameter isn't provided. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.8] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - top?: number | undefined; + load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundSolidFill; /** - * Specifies the formatting which applies uniformly to all of the table cells. - - To apply specific formatting to individual cells, use `specificCellProperties`. - - If both uniformCellProperties and specificCellProperties are undefined, the default formatting - will be used, and the default table style will be applied. The table will have the same - appearance as when the user adds a table through the PowerPoint UI. - - To provide a plain appearance for the table, set this property to an empty object - and don't specify `specificCellProperties`. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.8] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - uniformCellProperties?: PowerPoint.TableCellProperties; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.SlideBackgroundSolidFill; /** - * If provided, specifies the values for the table. - - When the table contains areas of merged cells, - only the top left cell of each merged area can have a - non-empty string value. The other cells - in the merged area must be an empty string. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideBackgroundSolidFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundSolidFillData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.SlideBackgroundSolidFillData; + } + /** + * Represents the available options for setting a {@link PowerPoint.SlideBackground} solid fill. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface SlideBackgroundSolidFillOptions { + /** + * If provided, specifies the fill color in HTML color format (e.g., "#FFA500" or "orange"). * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - values?: string[][]; + color?: string; /** - * Specifies the width, in points, of the table. - A default value is used when this parameter isn't provided. - Throws an `InvalidArgument` exception when set with a negative value. - - Note: If the table width isn't evenly divisible by the number of columns, PowerPoint sets it to the nearest possible value. - For example, a width of 400 for 3 columns may result in an actual width of 399.9999. + * If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - width?: number | undefined; + transparency?: number; } /** - * Represents the collection of shapes. + * Represents the fill formatting of a slide background object. * * @remarks - * [Api set: PowerPointApi 1.3] + * [Api set: PowerPointApi 1.10] */ - class ShapeCollection extends OfficeExtension.ClientObject { + class SlideBackgroundFill extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: PowerPoint.Shape[]; /** - * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape. + * Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details. * * @remarks - * [Api set: PowerPointApi 1.4] - * - * @param geometricShapeType Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details. - * @param options An optional parameter to specify the additional options such as the position of the shape. - * @returns The newly inserted shape. + * [Api set: PowerPointApi 1.10] */ - addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + readonly type: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern"; /** - * Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape. + * Gets the gradient fill properties. If the fill type is not `gradient`, an object with an `isNullObject` property set to `true` is returned. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] + */ + getGradientFillOrNullObject(): PowerPoint.SlideBackgroundGradientFill; + /** + * Gets the pattern fill properties. If the fill type is not `pattern`, an object with an `isNullObject` property set to `true` is returned. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * - * @param geometricShapeType Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details. - * @param options An optional parameter to specify the additional options such as the position of the shape. - * @returns The newly inserted shape. + * @remarks + * [Api set: PowerPointApi 1.10] */ - addGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + getPatternFillOrNullObject(): PowerPoint.SlideBackgroundPatternFill; /** - * Create a shape group for several shapes. + * Gets the picture or texture fill properties. If the fill type is not `pictureOrTexture`, an object with an `isNullObject` property set to `true` is returned. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] + */ + getPictureOrTextureFillOrNullObject(): PowerPoint.SlideBackgroundPictureOrTextureFill; + /** + * Gets the solid fill properties. If the fill type is not `solid`, an object with an `isNullObject` property set to `true` is returned. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * - * @param values An array of shape IDs or `Shape` objects. - * @returns A `Shape` object that represents the shape group. Use the `Shape.group` property to access the `ShapeGroup` object for the group. + * @remarks + * [Api set: PowerPointApi 1.10] */ - addGroup(values: Array): PowerPoint.Shape; + getSolidFillOrNullObject(): PowerPoint.SlideBackgroundSolidFill; /** - * Adds a line to the slide. Returns a `Shape` object that represents the new line. + * Sets the fill formatting of the slide background to a gradient fill. This changes the fill type to `gradient`. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] * - * @param connectorType Specifies the connector type of the line. If not provided, `straight` connector type will be used. See {@link PowerPoint.ConnectorType} for details. - * @param options An optional parameter to specify the additional options such as the position of the shape object that contains the line. - * @returns The newly inserted shape. + * @param options Options for the gradient fill. */ - addLine(connectorType?: PowerPoint.ConnectorType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + setGradientFill(options?: PowerPoint.SlideBackgroundGradientFillOptions): void; /** - * Adds a line to the slide. Returns a `Shape` object that represents the new line. + * Sets the fill formatting of the slide background to a pattern fill. This changes the fill type to `pattern`. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] * - * @param connectorType Specifies the connector type of the line. If not provided, `straight` connector type will be used. See {@link PowerPoint.ConnectorType} for details. - * @param options An optional parameter to specify the additional options such as the position of the shape object that contains the line. - * @returns The newly inserted shape. + * @param options Options for the pattern fill. */ - addLine(connectorType?: "Straight" | "Elbow" | "Curve", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + setPatternFill(options?: PowerPoint.SlideBackgroundPatternFillOptions): void; /** - * Adds a table to the slide. Returns a `Shape` object that represents the new table. - Use the `Shape.table` property to get the `Table` object for the shape. + * Sets the fill formatting of the slide background to a picture or texture fill. This changes the fill type to `pictureOrTexture`. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] * - * @param rowCount Number of rows in the table. Must be 1 or greater. - * @param columnCount Number of columns in the table. Must be 1 or greater. - * @param options Provides options describing the new table. - * @returns The newly inserted shape. + * @param options Options for the picture or texture fill. */ - addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions): PowerPoint.Shape; + setPictureOrTextureFill(options?: PowerPoint.SlideBackgroundPictureOrTextureFillOptions): void; /** - * Adds a text box to the slide with the provided text as the content. Returns a `Shape` object that represents the new text box. + * Sets the fill formatting of the slide background to a solid fill. This changes the fill type to `solid`. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] * - * @param text Specifies the text that will be shown in the created text box. - * @param options An optional parameter to specify the additional options such as the position of the text box. - * @returns The newly inserted shape. + * @param options Options for the solid fill. */ - addTextBox(text: string, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape; + setSolidFill(options?: PowerPoint.SlideBackgroundSolidFillOptions): void; /** - * Gets the number of shapes in the collection. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.3] - * @returns The number of shapes in the collection. + * @param options Provides options for which properties of the object to load. */ - getCount(): OfficeExtension.ClientResult; + load(options?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions): PowerPoint.SlideBackgroundFill; /** - * Gets a shape using its unique ID. An error is thrown if the shape doesn't exist. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param key The ID of the shape. - * @returns The shape with the unique ID. If such a shape doesn't exist, an error is thrown. + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - getItem(key: string): PowerPoint.Shape; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.SlideBackgroundFill; /** - * Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideBackgroundFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundFillData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.SlideBackgroundFillData; + } + /** + * Represents a background of a slide. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + class SlideBackground extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the fill formatting of the background. * * @remarks - * [Api set: PowerPointApi 1.3] + * [Api set: PowerPointApi 1.10] + */ + readonly fill: PowerPoint.SlideBackgroundFill; + /** + * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. * - * @param index The index of the shape in the collection. - * @returns The shape at the given index. An error is thrown if index is out of range. + * @remarks + * [Api set: PowerPointApi 1.10] */ - getItemAt(index: number): PowerPoint.Shape; + areBackgroundGraphicsHidden: boolean; /** - * Gets a shape using its unique ID. If such a shape doesn't exist, an object with an `isNullObject` property set to true is returned. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Specifies if the slide background follows the slide master background. * * @remarks - * [Api set: PowerPointApi 1.3] + * [Api set: PowerPointApi 1.10] + */ + isMasterBackgroundFollowed: boolean; + /** + * Resets the fill formatting of the slide background. * - * @param id The ID of the shape. - * @returns The shape with the unique ID. If such a shape doesn't exist, an object with an `isNullObject` property set to true is returned. + * @remarks + * [Api set: PowerPointApi 1.10] */ - getItemOrNullObject(id: string): PowerPoint.Shape; + reset(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection; + load(options?: PowerPoint.Interfaces.SlideBackgroundLoadOptions): PowerPoint.SlideBackground; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): PowerPoint.ShapeCollection; + load(propertyNames?: string | string[]): PowerPoint.SlideBackground; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.SlideBackground; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): PowerPoint.Interfaces.ShapeCollectionData; + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.SlideBackgroundData; } /** * Represents the available options when getting an image of a slide. @@ -182833,17 +184284,81 @@ declare namespace PowerPoint { /** * The desired height of the resulting image in pixels. * - * @remarks - * [Api set: PowerPointApi 1.8] + * @remarks + * [Api set: PowerPointApi 1.8] + */ + height?: number; + /** + * The desired width of the resulting image in pixels. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + width?: number; + } + /** + * Represents the background of a slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + class SlideLayoutBackground extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the fill formatting of the background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + readonly fill: PowerPoint.SlideBackgroundFill; + /** + * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + areBackgroundGraphicsHidden: boolean; + /** + * Specifies if the slide layout background follows the slide master background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + isMasterBackgroundFollowed: boolean; + /** + * Resets the fill formatting of the slide layout background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + reset(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions): PowerPoint.SlideLayoutBackground; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - height?: number; + load(propertyNames?: string | string[]): PowerPoint.SlideLayoutBackground; /** - * The desired width of the resulting image in pixels. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: PowerPointApi 1.8] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - width?: number; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.SlideLayoutBackground; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideLayoutBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutBackgroundData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.SlideLayoutBackgroundData; } /** * Specifies the type of a slide layout. @@ -183075,6 +184590,155 @@ declare namespace PowerPoint { */ verticalTitleAndTextOverChart = "VerticalTitleAndTextOverChart", } + /** + * Specifies the theme colors used in PowerPoint. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + enum ThemeColor { + /** + * Specifies a mixed theme color. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + mixed = "Mixed", + /** + * Specifies no theme color. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + none = "None", + /** + * Specifies the Accent 1 theme color. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + accent1 = "Accent1", + /** + * Specifies the Accent 2 theme color. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + accent2 = "Accent2", + /** + * Specifies the Accent 3 theme color. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + accent3 = "Accent3", + /** + * Specifies the Accent 4 theme color. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + accent4 = "Accent4", + /** + * Specifies the Accent 5 theme color. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + accent5 = "Accent5", + /** + * Specifies the Accent 6 theme color. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + accent6 = "Accent6", + /** + * Specifies the Dark 1 theme color. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + dark1 = "Dark1", + /** + * Specifies the Dark 2 theme color. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + dark2 = "Dark2", + /** + * Specifies the clicked hyperlink theme color. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + followedHyperlink = "FollowedHyperlink", + /** + * Specifies the hyperlink theme color. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + hyperlink = "Hyperlink", + /** + * Specifies the Light 1 theme color. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + light1 = "Light1", + /** + * Specifies the Light 2 theme color. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + light2 = "Light2", + } + /** + * Represents a theme color scheme. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + class ThemeColorScheme extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the color value for the specified `ThemeColor`. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * + * @param color The theme color. + * @returns The color value in #RRGGBB format (e.g., "FFA500"). + */ + getThemeColor(color: PowerPoint.ThemeColor): OfficeExtension.ClientResult; + /** + * Gets the color value for the specified `ThemeColor`. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * + * @param color The theme color. + * @returns The color value in #RRGGBB format (e.g., "FFA500"). + */ + getThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2"): OfficeExtension.ClientResult; + /** + * Sets the color value for the specified `ThemeColor`. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * + * @param color The theme color. + * @param rgbColor The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + */ + setThemeColor(color: PowerPoint.ThemeColor, rgbColor: string): void; + /** + * Sets the color value for the specified `ThemeColor`. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * + * @param color The theme color. + * @param rgbColor The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange"). + */ + setThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2", rgbColor: string): void; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ThemeColorScheme` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ThemeColorSchemeData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } /** * Represents the layout of a slide. * @@ -183084,6 +184748,13 @@ declare namespace PowerPoint { class SlideLayout extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** + * Gets the background of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + readonly background: PowerPoint.SlideLayoutBackground; /** * Returns a collection of custom XML parts in the slide layout. * @@ -183098,6 +184769,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.3] */ readonly shapes: PowerPoint.ShapeCollection; + /** + * Returns the `ThemeColorScheme` of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + readonly themeColorScheme: PowerPoint.ThemeColorScheme; /** * Gets the unique ID of the slide layout. * @@ -183141,9 +184819,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.SlideLayout; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideLayout` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideLayout` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.SlideLayoutData; } /** @@ -183215,11 +184893,54 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideLayoutCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideLayoutCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData; } + /** + * Represents the background of a slide master. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + class SlideMasterBackground extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the fill formatting of the background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + readonly fill: PowerPoint.SlideBackgroundFill; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions): PowerPoint.SlideMasterBackground; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.SlideMasterBackground; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.SlideMasterBackground; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideMasterBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterBackgroundData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.SlideMasterBackgroundData; + } /** * Represents the Slide Master of a slide. * @@ -183229,6 +184950,13 @@ declare namespace PowerPoint { class SlideMaster extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** + * Gets the background of the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + readonly background: PowerPoint.SlideMasterBackground; /** * Returns a collection of custom XML parts in the Slide Master. * @@ -183250,6 +184978,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.3] */ readonly shapes: PowerPoint.ShapeCollection; + /** + * Returns the `ThemeColorScheme` of the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + readonly themeColorScheme: PowerPoint.ThemeColorScheme; /** * Gets the unique ID of the Slide Master. * @@ -183286,9 +185021,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.SlideMaster; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideMaster` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideMaster` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.SlideMasterData; } /** @@ -183336,9 +185071,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.Tag; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Tag` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Tag` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.TagData; } /** @@ -183428,9 +185163,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TagCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.TagCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.TagCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.TagCollectionData; } /** @@ -183442,6 +185177,13 @@ declare namespace PowerPoint { class Slide extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** + * Gets the background of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + readonly background: PowerPoint.SlideBackground; /** * Returns a collection of custom XML parts in the slide. * @@ -183484,6 +185226,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.3] */ readonly tags: PowerPoint.TagCollection; + /** + * Returns the `ThemeColorScheme` of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + readonly themeColorScheme: PowerPoint.ThemeColorScheme; /** * Gets the unique ID of the slide. * @@ -183575,11 +185324,59 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.Slide; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Slide` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Slide` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.SlideData; } + /** + * Represents the format of an image. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + enum ShapeGetImageFormatType { + /** + * The picture is in PNG format. + * @remarks + * [Api set: PowerPointApi 1.10] + */ + png = "Png", + } + /** + * Represents the available options when getting an image of a shape. + The image is scaled to fit into the desired dimensions. If width and height aren't specified, the true size of the shape is used. + If only one of either width or height is specified, the other will be calculated to preserve aspect ratio. + The resulting dimensions will automatically be clamped to the maximum supported size if too large. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface ShapeGetImageOptions { + /** + * The desired format of the resulting image. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + format?: PowerPoint.ShapeGetImageFormatType | "Png"; + /** + * The desired height of the resulting image in pixels. This value will automatically be clamped to the maximum supported size if too large. + Throws an `InvalidArgument` exception when set with a non-positive integer. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + height?: number; + /** + * The desired width of the resulting image in pixels. This value will automatically be clamped to the maximum supported size if too large. + Throws an `InvalidArgument` exception when set with a non-positive integer. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + width?: number; + } /** * Represents a collection of shapes. * @@ -183657,9 +185454,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeScopedCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.ShapeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ShapeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData; } /** @@ -183685,6 +185482,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.8] */ readonly shapes: PowerPoint.ShapeScopedCollection; + /** + * Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + readonly creationId: string | null; /** * Gets the unique ID of the shape group. * @@ -183837,9 +185641,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.ShapeLineFormat; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.ShapeLineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeLineFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.ShapeLineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeLineFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.ShapeLineFormatData; } /** @@ -183883,6 +185687,13 @@ declare namespace PowerPoint { class Shape extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** + * Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + readonly adjustments: PowerPoint.Adjustments; /** * Returns a collection of custom XML parts in the shape. * @@ -183942,6 +185753,34 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ readonly textFrame: PowerPoint.TextFrame; + /** + * The alt text description of the Shape. + + Alt text provides alternative, text-based representations of the information contained in the Shape. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + altTextDescription: string; + /** + * The alt text title of the Shape. + + Alt text provides alternative, text-based representations of the information contained in the Shape. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. + A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + altTextTitle: string; + /** + * Gets the creation ID of the shape. Returns `null` if the shape has no creation ID. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + readonly creationId: string | null; /** * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. * @@ -183956,6 +185795,16 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.3] */ readonly id: string; + /** + * Represents whether the shape is decorative or not. + + Decorative objects add visual interest but aren't informative (e.g. stylistic borders). + People using screen readers will hear these are decorative so they know they aren't missing any important information. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + isDecorative: boolean; /** * The distance, in points, from the left side of the shape to the left side of the slide. * @@ -183983,6 +185832,14 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ name: string; + /** + * Specifies the rotation, in degrees, of the shape around the z-axis. + A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + rotation: number; /** * The distance, in points, from the top edge of the shape to the top edge of the slide. * @@ -183997,6 +185854,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox"; + /** + * Specifies if the shape is visible. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + visible: boolean; /** * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. * @@ -184019,6 +185883,16 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.3] */ delete(): void; + /** + * Renders an image of the shape. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * + * @param options Optional. Options to specify the desired output image properties. + * @returns A Base64-encoded string of the shape image in the specified format. + */ + getImageAsBase64(options?: PowerPoint.ShapeGetImageOptions): OfficeExtension.ClientResult; /** * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `Slide`. * @@ -184068,6 +185942,24 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.8] */ getTable(): PowerPoint.Table; + /** + * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. If the shape doesn't support a `TextFrame`, an object with an `isNullObject` property set to `true` is returned. + For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + getTextFrameOrNullObject(): PowerPoint.TextFrame; + /** + * Sets a hyperlink on this `Shape` with the specified options. This will delete any existing hyperlink on this `Shape`. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * + * @param options Optional. The options for the hyperlink. + * @returns The newly created {@link PowerPoint.Hyperlink} object. + */ + setHyperlink(options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink; /** * Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes. * @@ -184108,9 +186000,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.Shape; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.ShapeData; } /** @@ -184383,9 +186275,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.CustomProperty; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.CustomPropertyData; } /** @@ -184436,6 +186328,17 @@ declare namespace PowerPoint { * Keys have a maximum length of 255 characters. If the argument exceeds 255 characters, then this method returns the `InvalidArgument` error. */ getItem(key: string): PowerPoint.CustomProperty; + /** + * Gets a `CustomProperty` by its zero-based index in the collection. + Throws an `InvalidArgument` exception when the index is out of range. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * + * @param index The index of the custom property in the collection. + * @returns The custom property at the given index. + */ + getItemAt(index: number): PowerPoint.CustomProperty; /** * Gets a `CustomProperty` by its key. If the `CustomProperty` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. @@ -184467,9 +186370,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomPropertyCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData; } /** @@ -184587,9 +186490,9 @@ declare namespace PowerPoint { expand?: string; }): PowerPoint.DocumentProperties; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): PowerPoint.Interfaces.DocumentPropertiesData; } /** @@ -184647,6 +186550,56 @@ declare namespace PowerPoint { */ targetSlideId?: string; } + /** + * Represents the page setup information for the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + class PageSetup extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the height of the slides in the presentation, in points. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + slideHeight: number; + /** + * Specifies the width of the slides in the presentation, in points. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + slideWidth: number; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: PowerPoint.Interfaces.PageSetupLoadOptions): PowerPoint.PageSetup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): PowerPoint.PageSetup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): PowerPoint.PageSetup; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): PowerPoint.Interfaces.PageSetupData; + } /** * Represents the collection of slides in the presentation. * @@ -184667,6 +186620,17 @@ declare namespace PowerPoint { * @param options Optional. Options for configuring the properties of the new slide. */ add(options?: PowerPoint.AddSlideOptions): void; + /** + * Exports one or more slides found in this collection to their own presentation file, returned as Base64-encoded data. + Throws an `InvalidArgument` exception if provided slide IDs or `Slide` objects are not found in this collection. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * + * @param values An array of slide IDs or `Slide` objects. + * @returns A Base64-encoded string. + */ + exportAsBase64Presentation(values: Array): OfficeExtension.ClientResult; /** * Gets the number of slides in the collection. * @@ -184726,9 +186690,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.SlideCollectionData; } /** @@ -184742,6 +186706,14 @@ declare namespace PowerPoint { context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: PowerPoint.Slide[]; + /** + * Exports all slides in this collection to their own presentation file, returned as Base64-encoded data. + * + * @remarks + * [Api set: PowerPointApi 1.10] + * @returns A Base64-encoded string. + */ + exportAsBase64Presentation(): OfficeExtension.ClientResult; /** * Gets the number of slides in the collection. * @@ -184800,9 +186772,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideScopedCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.SlideScopedCollectionData; } /** @@ -184874,9 +186846,9 @@ declare namespace PowerPoint { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideMasterCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `PowerPoint.SlideMasterCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `PowerPoint.SlideMasterCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): PowerPoint.Interfaces.SlideMasterCollectionData; } enum ErrorCodes { @@ -184904,8 +186876,28 @@ declare namespace PowerPoint { interface CustomXmlPartCollectionUpdateData { items?: PowerPoint.Interfaces.CustomXmlPartData[]; } + /** An interface for updating data on the `HyperlinkScopedCollection` object, for use in `hyperlinkScopedCollection.set({ ... })`. */ + interface HyperlinkScopedCollectionUpdateData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } /** An interface for updating data on the `BulletFormat` object, for use in `bulletFormat.set({ ... })`. */ interface BulletFormatUpdateData { + /** + * Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details. + Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null; + /** + * Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details. + Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null; /** * Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values. * @@ -184923,17 +186915,24 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null; + /** + * Represents the indent level of the paragraph. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + indentLevel?: number; } /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */ interface ShapeFontUpdateData { /** * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - `true`: All the text has the **All Caps** attribute. + - `true`: All the text has the **All Caps** attribute. - - `false`: None of the text has the **All Caps** attribute. + - `false`: None of the text has the **All Caps** attribute. - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -184942,11 +186941,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: - - `true`: All the text is bold. + - `true`: All the text is bold. - - `false`: None of the text is bold. + - `false`: None of the text is bold. - - `null`: Returned if some, but not all, of the text is bold. + - `null`: Returned if some, but not all, of the text is bold. * * @remarks * [Api set: PowerPointApi 1.4] @@ -184962,11 +186961,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows: - - `true`: All the text has the **Double strikethrough** attribute. + - `true`: All the text has the **Double strikethrough** attribute. - - `false`: None of the text has the **Double strikethrough** attribute. + - `false`: None of the text has the **Double strikethrough** attribute. - - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. + - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -184975,11 +186974,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: - - `true`: All the text is italicized. + - `true`: All the text is italicized. - - `false`: None of the text is italicized. + - `false`: None of the text is italicized. - - `null`: Returned if some, but not all, of the text is italicized. + - `null`: Returned if some, but not all, of the text is italicized. * * @remarks * [Api set: PowerPointApi 1.4] @@ -185002,11 +187001,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - `true`: All the text has the **Small Caps** attribute. + - `true`: All the text has the **Small Caps** attribute. - - `false`: None of the text has the **Small Caps** attribute. + - `false`: None of the text has the **Small Caps** attribute. - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -185015,11 +187014,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows: - - `true`: All the text has the **Strikethrough** attribute. + - `true`: All the text has the **Strikethrough** attribute. - - `false`: None of the text has the **Strikethrough** attribute. + - `false`: None of the text has the **Strikethrough** attribute. - - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. + - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -185028,11 +187027,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows: - - `true`: All the text has the **Subscript** attribute. + - `true`: All the text has the **Subscript** attribute. - - `false`: None of the text has the **Subscript** attribute. + - `false`: None of the text has the **Subscript** attribute. - - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. + - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -185041,11 +187040,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows: - - `true`: All the text has the **Superscript** attribute. + - `true`: All the text has the **Superscript** attribute. - - `false`: None of the text has the **Superscript** attribute. + - `false`: None of the text has the **Superscript** attribute. - - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. + - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -185364,6 +187363,101 @@ declare namespace PowerPoint { interface ShapeCollectionUpdateData { items?: PowerPoint.Interfaces.ShapeData[]; } + /** An interface for updating data on the `SlideBackgroundGradientFill` object, for use in `slideBackgroundGradientFill.set({ ... })`. */ + interface SlideBackgroundGradientFillUpdateData { + /** + * Specifies the type of gradient fill. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle"; + } + /** An interface for updating data on the `SlideBackgroundPatternFill` object, for use in `slideBackgroundPatternFill.set({ ... })`. */ + interface SlideBackgroundPatternFillUpdateData { + /** + * Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white"). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + backgroundColor?: string; + /** + * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + foregroundColor?: string; + /** + * Specifies the pattern type. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag"; + } + /** An interface for updating data on the `SlideBackgroundPictureOrTextureFill` object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`. */ + interface SlideBackgroundPictureOrTextureFillUpdateData { + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + transparency?: number; + } + /** An interface for updating data on the `SlideBackgroundSolidFill` object, for use in `slideBackgroundSolidFill.set({ ... })`. */ + interface SlideBackgroundSolidFillUpdateData { + /** + * Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + color?: string; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + transparency?: number; + } + /** An interface for updating data on the `SlideBackground` object, for use in `slideBackground.set({ ... })`. */ + interface SlideBackgroundUpdateData { + /** + * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + areBackgroundGraphicsHidden?: boolean; + /** + * Specifies if the slide background follows the slide master background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + isMasterBackgroundFollowed?: boolean; + } + /** An interface for updating data on the `SlideLayoutBackground` object, for use in `slideLayoutBackground.set({ ... })`. */ + interface SlideLayoutBackgroundUpdateData { + /** + * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + areBackgroundGraphicsHidden?: boolean; + /** + * Specifies if the slide layout background follows the slide master background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + isMasterBackgroundFollowed?: boolean; + } /** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */ interface SlideLayoutCollectionUpdateData { items?: PowerPoint.Interfaces.SlideLayoutData[]; @@ -185433,6 +187527,27 @@ declare namespace PowerPoint { } /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ interface ShapeUpdateData { + /** + * The alt text description of the Shape. + + Alt text provides alternative, text-based representations of the information contained in the Shape. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + altTextDescription?: string; + /** + * The alt text title of the Shape. + + Alt text provides alternative, text-based representations of the information contained in the Shape. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. + A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + altTextTitle?: string; /** * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. * @@ -185440,6 +187555,16 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ height?: number; + /** + * Represents whether the shape is decorative or not. + + Decorative objects add visual interest but aren't informative (e.g. stylistic borders). + People using screen readers will hear these are decorative so they know they aren't missing any important information. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + isDecorative?: boolean; /** * The distance, in points, from the left side of the shape to the left side of the slide. * @@ -185454,6 +187579,14 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ name?: string; + /** + * Specifies the rotation, in degrees, of the shape around the z-axis. + A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + rotation?: number; /** * The distance, in points, from the top edge of the shape to the top edge of the slide. * @@ -185461,6 +187594,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ top?: number; + /** + * Specifies if the shape is visible. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + visible?: boolean; /** * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. * @@ -185554,6 +187694,23 @@ declare namespace PowerPoint { */ title?: string; } + /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */ + interface PageSetupUpdateData { + /** + * Specifies the height of the slides in the presentation, in points. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + slideHeight?: number; + /** + * Specifies the width of the slides in the presentation, in points. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + slideWidth?: number; + } /** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */ interface SlideCollectionUpdateData { items?: PowerPoint.Interfaces.SlideData[]; @@ -185583,6 +187740,16 @@ declare namespace PowerPoint { */ title?: string; } + /** An interface describing the data returned by calling `adjustments.toJSON()`. */ + interface AdjustmentsData { + /** + * Specifies the number of adjustment points. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + count?: number; + } /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ interface CustomXmlPartData { /** @@ -185608,8 +187775,28 @@ declare namespace PowerPoint { interface CustomXmlPartCollectionData { items?: PowerPoint.Interfaces.CustomXmlPartData[]; } + /** An interface describing the data returned by calling `hyperlinkScopedCollection.toJSON()`. */ + interface HyperlinkScopedCollectionData { + items?: PowerPoint.Interfaces.HyperlinkData[]; + } /** An interface describing the data returned by calling `bulletFormat.toJSON()`. */ interface BulletFormatData { + /** + * Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details. + Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null; + /** + * Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details. + Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null; /** * Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values. * @@ -185627,17 +187814,24 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null; + /** + * Represents the indent level of the paragraph. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + indentLevel?: number; } /** An interface describing the data returned by calling `shapeFont.toJSON()`. */ interface ShapeFontData { /** * Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - `true`: All the text has the **All Caps** attribute. + - `true`: All the text has the **All Caps** attribute. - - `false`: None of the text has the **All Caps** attribute. + - `false`: None of the text has the **All Caps** attribute. - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -185646,11 +187840,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows: - - `true`: All the text is bold. + - `true`: All the text is bold. - - `false`: None of the text is bold. + - `false`: None of the text is bold. - - `null`: Returned if some, but not all, of the text is bold. + - `null`: Returned if some, but not all, of the text is bold. * * @remarks * [Api set: PowerPointApi 1.4] @@ -185666,11 +187860,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute. The possible values are as follows: - - `true`: All the text has the **Double strikethrough** attribute. + - `true`: All the text has the **Double strikethrough** attribute. - - `false`: None of the text has the **Double strikethrough** attribute. + - `false`: None of the text has the **Double strikethrough** attribute. - - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. + - `null`: Returned if some, but not all, of the text has the **Double strikethrough** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -185679,11 +187873,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows: - - `true`: All the text is italicized. + - `true`: All the text is italicized. - - `false`: None of the text is italicized. + - `false`: None of the text is italicized. - - `null`: Returned if some, but not all, of the text is italicized. + - `null`: Returned if some, but not all, of the text is italicized. * * @remarks * [Api set: PowerPointApi 1.4] @@ -185706,11 +187900,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - `true`: All the text has the **Small Caps** attribute. + - `true`: All the text has the **Small Caps** attribute. - - `false`: None of the text has the **Small Caps** attribute. + - `false`: None of the text has the **Small Caps** attribute. - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -185719,11 +187913,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute. The possible values are as follows: - - `true`: All the text has the **Strikethrough** attribute. + - `true`: All the text has the **Strikethrough** attribute. - - `false`: None of the text has the **Strikethrough** attribute. + - `false`: None of the text has the **Strikethrough** attribute. - - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. + - `null`: Returned if some, but not all, of the text has the **Strikethrough** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -185732,11 +187926,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute. The possible values are as follows: - - `true`: All the text has the **Subscript** attribute. + - `true`: All the text has the **Subscript** attribute. - - `false`: None of the text has the **Subscript** attribute. + - `false`: None of the text has the **Subscript** attribute. - - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. + - `null`: Returned if some, but not all, of the text has the **Subscript** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -185745,11 +187939,11 @@ declare namespace PowerPoint { /** * Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows: - - `true`: All the text has the **Superscript** attribute. + - `true`: All the text has the **Superscript** attribute. - - `false`: None of the text has the **Superscript** attribute. + - `false`: None of the text has the **Superscript** attribute. - - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. + - `null`: Returned if some, but not all, of the text has the **Superscript** attribute. * * @remarks * [Api set: PowerPointApi 1.8] @@ -185864,6 +188058,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.6] */ screenTip?: string; + /** + * Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + type?: PowerPoint.HyperlinkType | "TextRange" | "Shape"; } /** An interface describing the data returned by calling `placeholderFormat.toJSON()`. */ interface PlaceholderFormatData { @@ -186178,6 +188379,111 @@ declare namespace PowerPoint { interface ShapeCollectionData { items?: PowerPoint.Interfaces.ShapeData[]; } + /** An interface describing the data returned by calling `slideBackgroundGradientFill.toJSON()`. */ + interface SlideBackgroundGradientFillData { + /** + * Specifies the type of gradient fill. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle"; + } + /** An interface describing the data returned by calling `slideBackgroundPatternFill.toJSON()`. */ + interface SlideBackgroundPatternFillData { + /** + * Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white"). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + backgroundColor?: string; + /** + * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + foregroundColor?: string; + /** + * Specifies the pattern type. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag"; + } + /** An interface describing the data returned by calling `slideBackgroundPictureOrTextureFill.toJSON()`. */ + interface SlideBackgroundPictureOrTextureFillData { + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + transparency?: number; + } + /** An interface describing the data returned by calling `slideBackgroundSolidFill.toJSON()`. */ + interface SlideBackgroundSolidFillData { + /** + * Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + color?: string; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + transparency?: number; + } + /** An interface describing the data returned by calling `slideBackgroundFill.toJSON()`. */ + interface SlideBackgroundFillData { + /** + * Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + type?: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern"; + } + /** An interface describing the data returned by calling `slideBackground.toJSON()`. */ + interface SlideBackgroundData { + /** + * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + areBackgroundGraphicsHidden?: boolean; + /** + * Specifies if the slide background follows the slide master background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + isMasterBackgroundFollowed?: boolean; + } + /** An interface describing the data returned by calling `slideLayoutBackground.toJSON()`. */ + interface SlideLayoutBackgroundData { + /** + * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + areBackgroundGraphicsHidden?: boolean; + /** + * Specifies if the slide layout background follows the slide master background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + isMasterBackgroundFollowed?: boolean; + } /** An interface describing the data returned by calling `slideLayout.toJSON()`. */ interface SlideLayoutData { /** @@ -186206,6 +188512,9 @@ declare namespace PowerPoint { interface SlideLayoutCollectionData { items?: PowerPoint.Interfaces.SlideLayoutData[]; } + /** An interface describing the data returned by calling `slideMasterBackground.toJSON()`. */ + interface SlideMasterBackgroundData { + } /** An interface describing the data returned by calling `slideMaster.toJSON()`. */ interface SlideMasterData { /** @@ -186267,6 +188576,13 @@ declare namespace PowerPoint { } /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ interface ShapeGroupData { + /** + * Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + creationId?: string | null; /** * Gets the unique ID of the shape group. * @@ -186322,6 +188638,34 @@ declare namespace PowerPoint { } /** An interface describing the data returned by calling `shape.toJSON()`. */ interface ShapeData { + /** + * The alt text description of the Shape. + + Alt text provides alternative, text-based representations of the information contained in the Shape. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + altTextDescription?: string; + /** + * The alt text title of the Shape. + + Alt text provides alternative, text-based representations of the information contained in the Shape. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. + A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + altTextTitle?: string; + /** + * Gets the creation ID of the shape. Returns `null` if the shape has no creation ID. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + creationId?: string | null; /** * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. * @@ -186336,6 +188680,16 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.3] */ id?: string; + /** + * Represents whether the shape is decorative or not. + + Decorative objects add visual interest but aren't informative (e.g. stylistic borders). + People using screen readers will hear these are decorative so they know they aren't missing any important information. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + isDecorative?: boolean; /** * The distance, in points, from the left side of the shape to the left side of the slide. * @@ -186363,6 +188717,14 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ name?: string; + /** + * Specifies the rotation, in degrees, of the shape around the z-axis. + A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + rotation?: number; /** * The distance, in points, from the top edge of the shape to the top edge of the slide. * @@ -186377,6 +188739,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox"; + /** + * Specifies if the shape is visible. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + visible?: boolean; /** * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. * @@ -186523,6 +188892,23 @@ declare namespace PowerPoint { */ title?: string; } + /** An interface describing the data returned by calling `pageSetup.toJSON()`. */ + interface PageSetupData { + /** + * Specifies the height of the slides in the presentation, in points. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + slideHeight?: number; + /** + * Specifies the width of the slides in the presentation, in points. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + slideWidth?: number; + } /** An interface describing the data returned by calling `slideCollection.toJSON()`. */ interface SlideCollectionData { items?: PowerPoint.Interfaces.SlideData[]; @@ -186549,11 +188935,18 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Gets the properties of the presentation. - * - * @remarks - * [Api set: PowerPointApi 1.7] - */ + * Returns the page setup information whose properties control slide setup attributes for the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + pageSetup?: PowerPoint.Interfaces.PageSetupLoadOptions; + /** + * Gets the properties of the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.7] + */ properties?: PowerPoint.Interfaces.DocumentPropertiesLoadOptions; /** * Gets the ID of the presentation. @@ -186570,6 +188963,25 @@ declare namespace PowerPoint { */ title?: boolean; } + /** + * Represents the adjustment values for a shape. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface AdjustmentsLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the number of adjustment points. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + count?: boolean; + } /** * Represents a custom XML part object. * @@ -186650,6 +189062,39 @@ declare namespace PowerPoint { */ namespaceUri?: boolean; } + /** + * Represents a scoped collection of hyperlinks. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface HyperlinkScopedCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Specifies the address of the hyperlink, which can be a URL, a file name or file path, or an email address with the `mailto` URI scheme. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + address?: boolean; + /** + * For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink. + * + * @remarks + * [Api set: PowerPointApi 1.6] + */ + screenTip?: boolean; + /** + * For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + type?: boolean; + } /** * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}. * @@ -186661,6 +189106,22 @@ declare namespace PowerPoint { Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ $all?: boolean; + /** + * Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details. + Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + style?: boolean; + /** + * Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details. + Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + type?: boolean; /** * Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values. * @@ -186694,6 +189155,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ horizontalAlignment?: boolean; + /** + * Represents the indent level of the paragraph. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + indentLevel?: boolean; } /** * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object. @@ -186988,6 +189456,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.6] */ screenTip?: boolean; + /** + * Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + type?: boolean; } /** * Represents the properties of a `placeholder` shape. @@ -187041,6 +189516,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.6] */ screenTip?: boolean; + /** + * For EACH ITEM in the collection: Returns the type of object that the hyperlink is applied to. See {@link PowerPoint.HyperlinkType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + type?: boolean; } /** * Represents the properties for a table cell border. @@ -187094,46 +189576,46 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Gets the bottom border. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the bottom border. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ bottom?: PowerPoint.Interfaces.BorderLoadOptions; /** - * Gets the diagonal border (top-left to bottom-right). - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the diagonal border (top-left to bottom-right). + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ diagonalDown?: PowerPoint.Interfaces.BorderLoadOptions; /** - * Gets the diagonal border (bottom-left to top-right). - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the diagonal border (bottom-left to top-right). + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ diagonalUp?: PowerPoint.Interfaces.BorderLoadOptions; /** - * Gets the left border. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the left border. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ left?: PowerPoint.Interfaces.BorderLoadOptions; /** - * Gets the right border. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ - right?: PowerPoint.Interfaces.BorderLoadOptions; - /** - * Gets the top border. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the right border. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ + right?: PowerPoint.Interfaces.BorderLoadOptions; + /** + * Gets the top border. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ top?: PowerPoint.Interfaces.BorderLoadOptions; } /** @@ -187221,32 +189703,32 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Gets the collection of borders for the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the collection of borders for the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ borders?: PowerPoint.Interfaces.BordersLoadOptions; /** - * Gets the fill color of the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the fill color of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; /** - * Gets the font of the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the font of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ font?: PowerPoint.Interfaces.ShapeFontLoadOptions; /** - * Gets the set of margins in the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the set of margins in the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ margins?: PowerPoint.Interfaces.MarginsLoadOptions; /** * Gets the number of table columns this cell spans across. @@ -187327,32 +189809,32 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the collection of borders for the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * For EACH ITEM in the collection: Gets the collection of borders for the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ borders?: PowerPoint.Interfaces.BordersLoadOptions; /** - * For EACH ITEM in the collection: Gets the fill color of the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * For EACH ITEM in the collection: Gets the fill color of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; /** - * For EACH ITEM in the collection: Gets the font of the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * For EACH ITEM in the collection: Gets the font of the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ font?: PowerPoint.Interfaces.ShapeFontLoadOptions; /** - * For EACH ITEM in the collection: Gets the set of margins in the table cell. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * For EACH ITEM in the collection: Gets the set of margins in the table cell. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ margins?: PowerPoint.Interfaces.MarginsLoadOptions; /** * For EACH ITEM in the collection: Gets the number of table columns this cell spans across. @@ -187612,11 +190094,11 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Gets the table style settings. - * - * @remarks - * [Api set: PowerPointApi 1.9] - */ + * Gets the table style settings. + * + * @remarks + * [Api set: PowerPointApi 1.9] + */ styleSettings?: PowerPoint.Interfaces.TableStyleSettingsLoadOptions; /** * Gets the number of columns in the table. @@ -187652,11 +190134,18 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * For EACH ITEM in the collection: Returns the fill formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions; + /** + * For EACH ITEM in the collection: Returns the fill formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; /** * For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape. @@ -187667,11 +190156,11 @@ declare namespace PowerPoint { */ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions; /** - * For EACH ITEM in the collection: Returns the line formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * For EACH ITEM in the collection: Returns the line formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; /** * For EACH ITEM in the collection: Returns the parent group of this shape. @@ -187691,11 +190180,39 @@ declare namespace PowerPoint { placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions; /** * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; + /** + * For EACH ITEM in the collection: The alt text description of the Shape. + + Alt text provides alternative, text-based representations of the information contained in the Shape. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; + altTextDescription?: boolean; + /** + * For EACH ITEM in the collection: The alt text title of the Shape. + + Alt text provides alternative, text-based representations of the information contained in the Shape. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. + A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + altTextTitle?: boolean; + /** + * For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + creationId?: boolean; /** * For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. * @@ -187710,6 +190227,16 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.3] */ id?: boolean; + /** + * For EACH ITEM in the collection: Represents whether the shape is decorative or not. + + Decorative objects add visual interest but aren't informative (e.g. stylistic borders). + People using screen readers will hear these are decorative so they know they aren't missing any important information. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + isDecorative?: boolean; /** * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the slide. * @@ -187737,6 +190264,14 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ name?: boolean; + /** + * For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape around the z-axis. + A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + rotation?: boolean; /** * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the slide. * @@ -187750,22 +190285,211 @@ declare namespace PowerPoint { * @remarks * [Api set: PowerPointApi 1.4] */ - type?: boolean; + type?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the shape is visible. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + visible?: boolean; + /** + * For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + width?: boolean; + /** + * For EACH ITEM in the collection: Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but + each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + zOrderPosition?: boolean; + } + /** + * Represents {@link PowerPoint.SlideBackground} gradient fill properties. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface SlideBackgroundGradientFillLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the type of gradient fill. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + type?: boolean; + } + /** + * Represents {@link PowerPoint.SlideBackground} pattern fill properties. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface SlideBackgroundPatternFillLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white"). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + backgroundColor?: boolean; + /** + * Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + foregroundColor?: boolean; + /** + * Specifies the pattern type. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + pattern?: boolean; + } + /** + * Represents {@link PowerPoint.SlideBackground} picture or texture fill properties. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface SlideBackgroundPictureOrTextureFillLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + transparency?: boolean; + } + /** + * Represents {@link PowerPoint.SlideBackground} solid fill properties. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface SlideBackgroundSolidFillLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange"). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + color?: boolean; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + transparency?: boolean; + } + /** + * Represents the fill formatting of a slide background object. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface SlideBackgroundFillLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + type?: boolean; + } + /** + * Represents a background of a slide. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface SlideBackgroundLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns the fill formatting of the background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions; + /** + * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + areBackgroundGraphicsHidden?: boolean; + /** + * Specifies if the slide background follows the slide master background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + isMasterBackgroundFollowed?: boolean; + } + /** + * Represents the background of a slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface SlideLayoutBackgroundLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; /** - * For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. + * Returns the fill formatting of the background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions; + /** + * Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - width?: boolean; + areBackgroundGraphicsHidden?: boolean; /** - * For EACH ITEM in the collection: Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but - each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number. + * Specifies if the slide layout background follows the slide master background. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - zOrderPosition?: boolean; + isMasterBackgroundFollowed?: boolean; } /** * Represents the layout of a slide. @@ -187778,6 +190502,13 @@ declare namespace PowerPoint { Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ $all?: boolean; + /** + * Gets the background of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions; /** * Gets the unique ID of the slide layout. * @@ -187811,6 +190542,13 @@ declare namespace PowerPoint { Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ $all?: boolean; + /** + * For EACH ITEM in the collection: Gets the background of the slide layout. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions; /** * For EACH ITEM in the collection: Gets the unique ID of the slide layout. * @@ -187833,6 +190571,25 @@ declare namespace PowerPoint { */ type?: boolean; } + /** + * Represents the background of a slide master. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + interface SlideMasterBackgroundLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + */ + $all?: boolean; + /** + * Returns the fill formatting of the background. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions; + } /** * Represents the Slide Master of a slide. * @@ -187844,6 +190601,13 @@ declare namespace PowerPoint { Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ $all?: boolean; + /** + * Gets the background of the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions; /** * Gets the unique ID of the Slide Master. * @@ -187923,6 +190687,13 @@ declare namespace PowerPoint { */ $all?: boolean; /** + * Gets the background of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions; + /** * Gets the layout of the slide. * * @remarks @@ -187963,50 +190734,85 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * For EACH ITEM in the collection: Returns the fill formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.5] - */ + * For EACH ITEM in the collection: Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions; + /** + * For EACH ITEM in the collection: Returns the fill formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; /** - * For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape. + * For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape. If the shape type isn't `group`, then this method returns the `GeneralException` error. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions; /** - * For EACH ITEM in the collection: Returns the line formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.5] - */ + * For EACH ITEM in the collection: Returns the line formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; /** - * For EACH ITEM in the collection: Returns the parent group of this shape. + * For EACH ITEM in the collection: Returns the parent group of this shape. If the shape isn't part of a group, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions; + /** + * For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder. + If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions; + /** + * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ + textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; + /** + * For EACH ITEM in the collection: The alt text description of the Shape. + + Alt text provides alternative, text-based representations of the information contained in the Shape. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions; + altTextDescription?: boolean; /** - * For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder. - If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. + * For EACH ITEM in the collection: The alt text title of the Shape. + + Alt text provides alternative, text-based representations of the information contained in the Shape. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. + A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions; + altTextTitle?: boolean; /** - * For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`. + * For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID. * * @remarks - * [Api set: PowerPointApi 1.5] + * [Api set: PowerPointApi 1.10] */ - textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; + creationId?: boolean; /** * For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. * @@ -188021,6 +190827,16 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.3] */ id?: boolean; + /** + * For EACH ITEM in the collection: Represents whether the shape is decorative or not. + + Decorative objects add visual interest but aren't informative (e.g. stylistic borders). + People using screen readers will hear these are decorative so they know they aren't missing any important information. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + isDecorative?: boolean; /** * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the slide. * @@ -188048,6 +190864,14 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ name?: boolean; + /** + * For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape around the z-axis. + A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + rotation?: boolean; /** * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the slide. * @@ -188062,6 +190886,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ type?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the shape is visible. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + visible?: boolean; /** * For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. * @@ -188096,6 +190927,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.8] */ shape?: PowerPoint.Interfaces.ShapeLoadOptions; + /** + * Gets the creation ID of the shape group. Returns `null` if the shape group has no creation ID. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + creationId?: boolean; /** * Gets the unique ID of the shape group. * @@ -188170,50 +191008,85 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * Returns the fill formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * Returns an `Adjustments` object that contains adjustment values for all the adjustments in this shape. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions; + /** + * Returns the fill formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ fill?: PowerPoint.Interfaces.ShapeFillLoadOptions; /** - * Returns the `ShapeGroup` associated with the shape. + * Returns the `ShapeGroup` associated with the shape. If the shape type isn't `group`, then this method returns the `GeneralException` error. - * - * @remarks - * [Api set: PowerPointApi 1.8] - */ + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions; /** - * Returns the line formatting of this shape. - * - * @remarks - * [Api set: PowerPointApi 1.4] - */ + * Returns the line formatting of this shape. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions; /** - * Returns the parent group of this shape. + * Returns the parent group of this shape. If the shape isn't part of a group, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions; + /** + * Returns the properties that apply specifically to this placeholder. + If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. + * + * @remarks + * [Api set: PowerPointApi 1.8] + */ + placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions; + /** + * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`. + * + * @remarks + * [Api set: PowerPointApi 1.4] + */ + textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; + /** + * The alt text description of the Shape. + + Alt text provides alternative, text-based representations of the information contained in the Shape. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions; + altTextDescription?: boolean; /** - * Returns the properties that apply specifically to this placeholder. - If the shape type isn't `placeholder`, then this method returns the `GeneralException` error. + * The alt text title of the Shape. + + Alt text provides alternative, text-based representations of the information contained in the Shape. + This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. + A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. * * @remarks - * [Api set: PowerPointApi 1.8] + * [Api set: PowerPointApi 1.10] */ - placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions; + altTextTitle?: boolean; /** - * Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`. + * Gets the creation ID of the shape. Returns `null` if the shape has no creation ID. * * @remarks - * [Api set: PowerPointApi 1.4] + * [Api set: PowerPointApi 1.10] */ - textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions; + creationId?: boolean; /** * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. * @@ -188228,6 +191101,16 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.3] */ id?: boolean; + /** + * Represents whether the shape is decorative or not. + + Decorative objects add visual interest but aren't informative (e.g. stylistic borders). + People using screen readers will hear these are decorative so they know they aren't missing any important information. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + isDecorative?: boolean; /** * The distance, in points, from the left side of the shape to the left side of the slide. * @@ -188255,6 +191138,14 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ name?: boolean; + /** + * Specifies the rotation, in degrees, of the shape around the z-axis. + A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + rotation?: boolean; /** * The distance, in points, from the top edge of the shape to the top edge of the slide. * @@ -188269,6 +191160,13 @@ declare namespace PowerPoint { * [Api set: PowerPointApi 1.4] */ type?: boolean; + /** + * Specifies if the shape is visible. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + visible?: boolean; /** * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value. * @@ -188495,29 +191393,62 @@ declare namespace PowerPoint { title?: boolean; } /** - * Represents the collection of slides in the presentation. + * Represents the page setup information for the presentation. * * @remarks - * [Api set: PowerPointApi 1.2] + * [Api set: PowerPointApi 1.10] */ - interface SlideCollectionLoadOptions { + interface PageSetupLoadOptions { /** Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the layout of the slide. + * Specifies the height of the slides in the presentation, in points. * * @remarks - * [Api set: PowerPointApi 1.3] + * [Api set: PowerPointApi 1.10] */ - layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions; + slideHeight?: boolean; /** - * For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content. + * Specifies the width of the slides in the presentation, in points. * * @remarks - * [Api set: PowerPointApi 1.3] + * [Api set: PowerPointApi 1.10] + */ + slideWidth?: boolean; + } + /** + * Represents the collection of slides in the presentation. + * + * @remarks + * [Api set: PowerPointApi 1.2] + */ + interface SlideCollectionLoadOptions { + /** + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ + $all?: boolean; + /** + * For EACH ITEM in the collection: Gets the background of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions; + /** + * For EACH ITEM in the collection: Gets the layout of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ + layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions; + /** + * For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content. + * + * @remarks + * [Api set: PowerPointApi 1.3] + */ slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions; /** * For EACH ITEM in the collection: Gets the unique ID of the slide. @@ -188546,18 +191477,25 @@ declare namespace PowerPoint { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the layout of the slide. - * - * @remarks - * [Api set: PowerPointApi 1.5] - */ + * For EACH ITEM in the collection: Gets the background of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions; + /** + * For EACH ITEM in the collection: Gets the layout of the slide. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions; /** - * For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content. - * - * @remarks - * [Api set: PowerPointApi 1.5] - */ + * For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content. + * + * @remarks + * [Api set: PowerPointApi 1.5] + */ slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions; /** * For EACH ITEM in the collection: Gets the unique ID of the slide. @@ -188585,6 +191523,13 @@ declare namespace PowerPoint { Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ $all?: boolean; + /** + * For EACH ITEM in the collection: Gets the background of the Slide Master. + * + * @remarks + * [Api set: PowerPointApi 1.10] + */ + background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions; /** * For EACH ITEM in the collection: Gets the unique ID of the Slide Master. *