interface XNameAccess in module com::sun::star::container::

(Global Index)

Syntax

interface XNameAccess : com::sun::star::container::XElementAccess ;

Description

is used to access named objects within a container.

To implement inaccurate name access, support the XExactName interface.

See also

XExactName

Method Summary

getByName

getElementNames

hasByName

Method Details



getByName

Syntax

any getByName (
string aName )
raises ( com::sun::star::container::NoSuchElementException , com::sun::star::lang::WrappedTargetException );

Description

Returns

the object with the specified name.

Parameter aName

the name of the object.

Throws

NoSuchElementException if an element under Name does not exist.

Throws

com::sun::star::lang::WrappedTargetException If the implementation has internal reasons for exceptions, then wrap these in a WrappedTargetException exception.

getElementNames

Syntax

sequence< string > getElementNames ();

Description

Returns

a sequence of all element names in this container.

The order of the names is not specified.


hasByName

Syntax

boolean hasByName (
string aName );

Description

Returns

true> if an element with this name is in the container, false otherwise.

In many cases the next call is XNameAccess::getByName . You should optimize this case.

Parameter iaName

the name of the object.
Top of Page