Word.Shading class

Paquet:: word

Représente l’objet Shading .

Extends: OfficeExtension.ClientObject

Remarques

Utilisateur

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Updates shading properties (e.g., texture, pattern colors) of the specified style.
await Word.run(async (context) => {
  const styleName = (document.getElementById("style-name") as HTMLInputElement).value;
  if (styleName == "") {
    console.warn("Enter a style name to update shading properties.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else {
    const shading: Word.Shading = style.shading;
    shading.load();
    await context.sync();

    shading.backgroundPatternColor = "blue";
    shading.foregroundPatternColor = "yellow";
    shading.texture = Word.ShadingTextureType.darkTrellis;

    console.log("Updated shading.");
  }
});

Propriétés

backgroundPatternColor	Spécifie la couleur de l’arrière-plan de l’objet. Vous pouvez fournir la valeur au format '#RRGGBB' ou le nom de la couleur.
context	Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
foregroundPatternColor	Spécifie la couleur du premier plan de l’objet. Vous pouvez fournir la valeur au format '#RRGGBB' ou le nom de la couleur.
texture	Spécifie la texture d’ombrage de l’objet. Pour en savoir plus sur l’application d’arrière-plans tels que des textures, voir Ajouter, modifier ou supprimer la couleur d’arrière-plan dans Word.

Méthodes

load(options)	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)	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)	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.
set(properties, options)	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)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
toJSON()	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.Shading` est un objet API, la `toJSON` méthode renvoie un objet JavaScript simple (typé ) `Word.Interfaces.ShadingData`qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
track()	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.
untrack()	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.

Détails de la propriété

backgroundPatternColor

Spécifie la couleur de l’arrière-plan de l’objet. Vous pouvez fournir la valeur au format '#RRGGBB' ou le nom de la couleur.

backgroundPatternColor: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApi 1.6

context

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é

Word.RequestContext

foregroundPatternColor

Spécifie la couleur du premier plan de l’objet. Vous pouvez fournir la valeur au format '#RRGGBB' ou le nom de la couleur.

foregroundPatternColor: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApiDesktop 1.1

texture

Spécifie la texture d’ombrage de l’objet. Pour en savoir plus sur l’application d’arrière-plans tels que des textures, voir Ajouter, modifier ou supprimer la couleur d’arrière-plan dans Word.

texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.1

Détails de la méthode

load(options)

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.ShadingLoadOptions): Word.Shading;

Paramètres

options: Word.Interfaces.ShadingLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Word.Shading

load(propertyNames)

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

Paramètres

propertyNames: string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

Word.Shading

load(propertyNamesAndPaths)

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

Paramètres

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Word.Shading

set(properties, options)

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.ShadingUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties: Word.Interfaces.ShadingUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.

options: OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

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

set(properties: Word.Shading): void;

Paramètres

properties: Word.Shading

Retours

void

toJSON()

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.Shading est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.ShadingDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.ShadingData;

Retours

Word.Interfaces.ShadingData

track()

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

Retours

Word.Shading

untrack()

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

Retours

Word.Shading

Commentaires

Cette page a-t-elle été utile ?