Skip to main content

GetTabs

Returns the custom tab stops of the current paragraph.

Syntax​

expression.GetTabs();

expression - A variable that represents a ApiParaPr class.

Parameters​

This method doesn't have any parameters.

Returns​

TabStop[]

Example​

Retrieve the tab stops set on a paragraph in a document.

// How do I read the tab stop positions and alignment types of a paragraph in a document?

// Inspect tab configuration to verify or display custom stop positions after applying them.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let paraPr = paragraph.GetParaPr();
paraPr.SetTabs([1440, 4320, 7200], ["left", "center", "right"]);
paragraph.AddTabStop();
paragraph.AddText("Left tab (1 inch)");
paragraph.AddLineBreak();
paragraph.AddTabStop();
paragraph.AddTabStop();
paragraph.AddText("Center tab (3 inches)");
let tabs = paraPr.GetTabs();
let paragraph2 = Api.CreateParagraph();
paragraph2.AddText("Tab count: " + tabs.length + ", first tab: " + tabs[0].Pos + " twips (" + tabs[0].Val + ")");
doc.Push(paragraph2);