Word.ShapeTextWrapSide enum

Remarks

API set: WordApiDesktop 1.2

Used by

• Word.ShapeTextWrap: side

Examples

// 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) => {
 // Sets text wrap properties of the first text box.
 const firstShapeWithTextBox: Word.Shape = context.document.body.shapes
 .getByTypes([Word.ShapeType.textBox])
 .getFirstOrNullObject();
 firstShapeWithTextBox.load("textWrap");
 await context.sync();

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

 const textWrap: Word.ShapeTextWrap = firstShapeWithTextBox.textWrap;
 textWrap.type = Word.ShapeTextWrapType.square;
 textWrap.side = Word.ShapeTextWrapSide.both;

 console.log("The first text box's text wrap properties were updated:", textWrap);
});

Fields