Access Keys:
Skip to content (Access Key - 0)


CharacterRun

Description

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

Signature: C#
Signature: VB.NET

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#
vb.net

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.
Adaptavist Theme Builder Powered by Atlassian Confluence