Word.TableOfAuthorities class

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

Extends

Комментарии

Набор API: WordApiDesktop 1.4

Используется

Свойства

bookmark

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

category

Определяет категорию элементов, которые должны быть включены в таблицу центров сертификации. Значения от 0 до 16 соответствуют элементам, перечисленным в поле Категория диалогового окна Таблица центров. Чтобы узнать, как получить доступ к этому через пользовательский интерфейс Word, см. статью Создание таблицы центров сертификации.

context

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

entrySeparator

Задает разделитель длиной до пяти знаков. Он отображается между записью таблицы центров и номером ее страницы.

isCategoryHeaderIncluded

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

isEntryFormattingKept

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

isPassimUsed

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

pageNumberSeparator

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

pageRangeSeparator

Задает разделитель длиной до пяти знаков. Этот диапазон отображается между диапазонами страниц в таблице центров обсуждения.

range

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

sequenceName

Определяет идентификатор поля последовательности (SEQ) для таблицы основных сведений.

sequenceSeparator

Задает разделитель длиной до пяти знаков. Он отображается между порядковым номером и номером страницы в таблице ссылок.

tabLeader

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

Методы

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.TableOfAuthorities объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.TableOfAuthoritiesData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

track()

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

untrack()

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

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

bookmark

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

bookmark: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.4

category

Определяет категорию элементов, которые должны быть включены в таблицу центров сертификации. Значения от 0 до 16 соответствуют элементам, перечисленным в поле Категория диалогового окна Таблица центров. Чтобы узнать, как получить доступ к этому через пользовательский интерфейс Word, см. статью Создание таблицы центров сертификации.

category: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.4

context

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

context: RequestContext;

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

entrySeparator

Задает разделитель длиной до пяти знаков. Он отображается между записью таблицы центров и номером ее страницы.

entrySeparator: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.4

isCategoryHeaderIncluded

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

isCategoryHeaderIncluded: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isEntryFormattingKept

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

isEntryFormattingKept: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.4

isPassimUsed

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

isPassimUsed: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.4

pageNumberSeparator

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

pageNumberSeparator: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.4

pageRangeSeparator

Задает разделитель длиной до пяти знаков. Этот диапазон отображается между диапазонами страниц в таблице центров обсуждения.

pageRangeSeparator: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.4

range

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

readonly range: Word.Range;

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

Комментарии

Набор API: WordApiDesktop 1.4

sequenceName

Определяет идентификатор поля последовательности (SEQ) для таблицы основных сведений.

sequenceName: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.4

sequenceSeparator

Задает разделитель длиной до пяти знаков. Он отображается между порядковым номером и номером страницы в таблице ссылок.

sequenceSeparator: string;

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

string

Комментарии

Набор 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

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

delete()

Удаляет эту таблицу центров сертификации.

delete(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.4

load(options)

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

load(options?: Word.Interfaces.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities;

Параметры

options
Word.Interfaces.TableOfAuthoritiesLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

set(properties, options)

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

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

Параметры

properties
Word.Interfaces.TableOfAuthoritiesUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.TableOfAuthorities): void;

Параметры

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

void

toJSON()

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

toJSON(): Word.Interfaces.TableOfAuthoritiesData;

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

track()

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

track(): Word.TableOfAuthorities;

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

untrack()

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

untrack(): Word.TableOfAuthorities;

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