Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

interface XSheetAnnotations
Base Interfaces
XSheetAnnotations
┗ ::com::sun::star::container::XIndexAccess
   ┗ ::com::sun::star::container::XElementAccess
::com::sun::star::container::XIndexAccess
(referenced interface's summary:)
provides access to the elements of a collection through an index.
Description
provides methods to access cell annotations via index and to insert and remove annotations.
See also
CellAnnotation, SheetCell
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

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.