Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: text ::

interface XAutoTextGroup

Base Interface
com::sun::star::container::XNameAccess

Description
The interface provide methods to insert, rename and delete autotext entries from the current autotext group.


Known Services which Export this Interface

com::sun::star::text::AutoTextGroup provides access to text blocks in a group.

Methods' Summary

getTitles returns the titles of all autotext entries. The order of the entries corresponds to the output of the function getElementNames().
renameByName renames an entry in the autotext group.
insertNewByName creates a new AutoTextEntry entry.
removeByName removes the specified autotext entry.

Methods' Details

getTitles
 
sequence< string >
getTitles();
Description
returns the titles of all autotext entries. The order of the entries corresponds to the output of the function getElementNames().
renameByName
 
void
renameByName(
[ in ] string aElementName,
[ in ] string aNewElementName,
[ in ] string aNewElementTitle )
raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::ElementExistException, com::sun::star::io::IOException );

Description
renames an entry in the autotext group.

The position of the autotext entry is not changed.

insertNewByName
 
com::sun::star::text::XAutoTextEntry
insertNewByName(
[ in ] string aName,
[ in ] string aTitle,
[ in ] com::sun::star::text::XTextRange xTextRange )
raises ( com::sun::star::container::ElementExistException );

Description
creates a new AutoTextEntry entry.
removeByName
 
void
removeByName(
[ in ] string aEntryName )
raises ( com::sun::star::container::NoSuchElementException );

Description
removes the specified autotext entry.

Top of Page