Language

The Free and Open Productivity Suite
Apache OpenOffice 4.1.9 released

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: container ::

interface XNameAccess
Base Interfaces
XNameAccessXElementAccess

XElementAccess
(referenced interface's summary:)
This is the base interface of all collection interfaces.
Description
is used to access named objects within a container.

To implement inaccurate name access, support the ::com::sun::star::beans::XExactName interface.

See also
::com::sun::star::beans::XExactName
Developers Guide
ProUNO - Collections and Containers

Methods' Summary
getByName  
getElementNames  
hasByName  
Methods' Details
getByName
any
getByName( [in] string  aName )
raises( NoSuchElementException,
::com::sun::star::lang::WrappedTargetException );

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 ::com::sun::star::lang::WrappedTargetException exception.
getElementNames
sequence< string >
getElementNames();

Returns
a sequence of all element names in this container.

The order of the names is not specified.

hasByName
boolean
hasByName( [in] string  aName );

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 aName
the name of the object.
Top of Page

Apache Events

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.