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

(Global Index)

Syntax

interface XIndexAccess : com::sun::star::container::XElementAccess ;

Description

provides access to the elements of a collection through an index.

This interface should only be used if the data structure, itself, is indexed.

Method Summary

getCount

getByIndex

Known Services Which Export this Interface

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

com::sun::star::table::TableRows

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

com::sun::star::form::control::GridControl

com::sun::star::sheet::LabelRanges

com::sun::star::sheet::TableAutoFormat

com::sun::star::sheet::SheetCellRanges

com::sun::star::sheet::SpreadsheetView

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

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

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

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

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

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

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

com::sun::star::text::AutoTextGroup

com::sun::star::text::Footnotes

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

com::sun::star::text::TextRanges

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

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

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

com::sun::star::text::NumberingRules

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

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

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

Method Details



getCount

Syntax

long getCount ();

Returns

the number of elements.

getByIndex

Syntax

any getByIndex (
long Index )
raises ( com::sun::star::lang::IndexOutOfBoundsException , com::sun::star::lang::WrappedTargetException );

Returns

the element at the specified index

Parameter Index

specifies the position in the array. The first index is 0.

Throws

com::sun::star::lang::IndexOutOfBoundException if the index is not valid.

Throws

com::sun::star::lang::WrappedTargetException If the implementation has internal reasons for exceptions, then wrap these in a WrappedTargetException exception.
Top of Page