Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

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

interface XNameAccess

Base Interface
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
com::sun::star::beans::XExactName


Known Services which Export this Interface

com::sun::star::table::TableColumns represents a collection of all columns of a table or spreadsheet.
com::sun::star::installation::InternetSettings
com::sun::star::document::FilterFactory factory to create filter objects
com::sun::star::document::LinkTargets This service gives access to a collection of names that are child links of the parent object that supplied this service.
com::sun::star::document::TypeDetection type detection of a specified resource (document)
com::sun::star::drawing::LayerManager This service is provided by documents to support Layer s.
com::sun::star::ucb::HierarchyDataReadAccess provides read access to a fragment of the hierarchy data.
com::sun::star::ucb::PropertySetRegistry This service contains the interfaces to implement by objects returned by XPropertySetRegistryFactory::createRegistry .
com::sun::star::sheet::DataPilotSourceDimensions the collection of dimensions in a data pilot source.
com::sun::star::sheet::NamedRanges a collection of named ranges.
com::sun::star::sheet::DDELinks a collection of DDE links.
com::sun::star::sheet::SheetLinks a collection of sheet links.
com::sun::star::sheet::FunctionDescriptions a list of function descriptions.
com::sun::star::sheet::DataPilotSourceLevels the collection of levels in a data pilot source hierarchy.
com::sun::star::sheet::DataPilotFields collection of fields in a DataPilotDescriptor.
com::sun::star::sheet::TableConditionalFormat the conditional formatting for a cell or cell range.
com::sun::star::sheet::TableAutoFormats a list of table autoformats.
com::sun::star::sheet::DataPilotSourceHierarchies the collection of hierarchies in a data pilot source dimension.
com::sun::star::sheet::DataPilotSourceMembers the collection of fields in a data pilot source level.
com::sun::star::sheet::DatabaseRanges a collection of database ranges.
com::sun::star::sheet::Spreadsheets the collection of spreadsheets in a spreadsheet document.
com::sun::star::configuration::SimpleSetAccess provides access to a dynamic, homogeneous, nonhierarchical set of values or objects.
com::sun::star::configuration::HierarchyAccess provides access to a (by name) hierarchy of descendant elements.
com::sun::star::sdbcx::Container describes every container which is used for data definition. Each container must support access to its elements by the element's name or by the element's position.
com::sun::star::style::StyleFamilies This service contains the collection of style families within the container document.
com::sun::star::style::StyleFamily This service is a container of style sheets of the same style family.
com::sun::star::sdb::DatabaseAccessContext is the context for data access beans. It allows to register aliases for database access beans. It is possible to have different aliases for different locales.
com::sun::star::sdb::DatabaseContext is the context for accessing datasource.
com::sun::star::sdb::DefinitionContainer describes a container which provides access to database related definitions like commands, forms, and reports.
com::sun::star::text::TextGraphicObjects This is the collection of all TextGraphicObject instances within a context (e.g. a document).
com::sun::star::text::TextContentCollection Objects of this type are collections of text contents of the same type.
com::sun::star::text::DocumentIndexes provides access to all indexes in a document.
com::sun::star::text::TextSections provides access to the text sections in a text document.
com::sun::star::text::TextFrames This is the collection of all TextFrame instances within a context (e.g. a document).
com::sun::star::text::TextTables provides access to all tables in a document.
com::sun::star::text::TextFieldMasters This is a collection of instances of TextFieldMaster , defined in a context (e.g. in a document).
com::sun::star::text::TextEmbeddedObjects provides access to all embedded objects in a document.
com::sun::star::text::ReferenceMarks provides access to the reference marks in a document.
com::sun::star::text::Bookmarks This service specifies a collection of Bookmark s.
com::sun::star::frame::FramesContainer This is a special container which can contain frames.
com::sun::star::frame::Settings [ DEPRECATED ]
com::sun::star::frame::FrameLoaderFactory factory to create frame loader

Methods' Summary

getByName
getElementNames
hasByName

Methods' Details

getByName
 
any
getByName(
[ in ] 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
 
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