Word.HtmlDivision class

Extends

Комментарии

Набор API: WordApiDesktop 1.4

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

Свойства

context

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

htmlDivisions
leftIndent

Задает значение отступа слева (в пунктах) для этого деления HTML.

range

Получает объект, Range представляющий часть документа, содержащуюся в данном разделе HTML.

rightIndent

Указывает правильный отступ (в пунктах) для этого деления HTML.

spaceAfter

Указывает величину интервала (в пунктах) после этого деления HTML.

spaceBefore

Указывает интервал (в точках) перед этим делением HTML.

Методы

delete()

Удаляет этот раздел HTML.

htmlDivisionParent(levelsUp)

Возвращает объект, HtmlDivision представляющий родительский раздел текущего деления HTML.

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

track()

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

untrack()

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

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

context

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

context: RequestContext;

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

htmlDivisions

readonly htmlDivisions: Word.HtmlDivisionCollection;

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

leftIndent

Задает значение отступа слева (в пунктах) для этого деления HTML.

leftIndent: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.4

range

Получает объект, Range представляющий часть документа, содержащуюся в данном разделе HTML.

readonly range: Word.Range;

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

Комментарии

Набор API: WordApiDesktop 1.4

rightIndent

Указывает правильный отступ (в пунктах) для этого деления HTML.

rightIndent: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.4

spaceAfter

Указывает величину интервала (в пунктах) после этого деления HTML.

spaceAfter: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.4

spaceBefore

Указывает интервал (в точках) перед этим делением HTML.

spaceBefore: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.4

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

delete()

Удаляет этот раздел HTML.

delete(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.4

htmlDivisionParent(levelsUp)

Возвращает объект, HtmlDivision представляющий родительский раздел текущего деления HTML.

htmlDivisionParent(levelsUp?: number): Word.HtmlDivision;

Параметры

levelsUp

number

Необязательный параметр. Количество уровней, которые необходимо поднять, чтобы получить родительское деление.

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

Комментарии

Набор API: WordApiDesktop 1.4

load(options)

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

load(options?: Word.Interfaces.HtmlDivisionLoadOptions): Word.HtmlDivision;

Параметры

options
Word.Interfaces.HtmlDivisionLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

toJSON()

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

toJSON(): Word.Interfaces.HtmlDivisionData;

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

track()

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

track(): Word.HtmlDivision;

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

untrack()

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

untrack(): Word.HtmlDivision;

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