OfficeIMO

API Reference

Class

WordTabStop

Namespace OfficeIMO.Word
Assembly OfficeIMO.Word
Implements
IEquatable<WordTabStop>

Represents a tab stop within a WordParagraph.

Inheritance

  • Object
  • WordTabStop

Constructors

WordTabStop 2 overloads
public WordTabStop(WordParagraph wordParagraph) #

Initializes a new instance of the WordTabStop class for the specified paragraph.

Parameters

wordParagraph OfficeIMO.Word.WordParagraph requiredposition: 0
The paragraph to which this tab stop belongs.
public WordTabStop(WordParagraph wordParagraph, TabStop tab) #

Initializes a new instance of the WordTabStop class using an existing TabStop element.

Parameters

wordParagraph OfficeIMO.Word.WordParagraph requiredposition: 0
The paragraph to which this tab stop belongs.
tab DocumentFormat.OpenXml.Wordprocessing.TabStop requiredposition: 1
The underlying Open XML tab stop element.

Methods

AddTab(System.Int32 position, System.Nullable{DocumentFormat.OpenXml.Wordprocessing.TabStopValues} alignment, System.Nullable{DocumentFormat.OpenXml.Wordprocessing.TabStopLeaderCharValues} leader) #

Adds a new tab stop to the paragraph and sets this instance to reference it.

Parameters

position System.Int32 required
The position of the tab stop in twentieths of a point.
alignment System.Nullable{DocumentFormat.OpenXml.Wordprocessing.TabStopValues} required
Optional alignment value. Defaults to Left.
leader System.Nullable{DocumentFormat.OpenXml.Wordprocessing.TabStopLeaderCharValues} required
Optional leader value. Defaults to None.

Returns

The current WordTabStop instance.

Equals 2 overloads
public virtual Boolean Equals(WordTabStop other) #
Returns: Boolean

Determines whether the specified WordTabStop is equal to the current instance.

Parameters

other OfficeIMO.Word.WordTabStop requiredposition: 0
The tab stop to compare with the current instance.

Returns

true if the tab stops have the same alignment, leader and position; otherwise, false.

public override Boolean Equals(Object obj) #
Returns: Boolean

Determines whether the specified object is equal to the current instance.

Parameters

obj System.Object requiredposition: 0
The object to compare with the current instance.

Returns

true if the objects are equal; otherwise, false.

public override Int32 GetHashCode() #
Returns: Int32

Returns a hash code for this instance.

Returns

A hash code for the current object.

Properties

public TabStopValues Alignment { get; set; } #

Gets or sets the alignment type for the tab stop.

public TabStopLeaderCharValues Leader { get; set; } #

Gets or sets the leader character displayed before the tab stop.

public Int32 Position { get; set; } #

Gets or sets the position of the tab stop in twentieths of a point.