LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XAutoTextGroup Interface Referencepublished

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

import"XAutoTextGroup.idl";

Inheritance diagram for XAutoTextGroup:
XNameAccess XElementAccess XInterface AutoTextGroup

Public Member Functions

sequence< string > getTitles ()
 returns the titles of all autotext entries. More...
 
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 )
 renames an entry in the autotext group. More...
 
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 )
 creates a new AutoTextEntry entry. More...
 
void removeByName ([in] string aEntryName) raises ( com::sun::star::container::NoSuchElementException )
 removes the specified autotext entry. More...
 
- Public Member Functions inherited from XNameAccess
any getByName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 
sequence< string > getElementNames ()
 
boolean hasByName ([in] string aName)
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

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

Member Function Documentation

sequence<string> getTitles ( )

returns the titles of all autotext entries.

The order of the entries corresponds to the output of the function getElementNames().

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
)

creates a new AutoTextEntry entry.

void removeByName ( [in] string  aEntryName)
raises (com::sun::star::container::NoSuchElementException
)

removes the specified autotext entry.

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
)

renames an entry in the autotext group.

The position of the autotext entry is not changed.


The documentation for this interface was generated from the following file: