Word.Canvas class

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é

Obtient un entier qui représente l’identificateur de canevas.

readonly id: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Obtient l’objet Shape associé au canevas.

readonly shape: Word.Shape;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Obtient la collection de Word. Objets Shape. Actuellement, seules les zones de texte, les images et les formes géométriques sont prises en charge.

readonly shapes: Word.ShapeCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-canvases.yaml

await Word.run(async (context) => {
  // Gets the first canvas found in the document body.
  const canvasShape: Word.Shape = context.document.body.shapes
    .getByTypes([Word.ShapeType.canvas])
    .getFirstOrNullObject();
  canvasShape.load();
  canvasShape.load("canvas/shapes");
  await context.sync();

  if (canvasShape.isNullObject) {
    console.log("No canvases found in the document body.");
    return;
  }

  console.log("First canvas found in the document body:", canvasShape);
  console.log("Shapes associated with the first canvas:", canvasShape.canvas.shapes);
  canvasShape.select();
});

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.CanvasLoadOptions): Word.Canvas;

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

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

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

toJSON(): Word.Interfaces.CanvasData;

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

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

Retours