getPositionByIndex method

getPositionByIndex(index)

Gets the position (in points) of the tab stop at the specified index.

getPositionByIndex(index: number)
ParameterTypeDescription
indexnumberAn index into the collection of tab stops.

Returns

The position of the tab stop.

Examples

Shows how to find a tab, stop by its index and verify its position.

let doc = new aw.Document();
let tabStops = doc.firstSection.body.paragraphs.at(0).paragraphFormat.tabStops;

tabStops.add(aw.ConvertUtil.millimeterToPoint(30), aw.TabAlignment.Left, aw.TabLeader.Dashes);
tabStops.add(aw.ConvertUtil.millimeterToPoint(60), aw.TabAlignment.Left, aw.TabLeader.Dashes);

// Verify the position of the second tab stop in the collection.
expect(tabStops.getPositionByIndex(1)).toBeCloseTo(aw.ConvertUtil.millimeterToPoint(60), 1);

See Also