Word.RelativeSize enum

Remarks

API set: WordApiDesktop 1.2

Used by

• Word.Shape: relativeHorizontalSize, relativeVerticalSize

Examples

// 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.");
});

Fields