Word.Frame class

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

readonly borders: Word.BorderUniversalCollection;

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

Комментарии

Набор API: WordApiDesktop 1.3

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

context: RequestContext;

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

Задает высоту (в точках) кадра.

height: number;

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

Комментарии

Набор API: WordApiDesktop 1.3

Задает FrameSizeRule значение, представляющее правило для определения высоты кадра.

heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";

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

Комментарии

Набор API: WordApiDesktop 1.3

Задает горизонтальное расстояние между рамкой и окружающим текстом в точках.

horizontalDistanceFromText: number;

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

Комментарии

Набор API: WordApiDesktop 1.3

Задает горизонтальное расстояние между краем кадра и элементом, заданным свойством relativeHorizontalPosition .

horizontalPosition: number;

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

Комментарии

Набор API: WordApiDesktop 1.3

Указывает, заблокирован ли кадр.

lockAnchor: boolean;

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

Комментарии

Набор API: WordApiDesktop 1.3

Range Возвращает объект , представляющий часть документа, содержащуюся в кадре.

readonly range: Word.Range;

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

Комментарии

Набор API: WordApiDesktop 1.3

Задает относительное горизонтальное положение кадра.

relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";

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

Комментарии

Набор API: WordApiDesktop 1.3

Задает относительное вертикальное положение кадра.

relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

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

Комментарии

Набор API: WordApiDesktop 1.3

ShadingUniversal Возвращает объект , который ссылается на форматирование затенения для кадра.

readonly shading: Word.ShadingUniversal;

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

Комментарии

Набор API: WordApiDesktop 1.3

Указывает, будет ли текст документа обтекать рамку.

textWrap: boolean;

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

Комментарии

Набор API: WordApiDesktop 1.3

Задает вертикальное расстояние (в точках) между рамкой и окружающим текстом.

verticalDistanceFromText: number;

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

Комментарии

Набор API: WordApiDesktop 1.3

Задает вертикальное расстояние между краем кадра и элементом, заданным свойством relativeVerticalPosition .

verticalPosition: number;

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

Комментарии

Набор API: WordApiDesktop 1.3

Задает ширину (в точках) кадра.

width: number;

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

Комментарии

Набор API: WordApiDesktop 1.3

Задает правило, используемое для определения ширины кадра.

widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";

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

Комментарии

Набор API: WordApiDesktop 1.3

Копирует кадр в буфер обмена.

copy(): void;

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

Комментарии

Набор API: WordApiDesktop 1.3

Удаляет кадр из документа и помещает его в буфер обмена.

cut(): void;

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

Комментарии

Набор API: WordApiDesktop 1.3

Удаляет кадр.

delete(): void;

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

Комментарии

Набор API: WordApiDesktop 1.3

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

load(options?: Word.Interfaces.FrameLoadOptions): Word.Frame;

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

Выбирает кадр.

select(): void;

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

Комментарии

Набор API: WordApiDesktop 1.3

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

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

Параметры

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

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

set(properties: Word.Frame): void;

Параметры

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

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

toJSON(): Word.Interfaces.FrameData;

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

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

track(): Word.Frame;

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

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

untrack(): Word.Frame;

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