Word.Interfaces.FrameData interface

一个描述通过调用 frame.toJSON()返回的数据的接口。

注解

使用方

属性

borders

返回 BorderUniversalCollection 表示框架所有边框的对象。

height

指定高度 (,以帧) 点为单位。

heightRule

指定表示 FrameSizeRule 用于确定框架高度的规则的值。

horizontalDistanceFromText

指定框架与周围文本之间的水平距离(以磅为单位)。

horizontalPosition

指定框架边缘与属性指定的 relativeHorizontalPosition 项目之间的水平距离。

lockAnchor

指定帧是否已锁定。

range

返回表示 Range 帧内包含的文档部分的对象。

relativeHorizontalPosition

指定帧的相对水平位置。

relativeVerticalPosition

指定框架的相对垂直位置。

shading

返回引用 ShadingUniversal 帧的着色格式的对象。

textWrap

指定文档文本是否环绕框架。

verticalDistanceFromText

指定框架与周围文本之间的垂直距离 ((以点) 为单位)。

verticalPosition

指定框架边缘与属性指定的 relativeVerticalPosition 项目之间的垂直距离。

width

指定帧) 点 (的宽度。

widthRule

指定用于确定帧宽度的规则。

属性详细信息

borders

返回 BorderUniversalCollection 表示框架所有边框的对象。

borders?: Word.Interfaces.BorderUniversalData[];

属性值

注解

API 集:WordApiDesktop 1.3

height

指定高度 (,以帧) 点为单位。

height?: number;

属性值

number

注解

API 集:WordApiDesktop 1.3

heightRule

指定表示 FrameSizeRule 用于确定框架高度的规则的值。

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

属性值

Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"

注解

API 集:WordApiDesktop 1.3

horizontalDistanceFromText

指定框架与周围文本之间的水平距离(以磅为单位)。

horizontalDistanceFromText?: number;

属性值

number

注解

API 集:WordApiDesktop 1.3

horizontalPosition

指定框架边缘与属性指定的 relativeHorizontalPosition 项目之间的水平距离。

horizontalPosition?: number;

属性值

number

注解

API 集:WordApiDesktop 1.3

lockAnchor

指定帧是否已锁定。

lockAnchor?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.3

range

返回表示 Range 帧内包含的文档部分的对象。

range?: Word.Interfaces.RangeData;

属性值

注解

API 集:WordApiDesktop 1.3

relativeHorizontalPosition

指定帧的相对水平位置。

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

属性值

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

注解

API 集:WordApiDesktop 1.3

relativeVerticalPosition

指定框架的相对垂直位置。

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

属性值

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

注解

API 集:WordApiDesktop 1.3

shading

返回引用 ShadingUniversal 帧的着色格式的对象。

shading?: Word.Interfaces.ShadingUniversalData;

属性值

注解

API 集:WordApiDesktop 1.3

textWrap

指定文档文本是否环绕框架。

textWrap?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.3

verticalDistanceFromText

指定框架与周围文本之间的垂直距离 ((以点) 为单位)。

verticalDistanceFromText?: number;

属性值

number

注解

API 集:WordApiDesktop 1.3

verticalPosition

指定框架边缘与属性指定的 relativeVerticalPosition 项目之间的垂直距离。

verticalPosition?: number;

属性值

number

注解

API 集:WordApiDesktop 1.3

width

指定帧) 点 (的宽度。

width?: number;

属性值

number

注解

API 集:WordApiDesktop 1.3

widthRule

指定用于确定帧宽度的规则。

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

属性值

Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"

注解

API 集:WordApiDesktop 1.3