Word.TableOfContents class
Представляет оглавление документа Word.
- Extends
Свойства
| additional |
Получает дополнительные стили, используемые для оглавления. Стили по умолчанию "Заголовок 1" - "Заголовок 9" не включены в эту коллекцию. |
| are |
Указывает, используются ли встроенные стили заголовков для оглавления. |
| are |
Указывает, включены ли поля элемента оглавления (TC) в оглавление. |
| are |
Указывает, должны ли записи в оглавлении форматироваться как гиперссылки при публикации в Интернете. |
| are |
Указывает, следует ли скрывать номера страниц в оглавлении при публикации в Интернете. |
| are |
Указывает, включены ли номера страниц в оглавление. |
| are |
Выравнивание номеров страниц по правому полю в оглавлении. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| 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
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
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.TableOfContentsLoadOptions): Word.TableOfContents;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.TableOfContents;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.TableOfContents;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.TableOfContentsUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.TableOfContentsUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Word.TableOfContents): void;Параметры
- properties
- Word.TableOfContents
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.TableOfContents объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.TableOfContentsData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Word.Interfaces.TableOfContentsData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
track(): Word.TableOfContents;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.
untrack(): Word.TableOfContents;Возвращаемое значение
updatePageNumbers()
Обновления всего содержания.
updatePageNumbers(): void;Возвращаемое значение
void