New to Telerik UI for WinForms? Start a free 30-day trial

ICharacterData

Interface

The

CharacterData

interface extends Node with a set of attributes and methods for accessing character data in the DOM. For clarity this set is defined here rather than on each object that uses these attributes and methods. No DOM objects correspond directly to

CharacterData

, though

Text

and others do inherit the interface from it. All

offsets

in this interface start from

As explained in the

DOMString

interface, text strings in the DOM are represented in UTF-16, i.e. as a sequence of 16-bit units. In the following, the term 16-bit units is used whenever necessary to indicate that indexing on CharacterData is done in 16-bit units.

Definition

Namespace:Telerik.WinForms.Documents.FormatProviders.Html.Parsing.Dom

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

public interface ICharacterData : INode

Inherited Members INode.InsertBefore(INode, INode)INode.ReplaceChild(INode, INode)INode.RemoveChild(INode)INode.AppendChild(INode)INode.HasChildNodes()INode.CloneNode(bool)INode.Normalize()INode.IsSupported(string, string)INode.HasAttributes()INode.NodeNameINode.NodeValueINode.NodeTypeINode.ParentNodeINode.ChildNodesINode.FirstChildINode.LastChildINode.PreviousSiblingINode.NextSiblingINode.AttributesINode.OwnerDocumentINode.NamespaceURIINode.PrefixINode.LocalName...

Properties

Data

string

The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a

CharacterData

node. However, implementation limits may mean that the entirety of a node's data may not fit into a single

DOMString

. In such cases, the user may call

substringData

to retrieve the data in appropriately sized pieces.

string Data { get; set; }

Exceptions: DomException

NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

DomException

DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a

DOMString

variable on the implementation platform.

Length

int

The number of 16-bit units that are available through

data

and the

substringData

method below. This may have the value zero, i.e.,

CharacterData

nodes may be empty.

int Length { get; }

Methods

AppendData(string)

Append the string to the end of the character data of the node. Upon success,

data

provides access to the concatenation of

data

and the

DOMString

specified.

void AppendData(string arg)

Parameters:argstring

The

DOMString

to append.

Exceptions: DomException

NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

DeleteData(int, int)

Remove a range of 16-bit units from the node. Upon success,

data

and

length

reflect the change.

void DeleteData(int offset, int count)

Parameters:offsetint

The offset from which to start removing.

countint

The number of 16-bit units to delete. If the sum of

offset

and

count

exceeds

length

then all 16-bit units from

offset

to the end of the data are deleted.

DomException

INDEX_SIZE_ERR: Raised if the specified

offset

is negative or greater than the number of 16-bit units in

csharp

data

csharp

count

negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

InsertData(int, string)

Insert a string at the specified 16-bit unit offset.

void InsertData(int offset, string arg)

Parameters:offsetint

The character offset at which to insert.

argstring

The

DOMString

to insert.

DomException

INDEX_SIZE_ERR: Raised if the specified

offset

is negative or greater than the number of 16-bit units in

csharp

data

NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

ReplaceData(int, int, string)

Replace the characters starting at the specified 16-bit unit offset with the specified string.

void ReplaceData(int offset, int count, string arg)

Parameters:offsetint

The offset from which to start replacing.

countint

The number of 16-bit units to replace. If the sum of

offset

and

count

exceeds

length

, then all 16-bit units to the end of the data are replaced; (i.e., the effect is the same as a

remove

method call with the same range, followed by an

append

method invocation).

argstring

The

DOMString

with which the range must be replaced.

DomException

INDEX_SIZE_ERR: Raised if the specified

offset

is negative or greater than the number of 16-bit units in

csharp

data

csharp

count

negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

SubstringData(int, int)

Extracts a range of data from the node.

string SubstringData(int offset, int count)

Parameters:offsetint

Start offset of substring to extract.

countint

The number of 16-bit units to extract.

Returns:

string

The specified substring. If the sum of

offset

and

count

exceeds the

length

, then all 16-bit units to the end of the data are returned.

DomException

INDEX_SIZE_ERR: Raised if the specified

offset

is negative or greater than the number of 16-bit units in

csharp

data

csharp

count

negative.
DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a

DOMString