Word.TableOfAuthorities class
Представляет таблицу полномочий в документе Word.
- Extends
Комментарии
Свойства
| bookmark | Указывает имя закладки, из которой будет собираться таблица записей центров. |
| category | Указывает категорию записей, которые будут включены в таблицу центров. Значения от 0 до 16 соответствуют элементам, перечисленным в поле Категория диалогового окна Таблица полномочий. Сведения о том, как получить к ней доступ через пользовательский интерфейс Word, см. в статье Создание таблицы центров. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| entry |
Задает разделитель не более пяти символов. Оно отображается между таблицей сведений о полномочиях и номером страницы. |
| is |
Указывает, отображается ли имя категории для группы записей в таблице центров. |
| is |
Указывает, отображаются ли записи в таблице центров с их форматированием в таблице. |
| is |
Указывает, заменяется ли ссылка на один и тот же центр, повторяющийся на пяти или более страницах, на "Passim". |
| page |
Задает разделитель не более пяти символов. Он отображается между отдельными ссылками на страницы в таблице центров. |
| page |
Задает разделитель не более пяти символов. Он отображается между диапазонами страниц в таблице центров. |
| range | Возвращает часть документа, которая является таблицей центров. |
| sequence |
Указывает идентификатор поля Последовательности (SEQ) для таблицы центров. |
| sequence |
Задает разделитель не более пяти символов. Он отображается между порядковый номер и номер страницы в таблице центров. |
| tab |
Указывает символ лидера, который отображается между записями и связанными с ними номерами страниц в таблице центров. |
Методы
| 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). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
bookmark
Указывает имя закладки, из которой будет собираться таблица записей центров.
bookmark: string;Значение свойства
string
Комментарии
category
Указывает категорию записей, которые будут включены в таблицу центров. Значения от 0 до 16 соответствуют элементам, перечисленным в поле Категория диалогового окна Таблица полномочий. Сведения о том, как получить к ней доступ через пользовательский интерфейс Word, см. в статье Создание таблицы центров.
category: number;Значение свойства
number
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
entrySeparator
Задает разделитель не более пяти символов. Оно отображается между таблицей сведений о полномочиях и номером страницы.
entrySeparator: string;Значение свойства
string
Комментарии
isCategoryHeaderIncluded
Указывает, отображается ли имя категории для группы записей в таблице центров.
isCategoryHeaderIncluded: boolean;Значение свойства
boolean
Комментарии
isEntryFormattingKept
Указывает, отображаются ли записи в таблице центров с их форматированием в таблице.
isEntryFormattingKept: boolean;Значение свойства
boolean
Комментарии
isPassimUsed
Указывает, заменяется ли ссылка на один и тот же центр, повторяющийся на пяти или более страницах, на "Passim".
isPassimUsed: boolean;Значение свойства
boolean
Комментарии
pageNumberSeparator
Задает разделитель не более пяти символов. Он отображается между отдельными ссылками на страницы в таблице центров.
pageNumberSeparator: string;Значение свойства
string
Комментарии
pageRangeSeparator
Задает разделитель не более пяти символов. Он отображается между диапазонами страниц в таблице центров.
pageRangeSeparator: string;Значение свойства
string
Комментарии
range
Возвращает часть документа, которая является таблицей центров.
readonly range: Word.Range;Значение свойства
Комментарии
sequenceName
Указывает идентификатор поля Последовательности (SEQ) для таблицы центров.
sequenceName: string;Значение свойства
string
Комментарии
sequenceSeparator
Задает разделитель не более пяти символов. Он отображается между порядковый номер и номер страницы в таблице центров.
sequenceSeparator: string;Значение свойства
string
Комментарии
tabLeader
Указывает символ лидера, который отображается между записями и связанными с ними номерами страниц в таблице центров.
tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";Значение свойства
Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"
Комментарии
Сведения о методе
delete()
Удаляет эту таблицу центров.
delete(): void;Возвращаемое значение
void
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
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
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Word.TableOfAuthorities): void;Параметры
- properties
- Word.TableOfAuthorities
Возвращаемое значение
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;