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

(Global Index)

Syntax

interface XHierarchicalNameAccess : com::sun::star::uno::XInterface ;

Description

is used to have hierarchical access to elements within a container.

You address an object of a specific level in the hierarchy by giving its fully qualified name, e.g., "com::sun::star::uno::XInterface".

To implement inaccurate name access, support the XExactName interface.

See also

XExactName

Method Summary

getByHierarchicalName

hasByHierarchicalName

Known Services Which Export this Interface

com::sun::star::reflection::TypeDescriptionManager

com::sun::star::reflection::TypeDescriptionProvider

com::sun::star::reflection::TypeDescriptionManager

com::sun::star::reflection::TypeDescriptionProvider

com::sun::star::ucb::HierarchyDataReadAccess

com::sun::star::configuration::HierarchyAccess

com::sun::star::packages::Package

Method Details



getByHierarchicalName

Syntax

any getByHierarchicalName (
string aName )
raises ( com::sun::star::container::NoSuchElementException );

Returns

the object with the specified name.

Parameter aName

the name of the object.

Throws

NoSuchElementException if an element under Name does not exist.

hasByHierarchicalName

Syntax

boolean hasByHierarchicalName (
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