Interface
ICharacterData

Definition

Properties

Data

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.

Declaration

cs-api-definition
string Data { get; set; }

Property Value

string

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

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.

Declaration

cs-api-definition
int Length { get; }

Property Value

int

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.

Declaration

cs-api-definition
void AppendData(string arg)

Parameters

arg

string

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.

Declaration

cs-api-definition
void DeleteData(int offset, int count)

Parameters

offset

int

count

int

Exceptions

DomException

INDEX_SIZE_ERR: Raised if the specified

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

data
, or if the specified
count
is

negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

InsertData(int, string)

Declaration

cs-api-definition
void InsertData(int offset, string arg)

Parameters

offset

int

arg

string

ReplaceData(int, int, string)

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

Declaration

cs-api-definition
void ReplaceData(int offset, int count, string arg)

Parameters

offset

int

count

int

arg

string

Exceptions

DomException

INDEX_SIZE_ERR: Raised if the specified

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

data
, or if the specified
count
is

negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

SubstringData(int, int)

Extracts a range of data from the node.

Declaration

cs-api-definition
string SubstringData(int offset, int count)

Parameters

offset

int

count

int

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.

Exceptions

DomException

INDEX_SIZE_ERR: Raised if the specified

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

data
, or if the specified
count
is

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

DOMString
.