The DOMCharacterData 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 0.

Instance Methods

AppendData( String arg )

Append the string to the end of the character data of the node.

DeleteData( Integer offset, Integer count )

Remove a range of characters from the node.

GetData( )

Get the character data of the node that implements this interface.

GetLength( )

The number of characters that are available through data and the substringData method.

InsertData( Integer offset, String arg )

Insert a string at the specified character offset.

ReplaceData( Integer offset, Integer count, String arg )

Replace the characters starting at the specified character offset with the specified string.

SetData( String arg )

Sets the character data of the node that implements this interface.

SubstringData( Integer offset, Integer count )

Extracts a range of data from the node.

Instance Methods

AppendData

Void AppendData( String arg )

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.

Parameters

arg

The DOMString to append.

Returns:

DeleteData

Void DeleteData( Integer offset,
Integer count )

Remove a range of characters from the node. Upon success, data and length reflect the change.

Parameters

offset

The offset from which to remove characters.

count

The number of characters to delete. If the sum of offset and count exceeds length then all characters from offset to the end of the data are deleted.

Returns:

GetData

String GetData()

Get the character data of the node that implements this interface.

Returns:

The character data of this node.

GetLength

Integer GetLength()

The number of characters that are available through data and the substringData method below. This may have the value zero, i.e., CharacterData nodes may be empty.

Returns:

The number of characters available.

InsertData

Void InsertData( Integer offset,
String arg )

Insert a string at the specified character offset.

Parameters

offset

The character offset at which to insert.

arg

The DOMString to insert.

Returns:

ReplaceData

Void ReplaceData( Integer offset,
Integer count,
String arg )

Replace the characters starting at the specified character offset with the specified string.

Parameters

offset

The offset from which to start replacing.

count

The number of characters to replace. If the sum of offset and count exceeds length, then all characters 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).

arg

The DOMString with which the range must be replaced.

Returns:

SetData

Void SetData( String arg )

Sets the character data of the node that implements this interface.

Parameters

arg

The data to set for this node.

Returns:

SubstringData

String SubstringData( Integer offset,
Integer count )

Extracts a range of data from the node.

Parameters

offset

Start offset of substring to extract.

count

The number of characters to extract.

Returns:

The specified substring. If the sum of offset and count exceeds the length, then all characters to the end of the data are returned.