Skip to content

Commit b34a9d8

Browse files
[office-js-preview] (Word) Add TableOfFiguresAddOptions descriptions (DefinitelyTyped#73680)
1 parent c046e6f commit b34a9d8

File tree

1 file changed

+99
-0
lines changed

1 file changed

+99
-0
lines changed

types/office-js-preview/index.d.ts

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114488,17 +114488,116 @@ declare namespace Word {
114488114488
* @beta
114489114489
*/
114490114490
interface TableOfFiguresAddOptions {
114491+
/**
114492+
* If provided, specifies the string names of additional styles to use for the table of figures.
114493+
*
114494+
* @remarks
114495+
* [Api set: WordApi BETA (PREVIEW ONLY)]
114496+
* @beta
114497+
*/
114491114498
addedStyles?: string;
114499+
/**
114500+
* If provided, specifies the label that identifies the items to include in a table of figures.
114501+
* Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}.
114502+
* The default value is "Figure".
114503+
*
114504+
* @remarks
114505+
* [Api set: WordApi BETA (PREVIEW ONLY)]
114506+
* @beta
114507+
*/
114492114508
captionLabel?: string;
114509+
/**
114510+
* If provided, specifies whether the page numbers in the table of figures should be hidden when publishing to the web.
114511+
* The default value is `true`.
114512+
*
114513+
* @remarks
114514+
* [Api set: WordApi BETA (PREVIEW ONLY)]
114515+
* @beta
114516+
*/
114493114517
hidePageNumbersOnWeb?: boolean;
114518+
/**
114519+
* If provided, specifies whether to include the caption label and caption number in a table of figures.
114520+
* The default value is `true`.
114521+
*
114522+
* @remarks
114523+
* [Api set: WordApi BETA (PREVIEW ONLY)]
114524+
* @beta
114525+
*/
114494114526
includeLabel?: boolean;
114527+
/**
114528+
* If provided, specifies whether page numbers are included in a table of figures.
114529+
* The default value is `true`.
114530+
*
114531+
* @remarks
114532+
* [Api set: WordApi BETA (PREVIEW ONLY)]
114533+
* @beta
114534+
*/
114495114535
includePageNumbers?: boolean;
114536+
/**
114537+
* If provided, specifies the ending heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and greater than `upperHeadingLevel`.
114538+
* Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}.
114539+
* The default value is `9`.
114540+
*
114541+
* @remarks
114542+
* [Api set: WordApi BETA (PREVIEW ONLY)]
114543+
* @beta
114544+
*/
114496114545
lowerHeadingLevel?: number;
114546+
/**
114547+
* If provided, specifies whether to align page numbers with the right margin in a table of figures.
114548+
* The default value is `true`.
114549+
*
114550+
* @remarks
114551+
* [Api set: WordApi BETA (PREVIEW ONLY)]
114552+
* @beta
114553+
*/
114497114554
rightAlignPageNumbers?: boolean;
114555+
/**
114556+
* If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of figures.
114557+
* Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of figures includes TC fields that use the table identifier T.
114558+
*
114559+
* @remarks
114560+
* [Api set: WordApi BETA (PREVIEW ONLY)]
114561+
* @beta
114562+
*/
114498114563
tableId?: string;
114564+
/**
114565+
* If provided, specifies the starting heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and smaller than `lowerHeadingLevel`.
114566+
* Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}.
114567+
* The default value is `1`.
114568+
*
114569+
* @remarks
114570+
* [Api set: WordApi BETA (PREVIEW ONLY)]
114571+
* @beta
114572+
*/
114499114573
upperHeadingLevel?: number;
114574+
/**
114575+
* If provided, specifies whether to use built-in heading styles to create a table of figures.
114576+
* The default value is `false`.
114577+
*
114578+
* @remarks
114579+
* [Api set: WordApi BETA (PREVIEW ONLY)]
114580+
* @beta
114581+
*/
114500114582
useBuiltInHeadingStyles?: boolean;
114583+
/**
114584+
* If provided, specifies whether to use {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} to create a table of figures.
114585+
* Use the {@link Word.TableOfFiguresCollection | TableOfFiguresCollection.markTocEntry} method to mark entries to include in a table of figures.
114586+
* The default value is `false`.
114587+
*
114588+
* @remarks
114589+
* [Api set: WordApi BETA (PREVIEW ONLY)]
114590+
* @beta
114591+
*/
114501114592
useFields?: boolean;
114593+
/**
114594+
* If provided, specifies whether entries in a table of figures should be formatted as hyperlinks when the document is published to the web.
114595+
* The default value is `true`.
114596+
*
114597+
* @remarks
114598+
* [Api set: WordApi BETA (PREVIEW ONLY)]
114599+
* @beta
114600+
*/
114502114601
useHyperlinksOnWeb?: boolean;
114503114602
}
114504114603
/**

0 commit comments

Comments
 (0)