GrapeCity.Documents.Word.Tab

Class Tab

Namespace

GrapeCity.Documents.Word

Assembly

GcDocs.Word.dll

Represents an absolute position tab element in a body content.

public class Tab : Text, IBrowsable<Text>

Inheritance

object

ContentObject

Text

Tab

Implements

IBrowsable<Text>

Inherited Members

Text.ToString()

Text.Previous

Text.Next

Text.PreserveSpace

Text.ParentRun

Text.IsOMathText

ContentObject.GetChildren<T>()

ContentObject.GetRange()

ContentObject.GetPersistentRange()

ContentObject.Delete()

ContentObject.CanAdd(Type)

ContentObject.CanAdd(Type, out Exception)

ContentObject.CanAddContentControl(ContentControlType)

ContentObject.CanAddContentControl(ContentControlType, out Exception)

ContentObject.Start

ContentObject.End

ContentObject.ParentBody

ContentObject.ParentContent

ContentObject.Document

ContentObject.Children

ContentObject.Guid

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Remarks

An absolute position tab is a character that is used to advance the position on the current line of text when displaying content, using the following logic:

Regardless of any number of custom tab stops defined using the TabStop, the absolute position tab character shall advance to the position specified by its Alignment and RelativeTo properties.

The resulting end position of the tab character shall not be affected by the addition of any custom tab stops or changes to the value of the DefaultTabStop.

If the alignment location specified by the positional tab cannot be found on the current line because the starting location is past that point, then the tab character shall advance to that location on the next available line in the document.

Properties

Alignment

Gets or sets the tab alignment.

public TabAlignment Alignment { get; set; }

Property Value

TabAlignment

Remarks

An absolute position tab is a character that is used to advance the position on the current line of text when displaying content, using the following logic:

Regardless of any number of custom tab stops defined using the TabStop, the absolute position tab character shall advance to the position specified by its Alignment and RelativeTo properties.

The resulting end position of the tab character shall not be affected by the addition of any custom tab stops or changes to the value of the DefaultTabStop.

If the alignment location specified by the positional tab cannot be found on the current line because the starting location is past that point, then the tab character shall advance to that location on the next available line in the document.

Leader

Gets or sets the tab leader character.

public TabLeader Leader { get; set; }

Property Value

TabLeader

Remarks

An absolute position tab is a character that is used to advance the position on the current line of text when displaying content, using the following logic:

Regardless of any number of custom tab stops defined using the TabStop, the absolute position tab character shall advance to the position specified by its Alignment and RelativeTo properties.

The resulting end position of the tab character shall not be affected by the addition of any custom tab stops or changes to the value of the DefaultTabStop.

If the alignment location specified by the positional tab cannot be found on the current line because the starting location is past that point, then the tab character shall advance to that location on the next available line in the document.

RelativeTo

Gets or sets the extent to calculate the position of the tab.

public TabRelativeTo RelativeTo { get; set; }

Property Value

TabRelativeTo

Remarks

An absolute position tab is a character that is used to advance the position on the current line of text when displaying content, using the following logic:

Regardless of any number of custom tab stops defined using the TabStop, the absolute position tab character shall advance to the position specified by its Alignment and RelativeTo properties.

The resulting end position of the tab character shall not be affected by the addition of any custom tab stops or changes to the value of the DefaultTabStop.

If the alignment location specified by the positional tab cannot be found on the current line because the starting location is past that point, then the tab character shall advance to that location on the next available line in the document.

Value

Gets the text representation of the tab.

public override string Value { get; set; }

Property Value

string

Remarks

Set is not supported.

Exceptions

IsReadOnlyException

Throws when set is called.

Methods

Split(int)

Splitting of a tab is not supported.

public override Text Split(int position)

Parameters

position int

Returns

Text

Remarks

An absolute position tab is a character that is used to advance the position on the current line of text when displaying content, using the following logic:

Regardless of any number of custom tab stops defined using the TabStop, the absolute position tab character shall advance to the position specified by its Alignment and RelativeTo properties.

The resulting end position of the tab character shall not be affected by the addition of any custom tab stops or changes to the value of the DefaultTabStop.

If the alignment location specified by the positional tab cannot be found on the current line because the starting location is past that point, then the tab character shall advance to that location on the next available line in the document.

Exceptions

ContentNotSplittableException

Throws always.