Word.ConditionalStyle class

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

Extends

Комментарии

Набор API: WordApiDesktop 1.4

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

Свойства

borders

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

bottomPadding

Указывает объем пространства (в точках) для добавления под содержимым одной ячейки или всех ячеек в таблице.

context

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

font

Font Возвращает объект , представляющий форматирование шрифта для условного стиля.

leftPadding

Указывает объем пространства (в точках) для добавления слева от содержимого одной ячейки или всех ячеек в таблице.

paragraphFormat

ParagraphFormat Возвращает объект , представляющий форматирование абзаца для условного стиля.

rightPadding

Указывает объем пространства (в точках) для добавления справа от содержимого одной ячейки или всех ячеек в таблице.

shading

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

topPadding

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

Методы

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

track()

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

untrack()

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

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

borders

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

readonly borders: Word.BorderUniversalCollection;

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

Комментарии

Набор API: WordApiDesktop 1.4

bottomPadding

Указывает объем пространства (в точках) для добавления под содержимым одной ячейки или всех ячеек в таблице.

bottomPadding: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.4

context

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

context: RequestContext;

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

font

Font Возвращает объект , представляющий форматирование шрифта для условного стиля.

readonly font: Word.Font;

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

Комментарии

Набор API: WordApiDesktop 1.4

leftPadding

Указывает объем пространства (в точках) для добавления слева от содержимого одной ячейки или всех ячеек в таблице.

leftPadding: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.4

paragraphFormat

ParagraphFormat Возвращает объект , представляющий форматирование абзаца для условного стиля.

readonly paragraphFormat: Word.ParagraphFormat;

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

Комментарии

Набор API: WordApiDesktop 1.4

rightPadding

Указывает объем пространства (в точках) для добавления справа от содержимого одной ячейки или всех ячеек в таблице.

rightPadding: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.4

shading

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

readonly shading: Word.ShadingUniversal;

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

Комментарии

Набор API: WordApiDesktop 1.4

topPadding

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

topPadding: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.4

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

load(options)

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

load(options?: Word.Interfaces.ConditionalStyleLoadOptions): Word.ConditionalStyle;

Параметры

options
Word.Interfaces.ConditionalStyleLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

toJSON()

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

toJSON(): Word.Interfaces.ConditionalStyleData;

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

track()

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

track(): Word.ConditionalStyle;

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

untrack()

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

untrack(): Word.ConditionalStyle;

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