Word.DropCap class

Пакет:

word

Обозначает пропуск прописной буквы в документе Word.

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: WordApiDesktop 1.4

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
distanceFromText	Получает расстояние (в пунктах) между пропущенной прописной буквой и текстом абзаца.
fontName	Получает название шрифта для пропущенной прописной буквы.
linesToDrop	Получает высоту прописной буквы (в строках).
position	Возвращает позицию пропущенной прописной буквы.

Методы

clear()	Удаляет пропущенные прописные буквы.
enable()	Отформатирует первый символ в указанном абзаце в виде прописной буквы.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.DropCap объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.DropCapData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

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

context

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

context: RequestContext;

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

Word.RequestContext

distanceFromText

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

readonly distanceFromText: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.4

fontName

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

readonly fontName: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.4

linesToDrop

Получает высоту прописной буквы (в строках).

readonly linesToDrop: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.4

position

Возвращает позицию пропущенной прописной буквы.

readonly position: Word.DropPosition | "None" | "Normal" | "Margin";

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

Word.DropPosition | "None" | "Normal" | "Margin"

Комментарии

Набор API: WordApiDesktop 1.4

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

clear()

Удаляет пропущенные прописные буквы.

clear(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.4

enable()

Отформатирует первый символ в указанном абзаце в виде прописной буквы.

enable(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.4

load(options)

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

load(options?: Word.Interfaces.DropCapLoadOptions): Word.DropCap;

Параметры

options

Word.Interfaces.DropCapLoadOptions

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

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

Word.DropCap

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.DropCap

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Word.DropCap

toJSON()

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

toJSON(): Word.Interfaces.DropCapData;

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

Word.Interfaces.DropCapData

track()

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

track(): Word.DropCap;

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

Word.DropCap

untrack()

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

untrack(): Word.DropCap;

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

Word.DropCap