Word.Shape class

Indique si une forme donnée peut chevaucher d’autres formes.

allowOverlap: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Spécifie une chaîne représentant le texte de remplacement associé à la forme.

altTextDescription: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Récupère l’objet Body de la forme. S’applique uniquement aux zones de texte et aux formes géométriques.

readonly body: Word.Body;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Inserts a content control into the first paragraph in the first text box.
  const firstShapeWithTextBox: Word.Shape = context.document.body.shapes
    .getByTypes([Word.ShapeType.textBox])
    .getFirst();
  firstShapeWithTextBox.load("type/body");
  await context.sync();

  const firstParagraphInTextBox: Word.Paragraph = firstShapeWithTextBox.body.paragraphs.getFirst();
  const newControl: Word.ContentControl = firstParagraphInTextBox.insertContentControl();
  newControl.load();
  await context.sync();

  console.log("New content control properties:", newControl);
});

Récupère la zone de dessin associée à la forme. Un objet dont la isNullObject propriété est définie sur true sera renvoyé si le type de forme n’est pas canvas. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

readonly canvas: Word.Canvas;

Valeur de propriété

Remarques

Jeu 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) => {
  // Inserts a canvas in the document.
  const canvasShape: Word.Shape = context.document.getSelection().insertCanvas();
  canvasShape.load();
  await context.sync();

  canvasShape.select();
  console.log("Inserted canvas:", canvasShape);

  const canvas: Word.Canvas = canvasShape.canvas;
  canvas.load("shape,shapes");
  await context.sync();

  console.log("Canvas object:", canvas);
});

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 la mise en forme de remplissage de la forme.

readonly fill: Word.ShapeFill;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Gets the color fill properties of the first moon found in the document body.
  const moon: Word.Shape = context.document.body.shapes
    .getByGeometricTypes([Word.GeometricShapeType.moon])
    .getFirstOrNullObject();
  moon.load("fill");
  await context.sync();

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

  const moonFill: Word.ShapeFill = moon.fill;
  const moonFillType = moonFill.type as Word.ShapeFillType;

  console.log("Color fill properties of the first moon found in the document body:");
  console.log(`\tForeground color: ${moonFill.foregroundColor}`);
  console.log(`\tBackground color: ${moonFill.backgroundColor}`);
  console.log(`\tTransparency: ${moonFill.transparency}`);
  console.log(`\tFill type: ${moonFillType}`);
});

Spécifie le type de forme géométrique de la forme. La valeur sera nulle si ce n’est pas une forme géométrique.

geometricShapeType: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

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

  if (geometricShape.isNullObject) {
    console.log("No geometric shapes found in the document body.");
    return;
  }

  console.log(
    `First geometric shape found in the document body is of type ${geometricShape.geometricShapeType}:`,
    geometricShape,
  );
});

Spécifie la hauteur, en points, de la forme.

height: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Spécifie le pourcentage de la hauteur de la forme par rapport à la taille verticale relative (c’est-à-dire la relativeVerticalSize propriété). Il ne peut pas être défini pour une forme incorporée ou enfant.

heightRelative: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Changes the relative size of the first set of grouped shapes (including text boxes) found in the document body.
  const firstShapeGroup: Word.Shape = context.document.body.shapes
    .getByTypes([Word.ShapeType.group])
    .getFirstOrNullObject();
  firstShapeGroup.load("shapeGroup/shapes");
  await context.sync();

  if (firstShapeGroup.isNullObject) {
    console.log("No shape groups found in the document body.");
    return;
  }

  let shapeGroup: Word.ShapeGroup = firstShapeGroup.shapeGroup;
  console.log(
    "About to change the relative size of the first shape group found in the document body:",
    shapeGroup.shapes,
  );
  firstShapeGroup.relativeHorizontalSize = Word.RelativeSize.insideMargin;
  firstShapeGroup.relativeVerticalSize = Word.RelativeSize.bottomMargin;
  firstShapeGroup.heightRelative = 50;

  console.log("Changed the relative size of the first shape group.");
});

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

