CharacterRun

Description

The CharacterRun class represents a contiguous run of characters in the document, all of which have the same formatting.

C#

public sealed class CharacterRun : Element

vb.net

Public NotInheritable Class CharacterRun

Inherits Element

Remarks

To insert a new character run into a document, use Element.InsertTextBefore() or Element.InsertTextAfter(). To get an existing character run, use Element.GetElements(Element.Type.CharacterRun) or Element.Children and check which elements are of type Element.Type.CharacterRun.

The following sample demonstrates inserting a new character run into a document and retrieving the first character run from an existing document.

Examples

C#

//--- Insert a character run at the end of the document
WordApplication app = new WordApplication();
Document doc = app.Create();
CharacterRun run = doc.InsertTextAfter("Hello world!", true);
 
//--- Get the first character run of an existing document
WordApplication app = new WordApplication();
Document doc = app.Open(@"C:\sample.doc");
CharacterRun firstCharRun =
     (CharacterRun)doc.GetElements(Element.Type.CharacterRun)[0];

vb.net

'--- Insert a character run at the end of the document
Dim app As New WordApplication()
Dim doc As Document = app.Create()
Dim run As CharacterRun = doc.InsertTextAfter("Hello world!", True)
 
'--- Get the first character run of an existing document
Dim app As New WordApplication()
Dim doc As Document = app.Open("C:\sample.doc")
Dim firstCharRun As CharacterRun = _
     doc.GetElements(Elements.Type.CharacterRun)(0)

Properties

Name	Description
Deleted	Returns a `boolean` that represents if this character run was deleted with revision tracking on.
DeletedBy	Returns a `String` that represents the name of the author who deleted the text in this character run (if revision tracking was on when it was deleted -- Deleted returns true).
DeletedTime	Returns a `DateTime` object that represents the date and time the text in this character run was deleted (if revision tracking was on when it was deleted -- Deleted returns true).
Font	Sets or returns a font for the CharacterRun.
ModifiedBy	Returns a `String` that represents the name of the author who inserted the text in this character run (if revision tracking was on when it was modified).
ModifiedTime	Returns a `DateTime` object that represents the date and time the text in this character run was inserted (if revision tracking was on when it was modified).
New	Returns a `boolean` that represents if this character run was added while revision tracking was turned on.
PropertiesChangedBy	Returns a `String` that represents the name of the author who modified the properties of this character run.
PropertiesChangedTime	Returns a `DateTime` object that represents the date and time the properties of this character run were modified.
Style	Sets or Returns a NamedStyle object that represents the Style of this character run.

Space Shortcuts

Page tree

Description

Remarks

Examples

Properties