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