readonly id: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Vérifiez si cette forme est l’enfant d’une forme de groupe ou d’une forme de canevas.

readonly isChild: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Spécifie la distance, en points, entre le côté gauche de la forme et la position horizontale relative (c’est-à-dire la relativeHorizontalPosition propriété). Pour une forme en ligne, la valeur 0 est renvoyée et ne peut pas être définie. Pour une forme enfant dans une zone de dessin ou un groupe, elle est relative au coin supérieur gauche.

left: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Spécifie la position relative à gauche sous forme de pourcentage, entre le côté gauche de la forme et la position horizontale relative (c’est-à-dire la relativeHorizontalalPosition propriété). Pour une forme en ligne ou enfant, elle renvoie 0 et ne peut pas être définie.

leftRelative: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Indique si les proportions de cette forme sont verrouillées.

lockAspectRatio: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Spécifie le nom de la forme.

name: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Obtient la forme de canevas parent de niveau supérieur de cette forme enfant. Elle sera nulle si ce n’est pas une forme enfant d’une toile.

readonly parentCanvas: Word.Shape;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Obtient la forme de groupe parent de niveau supérieur de cette forme enfant. Elle sera nulle si ce n’est pas une forme enfant d’un groupe.

readonly parentGroup: Word.Shape;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Spécifie la position horizontale relative de la forme. Pour une forme en ligne, il ne peut pas être défini. Pour plus d’informations, voir Word. Position horizontale relative.

relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Changes the position of the first set of grouped shapes (including text boxes) found in the document body.
  const firstShapeGroup: Word.Shape = context.document.body.shapes
    .getByTypes([Word.ShapeType.group])
    .getFirstOrNullObject();
  firstShapeGroup.load("shapeGroup/shapes");
  await context.sync();

  if (firstShapeGroup.isNullObject) {
    console.log("No shape groups found in the document body.");
    return;
  }

  let shapeGroup: Word.ShapeGroup = firstShapeGroup.shapeGroup;
  console.log("About to change the position of the first shape group found in document body:", shapeGroup.shapes);
  firstShapeGroup.relativeVerticalPosition = Word.RelativeVerticalPosition.insideMargin;
  firstShapeGroup.relativeHorizontalPosition = Word.RelativeHorizontalPosition.margin;

  console.log("Changed the position of the first shape group.");
});

Spécifie la taille horizontale relative de la forme. Utilisez-la avec la widthRelative propriété. Il ne peut pas être défini pour une forme incorporée ou enfant.

relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Changes the relative size of the first set of grouped shapes (including text boxes) found in the document body.
  const firstShapeGroup: Word.Shape = context.document.body.shapes
    .getByTypes([Word.ShapeType.group])
    .getFirstOrNullObject();
  firstShapeGroup.load("shapeGroup/shapes");
  await context.sync();

  if (firstShapeGroup.isNullObject) {
    console.log("No shape groups found in the document body.");
    return;
  }

  let shapeGroup: Word.ShapeGroup = firstShapeGroup.shapeGroup;
  console.log(
    "About to change the relative size of the first shape group found in the document body:",
    shapeGroup.shapes,
  );
  firstShapeGroup.relativeHorizontalSize = Word.RelativeSize.insideMargin;
  firstShapeGroup.relativeVerticalSize = Word.RelativeSize.bottomMargin;
  firstShapeGroup.heightRelative = 50;

  console.log("Changed the relative size of the first shape group.");
});

Spécifie la position verticale relative de la forme. Pour une forme en ligne, il ne peut pas être défini. Pour plus d’informations, voir Word. Position verticale relative.

relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Changes the position of the first set of grouped shapes (including text boxes) found in the document body.
  const firstShapeGroup: Word.Shape = context.document.body.shapes
    .getByTypes([Word.ShapeType.group])
    .getFirstOrNullObject();
  firstShapeGroup.load("shapeGroup/shapes");
  await context.sync();

  if (firstShapeGroup.isNullObject) {
    console.log("No shape groups found in the document body.");
    return;
  }

  let shapeGroup: Word.ShapeGroup = firstShapeGroup.shapeGroup;
  console.log("About to change the position of the first shape group found in document body:", shapeGroup.shapes);
  firstShapeGroup.relativeVerticalPosition = Word.RelativeVerticalPosition.insideMargin;
  firstShapeGroup.relativeHorizontalPosition = Word.RelativeHorizontalPosition.margin;

  console.log("Changed the position of the first shape group.");
});

Spécifie la taille verticale relative de la forme. Utilisez-la avec la heightRelative propriété. Il ne peut pas être défini pour une forme incorporée ou enfant.

relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Changes the relative size of the first set of grouped shapes (including text boxes) found in the document body.
  const firstShapeGroup: Word.Shape = context.document.body.shapes
    .getByTypes([Word.ShapeType.group])
    .getFirstOrNullObject();
  firstShapeGroup.load("shapeGroup/shapes");
  await context.sync();

  if (firstShapeGroup.isNullObject) {
    console.log("No shape groups found in the document body.");
    return;
  }

  let shapeGroup: Word.ShapeGroup = firstShapeGroup.shapeGroup;
  console.log(
    "About to change the relative size of the first shape group found in the document body:",
    shapeGroup.shapes,
  );
  firstShapeGroup.relativeHorizontalSize = Word.RelativeSize.insideMargin;
  firstShapeGroup.relativeVerticalSize = Word.RelativeSize.bottomMargin;
  firstShapeGroup.heightRelative = 50;

  console.log("Changed the relative size of the first shape group.");
});

Spécifie la rotation, en degrés, de la forme. Ne s’applique pas à la forme Canvas.

rotation: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Récupère le groupe de formes associé à la forme. Un objet dont la isNullObject propriété est définie sur true sera renvoyé si le type de forme n’est pas groupShape. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

readonly shapeGroup: Word.ShapeGroup;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Groups the shapes (including text boxes and pictures) found in the document body.
  const shapes: Word.ShapeCollection = context.document.body.shapes.getByTypes([
    Word.ShapeType.geometricShape,
    Word.ShapeType.textBox,
    Word.ShapeType.picture,
  ]);
  shapes.load("items");
  await context.sync();

  const numShapes = shapes.items.length;
  if (numShapes === 0) {
    console.log("No shapes found in the document body.");
    return;
  }

  console.log(`Number of shapes to group: ${numShapes}`);

  const groupedShape: Word.Shape = shapes.group();
  groupedShape.load("shapeGroup/shapes");
  await context.sync();

  const shapeGroup: Word.ShapeGroup = groupedShape.shapeGroup;
  console.log("Shapes grouped:", shapeGroup.shapes);
  groupedShape.select();
});

Récupère l’objet TextFrame de la forme.

readonly textFrame: Word.TextFrame;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Gets the text frame of the first text box in the main document.
  const shape: Word.Shape = context.document.body.shapes.getByTypes([Word.ShapeType.textBox]).getFirstOrNullObject();
  shape.load("textFrame");
  await context.sync();

  if (shape.isNullObject) {
    console.log("No shapes with text boxes found in the main document.");
    return;
  }

  console.log("Text frame of first text box:", shape.textFrame);
});

Renvoie la mise en forme d’habillage du texte de la forme.

readonly textWrap: Word.ShapeTextWrap;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Gets text wrap properties of the first text box in the main document.
  const shape: Word.Shape = context.document.body.shapes.getByTypes([Word.ShapeType.textBox]).getFirstOrNullObject();
  shape.load("textWrap");
  await context.sync();

  if (shape.isNullObject) {
    console.log("No shapes with text boxes found in the main document.");
    return;
  }

  console.log("Text wrap properties of first text box:", shape.textWrap);
});

