SpecialCharacter Class

Namespace:

GemBox.Document

Assembly:

GemBox.Document.dll

Represents a character, such as break or tab, which shall be placed at the current location in the document content.

• C#
• VB.NET

public sealed class SpecialCharacter : Inline

Public NotInheritable Class SpecialCharacter
    Inherits Inline

Inheritance:

System.Object

Element

Inline

SpecialCharacter

Remarks

SpecialCharacter is an Inline element. To specify which special character you want to insert, use CharacterType property.

For more information about breaks, see breaks example.

For more information about tabs, see TabStop.

Constructors

SpecialCharacter(DocumentModel, SpecialCharacterType)

Initializes a new instance of the SpecialCharacter class.

• C#
• VB.NET

public SpecialCharacter(DocumentModel document, SpecialCharacterType specialCharacterType)

Public Sub New(document As DocumentModel, specialCharacterType As SpecialCharacterType)

Parameters

document

DocumentModel

The owner document.

specialCharacterType

SpecialCharacterType

The character type.

Properties

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.

Remarks

This property is defined as direct formatting, since it is directly applied to the SpecialCharacter and supersedes any formatting from styles.

For more information about character formatting, see character formatting example.

CharacterFormatRevision

Gets or sets the revision of the format of this SpecialCharacter. This property contains the format which was applied to this SpecialCharacter 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 SpecialCharacter.

Remarks

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

CharacterType

Gets or sets the character type.

• C#
• VB.NET

public SpecialCharacterType CharacterType { get; set; }

Public Property CharacterType As SpecialCharacterType

Property Value

SpecialCharacterType

The character type.

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

Methods

Clone()

Clones this SpecialCharacter instance.

• C#
• VB.NET

public SpecialCharacter Clone()

Public Function Clone As SpecialCharacter

Returns

SpecialCharacter

Cloned SpecialCharacter.

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)

See Also

TabStop