TabAlignment

TabAlignment enumeration

Specifies the alignment/type of a tab stop.

public enum TabAlignment

Values

NameValueDescription
Left0Left-aligns the text after the tab stop.
Center1Centers the text around the tab stop.
Right2Right-aligns the text at the tab stop.
Decimal3Aligns the text at the decimal dot.
Bar4Draws a vertical bar at the tab stop position.
List6The tab is a delimiter between the number/bullet and text in a list item.
Clear7Clears any tab stop in this position.

Examples

Shows how to set custom tab stops for a paragraph.

Document doc = new Document();
Paragraph para = doc.FirstSection.Body.FirstParagraph;

// If we are in a paragraph with no tab stops in this collection,
// the cursor will jump 36 points each time we press the Tab key in Microsoft Word.
Assert.AreEqual(0, doc.FirstSection.Body.FirstParagraph.GetEffectiveTabStops().Length);

// We can add custom tab stops in Microsoft Word if we enable the ruler via the "View" tab.
// Each unit on this ruler is two default tab stops, which is 72 points.
// We can add custom tab stops programmatically like this.
TabStopCollection tabStops = doc.FirstSection.Body.FirstParagraph.ParagraphFormat.TabStops;
tabStops.Add(72, TabAlignment.Left, TabLeader.Dots);
tabStops.Add(216, TabAlignment.Center, TabLeader.Dashes);
tabStops.Add(360, TabAlignment.Right, TabLeader.Line);

// We can see these tab stops in Microsoft Word by enabling the ruler via "View" -> "Show" -> "Ruler".
Assert.AreEqual(3, para.GetEffectiveTabStops().Length);

// Any tab characters we add will make use of the tab stops on the ruler and may,
// depending on the tab leader's value, leave a line between the tab departure and arrival destinations.
para.AppendChild(new Run(doc, "\tTab 1\tTab 2\tTab 3"));

doc.Save(ArtifactsDir + "Paragraph.TabStops.docx");

See Also

SubDocument Class TabLeader Enum