Word.FillFormat class

返回一个 ColorFormat 对象，该对象代表填充的背景色。

readonly backgroundColor: Word.ColorFormat;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

context: RequestContext;

属性值

返回一个 ColorFormat 对象，该对象代表填充的前景色。

readonly foregroundColor: Word.ColorFormat;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定渐变填充的角度。 值的有效范围为 0 到 359.9。

gradientAngle: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取渐变颜色类型。

readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回单色渐变填充的深色或浅色。 值 0 表示黑色与形状的前景色混合以形成渐变。 值为 1 表示白色已混合。 介于 0 和 1 之间的值表示前景色的深色或较浅阴影混合在一起。

readonly gradientDegree: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回填充的渐变样式。

readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

对于大多数渐变填充，以 1 到 4 的整数值的形式返回填充的渐变变体。

readonly gradientVariant: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

isVisible: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回一个 PatternType 值，该值代表应用于填充或线条的图案。

readonly 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 ]

返回填充的预设渐变类型。

readonly presetGradientType: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取预设纹理。

readonly presetTexture: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定填充是否随形状一起旋转。

rotateWithObject: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定用于平铺纹理填充的对齐方式（坐标网格的原点）。

textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定纹理填充的水平缩放因子。

textureHorizontalScale: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回填充的自定义纹理文件的名称。

readonly textureName: string;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定纹理与原点的水平偏移量（以磅为单位）。

textureOffsetX: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定纹理的垂直偏移量。

textureOffsetY: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定纹理是否平铺。

textureTile: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

返回填充的纹理类型。

readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

将纹理填充的垂直缩放因子指定为介于 0.0 和 1.0 之间的值。

textureVerticalScale: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

将形状的填充透明度指定为介于 0.0 (不透明) 和 1.0 (清除) 之间的值。

transparency: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取填充格式类型。

readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture";

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

load(options?: Word.Interfaces.FillFormatLoadOptions): Word.FillFormat;

参数

返回

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

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

参数

返回

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

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

参数

返回

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

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

参数

返回

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

set(properties: Word.FillFormat): void;

参数

返回

将填充设置为单色渐变。

setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将填充设置为单色渐变。

setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将填充设置为图案。

setPatterned(pattern: Word.PatternType): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将填充设置为图案。

setPatterned(pattern: "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"): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将填充设置为预设渐变。 渐变样式。渐变变体。 可以是介于 1 到 4 的值。预设渐变类型。

setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将填充设置为预设渐变。 渐变样式。渐变变体。 可以是介于 1 到 4 的值。预设渐变类型。

setPresetGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, presetGradientType: "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将填充设置为预设纹理。

setPresetTextured(presetTexture: Word.PresetTexture): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将填充设置为预设纹理。

setPresetTextured(presetTexture: "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将填充设置为双色渐变。

setTwoColorGradient(style: Word.GradientStyle, variant: number): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将填充设置为双色渐变。

setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.3 ]

将填充设置为统一颜色。

solid(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

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

toJSON(): Word.Interfaces.FillFormatData;

返回

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

track(): Word.FillFormat;

返回

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

untrack(): Word.FillFormat;

返回