Word.TableOfFigures class
Представляет список иллюстраций в документе Word.
- Extends
Свойства
| additional |
Получает дополнительные стили, используемые для таблицы иллюстраций. Стили по умолчанию "Заголовок 1" - "Заголовок 9" не включены в эту коллекцию. |
| are |
Определяет, используются ли встроенные стили заголовков для таблицы иллюстраций. |
| are |
Указывает, включены ли поля элемента оглавления (TC) в список иллюстраций. |
| are |
Указывает, должны ли элементы в таблице иллюстраций форматироваться как гиперссылки при публикации в Интернете. |
| are |
Указывает, следует ли скрывать номера страниц в таблице иллюстраций при публикации в Интернете. |
| are |
Указывает, включены ли номера страниц в таблицу иллюстраций. |
| are |
Выравнивание номеров страниц по правому полю в таблице иллюстраций. |
| caption |
Задает название, определяющее элементы, которые нужно включить в оглавление рисунков. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| is |
Указывает, включена ли в таблицу рисунков метка подписи и номер подписи. |
| lower |
Указывает конечный уровень заголовка для таблицы иллюстраций. Должно быть значением от 1 до 9 и больше |
| range | Получает часть документа, которая является этим описанием иллюстраций. |
| tab |
Определяет знак между записями и номерами их страниц в таблице иллюстраций. |
| table |
Определяет однобуквенный идентификатор из полей TC , используемый для остановки иллюстраций. |
| upper |
Начальный уровень заголовка для таблицы иллюстраций. Должно быть значением от 1 до 9, которое меньше |
Методы
| delete() | Удаляет эту таблицу иллюстраций. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить |
| update |
Обновления всего перечня иллюминаторов. |
Сведения о свойстве
additionalHeadingStyles
Получает дополнительные стили, используемые для таблицы иллюстраций. Стили по умолчанию "Заголовок 1" - "Заголовок 9" не включены в эту коллекцию.
readonly additionalHeadingStyles: Word.HeadingStyleCollection;Значение свойства
Комментарии
areBuiltInHeadingStylesUsed
Определяет, используются ли встроенные стили заголовков для таблицы иллюстраций.
areBuiltInHeadingStylesUsed: boolean;Значение свойства
boolean
Комментарии
areFieldsUsed
Указывает, включены ли поля элемента оглавления (TC) в список иллюстраций.
areFieldsUsed: boolean;Значение свойства
boolean
Комментарии
areHyperlinksUsedOnWeb
Указывает, должны ли элементы в таблице иллюстраций форматироваться как гиперссылки при публикации в Интернете.
areHyperlinksUsedOnWeb: boolean;Значение свойства
boolean
Комментарии
arePageNumbersHiddenOnWeb
Указывает, следует ли скрывать номера страниц в таблице иллюстраций при публикации в Интернете.
arePageNumbersHiddenOnWeb: boolean;Значение свойства
boolean
Комментарии
arePageNumbersIncluded
Указывает, включены ли номера страниц в таблицу иллюстраций.
arePageNumbersIncluded: boolean;Значение свойства
boolean
Комментарии
arePageNumbersRightAligned
Выравнивание номеров страниц по правому полю в таблице иллюстраций.
arePageNumbersRightAligned: boolean;Значение свойства
boolean
Комментарии
captionLabel
Задает название, определяющее элементы, которые нужно включить в оглавление рисунков.
captionLabel: string;Значение свойства
string
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
isLabelIncluded
Указывает, включена ли в таблицу рисунков метка подписи и номер подписи.
isLabelIncluded: boolean;Значение свойства
boolean
Комментарии
lowerHeadingLevel
Указывает конечный уровень заголовка для таблицы иллюстраций. Должно быть значением от 1 до 9 и больше upperHeadingLevel.
lowerHeadingLevel: number;Значение свойства
number
Комментарии
range
Получает часть документа, которая является этим описанием иллюстраций.
readonly range: Word.Range;Значение свойства
Комментарии
tabLeader
Определяет знак между записями и номерами их страниц в таблице иллюстраций.
tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";Значение свойства
Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"
Комментарии
tableId
Определяет однобуквенный идентификатор из полей TC , используемый для остановки иллюстраций.
tableId: string;Значение свойства
string
Комментарии
upperHeadingLevel
Начальный уровень заголовка для таблицы иллюстраций. Должно быть значением от 1 до 9, которое меньше lowerHeadingLevel.
upperHeadingLevel: number;Значение свойства
number
Комментарии
Сведения о методе
delete()
Удаляет эту таблицу иллюстраций.
delete(): void;Возвращаемое значение
void
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.TableOfFiguresLoadOptions): Word.TableOfFigures;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.TableOfFigures;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.TableOfFigures;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.TableOfFiguresUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.TableOfFiguresUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
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;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
track(): Word.TableOfFigures;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.
untrack(): Word.TableOfFigures;Возвращаемое значение
updatePageNumbers()
Обновления всего перечня иллюминаторов.
updatePageNumbers(): void;Возвращаемое значение
void