pdk.flow.xml.XmlCharacterData
contains functions to operate with XML CharacterData variables
Last updated
contains functions to operate with XML CharacterData variables
Last updated
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.
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.
Arguments:
Result:
No variable is returned. The input characterData has arg data.
Possible exceptions
Example:
XML Document
Removes a range of 16-bit units from the node. Upon success, data and length reflect the change.
Arguments:
Result:
No variable is returned. The input characterData has updated value.
Possible exceptions
Example:
XML Document
Arguments:
Result:
Possible exceptions
Example:
XML Document
Arguments:
Result:
Possible exceptions
Example:
XML Document
Insert a string at the specified 16-bit unit offset.
Arguments:
Result:
No variable is returned. The input characterData has updated value.
Possible exceptions
Example:
XML Document
Replace the characters starting at the specified 16-bit unit offset with the specified string.
Arguments:
Result:
No variable is returned. The input characterData has updated value.
Possible exceptions
Example:
XML Document
Arguments:
Result:
No variable is returned. The input characterData has updated value.
Possible exceptions
Example:
XML Document
Extracts a range of data from the node.
Arguments:
Result:
Possible exceptions
Example:
XML Document
characterData ::
arg ::
- throws if the input characterData or arg is NULL
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly
characterData ::
offset :: - The offset from which to start removing.
limit :: - 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.
- throws if the input characterData or offset or limit is NULL
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly
The character data of the node. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a 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.
characterData ::
output ::
- throws if the input characterData is NULL
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.
The number of 16-bit units that are available through data and the substringData functions below. This may have the value zero, i.e., nodes may be empty.
characterData ::
output ::
- throws if the input characterData is NULL
characterData ::
offset :: - The character offset at which to insert.
arg :: - The DOMString to insert.
- throws if the input characterData or offset or arg is NULL
- INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
characterData ::
offset :: - The offset from which to start replacing.
count :: - 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 function call with the same range, followed by an function invocation).
arg :: - The DOMString with which the range must be replaced.
- throws if the input characterData or offset or arg is NULL
- 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.
Sets 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 node.
characterData ::
data ::
- throws if the input characterData or offset or arg is NULL
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
characterData ::
offset :: - Start offset of substring to extract.
count :: - The number of 16-bit units to extract.
output :: - 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.
- throws if the input characterData or offset or arg is NULL
- 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.