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

Known Services Which Export this Interface

com::sun::star::table::TableCharts

com::sun::star::table::TableColumns

com::sun::star::installation::InternetSettings

com::sun::star::document::FilterFactory

com::sun::star::document::LinkTargets

com::sun::star::document::TypeDetection

com::sun::star::drawing::LayerManager

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

com::sun::star::ucb::PropertySetRegistry

com::sun::star::sheet::DataPilotSourceDimensions

com::sun::star::sheet::NamedRanges

com::sun::star::sheet::DDELinks

com::sun::star::sheet::SheetLinks

com::sun::star::sheet::FunctionDescriptions

com::sun::star::sheet::DataPilotSourceLevels

com::sun::star::sheet::DataPilotFields

com::sun::star::sheet::TableConditionalFormat

com::sun::star::sheet::TableAutoFormats

com::sun::star::sheet::DataPilotSourceHierarchies

com::sun::star::sheet::DataPilotSourceMembers

com::sun::star::sheet::DatabaseRanges

com::sun::star::sheet::Spreadsheets

com::sun::star::configuration::SimpleSetAccess

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

com::sun::star::sdbcx::Container

com::sun::star::style::StyleFamilies

com::sun::star::style::StyleFamily

com::sun::star::sdb::DatabaseAccessContext

com::sun::star::sdb::DatabaseContext

com::sun::star::sdb::DefinitionContainer

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

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

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

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

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

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

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

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

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

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

com::sun::star::frame::FramesContainer

com::sun::star::frame::Settings

com::sun::star::frame::FrameLoaderFactory

Method Details



getByName

Syntax

any getByName (
string aName )
raises ( com::sun::star::container::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 WrappedTargetException exception.

getElementNames

Syntax

sequence< string > getElementNames ();

Returns

a sequence of all element names in this container.

The order of the names is not specified.


hasByName

Syntax

boolean hasByName (
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 iaName

the name of the object.
Top of Page