Word.HtmlDivision class
- Extends
Комментарии
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| html |
|
| left |
Задает значение левого отступа (в точках) для этого деления HTML. |
| range |
|
| right |
Указывает правый отступ (в точках) для этого деления HTML. |
| space |
Указывает интервал (в точках) после этого деления HTML. |
| space |
Указывает интервал (в точках) перед этим делением HTML. |
Методы
| delete() | Удаляет это деление HTML. |
| html |
|
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
htmlDivisions
leftIndent
Задает значение левого отступа (в точках) для этого деления HTML.
leftIndent: number;Значение свойства
number
Комментарии
range
Range Возвращает объект , представляющий часть документа, содержащегося в этом разделе HTML.
readonly range: Word.Range;Значение свойства
Комментарии
rightIndent
Указывает правый отступ (в точках) для этого деления HTML.
rightIndent: number;Значение свойства
number
Комментарии
spaceAfter
Указывает интервал (в точках) после этого деления HTML.
spaceAfter: number;Значение свойства
number
Комментарии
spaceBefore
Указывает интервал (в точках) перед этим делением HTML.
spaceBefore: number;Значение свойства
number
Комментарии
Сведения о методе
delete()
Удаляет это деление HTML.
delete(): void;Возвращаемое значение
void
Комментарии
htmlDivisionParent(levelsUp)
HtmlDivision Возвращает объект , представляющий родительское деление текущего деления HTML.
htmlDivisionParent(levelsUp?: number): Word.HtmlDivision;Параметры
- levelsUp
-
number
Необязательный параметр. Количество уровней, которые нужно поднять для получения родительского деления.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.HtmlDivisionLoadOptions): Word.HtmlDivision;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
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;