Run Class

Namespace:

GemBox.Document

Assembly:

GemBox.Document.dll

Represents a region of text with a common set of properties.

• C#
• VB.NET

public sealed class Run : Inline

Public NotInheritable Class Run
 Inherits Inline

Run is an Inline element used to insert textual content to a document.

Text property holds a text contained in the Run instance.

Run can be formatted directly using the CharacterFormat property or, indirectly, using a CharacterStyle class. For more information, see character formatting example.

Initializes a new instance of the Run class with empty Text.

• C#
• VB.NET

public Run(DocumentModel document)

Public Sub New(document As DocumentModel)

document

DocumentModel

Initializes a new instance of the Run class with specified text.

• C#
• VB.NET

public Run(DocumentModel document, string text)

Public Sub New(document As DocumentModel, text As String)

document

DocumentModel

text

System.String

Gets or sets the character format.

• C#
• VB.NET

public CharacterFormat CharacterFormat { get; set; }

Public Property CharacterFormat As CharacterFormat

CharacterFormat

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

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

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

• C#
• VB.NET

public CharacterFormatRevision CharacterFormatRevision { get; set; }

Public Property CharacterFormatRevision As CharacterFormatRevision

CharacterFormatRevision

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

Gets the owner document.

• C#
• VB.NET

public override DocumentModel Document { get; }

Public Overrides ReadOnly Property Document As DocumentModel

DocumentModel

Gets the ElementType of this Element instance.

• C#
• VB.NET

public override ElementType ElementType { get; }

Public Overrides ReadOnly Property ElementType As ElementType

ElementType

Gets or sets the text of this Run instance.

• C#
• VB.NET

public string Text { get; set; }

Public Property Text As String

System.String

Text should not contain special characters like '\n', '\r', '\t', '\v' and '\f'. If it does, System.InvalidOperationException will be thrown. To add line breaks, page breaks, column breaks and tabs, use SpecialCharacter element.

Clones this Run instance.

• C#
• VB.NET

public Run Clone()

Public Function Clone As Run

Run

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.