Word.TableOfFigures class

Пакет:

word

Представляет таблицу цифр в документе Word.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

Свойства

additionalHeadingStyles	Возвращает дополнительные стили, используемые для таблицы рисунков. Стили "Заголовок 1" — "Заголовок 9" по умолчанию не включены в эту коллекцию.
areBuiltInHeadingStylesUsed	Указывает, используются ли встроенные стили заголовков для таблицы рисунков.
areFieldsUsed	Указывает, включаются ли поля оглавление (TC) в таблицу рисунков.
areHyperlinksUsedOnWeb	Указывает, должны ли записи в таблице рисунков форматироваться в виде гиперссылок при публикации в Интернете.
arePageNumbersHiddenOnWeb	Указывает, следует ли скрывать номера страниц в таблице цифр при публикации в Интернете.
arePageNumbersIncluded	Указывает, включаются ли номера страниц в таблицу цифр.
arePageNumbersRightAligned	Указывает, выравниваются ли номера страниц по правому краю в таблице рисунков.
captionLabel	Указывает метку, определяющую элементы, которые должны быть включены в таблицу рисунков.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
isLabelIncluded	Указывает, включаются ли метка подпись и номер подпись в таблицу цифр.
lowerHeadingLevel	Указывает конечный уровень заголовка для таблицы цифр. Значение должно быть от 1 до 9 и больше .upperHeadingLevel
range	Возвращает часть документа, которая является таблицей цифр.
tabLeader	Указывает символ между записями и их номерами страниц в таблице цифр.
tableId	Указывает однобуквенный идентификатор из полей TC , используемый для таблицы цифр.
upperHeadingLevel	Задает начальный уровень заголовка для таблицы цифр. Значение должно быть от 1 до 9 и меньше .lowerHeadingLevel

Методы

delete()	Удаляет эту таблицу цифр.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.TableOfFigures объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.TableOfFiguresData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
updatePageNumbers()	Обновления всю таблицу цифр.

Сведения о свойстве

additionalHeadingStyles

Возвращает дополнительные стили, используемые для таблицы рисунков. Стили "Заголовок 1" — "Заголовок 9" по умолчанию не включены в эту коллекцию.

readonly additionalHeadingStyles: Word.HeadingStyleCollection;

Значение свойства

Word.HeadingStyleCollection

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

areBuiltInHeadingStylesUsed

Указывает, используются ли встроенные стили заголовков для таблицы рисунков.

areBuiltInHeadingStylesUsed: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

areFieldsUsed

Указывает, включаются ли поля оглавление (TC) в таблицу рисунков.

areFieldsUsed: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

areHyperlinksUsedOnWeb

Указывает, должны ли записи в таблице рисунков форматироваться в виде гиперссылок при публикации в Интернете.

areHyperlinksUsedOnWeb: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

arePageNumbersHiddenOnWeb

Указывает, следует ли скрывать номера страниц в таблице цифр при публикации в Интернете.

arePageNumbersHiddenOnWeb: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

arePageNumbersIncluded

Указывает, включаются ли номера страниц в таблицу цифр.

arePageNumbersIncluded: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

arePageNumbersRightAligned

Указывает, выравниваются ли номера страниц по правому краю в таблице рисунков.

arePageNumbersRightAligned: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

captionLabel

Указывает метку, определяющую элементы, которые должны быть включены в таблицу рисунков.

captionLabel: string;

Значение свойства

string

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

isLabelIncluded

Указывает, включаются ли метка подпись и номер подпись в таблицу цифр.

isLabelIncluded: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

lowerHeadingLevel

Указывает конечный уровень заголовка для таблицы цифр. Значение должно быть от 1 до 9 и больше .upperHeadingLevel

lowerHeadingLevel: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

range

Возвращает часть документа, которая является таблицей цифр.

readonly range: Word.Range;

Значение свойства

Word.Range

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

tabLeader

Указывает символ между записями и их номерами страниц в таблице цифр.

tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";

Значение свойства

Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

tableId

Указывает однобуквенный идентификатор из полей TC , используемый для таблицы цифр.

tableId: string;

Значение свойства

string

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

upperHeadingLevel

Задает начальный уровень заголовка для таблицы цифр. Значение должно быть от 1 до 9 и меньше .lowerHeadingLevel

upperHeadingLevel: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

Сведения о методе

delete()

Удаляет эту таблицу цифр.

delete(): void;

Возвращаемое значение

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Word.Interfaces.TableOfFiguresLoadOptions): Word.TableOfFigures;

Параметры

options

Word.Interfaces.TableOfFiguresLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Word.TableOfFigures

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Word.TableOfFigures;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Word.TableOfFigures

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.TableOfFigures;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Word.TableOfFigures

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.TableOfFiguresUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties

Word.Interfaces.TableOfFiguresUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options

OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Word.TableOfFigures): void;

Параметры

properties

Word.TableOfFigures

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.TableOfFigures объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.TableOfFiguresData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Word.Interfaces.TableOfFiguresData;

Возвращаемое значение

Word.Interfaces.TableOfFiguresData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

track(): Word.TableOfFigures;

Возвращаемое значение

Word.TableOfFigures

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): Word.TableOfFigures;

Возвращаемое значение

Word.TableOfFigures

updatePageNumbers()

Обновления всю таблицу цифр.

updatePageNumbers(): void;

Возвращаемое значение

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]