Spécifie la distance, en points, entre le bord supérieur de la forme et la position verticale relative (c’est-à-dire la relativeVerticalPosition propriété). Pour une forme en ligne, la valeur 0 est renvoyée et ne peut pas être définie. Pour une forme enfant dans une zone de dessin ou un groupe, elle est relative au coin supérieur gauche.

top: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Spécifie la position supérieure relative sous forme de pourcentage, du bord supérieur de la forme à la position verticale relative (c’est-à-dire la relativeVerticalPosition propriété). Pour une forme en ligne ou enfant, elle renvoie 0 et ne peut pas être définie.

topRelative: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Récupère le type de forme. Actuellement, seules les formes suivantes sont prises en charge : zones de texte, formes géométriques, groupes, images et canevas.

readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Gets text boxes in the main document.
  const shapes: Word.ShapeCollection = context.document.body.shapes;
  shapes.load();
  await context.sync();

  if (shapes.items.length > 0) {
    console.log(`Number of shapes found in the main document: ${shapes.items.length}`);
    shapes.items.forEach(function (shape, index) {
      if (shape.type === Word.ShapeType.textBox) {
        console.log(`Shape ${index} in the main document has a text box. Properties:`, shape);
      } else {
        console.log(`Shape ${index} in the main document doesn't have a text box.`);
      }
    });
  } else {
    console.log("No shapes found in the main document.");
  }
});

Indique si la forme est visible. Ne s’applique pas aux formes en ligne.

visible: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Spécifie la largeur, en points, de la forme.

width: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Spécifie le pourcentage de largeur de la forme par rapport à la taille horizontale relative (c’est-à-dire la relativeHorizontalSize propriété). Il ne peut pas être défini pour une forme incorporée ou enfant.

widthRelative: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Supprime la forme et son contenu.

delete(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Deletes the first text box.
  context.document.body.shapes.getByTypes([Word.ShapeType.textBox]).getFirst().delete();
  await context.sync();

  console.log("The first text box in document was deleted.");
});

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.ShapeLoadOptions): Word.Shape;

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

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

Paramètres

Retours

Déplace la forme horizontalement en fonction du nombre de points.

moveHorizontally(distance: number): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Moves the first set of grouped shapes (including text boxes) found in the document body.
  const firstShapeGroup: Word.Shape = context.document.body.shapes
    .getByTypes([Word.ShapeType.group])
    .getFirstOrNullObject();
  firstShapeGroup.load("shapeGroup/shapes");
  await context.sync();

  if (firstShapeGroup.isNullObject) {
    console.log("No shape groups found in the document body.");
    return;
  }

  let shapeGroup: Word.ShapeGroup = firstShapeGroup.shapeGroup;
  console.log("About to move the first shape group found in the document body:", shapeGroup.shapes);
  firstShapeGroup.moveHorizontally(-10);
  firstShapeGroup.moveVertically(50);

  console.log("Moved the first shape group.");
});

Déplace la forme verticalement en fonction du nombre de points.

moveVertically(distance: number): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Moves the first set of grouped shapes (including text boxes) found in the document body.
  const firstShapeGroup: Word.Shape = context.document.body.shapes
    .getByTypes([Word.ShapeType.group])
    .getFirstOrNullObject();
  firstShapeGroup.load("shapeGroup/shapes");
  await context.sync();

  if (firstShapeGroup.isNullObject) {
    console.log("No shape groups found in the document body.");
    return;
  }

  let shapeGroup: Word.ShapeGroup = firstShapeGroup.shapeGroup;
  console.log("About to move the first shape group found in the document body:", shapeGroup.shapes);
  firstShapeGroup.moveHorizontally(-10);
  firstShapeGroup.moveVertically(50);

  console.log("Moved the first shape group.");
});

Met la hauteur de la forme à l’échelle en utilisant un facteur spécifié. Pour des images, vous pouvez indiquer si vous souhaitez mettre la forme à l’échelle par rapport à la taille d’origine ou la taille actuelle. Les formes autres que des images sont toujours mis à l’échelle par rapport à leur hauteur actuelle.

scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Scales the first set of grouped shapes (including text boxes) found in the document body.
  const firstShapeGroup: Word.Shape = context.document.body.shapes
    .getByTypes([Word.ShapeType.group])
    .getFirstOrNullObject();
  firstShapeGroup.load("shapeGroup/shapes");
  await context.sync();

  if (firstShapeGroup.isNullObject) {
    console.log("No shape groups found in the document body.");
    return;
  }

  let shapeGroup: Word.ShapeGroup = firstShapeGroup.shapeGroup;
  console.log("About to scale the first shape group found in the document body:", shapeGroup.shapes);
  firstShapeGroup.scaleHeight(0.75, Word.ShapeScaleType.currentSize);
  firstShapeGroup.scaleWidth(0.5, Word.ShapeScaleType.currentSize, Word.ShapeScaleFrom.scaleFromBottomRight);

  console.log("Scaled the first shape group.");
});

Met la hauteur de la forme à l’échelle en utilisant un facteur spécifié. Pour des images, vous pouvez indiquer si vous souhaitez mettre la forme à l’échelle par rapport à la taille d’origine ou la taille actuelle. Les formes autres que des images sont toujours mis à l’échelle par rapport à leur hauteur actuelle.

scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

Met la largeur de la forme à l’échelle en utilisant un facteur spécifié. Pour des images, vous pouvez indiquer si vous souhaitez mettre la forme à l’échelle par rapport à la taille d’origine ou la taille actuelle. Les formes autres que des images sont toujours mis à l’échelle par rapport à leur hauteur actuelle.

scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Scales the first set of grouped shapes (including text boxes) found in the document body.
  const firstShapeGroup: Word.Shape = context.document.body.shapes
    .getByTypes([Word.ShapeType.group])
    .getFirstOrNullObject();
  firstShapeGroup.load("shapeGroup/shapes");
  await context.sync();

  if (firstShapeGroup.isNullObject) {
    console.log("No shape groups found in the document body.");
    return;
  }

  let shapeGroup: Word.ShapeGroup = firstShapeGroup.shapeGroup;
  console.log("About to scale the first shape group found in the document body:", shapeGroup.shapes);
  firstShapeGroup.scaleHeight(0.75, Word.ShapeScaleType.currentSize);
  firstShapeGroup.scaleWidth(0.5, Word.ShapeScaleType.currentSize, Word.ShapeScaleFrom.scaleFromBottomRight);

  console.log("Scaled the first shape group.");
});

Met la largeur de la forme à l’échelle en utilisant un facteur spécifié. Pour des images, vous pouvez indiquer si vous souhaitez mettre la forme à l’échelle par rapport à la taille d’origine ou la taille actuelle. Les formes autres que des images sont toujours mis à l’échelle par rapport à leur hauteur actuelle.

scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

Sélectionne la forme.

select(selectMultipleShapes?: boolean): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

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

await Word.run(async (context) => {
  // Groups the shapes (including text boxes and pictures) found in the document body.
  const shapes: Word.ShapeCollection = context.document.body.shapes.getByTypes([
    Word.ShapeType.geometricShape,
    Word.ShapeType.textBox,
    Word.ShapeType.picture,
  ]);
  shapes.load("items");
  await context.sync();

  const numShapes = shapes.items.length;
  if (numShapes === 0) {
    console.log("No shapes found in the document body.");
    return;
  }

  console.log(`Number of shapes to group: ${numShapes}`);

  const groupedShape: Word.Shape = shapes.group();
  groupedShape.load("shapeGroup/shapes");
  await context.sync();

  const shapeGroup: Word.ShapeGroup = groupedShape.shapeGroup;
  console.log("Shapes grouped:", shapeGroup.shapes);
  groupedShape.select();
});

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

toJSON(): Word.Interfaces.ShapeData;

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

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

Retours