XNameAccess Interface Reference

is used to access named objects within a container. More...

import"XNameAccess.idl";

Inherits XElementAccess.

Inherited by HierarchyAccess, SimpleSetAccess, ExtendedTypeDetectionFactory, FilterFactory, LinkTargets, TypeDetection, LayerManager, XStorage, Settings, XLoaderFactory, XZipFileAccess2, DatabaseAccessContext, DefinitionContainer, XDatabaseContext, Container, DataPilotFieldGroup, DataPilotFieldGroups, DataPilotFields, DataPilotItems, DataPilotSourceDimensions, DataPilotSourceHierarchies, DataPilotSourceLevels, DDELinks, FunctionDescriptions, SheetLinks, TableConditionalFormat, XExternalDocLink, XExternalDocLinks, StyleFamilies, StyleFamily, XAutoStyles, TableColumns [protected], Bookmarks, DocumentIndexes, ReferenceMarks, TextContentCollection, TextEmbeddedObjects, TextFieldMasters, TextFrames, TextGraphicObjects, TextSections, TextTables, HierarchyDataReadAccess, PropertySetRegistry, ModuleUICategoryDescription, ModuleUICommandDescription, XDecks, XPanels, XDataTypeRepository, XNameReplace, Bibliography, UICommandDescription, theUICommandDescription, XGalleryThemeProvider, XLibraryContainer, XDDELinks, XDataPilotTables, XDatabaseRanges, XMembersAccess, XNamedRanges, XScenarios, XTableCharts, XTablePivotCharts, XAutoTextContainer, XAutoTextGroup, UICategoryDescription, WindowStateConfiguration, theUICategoryDescription, and theWindowStateConfiguration.

Collaboration diagram for XNameAccess:

Public Member Functions
any	getByName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
sequence< string >	getElementNames ()
boolean	hasByName ([in] string aName)
Public Member Functions inherited from XElementAccess
type	getElementType ()
boolean	hasElements ()
Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...
void	acquire ()
	increases the reference counter by one. More...
void	release ()
	decreases the reference counter by one. More...

Detailed 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

Professional UNO - Collections and Containers

Member Function Documentation

getByName()

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

Returns

the object with the specified name.

Parameters

aName

the name of the object.

Exceptions

NoSuchElementException	if an element under Name does not exist.
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.

Parameters

aName

the name of the object.

---

The documentation for this interface was generated from the following file:

• com/sun/star/container/XNameAccess.idl