@types/office-js-preview 1.0.586 → 1.0.588

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Wed, 30 Apr 2025 15:35:40 GMT
11
+ * Last updated: Mon, 05 May 2025 20:02:28 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -4613,7 +4613,7 @@ declare namespace Office {
4613
4613
  *
4614
4614
  * @remarks
4615
4615
  *
4616
- * The `contentLanguage` value reflects the **Editing Language** setting specified with **File** \> **Options** \> **Language** in the Office
4616
+ * The `contentLanguage` value reflects the **Editing Language** setting specified with **File** > **Options** > **Language** in the Office
4617
4617
  * application.
4618
4618
  *
4619
4619
  * **Support details**
@@ -4649,7 +4649,7 @@ declare namespace Office {
4649
4649
  *
4650
4650
  * The returned value is a string in the RFC 1766 Language tag format, such as en-US.
4651
4651
  *
4652
- * The `displayLanguage` value reflects the current **Display Language** setting specified with **File** \> **Options** \> **Language** in the Office
4652
+ * The `displayLanguage` value reflects the current **Display Language** setting specified with **File** > **Options** > **Language** in the Office
4653
4653
  * application.
4654
4654
  *
4655
4655
  * When using in Outlook, the applicable modes are Compose or Read.
@@ -7154,7 +7154,7 @@ declare namespace Office {
7154
7154
  * Provides access to the properties for Office theme colors.
7155
7155
  *
7156
7156
  * Using Office theme colors lets you coordinate the color scheme of your add-in with the current Office theme selected by the user.
7157
- * The user sets a theme in an Office application through **File** \> **Account** or **Office Account** \> **Office Theme**.
7157
+ * The user sets a theme in an Office application through **File** > **Account** or **Office Account** > **Office Theme**.
7158
7158
  * The selected theme is then applied across all Office applications. Using Office theme colors is appropriate for mail and
7159
7159
  * task pane add-ins.
7160
7160
  *
@@ -8146,7 +8146,7 @@ declare namespace Office {
8146
8146
  * </table>
8147
8147
  *
8148
8148
  * The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
8149
- * (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** \> **Format** \> **Format Cells**).
8149
+ * (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** > **Format** > **Format Cells**).
8150
8150
  *
8151
8151
  * @param cellReference An object literal containing name-value pairs that specify the range of cells to get formatting from.
8152
8152
  * @param formats An array specifying the format properties to get.
@@ -8200,7 +8200,7 @@ declare namespace Office {
8200
8200
  * </table>
8201
8201
  *
8202
8202
  * The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
8203
- * (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** \> **Format** \> **Format Cells**).
8203
+ * (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** > **Format** > **Format Cells**).
8204
8204
  *
8205
8205
  * @param cellReference An object literal containing name-value pairs that specify the range of cells to get formatting from.
8206
8206
  * @param formats An array specifying the format properties to get.
@@ -8257,7 +8257,7 @@ declare namespace Office {
8257
8257
  * </table>
8258
8258
  *
8259
8259
  * The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
8260
- * (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** \> **Format** \> **Format Cells**).
8260
+ * (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** > **Format** > **Format Cells**).
8261
8261
  *
8262
8262
  * You specify the value of the `format:` property as a list of one or more property name - value pairs in a JavaScript object literal. The
8263
8263
  * property name specifies the name of the formatting property to set, and value specifies the property value.
@@ -8356,7 +8356,7 @@ declare namespace Office {
8356
8356
  * </table>
8357
8357
  *
8358
8358
  * The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
8359
- * (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** \> **Format** \> **Format Cells**).
8359
+ * (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** > **Format** > **Format Cells**).
8360
8360
  *
8361
8361
  * You specify the value of the `format:` property as a list of one or more property name - value pairs in a JavaScript object literal. The
8362
8362
  * property name specifies the name of the formatting property to set, and value specifies the property value.
@@ -133493,6 +133493,7 @@ declare namespace PowerPoint {
133493
133493
  /**
133494
133494
  * Returns the selected {@link PowerPoint.TextRange} in the current view of the presentation.
133495
133495
  If no text is selected, an object with an `isNullObject` property set to `true` is returned.
133496
+ 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}.
133496
133497
  *
133497
133498
  * @remarks
133498
133499
  * [Api set: PowerPointApi 1.5]
@@ -135468,7 +135469,7 @@ declare namespace PowerPoint {
135468
135469
  */
135469
135470
  right = "Right",
135470
135471
  /**
135471
- * Align text so that it is justified across the whole line.
135472
+ * Align text so that it's justified across the whole line.
135472
135473
  * @remarks
135473
135474
  * [Api set: PowerPointApi 1.4]
135474
135475
  */
@@ -135553,7 +135554,7 @@ declare namespace PowerPoint {
135553
135554
  */
135554
135555
  foregroundColor: string;
135555
135556
  /**
135556
- * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
135557
+ * 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.
135557
135558
  *
135558
135559
  * @remarks
135559
135560
  * [Api set: PowerPointApi 1.4]
@@ -136149,7 +136150,7 @@ declare namespace PowerPoint {
136149
136150
  */
136150
136151
  getCount(): OfficeExtension.ClientResult<number>;
136151
136152
  /**
136152
- * Gets the table cell using its zero-based index in the collection. If the `TableCell` does not 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](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties) | *OrNullObject methods and properties}.
136153
+ * 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](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties) | *OrNullObject methods and properties}.
136153
136154
  *
136154
136155
  * @remarks
136155
136156
  * [Api set: PowerPointApi 1.8]
@@ -136439,7 +136440,7 @@ declare namespace PowerPoint {
136439
136440
  *
136440
136441
  * @param rowIndex The zero-based row index of the cell.
136441
136442
  * @param columnIndex The zero-based column index of the cell.
136442
- * @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.
136443
+ * @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}.
136443
136444
  */
136444
136445
  getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell;
136445
136446
  /**
@@ -136496,7 +136497,7 @@ declare namespace PowerPoint {
136496
136497
 
136497
136498
  When a table is being added, for columns whose width is undefined,
136498
136499
  the column width will be calculated by evenly dividing the remaining width
136499
- of the table amongst those columns. If the table does not have a defined width,
136500
+ of the table amongst those columns. If the table doesn't have a defined width,
136500
136501
  a default column width will be used.
136501
136502
  *
136502
136503
  * @remarks
@@ -136554,7 +136555,7 @@ declare namespace PowerPoint {
136554
136555
 
136555
136556
  When a table is being added, for rows whose height is undefined,
136556
136557
  the row height will be calculated by evenly dividing the remaining height
136557
- of the table amongst those rows. If the table does not have a defined height,
136558
+ of the table amongst those rows. If the table doesn't have a defined height,
136558
136559
  a default row height will be used.
136559
136560
  *
136560
136561
  * @remarks
@@ -136580,7 +136581,7 @@ declare namespace PowerPoint {
136580
136581
  columns?: PowerPoint.TableColumnProperties[];
136581
136582
  /**
136582
136583
  * Specifies the height, in points, of the table.
136583
- A default value is used when this parameter is not provided.
136584
+ A default value is used when this parameter isn't provided.
136584
136585
  Throws an `InvalidArgument` exception when set with a negative value.
136585
136586
  *
136586
136587
  * @remarks
@@ -136589,7 +136590,7 @@ declare namespace PowerPoint {
136589
136590
  height?: number | undefined;
136590
136591
  /**
136591
136592
  * Specifies the distance, in points, from the left side of the table to the left side of the slide.
136592
- The table is centered horizontally when this parameter is not provided.
136593
+ The table is centered horizontally when this parameter isn't provided.
136593
136594
  *
136594
136595
  * @remarks
136595
136596
  * [Api set: PowerPointApi 1.8]
@@ -136615,7 +136616,7 @@ declare namespace PowerPoint {
136615
136616
  * If provided, specifies properties for each cell in the table.
136616
136617
 
136617
136618
  This should be an 2D array with the same number of rows and columns as the table.
136618
- If a cell does not require specific formatting, specify an empty object for that cell.
136619
+ If a cell doesn't require specific formatting, specify an empty object for that cell.
136619
136620
  Only the top left cell of a merged are can have properties specified, which will be applied
136620
136621
  to the entire merged area. For the other cells in the merged area, an empty object should be provided.
136621
136622
  *
@@ -136625,7 +136626,7 @@ declare namespace PowerPoint {
136625
136626
  specificCellProperties?: PowerPoint.TableCellProperties[][];
136626
136627
  /**
136627
136628
  * Specifies the distance, in points, from the top edge of the table to the top edge of the slide.
136628
- A default value is used when this parameter is not provided.
136629
+ A default value is used when this parameter isn't provided.
136629
136630
  *
136630
136631
  * @remarks
136631
136632
  * [Api set: PowerPointApi 1.8]
@@ -136641,7 +136642,7 @@ declare namespace PowerPoint {
136641
136642
  appearance as when the user adds a table through the PowerPoint UI.
136642
136643
 
136643
136644
  To provide a plain appearance for the table, set this property to an empty object
136644
- and do not specify specificCellProperties.
136645
+ and don't specify specificCellProperties.
136645
136646
  *
136646
136647
  * @remarks
136647
136648
  * [Api set: PowerPointApi 1.8]
@@ -136661,7 +136662,7 @@ declare namespace PowerPoint {
136661
136662
  values?: string[][];
136662
136663
  /**
136663
136664
  * Specifies the width, in points, of the table.
136664
- A default value is used when this parameter is not provided.
136665
+ A default value is used when this parameter isn't provided.
136665
136666
  Throws an `InvalidArgument` exception when set with a negative value.
136666
136667
  *
136667
136668
  * @remarks
@@ -136767,13 +136768,13 @@ declare namespace PowerPoint {
136767
136768
  */
136768
136769
  getCount(): OfficeExtension.ClientResult<number>;
136769
136770
  /**
136770
- * Gets a shape using its unique ID. An error is thrown if the shape does not exist.
136771
+ * Gets a shape using its unique ID. An error is thrown if the shape doesn't exist.
136771
136772
  *
136772
136773
  * @remarks
136773
136774
  * [Api set: PowerPointApi 1.3]
136774
136775
  *
136775
136776
  * @param key The ID of the shape.
136776
- * @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
136777
+ * @returns The shape with the unique ID. If such a shape doesn't exist, an error is thrown.
136777
136778
  */
136778
136779
  getItem(key: string): PowerPoint.Shape;
136779
136780
  /**
@@ -136787,13 +136788,13 @@ declare namespace PowerPoint {
136787
136788
  */
136788
136789
  getItemAt(index: number): PowerPoint.Shape;
136789
136790
  /**
136790
- * Gets a shape using its unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
136791
+ * 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}.
136791
136792
  *
136792
136793
  * @remarks
136793
136794
  * [Api set: PowerPointApi 1.3]
136794
136795
  *
136795
136796
  * @param id The ID of the shape.
136796
- * @returns The shape with the unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
136797
+ * @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.
136797
136798
  */
136798
136799
  getItemOrNullObject(id: string): PowerPoint.Shape;
136799
136800
  /**
@@ -137169,7 +137170,7 @@ declare namespace PowerPoint {
137169
137170
  * [Api set: PowerPointApi 1.3]
137170
137171
  *
137171
137172
  * @param key The ID of the layout.
137172
- * @returns The layout with the unique ID. If such a layout does not exist, an error is thrown.
137173
+ * @returns The layout with the unique ID. If such a layout doesn't exist, an error is thrown.
137173
137174
  */
137174
137175
  getItem(key: string): PowerPoint.SlideLayout;
137175
137176
  /**
@@ -137183,7 +137184,7 @@ declare namespace PowerPoint {
137183
137184
  */
137184
137185
  getItemAt(index: number): PowerPoint.SlideLayout;
137185
137186
  /**
137186
- * Gets a layout using its unique ID. If such a layout does not exist, an object with an `isNullObject` property set to true is returned. For further information,
137187
+ * Gets a layout using its unique ID. If such a layout doesn't exist, an object with an `isNullObject` property set to true is returned. For further information,
137187
137188
  see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
137188
137189
  *
137189
137190
  * @remarks
@@ -137355,12 +137356,12 @@ declare namespace PowerPoint {
137355
137356
  * @remarks
137356
137357
  * [Api set: PowerPointApi 1.3]
137357
137358
  *
137358
- * @param key The unique ID of a tag, which is unique within this `TagCollection`. 'key' parameter is case-insensitive, but it is always capitalized when saved in the document.
137359
+ * @param key The unique ID of a tag, which is unique within this `TagCollection`. 'key' parameter is case-insensitive, but it's always capitalized when saved in the document.
137359
137360
  * @param value The value of the tag.
137360
137361
  */
137361
137362
  add(key: string, value: string): void;
137362
137363
  /**
137363
- * Deletes the tag with the given `key` in this collection. Does nothing if the `key` does not exist.
137364
+ * Deletes the tag with the given `key` in this collection. Does nothing if the `key` doesn't exist.
137364
137365
  *
137365
137366
  * @remarks
137366
137367
  * [Api set: PowerPointApi 1.3]
@@ -137377,13 +137378,13 @@ declare namespace PowerPoint {
137377
137378
  */
137378
137379
  getCount(): OfficeExtension.ClientResult<number>;
137379
137380
  /**
137380
- * Gets a tag using its unique ID. An error is thrown if the tag does not exist.
137381
+ * Gets a tag using its unique ID. An error is thrown if the tag doesn't exist.
137381
137382
  *
137382
137383
  * @remarks
137383
137384
  * [Api set: PowerPointApi 1.3]
137384
137385
  *
137385
137386
  * @param key The ID of the tag.
137386
- * @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
137387
+ * @returns The tag with the unique ID. If such a tag doesn't exist, an error is thrown.
137387
137388
  */
137388
137389
  getItem(key: string): PowerPoint.Tag;
137389
137390
  /**
@@ -137397,13 +137398,13 @@ declare namespace PowerPoint {
137397
137398
  */
137398
137399
  getItemAt(index: number): PowerPoint.Tag;
137399
137400
  /**
137400
- * Gets a tag using its unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
137401
+ * Gets a tag using its unique ID. If such a tag 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}.
137401
137402
  *
137402
137403
  * @remarks
137403
137404
  * [Api set: PowerPointApi 1.3]
137404
137405
  *
137405
137406
  * @param key The ID of the tag.
137406
- * @returns The tag with the unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
137407
+ * @returns The tag with the unique ID. If such a tag doesn't exist, an object with an `isNullObject` property set to true is returned.
137407
137408
  */
137408
137409
  getItemOrNullObject(key: string): PowerPoint.Tag;
137409
137410
  /**
@@ -137505,7 +137506,7 @@ declare namespace PowerPoint {
137505
137506
  */
137506
137507
  applyLayout(slideLayout: PowerPoint.SlideLayout): void;
137507
137508
  /**
137508
- * Deletes the slide from the presentation. Does nothing if the slide does not exist.
137509
+ * Deletes the slide from the presentation. Does nothing if the slide doesn't exist.
137509
137510
  *
137510
137511
  * @remarks
137511
137512
  * [Api set: PowerPointApi 1.2]
@@ -137595,13 +137596,13 @@ declare namespace PowerPoint {
137595
137596
  */
137596
137597
  getCount(): OfficeExtension.ClientResult<number>;
137597
137598
  /**
137598
- * Gets a shape using its unique ID. An error is thrown if the shape does not exist.
137599
+ * Gets a shape using its unique ID. An error is thrown if the shape doesn't exist.
137599
137600
  *
137600
137601
  * @remarks
137601
137602
  * [Api set: PowerPointApi 1.5]
137602
137603
  *
137603
137604
  * @param key The ID of the shape.
137604
- * @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
137605
+ * @returns The shape with the unique ID. If such a shape doesn't exist, an error is thrown.
137605
137606
  */
137606
137607
  getItem(key: string): PowerPoint.Shape;
137607
137608
  /**
@@ -137615,13 +137616,13 @@ declare namespace PowerPoint {
137615
137616
  */
137616
137617
  getItemAt(index: number): PowerPoint.Shape;
137617
137618
  /**
137618
- * Gets a shape using its unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
137619
+ * 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}.
137619
137620
  *
137620
137621
  * @remarks
137621
137622
  * [Api set: PowerPointApi 1.5]
137622
137623
  *
137623
137624
  * @param id The ID of the shape.
137624
- * @returns The shape with the unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
137625
+ * @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.
137625
137626
  */
137626
137627
  getItemOrNullObject(id: string): PowerPoint.Shape;
137627
137628
  /**
@@ -137776,14 +137777,14 @@ declare namespace PowerPoint {
137776
137777
  */
137777
137778
  color: string;
137778
137779
  /**
137779
- * Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details.
137780
+ * Represents the dash style of the line. Returns null when the line isn't visible or there are inconsistent dash styles. See {@link PowerPoint.ShapeLineDashStyle} for details.
137780
137781
  *
137781
137782
  * @remarks
137782
137783
  * [Api set: PowerPointApi 1.4]
137783
137784
  */
137784
137785
  dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";
137785
137786
  /**
137786
- * Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details.
137787
+ * Represents the line style of the shape. Returns null when the line isn't visible or there are inconsistent styles. See {@link PowerPoint.ShapeLineStyle} for details.
137787
137788
  *
137788
137789
  * @remarks
137789
137790
  * [Api set: PowerPointApi 1.4]
@@ -137804,7 +137805,7 @@ declare namespace PowerPoint {
137804
137805
  */
137805
137806
  visible: boolean;
137806
137807
  /**
137807
- * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
137808
+ * Represents the weight of the line, in points. Returns `null` when the line isn't visible or there are inconsistent line weights.
137808
137809
  *
137809
137810
  * @remarks
137810
137811
  * [Api set: PowerPointApi 1.4]
@@ -138343,49 +138344,49 @@ declare namespace PowerPoint {
138343
138344
  */
138344
138345
  readonly zOrderPosition: number;
138345
138346
  /**
138346
- * Deletes the shape from the shape collection. Does nothing if the shape does not exist.
138347
+ * Deletes the shape from the shape collection. Does nothing if the shape doesn't exist.
138347
138348
  *
138348
138349
  * @remarks
138349
138350
  * [Api set: PowerPointApi 1.3]
138350
138351
  */
138351
138352
  delete(): void;
138352
138353
  /**
138353
- * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape does not belong to a `Slide`.
138354
+ * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `Slide`.
138354
138355
  *
138355
138356
  * @remarks
138356
138357
  * [Api set: PowerPointApi 1.5]
138357
138358
  */
138358
138359
  getParentSlide(): PowerPoint.Slide;
138359
138360
  /**
138360
- * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideLayout`.
138361
+ * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `SlideLayout`.
138361
138362
  *
138362
138363
  * @remarks
138363
138364
  * [Api set: PowerPointApi 1.5]
138364
138365
  */
138365
138366
  getParentSlideLayout(): PowerPoint.SlideLayout;
138366
138367
  /**
138367
- * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. If this shape does not belong to a `SlideLayout`, an object with an `isNullObject` property set to `true` is returned.
138368
+ * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. If this shape doesn't belong to a `SlideLayout`, 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}.
138368
138369
  *
138369
138370
  * @remarks
138370
138371
  * [Api set: PowerPointApi 1.5]
138371
138372
  */
138372
138373
  getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;
138373
138374
  /**
138374
- * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideMaster`.
138375
+ * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `SlideMaster`.
138375
138376
  *
138376
138377
  * @remarks
138377
138378
  * [Api set: PowerPointApi 1.5]
138378
138379
  */
138379
138380
  getParentSlideMaster(): PowerPoint.SlideMaster;
138380
138381
  /**
138381
- * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. If this shape does not belong to a `SlideMaster`, an object with an `isNullObject` property set to `true` is returned.
138382
+ * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. If this shape doesn't belong to a `SlideMaster`, 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}.
138382
138383
  *
138383
138384
  * @remarks
138384
138385
  * [Api set: PowerPointApi 1.5]
138385
138386
  */
138386
138387
  getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;
138387
138388
  /**
138388
- * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. If this shape does not belong to a `Slide`, an object with an `isNullObject` property set to `true` is returned.
138389
+ * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. If this shape doesn't belong to a `Slide`, 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}.
138389
138390
  *
138390
138391
  * @remarks
138391
138392
  * [Api set: PowerPointApi 1.5]
@@ -138474,7 +138475,7 @@ declare namespace PowerPoint {
138474
138475
  */
138475
138476
  delete(): void;
138476
138477
  /**
138477
- * Returns the shape represented by the binding. Will throw an error if the binding is not of the correct type.
138478
+ * Returns the shape represented by the binding. Will throw an error if the binding isn't of the correct type.
138478
138479
  *
138479
138480
  * @remarks
138480
138481
  * [Api set: PowerPointApi 1.8]
@@ -138960,8 +138961,8 @@ declare namespace PowerPoint {
138960
138961
  /**
138961
138962
  * Specifies the slides from the source presentation that will be inserted into the current presentation. These slides are represented by their IDs which can be retrieved from a `Slide` object.
138962
138963
  The order of these slides is preserved during the insertion.
138963
- If any of the source slides are not found, or if the IDs are invalid, the operation throws a `SlideNotFound` exception and no slides will be inserted.
138964
- All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior).
138964
+ If any of the source slides aren't found, or if the IDs are invalid, the operation throws a `SlideNotFound` exception and no slides will be inserted.
138965
+ All of the source slides will be inserted when `sourceSlideIds` isn't provided (this is the default behavior).
138965
138966
  *
138966
138967
  * @remarks
138967
138968
  * [Api set: PowerPointApi 1.2]
@@ -138969,8 +138970,8 @@ declare namespace PowerPoint {
138969
138970
  sourceSlideIds?: string[];
138970
138971
  /**
138971
138972
  * Specifies where in the presentation the new slides will be inserted. The new slides will be inserted after the slide with the given slide ID.
138972
- If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation.
138973
- If `targetSlideId` is invalid or if it is pointing to a non-existing slide, the operation throws a `SlideNotFound` exception and no slides will be inserted.
138973
+ If `targetSlideId` isn't provided, the slides will be inserted at the beginning of the presentation.
138974
+ If `targetSlideId` is invalid or if it's pointing to a non-existing slide, the operation throws a `SlideNotFound` exception and no slides will be inserted.
138974
138975
  *
138975
138976
  * @remarks
138976
138977
  * [Api set: PowerPointApi 1.2]
@@ -139012,7 +139013,7 @@ declare namespace PowerPoint {
139012
139013
  * [Api set: PowerPointApi 1.2]
139013
139014
  *
139014
139015
  * @param key The ID of the slide.
139015
- * @returns The slide with the unique ID. If such a slide does not exist, an error is thrown.
139016
+ * @returns The slide with the unique ID. If such a slide doesn't exist, an error is thrown.
139016
139017
  */
139017
139018
  getItem(key: string): PowerPoint.Slide;
139018
139019
  /**
@@ -139027,7 +139028,7 @@ declare namespace PowerPoint {
139027
139028
  */
139028
139029
  getItemAt(index: number): PowerPoint.Slide;
139029
139030
  /**
139030
- * Gets a slide using its unique ID. If such a slide does not exist, an object with an `isNullObject` property set to true is returned. For further information, see
139031
+ * Gets a slide using its unique ID. If such a slide doesn't exist, an object with an `isNullObject` property set to true is returned. For further information, see
139031
139032
  {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
139032
139033
  *
139033
139034
  * @remarks
@@ -139087,7 +139088,7 @@ declare namespace PowerPoint {
139087
139088
  * [Api set: PowerPointApi 1.5]
139088
139089
  *
139089
139090
  * @param key The ID of the slide.
139090
- * @returns The slide with the unique ID. If such a slide does not exist, an error is thrown.
139091
+ * @returns The slide with the unique ID. If such a slide doesn't exist, an error is thrown.
139091
139092
  */
139092
139093
  getItem(key: string): PowerPoint.Slide;
139093
139094
  /**
@@ -139101,7 +139102,7 @@ declare namespace PowerPoint {
139101
139102
  */
139102
139103
  getItemAt(index: number): PowerPoint.Slide;
139103
139104
  /**
139104
- * Gets a slide using its unique ID. If such a slide does not exist, an object with an `isNullObject` property set to true is returned. For further information, see
139105
+ * Gets a slide using its unique ID. If such a slide doesn't exist, an object with an `isNullObject` property set to true is returned. For further information, see
139105
139106
  {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
139106
139107
  *
139107
139108
  * @remarks
@@ -139161,7 +139162,7 @@ declare namespace PowerPoint {
139161
139162
  * [Api set: PowerPointApi 1.3]
139162
139163
  *
139163
139164
  * @param key The ID of the Slide Master.
139164
- * @returns The Slide Master with the unique ID. If such a Slide Master does not exist, an error is thrown.
139165
+ * @returns The Slide Master with the unique ID. If such a Slide Master doesn't exist, an error is thrown.
139165
139166
  */
139166
139167
  getItem(key: string): PowerPoint.SlideMaster;
139167
139168
  /**
@@ -139175,7 +139176,7 @@ declare namespace PowerPoint {
139175
139176
  */
139176
139177
  getItemAt(index: number): PowerPoint.SlideMaster;
139177
139178
  /**
139178
- * Gets a Slide Master using its unique ID. If such a Slide Master does not exist, an object with an `isNullObject` property set to true is returned.
139179
+ * Gets a Slide Master using its unique ID. If such a Slide Master doesn't exist, an object with an `isNullObject` property set to true is returned.
139179
139180
  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}.
139180
139181
  *
139181
139182
  * @remarks
@@ -139265,7 +139266,7 @@ declare namespace PowerPoint {
139265
139266
  */
139266
139267
  foregroundColor?: string;
139267
139268
  /**
139268
- * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
139269
+ * 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.
139269
139270
  *
139270
139271
  * @remarks
139271
139272
  * [Api set: PowerPointApi 1.4]
@@ -139334,7 +139335,7 @@ declare namespace PowerPoint {
139334
139335
  */
139335
139336
  italic?: boolean | null;
139336
139337
  /**
139337
- * 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 is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
139338
+ * 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.
139338
139339
  *
139339
139340
  * @remarks
139340
139341
  * [Api set: PowerPointApi 1.4]
@@ -139457,14 +139458,14 @@ declare namespace PowerPoint {
139457
139458
  */
139458
139459
  color?: string;
139459
139460
  /**
139460
- * Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details.
139461
+ * Represents the dash style of the line. Returns null when the line isn't visible or there are inconsistent dash styles. See {@link PowerPoint.ShapeLineDashStyle} for details.
139461
139462
  *
139462
139463
  * @remarks
139463
139464
  * [Api set: PowerPointApi 1.4]
139464
139465
  */
139465
139466
  dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";
139466
139467
  /**
139467
- * Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details.
139468
+ * Represents the line style of the shape. Returns null when the line isn't visible or there are inconsistent styles. See {@link PowerPoint.ShapeLineStyle} for details.
139468
139469
  *
139469
139470
  * @remarks
139470
139471
  * [Api set: PowerPointApi 1.4]
@@ -139485,7 +139486,7 @@ declare namespace PowerPoint {
139485
139486
  */
139486
139487
  visible?: boolean;
139487
139488
  /**
139488
- * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
139489
+ * Represents the weight of the line, in points. Returns `null` when the line isn't visible or there are inconsistent line weights.
139489
139490
  *
139490
139491
  * @remarks
139491
139492
  * [Api set: PowerPointApi 1.4]
@@ -139810,7 +139811,7 @@ declare namespace PowerPoint {
139810
139811
  */
139811
139812
  foregroundColor?: string;
139812
139813
  /**
139813
- * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
139814
+ * 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.
139814
139815
  *
139815
139816
  * @remarks
139816
139817
  * [Api set: PowerPointApi 1.4]
@@ -139886,7 +139887,7 @@ declare namespace PowerPoint {
139886
139887
  */
139887
139888
  italic?: boolean | null;
139888
139889
  /**
139889
- * 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 is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
139890
+ * 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.
139890
139891
  *
139891
139892
  * @remarks
139892
139893
  * [Api set: PowerPointApi 1.4]
@@ -140138,14 +140139,14 @@ declare namespace PowerPoint {
140138
140139
  */
140139
140140
  color?: string;
140140
140141
  /**
140141
- * Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details.
140142
+ * Represents the dash style of the line. Returns null when the line isn't visible or there are inconsistent dash styles. See {@link PowerPoint.ShapeLineDashStyle} for details.
140142
140143
  *
140143
140144
  * @remarks
140144
140145
  * [Api set: PowerPointApi 1.4]
140145
140146
  */
140146
140147
  dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";
140147
140148
  /**
140148
- * Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details.
140149
+ * Represents the line style of the shape. Returns null when the line isn't visible or there are inconsistent styles. See {@link PowerPoint.ShapeLineStyle} for details.
140149
140150
  *
140150
140151
  * @remarks
140151
140152
  * [Api set: PowerPointApi 1.4]
@@ -140166,7 +140167,7 @@ declare namespace PowerPoint {
140166
140167
  */
140167
140168
  visible?: boolean;
140168
140169
  /**
140169
- * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
140170
+ * Represents the weight of the line, in points. Returns `null` when the line isn't visible or there are inconsistent line weights.
140170
140171
  *
140171
140172
  * @remarks
140172
140173
  * [Api set: PowerPointApi 1.4]
@@ -140696,7 +140697,7 @@ declare namespace PowerPoint {
140696
140697
  */
140697
140698
  foregroundColor?: boolean;
140698
140699
  /**
140699
- * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
140700
+ * 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.
140700
140701
  *
140701
140702
  * @remarks
140702
140703
  * [Api set: PowerPointApi 1.4]
@@ -140781,7 +140782,7 @@ declare namespace PowerPoint {
140781
140782
  */
140782
140783
  italic?: boolean;
140783
140784
  /**
140784
- * 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 is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
140785
+ * 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.
140785
140786
  *
140786
140787
  * @remarks
140787
140788
  * [Api set: PowerPointApi 1.4]
@@ -141468,14 +141469,14 @@ declare namespace PowerPoint {
141468
141469
  */
141469
141470
  color?: boolean;
141470
141471
  /**
141471
- * Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details.
141472
+ * Represents the dash style of the line. Returns null when the line isn't visible or there are inconsistent dash styles. See {@link PowerPoint.ShapeLineDashStyle} for details.
141472
141473
  *
141473
141474
  * @remarks
141474
141475
  * [Api set: PowerPointApi 1.4]
141475
141476
  */
141476
141477
  dashStyle?: boolean;
141477
141478
  /**
141478
- * Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details.
141479
+ * Represents the line style of the shape. Returns null when the line isn't visible or there are inconsistent styles. See {@link PowerPoint.ShapeLineStyle} for details.
141479
141480
  *
141480
141481
  * @remarks
141481
141482
  * [Api set: PowerPointApi 1.4]
@@ -141496,7 +141497,7 @@ declare namespace PowerPoint {
141496
141497
  */
141497
141498
  visible?: boolean;
141498
141499
  /**
141499
- * Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
141500
+ * Represents the weight of the line, in points. Returns `null` when the line isn't visible or there are inconsistent line weights.
141500
141501
  *
141501
141502
  * @remarks
141502
141503
  * [Api set: PowerPointApi 1.4]
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.586",
3
+ "version": "1.0.588",
4
4
  "description": "TypeScript definitions for office-js-preview",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -46,7 +46,7 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "2ede5dc09e133f24acdb18649ff8a8b448aae3a6b233b89701978f31aede957c",
49
+ "typesPublisherContentHash": "b3baff0756871dd5a8f9cf03e16d00497e2e69ad7b2145594be4ff88c36a55c9",
50
50
  "typeScriptVersion": "5.1",
51
51
  "nonNpm": true
52
52
  }