Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: xml :: dom ::

interface XCharacterData
Base Interfaces
XCharacterDataXNode

XNode
(referenced interface's summary:)
The primary dom datatype

Methods' Summary
appendData Append the string to the end of the character data of the node. Throws: DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.  
deleteData Remove a range of 16-bit units from the node. Throws: 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.  
getData Return the character data of the node that implements this interface. Throws: 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.  
getLength The number of 16-bit units that are available through data and the substringData method below.  
insertData Insert a string at the specified 16-bit unit offset. Throws: DOMException - 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.  
replaceData Replace the characters starting at the specified 16-bit unit offset with the specified string. Throws; 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.  
setData Set the character data of the node that implements this interface. Throws: 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.  
subStringData Extracts a range of data from the node. Throws: 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.  
Methods' Details
appendData
void
appendData( [in] string  arg )
raises( DOMException );

Description
Append the string to the end of the character data of the node. Throws: DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
deleteData
void
deleteData( [in] long  offset,
[in] long  count )
raises( DOMException );

Description
Remove a range of 16-bit units from the node. Throws: 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.
getData
string
getData()
raises( DOMException );

Description
Return the character data of the node that implements this interface. Throws: 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.
getLength
long
getLength();

Description
The number of 16-bit units that are available through data and the substringData method below.
insertData
void
insertData( [in] long  offset,
[in] string  arg )
raises( DOMException );

Description
Insert a string at the specified 16-bit unit offset. Throws: DOMException - 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.
replaceData
void
replaceData( [in] long  offset,
[in] long  count,
[in] string  arg )
raises( DOMException );

Description
Replace the characters starting at the specified 16-bit unit offset with the specified string. Throws; 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.
setData
void
setData( [in] string  data )
raises( DOMException );

Description
Set the character data of the node that implements this interface. Throws: 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.
subStringData
string
subStringData( [in] long  offset,
[in] long  count )
raises( DOMException );

Description
Extracts a range of data from the node. Throws: 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.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.