Word.TabStop class

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

Extends

Комментарии

Набор API: WordApiDesktop 1.4

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

Свойства

alignment

Получает TabAlignment значение, представляющее выравнивание для позиции табуляции.

context

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

customTab

Определяет, является ли эта позиция табуляции пользовательской.

leader

Получает TabLeader значение, представляющее лидера для этого TabStop объекта.

next

Переход к следующей точке табуляции в коллекции.

position

Получает положение позиции табуляции относительно левого поля.

previous

Получение предыдущей позиции табуляции в коллекции.

Методы

clear()

Удаляет эту позицию табуляции.

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

track()

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

untrack()

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

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

alignment

Получает TabAlignment значение, представляющее выравнивание для позиции табуляции.

readonly alignment: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List";

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

Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"

Комментарии

Набор API: WordApiDesktop 1.4

context

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

context: RequestContext;

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

customTab

Определяет, является ли эта позиция табуляции пользовательской.

readonly customTab: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.4

leader

Получает TabLeader значение, представляющее лидера для этого TabStop объекта.

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

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

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

Комментарии

Набор API: WordApiDesktop 1.4

next

Переход к следующей точке табуляции в коллекции.

readonly next: Word.TabStop;

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

Комментарии

Набор API: WordApiDesktop 1.4

position

Получает положение позиции табуляции относительно левого поля.

readonly position: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.4

previous

Получение предыдущей позиции табуляции в коллекции.

readonly previous: Word.TabStop;

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

Комментарии

Набор API: WordApiDesktop 1.4

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

clear()

Удаляет эту позицию табуляции.

clear(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.4

load(options)

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

load(options?: Word.Interfaces.TabStopLoadOptions): Word.TabStop;

Параметры

options
Word.Interfaces.TabStopLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

toJSON()

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

toJSON(): Word.Interfaces.TabStopData;

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

track()

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

track(): Word.TabStop;

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

untrack()

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

untrack(): Word.TabStop;

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