Word.FillFormat class

Gibt ein ColorFormat -Objekt zurück, das die Hintergrundfarbe für die Füllung darstellt.

readonly backgroundColor: Word.ColorFormat;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Gibt ein ColorFormat -Objekt zurück, das die Vordergrundfarbe für die Füllung darstellt.

readonly foregroundColor: Word.ColorFormat;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Winkel der Farbverlaufsfüllung an. Der gültige Wertebereich liegt zwischen 0 und 359,9.

gradientAngle: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Ruft den Farbverlaufstyp ab.

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

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt zurück, wie dunkel oder hell eine einfarbige Farbverlaufsfüllung ist. Der Wert 0 bedeutet, dass Schwarz mit der Vordergrundfarbe der Form gemischt wird, um den Farbverlauf zu bilden. Der Wert 1 bedeutet, dass Weiß gemischt wird. Werte zwischen 0 und 1 bedeuten, dass ein dunklerer oder hellerer Farbton der Vordergrundfarbe gemischt wird.

readonly gradientDegree: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Farbverlaufsstil für die Füllung zurück.

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

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Farbverlaufsvariante für die Füllung als ganzzahligen Wert von 1 bis 4 für die meisten Farbverlaufsfüllungen zurück.

readonly gradientVariant: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob das Objekt oder die darauf angewendete Formatierung sichtbar ist.

isVisible: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt einen PatternType Wert zurück, der das Muster darstellt, das auf die Füllung oder Zeile angewendet wird.

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";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den voreingestellten Farbverlaufstyp für die Füllung zurück.

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";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Ruft die voreingestellte Textur ab.

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";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob die Füllung mit der Form gedreht wird.

rotateWithObject: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Hiermit wird die Ausrichtung (der Ursprung des Koordinatenrasters) für die Anordnung der Texturfüllung angegeben.

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

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den horizontalen Skalierungsfaktor für die Texturfüllung an.

textureHorizontalScale: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Namen der benutzerdefinierten Texturdatei für die Füllung zurück.

readonly textureName: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den horizontalen Offset der Textur vom Ursprung in Punkt an.

textureOffsetX: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den vertikalen Offset der Textur an.

textureOffsetY: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob die Textur nebeneinander angeordnet ist.

textureTile: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Texturtyp für die Füllung zurück.

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

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den vertikalen Skalierungsfaktor für die Texturfüllung als Wert zwischen 0,0 und 1,0 an.

textureVerticalScale: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Transparenzgrad der Füllung für eine Form als Wert zwischen 0,0 (undurchsichtig) und 1,0 (klar) an.

transparency: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Ruft den Füllformattyp ab.

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

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

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

Parameter

Gibt zurück

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Word.FillFormat): void;

Parameter

Gibt zurück

Legt die Füllung auf einen einfarbigen Farbverlauf fest.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt die Füllung auf einen einfarbigen Farbverlauf fest.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt die Füllung auf ein Muster fest.

setPatterned(pattern: Word.PatternType): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt die Füllung auf ein Muster fest.

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;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt die Füllung auf einen voreingestellten Farbverlauf fest. Der Farbverlaufsstil. Die Farbverlaufsvariante. Kann ein Wert von 1 bis 4 sein.Der voreingestellte Farbverlaufstyp.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt die Füllung auf einen voreingestellten Farbverlauf fest. Der Farbverlaufsstil. Die Farbverlaufsvariante. Kann ein Wert von 1 bis 4 sein.Der voreingestellte Farbverlaufstyp.

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;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt die Füllung auf eine voreingestellte Textur fest.

setPresetTextured(presetTexture: Word.PresetTexture): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt die Füllung auf eine voreingestellte Textur fest.

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;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt die Füllung auf einen zweifarbigen Farbverlauf fest.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt die Füllung auf einen zweifarbigen Farbverlauf fest.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Legt die Füllung auf eine einheitliche Farbe fest.

solid(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Word.FillFormat Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.FillFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Word.Interfaces.FillFormatData;

Gibt zurück

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.

track(): Word.FillFormat;

Gibt zurück

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.FillFormat;

Gibt zurück