Word.ShapeTextVerticalAlignment enum

Package:: word

Specifies the vertical alignment for the text frame in a shape.

Remarks

API set: WordApiDesktop 1.2

Used by

Word.TextFrame: verticalAlignment

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 frame 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("textFrame");
 await context.sync();

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

 const textFrame: Word.TextFrame = shape.textFrame;
 textFrame.verticalAlignment = Word.ShapeTextVerticalAlignment.bottom;
 textFrame.orientation = Word.ShapeTextOrientation.vertical270;
 textFrame.autoSizeSetting = Word.ShapeAutoSize.shapeToFitText;

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