Interface XNameAccess

Content for OpenOffice.org version 3.3.

Attributes' Summary

Attributes' Details

interface XNameAccess

Base Interfaces

XNameAccess
┗ XElementAccess

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

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous