Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.3 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XAutoTextGroup
Base Interfaces
XAutoTextGroup
┗ ::com::sun::star::container::XNameAccess
   ┗ ::com::sun::star::container::XElementAccess

::com::sun::star::container::XNameAccess
(referenced interface's summary:)
is used to access named objects within a container.
Description
The interface provide methods to insert, rename and delete autotext entries from the current autotext 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
XAutoTextEntry
insertNewByName( [in] string  aName,
[in] string  aTitle,
[in] 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

Apache Software Foundation

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

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