AlignmentTab Class

Namespace:: GemBox.Document

Assembly:: GemBox.Document.dll

Represents an alignment tab, also called an absolute position tab (ptab).

C#
VB.NET

public class AlignmentTab : Inline

Public Class AlignmentTab
    Inherits Inline

Inheritance:: System.Object
Element
Inline
AlignmentTab

Remarks

An absolute position tab is a character which is used to advance the position on the current line of text based on its Alignment and RelativeTo properties. The resulting end position of the tab character is not affected by the addition of any custom tab stops or changes to the value of the default tab stop.

Constructors

AlignmentTab(DocumentModel, TabStopAlignment)

Initializes a new instance of the AlignmentTab.

C#
VB.NET

public AlignmentTab(DocumentModel document, TabStopAlignment alignment)

Public Sub New(document As DocumentModel, alignment As TabStopAlignment)

Parameters

document: DocumentModel

The owner document.

alignment: TabStopAlignment

The alignment of the tab. The only valid values for AlignmentTab are Left, Center and Right.

Properties

Alignment

Gets or sets the alignment of the current AlignmentTab, which determines the alignment that will be applied to text entered at the current AlignmentTab position.

C#
VB.NET

public TabStopAlignment Alignment { get; set; }

Public Property Alignment As TabStopAlignment

Property Value

TabStopAlignment

The alignment of the current AlignmentTab.

Remarks

The only valid values for AlignmentTab are Left, Center and Right.

CharacterFormat

Gets or sets the character format.

C#
VB.NET

public CharacterFormat CharacterFormat { get; set; }

Public Property CharacterFormat As CharacterFormat

Property Value

CharacterFormat

The character format.

CharacterFormatRevision

Gets or sets the revision of the format of this AlignmentTab. This property contains the format which was applied to this AlignmentTab before the revision.

C#
VB.NET

public CharacterFormatRevision CharacterFormatRevision { get; set; }

Public Property CharacterFormatRevision As CharacterFormatRevision

Property Value

CharacterFormatRevision

The revision of the format of this AlignmentTab.

Remarks

The revision is internally stored as a member of CharacterFormat. Using set property on CharacterFormat overrides this revision.

Document

Gets the owner document.

C#
VB.NET

public override DocumentModel Document { get; }

Public Overrides ReadOnly Property Document As DocumentModel

Property Value

DocumentModel

The owner document.

Overrides

Element.Document

ElementType

Gets the ElementType of this Element instance.

C#
VB.NET

public override ElementType ElementType { get; }

Public Overrides ReadOnly Property ElementType As ElementType

Property Value

ElementType

The ElementType of this Element instance.

Overrides

Element.ElementType

Leader

Gets or sets the character which shall be used to fill in the space created by a tab which ends at this AlignmentTab position.

C#
VB.NET

public TabStopLeader Leader { get; set; }

Public Property Leader As TabStopLeader

Property Value

TabStopLeader

The character which shall be used to fill in the space created by a tab which ends at this AlignmentTab position.

RelativeTo

Gets or sets a value that specifies the base position which should be used to align the tab.

C#
VB.NET

public TabPositioningBase RelativeTo { get; set; }

Public Property RelativeTo As TabPositioningBase

Property Value

TabPositioningBase

The base position which should be used to align the tab.

Methods

Clone()

Clones this AlignmentTab instance.

C#
VB.NET

public AlignmentTab Clone()

Public Function Clone As AlignmentTab

Returns

AlignmentTab

Cloned AlignmentTab.

Remarks

Document content element instance can exist only in a one place in the document.

If you want to insert document content element into some other part of the same document, then clone the element and insert its clone.

If you want to insert document content element into another document, then you should first import it into another document with Import<T>(T, Boolean, Boolean) method and then insert the imported element.

For more information, see cloning example.

Inherited Properties

Content	Gets the content of the current Element. (Inherited from Element)
Parent	Gets the parent of this Element instance. (Inherited from Element)
ParentCollection	Gets the InlineCollection that contains this Inline instance. (Inherited from Inline)
Revision	Gets or sets the revision information for the inline. (Inherited from Inline)

Inherited Methods

Clone(System.Boolean)	Clones this Inline instance. (Inherited from Inline)
GetChildElements(System.Boolean)	Gets the child elements. (Inherited from Element)
GetChildElements(System.Boolean, ElementType[])	Gets the child elements filtered by ElementType. (Inherited from Element)
GetParentElements()	Gets the parent elements. (Inherited from Element)
GetParentElements(ElementType[])	Gets the parent elements. (Inherited from Element)