Word.ShadowFormat class

Spécifie le niveau de flou pour un format d’ombre sous la forme d’une valeur comprise entre 0,0 et 100,0.

blur: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus 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, du trait ou de l’ombre.

readonly foregroundColor: Word.ColorFormat;

Valeur de propriété

Remarques

[ Ensemble 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

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie true si l’ombre de la forme apparaît remplie et est masquée par la forme, même si la forme n’a pas de remplissage, false si l’ombre n’a pas de remplissage et si le contour de l’ombre est visible à travers la forme si la forme n’a pas de remplissage.

obscured: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le décalage horizontal (en points) de l’ombre de la forme. Une valeur positive décale l'ombre vers la droite de la forme ; une valeur négative la décale vers la gauche.

offsetX: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le décalage vertical (en points) de l’ombre de la forme. Une valeur positive décalée l’ombre vers le haut de la forme ; une valeur négative la décalera vers le bas.

offsetY: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie s’il faut faire pivoter l’ombre lors de la rotation de la forme.

rotateWithShape: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie la largeur de l’ombre.

size: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le type de mise en forme d’ombre à appliquer à une forme.

style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

transparency: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le type d’ombre de forme.

type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Modifie le décalage horizontal de l’ombre par le nombre de points. Incrémenter Le nombre de points à ajuster.

incrementOffsetX(increment: number): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Modifie le décalage vertical de l'ombre suivant le nombre de points spécifié. Incrémenter Le nombre de points à ajuster.

incrementOffsetY(increment: number): void;

Paramètres

Retours

Remarques

[ Ensemble 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.ShadowFormatLoadOptions): Word.ShadowFormat;

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.ShadowFormat;

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.ShadowFormat;

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.ShadowFormatUpdateData, 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.ShadowFormat): void;

Paramètres

Retours

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.ShadowFormat est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.ShadowFormatDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.ShadowFormatData;

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 sur 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 suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.ShadowFormat;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour 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 mise en production de la mémoire ne prenne effet.

untrack(): Word.ShadowFormat;

Retours