Word.LineFormat class

获取一个 ColorFormat 对象，该对象表示图案线条的背景色。

readonly backgroundColor: Word.ColorFormat;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定线条开头的箭头的长度。

beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定线条开头的箭头样式。

beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定线条开头箭头的宽度。

beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

指定线条的短划线样式。

dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定线条末尾箭头的长度。

endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定线条末尾的箭头样式。

endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定线条末尾箭头的宽度。

endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取一个 ColorFormat 对象，该对象表示线条的前景色。

readonly foregroundColor: Word.ColorFormat;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定是否在形状内绘制线条。

insetPen: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定对象或应用于该对象的格式是否可见。

isVisible: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定应用于行的模式。

pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定线条格式样式。

style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

将行的透明度指定为介于 0.0 (不透明) 和 1.0 之间的值， (清除) 。

transparency: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定线条的粗细（以磅为单位）。

weight: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Word.Interfaces.LineFormatLoadOptions): Word.LineFormat;

参数

返回

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

返回

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

返回

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

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

参数

返回

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Word.LineFormat): void;

参数

返回

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.LineFormat对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.LineFormatData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Word.Interfaces.LineFormatData;

返回

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.LineFormat;

返回

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.LineFormat;

返回