Word.FillFormat class

Renvoie un ColorFormat objet qui représente la couleur d’arrière-plan du remplissage.

readonly backgroundColor: Word.ColorFormat;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Renvoie un ColorFormat objet qui représente la couleur de premier plan du remplissage.

readonly foregroundColor: Word.ColorFormat;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie l’angle du remplissage dégradé. La plage de valeurs valide est comprise entre 0 et 359,9.

gradientAngle: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Obtient le type de couleur dégradé.

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

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Renvoie la couleur foncée ou claire d’un remplissage dégradé unicolore. La valeur 0 signifie que le noir est mélangé à la couleur de premier plan de la forme pour former le dégradé. La valeur 1 signifie que le blanc est mélangé. Les valeurs comprises entre 0 et 1 signifient qu’une nuance plus foncée ou plus claire de la couleur de premier plan est mélangée.

readonly gradientDegree: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Renvoie le style de dégradé du remplissage.

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

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Renvoie la variante de dégradé du remplissage sous la forme d’une valeur entière de 1 à 4 pour la plupart des remplissages de dégradé.

readonly gradientVariant: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie si l’objet ou la mise en forme qui lui est appliquée est visible.

isVisible: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Renvoie une PatternType valeur qui représente le motif appliqué au remplissage ou à la ligne.

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

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Renvoie le type de dégradé prédéfini pour le remplissage.

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

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Obtient la texture prédéfinie.

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

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique si le remplissage pivote avec la forme.

rotateWithObject: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Définit l’alignement (l’origine de la grille de coordonnées) de la mosaïque de la texture de remplissage.

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

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie le facteur de mise à l’échelle horizontale pour le remplissage de texture.

textureHorizontalScale: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Retourne le nom du fichier de texture personnalisé pour le remplissage.

readonly textureName: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie le décalage horizontal de la texture par rapport à l’origine en points.

textureOffsetX: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie le décalage vertical de la texture.

textureOffsetY: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique si la texture est en mosaïque.

textureTile: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Retourne le type de texture du remplissage.

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

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie le facteur de mise à l’échelle verticale pour le remplissage de texture sous la forme d’une valeur comprise entre 0,0 et 1,0.

textureVerticalScale: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie le degré de transparence du remplissage d’une forme sous la forme d’une valeur comprise entre 0,0 (opaque) et 1,0 (clair).

transparency: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Obtient le type de format de remplissage.

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

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

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

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.FillFormat): void;

Paramètres

Retours

Définit le remplissage sur un dégradé d’une couleur.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Définit le remplissage sur un dégradé d’une couleur.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Définit le remplissage sur un modèle.

setPatterned(pattern: Word.PatternType): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Définit le remplissage sur un modèle.

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;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Définit le remplissage sur un dégradé prédéfini. Style dégradé. Variante de gradient. Peut être une valeur comprise entre 1 et 4. Type de dégradé prédéfini.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Définit le remplissage sur un dégradé prédéfini. Style dégradé. Variante de gradient. Peut être une valeur comprise entre 1 et 4. Type de dégradé prédéfini.

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;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Définit le remplissage sur une texture prédéfinie.

setPresetTextured(presetTexture: Word.PresetTexture): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Définit le remplissage sur une texture prédéfinie.

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;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Définit le remplissage sur un dégradé à deux couleurs.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Définit le remplissage sur un dégradé à deux couleurs.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Définit le remplissage sur une couleur uniforme.

solid(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.FillFormat est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.FillFormatDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.FillFormatData;

Retours

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.FillFormat;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.

untrack(): Word.FillFormat;

Retours