Word.TextFrame class

Параметры автоматического изменения размера текстового фрейма. Для рамки с текстом можно настроить автоматический подбор размера текста в соответствии с размером рамки, автоматический подбор размера рамки в соответствии с содержимым или не выполнять автоматический подбор размера.

autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed";

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Представляет нижнее поле рамки с текстом (в пунктах).

bottomMargin: number;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

context: RequestContext;

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

Указывает, содержит ли текстовый фрейм текст.

readonly hasText: boolean;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Представляет левое поле рамки с текстом (в пунктах).

leftMargin: number;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Возвращает значение True, если текст в текстовом фрейме не должен поворачиваться при повороте фигуры.

noTextRotation: boolean;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Представляет угол, на который ориентирован текст для текстового фрейма. Дополнительные сведения см. в этой Word.ShapeTextOrientation статье.

orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed";

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Представляет правое поле рамки с текстом (в пунктах).

rightMargin: number;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Представляет верхнее поле рамки с текстом (в пунктах).

topMargin: number;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Представляет вертикальное выравнивание для рамки с текстом. Дополнительные сведения см. в этой Word.ShapeTextVerticalAlignment статье.

verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom";

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Определяет, разбиваются ли строки автоматически для размещения текста внутри фигуры.

wordWrap: boolean;

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

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

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

load(options?: Word.Interfaces.TextFrameLoadOptions): Word.TextFrame;

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

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

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Word.TextFrame): void;

Параметры

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

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

toJSON(): Word.Interfaces.TextFrameData;

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

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

track(): Word.TextFrame;

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

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

untrack(): Word.TextFrame;

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