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

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

interface XSheetAnnotations

Base Interface
com::sun::star::container::XIndexAccess

Description
provides methods to access cell annotations via index and to insert and remove annotations.
See also
com::sun::star::sheet::CellAnnotation
See also
com::sun::star::sheet::SheetCell


Known Services which Export this Interface

com::sun::star::sheet::CellAnnotations represents a collection of cell annotations.

Methods' Summary

insertNew creates a new annotation.
removeByIndex removes a cell annotation from the collection.

Methods' Details

insertNew
 
void
insertNew(
[ in ] com::sun::star::table::CellAddress aPosition,
[ in ] string aText );

Description
creates a new annotation.

This method creates a new annotation object, attaches it to the specified cell and inserts it into the collection.

Parameter aPosition
contains the address of the cell thta will contain the annotation.
Parameter aText
contains the annotation text.
removeByIndex
 
void
removeByIndex(
[ in ] long nIndex );

Description
removes a cell annotation from the collection.

This method removes the annotation from its cell and from the collection.

Parameter nIndex
is the index of the annotation in the collection.

Top of Page