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

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

interface XIndexAccess

Base Interface
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.



Known Services which Export this Interface

com::sun::star::table::TableCharts represents a collection of all charts based on data in a table.
com::sun::star::form::control::GridControl describes a table-like control for displaying data.
com::sun::star::sheet::LabelRanges a collection of label ranges.
com::sun::star::sheet::TableAutoFormat an autoformat for tables.
com::sun::star::sheet::SpreadsheetView a view of a spreadsheet document.
com::sun::star::sheet::TableConditionalFormat the conditional formatting for a cell or cell range.
com::sun::star::sheet::Spreadsheets the collection of spreadsheets in a spreadsheet document.
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::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::AutoTextGroup provides access to text blocks in a group.
com::sun::star::text::Footnotes provides access to the footnotes or endnotes of a (text) document.
com::sun::star::text::DocumentIndexes provides access to all indexes in a document.
com::sun::star::text::TextRanges provides a container for XTextRange objects.
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::NumberingRules provides access to the numbering rules.
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.

Methods' Summary

getCount
getByIndex

Methods' Details

getCount
 
long
getCount();
Returns
the number of elements in this container.
getByIndex
 
any
getByIndex(
[ in ] 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