LibreOffice
LibreOffice 6.0 SDK API Reference
Included Services | Exported Interfaces | List of all members
SheetCellCursor Service Referencepublished

represents a cursor in a spreadsheet. More...

import"SheetCellCursor.idl";

Inheritance diagram for SheetCellCursor:
CellCursor SheetCellRange XSheetCellCursor XUsedAreaCursor XInterface XSheetCellRange XModifyBroadcaster XTolerantMultiPropertySet XChartDataArray XUniqueCellFormatRangesSupplier XCellFormatRangesSupplier XSheetFilterableEx XSubTotalCalculatable XImportable XSortable XMultipleOperation XArrayFormulaRange XCellSeries XSheetOperation XCellRangeAddressable XCellRangeFormula XCellRangeData XSheetCellRange XAutoFormattable XColumnRowRange XIndent XMergeable XReplaceable SheetRangesQuery ParagraphProperties CharacterPropertiesComplex CharacterPropertiesAsian CharacterProperties CellRange XCellCursor

Included Services

service com::sun::star::table::CellCursor
 provides common methods to control the position of the cursor. More...
 
service com::sun::star::sheet::SheetCellRange
 provides the complete functionality of a cell range in a spreadsheet document. More...
 
- Included Services inherited from SheetCellRange
service com::sun::star::table::CellRange
 provides basic handling of cell ranges and contributes common cell formatting properties. More...
 
service com::sun::star::style::CharacterProperties
 contributes properties for character formatting of Western text. More...
 
service com::sun::star::style::CharacterPropertiesAsian
 contributes properties for character formatting of Asian text. More...
 
service com::sun::star::style::CharacterPropertiesComplex
 contributes properties for character formatting of Complex text. More...
 
service com::sun::star::style::ParagraphProperties
 contributes properties for paragraph formatting. More...
 
service com::sun::star::sheet::SheetRangesQuery
 provides interfaces to find cells with specific properties. More...
 
- Included Services inherited from CellRange
service com::sun::star::table::CellProperties
 contains the properties of the cells of this cell range. More...
 

Exported Interfaces

interface com::sun::star::sheet::XSheetCellCursor
 provides advanced methods to control the position of the cursor. More...
 
interface com::sun::star::sheet::XUsedAreaCursor
 provides methods to find the used area of the entire sheet. More...
 
- Exported Interfaces inherited from CellCursor
interface com::sun::star::table::XCellCursor
 provides methods to control the position of the cursor. More...
 
- Exported Interfaces inherited from SheetCellRange
interface com::sun::star::util::XReplaceable
 provides "Find & Replace" functionality. More...
 
interface com::sun::star::util::XMergeable
 provides merging and unmerging the cells of this cell range. More...
 
interface com::sun::star::util::XIndent
 provides modifying the cell indentation. More...
 
interface com::sun::star::table::XColumnRowRange
 provides access to the collections of columns and rows. More...
 
interface com::sun::star::table::XAutoFormattable
 provides applying an AutoFormat to the cell range. More...
 
interface com::sun::star::sheet::XSheetCellRange
 provides access to the spreadsheet that contains this cell range. More...
 
interface com::sun::star::sheet::XCellRangeData
 provides simultaneous access to the contents of all cells. More...
 
interface com::sun::star::sheet::XCellRangeFormula
 provides simultaneous access to the formula contents of all cells. More...
 
interface com::sun::star::sheet::XCellRangeAddressable
 provides access to the cell range address of this range. More...
 
interface com::sun::star::sheet::XSheetOperation
 provides computation of a value based on the contents of all cells of this range and to clear specific cells. More...
 
interface com::sun::star::sheet::XCellSeries
 provides filling out the cell range automatically with values based on a start value, step count and fill mode. More...
 
interface com::sun::star::sheet::XArrayFormulaRange
 provides handling of array formulas. More...
 
interface com::sun::star::sheet::XMultipleOperation
 provides access to the Multiple Operations feature. More...
 
interface com::sun::star::util::XSortable
 provides sorting functionality. More...
 
interface com::sun::star::util::XImportable
 provides functionality to import data from external data sources. More...
 
interface com::sun::star::sheet::XSubTotalCalculatable
 provides calculating SubTotal values in this range. More...
 
interface com::sun::star::sheet::XSheetFilterableEx
 provides filtering the contents of this range. More...
 
interface com::sun::star::sheet::XCellFormatRangesSupplier
 provide access to a collection of equal-formatted cell ranges. More...
 
interface com::sun::star::sheet::XUniqueCellFormatRangesSupplier
 provide access to a collection of equal-formatted cell ranges. More...
 
interface com::sun::star::chart::XChartDataArray
 provides modifying the source data cells of a chart and makes it possible to learn about changes in the cell values. More...
 
interface com::sun::star::beans::XTolerantMultiPropertySet
 
interface com::sun::star::util::XModifyBroadcaster
 
- Exported Interfaces inherited from CellRange
interface com::sun::star::table::XCellRange
 provides access to the cells or to sub-ranges of this cell range. More...
 
- Exported Interfaces inherited from CellProperties
interface com::sun::star::beans::XPropertySet
 published service PropertySet More...
 
- Exported Interfaces inherited from SheetRangesQuery
interface com::sun::star::sheet::XCellRangesQuery
 provides methods to query for cell ranges with specific contents. More...
 
interface com::sun::star::sheet::XFormulaQuery
 provides methods to find dependent cells of formula cells. More...
 

Additional Inherited Members

- Public Member Functions inherited from XCellCursor
void gotoStart ()
 points the cursor to a single cell which is the beginning of a contiguous series of (filled) cells. More...
 
void gotoEnd ()
 points the cursor to a single cell which is the end of a contiguous series of (filled) cells. More...
 
void gotoNext ()
 points the cursor to the next unprotected cell. More...
 
void gotoPrevious ()
 points the cursor to the previous unprotected cell. More...
 
void gotoOffset ([in] long nColumnOffset, [in] long nRowOffset)
 moves the origin of the cursor relative to the current position. More...
 
- Public Member Functions inherited from XCellRange
com::sun::star::table::XCell getCellByPosition ([in] long nColumn, [in] long nRow) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 Returns a single cell within the range. More...
 
com::sun::star::table::XCellRange getCellRangeByPosition ([in] long nLeft, [in] long nTop, [in] long nRight, [in] long nBottom) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 Returns a sub-range of cells within the range. More...
 
com::sun::star::table::XCellRange getCellRangeByName ([in] string aRange)
 Returns a sub-range of cells within the range. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Public Member Functions inherited from XCellRangesQuery
com::sun::star::sheet::XSheetCellRanges queryVisibleCells ()
 queries all visible cells. More...
 
com::sun::star::sheet::XSheetCellRanges queryEmptyCells ()
 queries all empty cells. More...
 
com::sun::star::sheet::XSheetCellRanges queryContentCells ([in] short nContentFlags)
 queries all cells with the specified content type(s). More...
 
com::sun::star::sheet::XSheetCellRanges queryFormulaCells ([in] long nResultFlags)
 queries all formula cells with the specified result type. More...
 
com::sun::star::sheet::XSheetCellRanges queryColumnDifferences ([in] com::sun::star::table::CellAddress aCompare)
 queries all cells with different values in a specified row. More...
 
com::sun::star::sheet::XSheetCellRanges queryRowDifferences ([in] com::sun::star::table::CellAddress aCompare)
 queries all cells with different values in a specified column. More...
 
com::sun::star::sheet::XSheetCellRanges queryIntersection ([in] com::sun::star::table::CellRangeAddress aRange)
 intersects the current cell range(s) with the specified cell range. More...
 
- Public Member Functions inherited from XFormulaQuery
com::sun::star::sheet::XSheetCellRanges queryDependents ([in] boolean bRecursive)
 queries all dependent formula cells. More...
 
com::sun::star::sheet::XSheetCellRanges queryPrecedents ([in] boolean bRecursive)
 queries all precedent cells. More...
 
- Public Member Functions inherited from XReplaceable
com::sun::star::util::XReplaceDescriptor createReplaceDescriptor ()
 creates a descriptor which contains properties that specify a search in this container. More...
 
long replaceAll ([in] com::sun::star::util::XSearchDescriptor xDesc)
 searches for all occurrences of whatever is specified. More...
 
- Public Member Functions inherited from XSearchable
com::sun::star::util::XSearchDescriptor createSearchDescriptor ()
 creates a SearchDescriptor which contains properties that specify a search in this container. More...
 
com::sun::star::container::XIndexAccess findAll ([in] com::sun::star::util::XSearchDescriptor xDesc)
 searches the contained texts for all occurrences of whatever is specified. More...
 
com::sun::star::uno::XInterface findFirst ([in] com::sun::star::util::XSearchDescriptor xDesc)
 searches the contained texts for the next occurrence of whatever is specified. More...
 
com::sun::star::uno::XInterface findNext ([in] com::sun::star::uno::XInterface xStartAt, [in] com::sun::star::util::XSearchDescriptor xDesc)
 searches the contained texts for the next occurrence of whatever is specified. More...
 
- Public Member Functions inherited from XMergeable
void merge ([in] boolean bMerge)
 merges/unmerges the area specified by this object. More...
 
boolean getIsMerged ()
 
- Public Member Functions inherited from XIndent
void decrementIndent ()
 shifts the indentation by one default step to the left. More...
 
void incrementIndent ()
 shifts the indentation by one default step to the right. More...
 
- Public Member Functions inherited from XColumnRowRange
com::sun::star::table::XTableColumns getColumns ()
 returns the collection of columns in the range. More...
 
com::sun::star::table::XTableRows getRows ()
 returns the collection of rows in the range. More...
 
- Public Member Functions inherited from XAutoFormattable
void autoFormat ([in] string aName) raises ( com::sun::star::lang::IllegalArgumentException )
 applies an AutoFormat to the cell range of the current context. More...
 
- Public Member Functions inherited from XSheetCellRange
com::sun::star::sheet::XSpreadsheet getSpreadsheet ()
 returns the spreadsheet interface which contains the cell range. More...
 
- Public Member Functions inherited from XCellRangeData
sequence< sequence< any > > getDataArray ()
 gets an array from the contents of the cell range. More...
 
void setDataArray ([in] sequence< sequence< any > > aArray)
 fills the cell range with values from an array. More...
 
- Public Member Functions inherited from XCellRangeAddressable
com::sun::star::table::CellRangeAddress getRangeAddress ()
 returns the address of the cell range in the spreadsheet document. More...
 
- Public Member Functions inherited from XSheetOperation
double computeFunction ([in] com::sun::star::sheet::GeneralFunction nFunction) raises ( com::sun::star::uno::Exception )
 computes a general function based on all cells in the current cell range(s). More...
 
void clearContents ([in] long nContentFlags)
 unnecessary More...
 
- Public Member Functions inherited from XCellSeries
void fillSeries ([in] com::sun::star::sheet::FillDirection nFillDirection, [in] com::sun::star::sheet::FillMode nFillMode, [in] com::sun::star::sheet::FillDateMode nFillDateMode, [in] double fStep, [in] double fEndValue)
 fills all cells in the range based on the specified settings. More...
 
void fillAuto ([in] com::sun::star::sheet::FillDirection nFillDirection, [in] long nSourceCount)
 fills all cells in the range in a way that is specified by the first cell(s) in the range. More...
 
- Public Member Functions inherited from XArrayFormulaRange
string getArrayFormula ()
 returns the array formula of the range or an empty string, if the range does not contain an array formula. More...
 
void setArrayFormula ([in] string aFormula)
 applies the array formula to the entire cell range. More...
 
- Public Member Functions inherited from XMultipleOperation
void setTableOperation ([in] com::sun::star::table::CellRangeAddress aFormulaRange, [in] com::sun::star::sheet::TableOperationMode nMode, [in] com::sun::star::table::CellAddress aColumnCell, [in] com::sun::star::table::CellAddress aRowCell)
 creates a table of formulas (a "Multiple Operations Table"). More...
 
- Public Member Functions inherited from XSortable
sequence< com::sun::star::beans::PropertyValuecreateSortDescriptor ()
 
void sort ([in] sequence< com::sun::star::beans::PropertyValue > xDescriptor)
 sorts the contents of the object according to the specified properties. More...
 
- Public Member Functions inherited from XImportable
sequence< com::sun::star::beans::PropertyValuecreateImportDescriptor ([in] boolean bEmpty)
 
void doImport ([in] sequence< com::sun::star::beans::PropertyValue > aDescriptor)
 imports data from an external database. More...
 
- Public Member Functions inherited from XSubTotalCalculatable
com::sun::star::sheet::XSubTotalDescriptor createSubTotalDescriptor ([in] boolean bEmpty)
 creates a subtotal descriptor. More...
 
void applySubTotals ([in] com::sun::star::sheet::XSubTotalDescriptor xDescriptor, [in] boolean bReplace)
 creates subtotals using the settings of the passed descriptor. More...
 
void removeSubTotals ()
 removes the subtotals from the current object. More...
 
- Public Member Functions inherited from XSheetFilterableEx
com::sun::star::sheet::XSheetFilterDescriptor createFilterDescriptorByObject ([in] com::sun::star::sheet::XSheetFilterable xObject)
 creates a filter descriptor for the specified filterable object from the contents of this object. More...
 
- Public Member Functions inherited from XSheetFilterable
com::sun::star::sheet::XSheetFilterDescriptor createFilterDescriptor ([in] boolean bEmpty)
 creates a filter descriptor. More...
 
void filter ([in] com::sun::star::sheet::XSheetFilterDescriptor xDescriptor)
 performs a filter operation, using the settings of the passed filter descriptor. More...
 
- Public Member Functions inherited from XCellFormatRangesSupplier
com::sun::star::container::XIndexAccess getCellFormatRanges ()
 returns a collection of equal-formatted cell ranges. More...
 
- Public Member Functions inherited from XUniqueCellFormatRangesSupplier
com::sun::star::container::XIndexAccess getUniqueCellFormatRanges ()
 returns a collection of equal-formatted cell range collections. More...
 
- Public Member Functions inherited from XChartDataArray
sequence< sequence< double > > getData ()
 retrieves the numerical data as a nested sequence of values. More...
 
void setData ([in] sequence< sequence< double > > aData)
 sets the chart data as an array of numbers. More...
 
sequence< string > getRowDescriptions ()
 retrieves the description texts for all rows. More...
 
void setRowDescriptions ([in] sequence< string > aRowDescriptions)
 sets the description texts for all rows. More...
 
sequence< string > getColumnDescriptions ()
 retrieves the description texts for all columns. More...
 
void setColumnDescriptions ([in] sequence< string > aColumnDescriptions)
 sets the description texts for all columns. More...
 
- Public Member Functions inherited from XChartData
void addChartDataChangeEventListener ([in] com::sun::star::chart::XChartDataChangeEventListener aListener)
 allows a component supporting the XChartDataChangeEventListener interface to register as listener. More...
 
void removeChartDataChangeEventListener ([in] com::sun::star::chart::XChartDataChangeEventListener aListener)
 removes a previously registered listener. More...
 
double getNotANumber ()
 
boolean isNotANumber ([in] double nNumber)
 checks whether the value given is equal to the indicator value for a missing value. More...
 
- Public Member Functions inherited from XSheetCellCursor
void collapseToCurrentRegion ()
 expands the cursor into the region containing the cells to which it currently points. More...
 
void collapseToCurrentArray ()
 collapses the cursor into the range of the array formula to which it is currently pointing. More...
 
void collapseToMergedArea ()
 expands the cursor to merged cell ranges. More...
 
void expandToEntireColumns ()
 expands the cursor to include the entire columns of the cells to which it is currently pointing. More...
 
void expandToEntireRows ()
 expands the cursor to include the entire rows of the cells to which it is currently pointing. More...
 
void collapseToSize ([in] long nColumns, [in] long nRows)
 changes the size of a cursor range. More...
 
- Public Member Functions inherited from XUsedAreaCursor
void gotoStartOfUsedArea ([in] boolean bExpand)
 points the cursor to the start of the used area. More...
 
void gotoEndOfUsedArea ([in] boolean bExpand)
 points the cursor to the end of the used area. More...
 
- Public Attributes inherited from SheetCellRange
com::sun::star::awt::Point Position
 contains the position of the top left cell of this range in the sheet (in 1/100 mm). More...
 
com::sun::star::awt::Size Size
 contains the size of this range (in 1/100 mm). More...
 
com::sun::star::sheet::XSheetConditionalEntries ConditionalFormat
 contains the conditional formatting settings for this cell. More...
 
com::sun::star::sheet::XSheetConditionalEntries ConditionalFormatLocal
 contains the conditional formatting settings for this cell, using localized formulas. More...
 
com::sun::star::beans::XPropertySet Validation
 contains the data validation settings for this cell. More...
 
com::sun::star::beans::XPropertySet ValidationLocal
 contains the data validation settings for this cell, using localized formulas. More...
 
string AbsoluteName
 Returns the absolute address of the range as string, e.g. More...
 
- Public Attributes inherited from CellProperties
string CellStyle
 contains the name of the style of the cell. More...
 
com::sun::star::util::Color CellBackColor
 contains the cell background color. More...
 
boolean IsCellBackgroundTransparent
 is TRUE, if the cell background is transparent. More...
 
com::sun::star::table::CellHoriJustify HoriJustify
 contains the horizontal alignment of the cell contents. More...
 
long VertJustify
 contains the vertical alignment of the cell contents. More...
 
boolean IsTextWrapped
 is TRUE, if text in the cells will be wrapped automatically at the right border. More...
 
short ParaIndent
 defines the indentation of the cell contents (in 1/100 mm). More...
 
com::sun::star::table::CellOrientation Orientation
 contains the orientation of the cell contents. More...
 
long RotateAngle
 defines how much the content of cells is rotated (in 1/100 degrees). More...
 
long RotateReference
 defines at which edge rotated cells are aligned. More...
 
boolean AsianVerticalMode
 selects Asian character orientation in vertical orientation. More...
 
com::sun::star::table::TableBorder TableBorder
 contains a description of the cell or cell range border. More...
 
com::sun::star::table::BorderLine TopBorder
 contains a description of the top border line of each cell. More...
 
com::sun::star::table::BorderLine BottomBorder
 contains a description of the bottom border line of each cell. More...
 
com::sun::star::table::BorderLine LeftBorder
 contains a description of the left border line of each cell. More...
 
com::sun::star::table::BorderLine RightBorder
 contains a description of the right border line of each cell. More...
 
long NumberFormat
 contains the index of the number format that is used in the cells. More...
 
com::sun::star::table::ShadowFormat ShadowFormat
 contains a description of the shadow. More...
 
com::sun::star::util::CellProtection CellProtection
 contains a description of the cell protection. More...
 
com::sun::star::container::XNameContainer UserDefinedAttributes
 stores additional attributes. More...
 
com::sun::star::table::BorderLine DiagonalTLBR
 contains a description of the top left to bottom right diagonal line of each cell. More...
 
com::sun::star::table::BorderLine DiagonalBLTR
 contains a description of the bottom left to top right diagonal line of each cell. More...
 
boolean ShrinkToFit
 is TRUE, if the cell content will be shrunk to fit in the cell. More...
 
com::sun::star::table::TableBorder2 TableBorder2
 contains a description of the cell or cell range border. More...
 
com::sun::star::table::BorderLine2 TopBorder2
 contains a description of the top border line of each cell. More...
 
com::sun::star::table::BorderLine2 BottomBorder2
 contains a description of the bottom border line of each cell. More...
 
com::sun::star::table::BorderLine2 LeftBorder2
 contains a description of the left border line of each cell. More...
 
com::sun::star::table::BorderLine2 RightBorder2
 contains a description of the right border line of each cell. More...
 
com::sun::star::table::BorderLine2 DiagonalTLBR2
 contains a description of the top left to bottom right diagonal line of each cell. More...
 
com::sun::star::table::BorderLine2 DiagonalBLTR2
 contains a description of the bottom left to top right diagonal line of each cell. More...
 
sequence< com::sun::star::beans::PropertyValueCellInteropGrabBag
 Grab bag of cell properties, used as a string-any map for interim interop purposes. More...
 
- Public Attributes inherited from CharacterProperties
string CharFontName
 This property specifies the name of the font style. More...
 
string CharFontStyleName
 This property contains the name of the font style. More...
 
short CharFontFamily
 This property contains font family. More...
 
short CharFontCharSet
 This property contains the text encoding of the font. More...
 
short CharFontPitch
 This property contains the font pitch. More...
 
com::sun::star::util::Color CharColor
 This property contains the value of the text color. More...
 
short CharEscapement
 specifies the percentage by which to raise/lower superscript/subscript characters. More...
 
float CharHeight
 This value contains the height of the characters in point. More...
 
short CharUnderline
 This property contains the value for the character underline. More...
 
float CharWeight
 This property contains the value of the font weight. More...
 
com::sun::star::awt::FontSlant CharPosture
 This property contains the value of the posture of the document. More...
 
boolean CharAutoKerning
 This optional property determines whether the kerning tables from the current font are used. More...
 
com::sun::star::util::Color CharBackColor
 This optional property contains the text background color. More...
 
long CharShadingValue
 This optional property contains the text shading value. More...
 
boolean CharBackTransparent
 This property determines if the text background color is set to transparent. More...
 
short CharCaseMap
 This optional property contains the value of the case-mapping of the text for formatting and displaying. More...
 
boolean CharCrossedOut
 This property is TRUE if the characters are crossed out. More...
 
boolean CharFlash
 If this optional property is TRUE, then the characters are flashing. More...
 
short CharStrikeout
 This property determines the type of the strike out of the character. More...
 
boolean CharWordMode
 If this property is TRUE, the underline and strike-through properties are not applied to white spaces. More...
 
short CharKerning
 This optional property contains the value of the kerning of the characters. More...
 
com::sun::star::lang::Locale CharLocale
 This property contains the value of the locale. More...
 
boolean CharKeepTogether
 This optional property marks a range of characters to prevent it from being broken into two lines. More...
 
boolean CharNoLineBreak
 This optional property marks a range of characters to ignore a line break in this area. More...
 
boolean CharShadowed
 This optional property specifies if the characters are formatted and displayed with a shadow effect. More...
 
short CharFontType
 This optional property specifies the fundamental technology of the font. More...
 
string CharStyleName
 This optional property specifies the name of the style of the font. More...
 
boolean CharContoured
 This optional property specifies if the characters are formatted and displayed with a contour effect. More...
 
boolean CharCombineIsOn
 This optional property determines whether text is formatted in two lines. More...
 
string CharCombinePrefix
 This optional property contains the prefix (usually parenthesis) before text that is formatted in two lines. More...
 
string CharCombineSuffix
 This optional property contains the suffix (usually parenthesis) after text that is formatted in two lines. More...
 
short CharEmphasis
 This optional property contains the font emphasis value. More...
 
short CharRelief
 This optional property contains the relief style of the characters. More...
 
string RubyText
 This optional property contains the text that is set as ruby. More...
 
short RubyAdjust
 This optional property determines the adjustment of the ruby . More...
 
string RubyCharStyleName
 This optional property contains the name of the character style that is applied to RubyText. More...
 
boolean RubyIsAbove
 This optional property determines whether the ruby text is printed above/left or below/right of the text. More...
 
short CharRotation
 This optional property determines the rotation of a character in tenths of a degree. More...
 
boolean CharRotationIsFitToLine
 This optional property determines whether the text formatting tries to fit rotated text into the surrounded line height. More...
 
short CharScaleWidth
 This optional property determines the percentage value for scaling the width of characters. More...
 
string HyperLinkURL
 This optional property contains the URL of a hyperlink. More...
 
string HyperLinkTarget
 This optional property contains the name of the target for a hyperlink. More...
 
string HyperLinkName
 This optional property contains the name of the hyperlink. More...
 
string VisitedCharStyleName
 This optional property contains the character style name for visited hyperlinks. More...
 
string UnvisitedCharStyleName
 This optional property contains the character style name for unvisited hyperlinks. More...
 
byte CharEscapementHeight
 This is the relative height used for subscript or superscript characters in units of percent. More...
 
boolean CharNoHyphenation
 This optional property determines if the word can be hyphenated at the character. More...
 
com::sun::star::util::Color CharUnderlineColor
 This property contains the color of the underline for the characters. More...
 
boolean CharUnderlineHasColor
 This property specifies if the property CharUnderlineColor is used for an underline. More...
 
sequence< string > CharStyleNames
 This optional property specifies the names of the all styles applied to the font. More...
 
boolean CharHidden
 If this optional property is TRUE, then the characters are invisible. More...
 
com::sun::star::container::XNameContainer TextUserDefinedAttributes
 This property stores XML attributes. More...
 
com::sun::star::table::BorderLine2 CharLeftBorder
 This property contains the left border of the object. More...
 
com::sun::star::table::BorderLine2 CharRightBorder
 This property contains the right border of the object. More...
 
com::sun::star::table::BorderLine2 CharTopBorder
 This property contains the top border of the object. More...
 
com::sun::star::table::BorderLine2 CharBottomBorder
 This property contains the bottom border of the object. More...
 
long CharBorderDistance
 This property contains the distance from the border to the object. More...
 
long CharLeftBorderDistance
 This property contains the distance from the left border to the object. More...
 
long CharRightBorderDistance
 This property contains the distance from the right border to the object. More...
 
long CharTopBorderDistance
 This property contains the distance from the top border to the object. More...
 
long CharBottomBorderDistance
 This property contains the distance from the bottom border to the object. More...
 
com::sun::star::table::ShadowFormat CharShadowFormat
 Determines the type, color, and width of the shadow. More...
 
com::sun::star::util::Color CharHighlight
 Determines the color of the highlight. More...
 
sequence< com::sun::star::beans::PropertyValueCharInteropGrabBag
 Grab bag of character properties, used as a string-any map for interim interop purposes. More...
 
- Public Attributes inherited from CharacterPropertiesAsian
float CharHeightAsian
 This value contains the height of the characters in point. More...
 
float CharWeightAsian
 This property contains the value of the font weight. More...
 
string CharFontNameAsian
 This property specifies the name of the font style. More...
 
string CharFontStyleNameAsian
 This property contains the name of the font style. More...
 
short CharFontFamilyAsian
 This property contains font family as specified in com.sun.star.awt.FontFamily . More...
 
short CharFontCharSetAsian
 This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More...
 
short CharFontPitchAsian
 This property contains the font pitch as specified in com.sun.star.awt.FontPitch. More...
 
com::sun::star::awt::FontSlant CharPostureAsian
 This property contains the value of the posture of the document. More...
 
com::sun::star::lang::Locale CharLocaleAsian
 contains the value of the locale. More...
 
- Public Attributes inherited from CharacterPropertiesComplex
float CharHeightComplex
 This value contains the height of the characters in point. More...
 
float CharWeightComplex
 This property contains the value of the font weight. More...
 
string CharFontNameComplex
 This property specifies the name of the font style. More...
 
string CharFontStyleNameComplex
 This property contains the name of the font style. More...
 
short CharFontFamilyComplex
 This property contains font family as specified in com.sun.star.awt.FontFamily . More...
 
short CharFontCharSetComplex
 This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More...
 
short CharFontPitchComplex
 This property contains the font pitch as specified in com.sun.star.awt.FontPitch. More...
 
com::sun::star::awt::FontSlant CharPostureComplex
 This property contains the value of the posture of the document. More...
 
com::sun::star::lang::Locale CharLocaleComplex
 contains the value of the locale. More...
 
- Public Attributes inherited from ParagraphProperties
com::sun::star::style::ParagraphAdjust ParaAdjust
 determines the adjustment of a paragraph. More...
 
com::sun::star::style::LineSpacing ParaLineSpacing
 contains the type of the line spacing of a paragraph. More...
 
com::sun::star::util::Color ParaBackColor
 contains the paragraph background color. More...
 
boolean ParaBackTransparent
 This value is TRUE if the paragraph background color is set to transparent. More...
 
string ParaBackGraphicURL
 contains the value of a link for the background graphic of a paragraph. More...
 
string ParaBackGraphicFilter
 contains the name of the graphic filter for the background graphic of a paragraph. More...
 
com::sun::star::style::GraphicLocation ParaBackGraphicLocation
 contains the value for the position of a background graphic. More...
 
short ParaLastLineAdjust
 determines the adjustment of the last line. More...
 
boolean ParaExpandSingleWord
 determines if single words are stretched. More...
 
long ParaLeftMargin
 determines the left margin of the paragraph in 100th mm. More...
 
long ParaRightMargin
 determines the right margin of the paragraph in 100th mm. More...
 
long ParaTopMargin
 determines the top margin of the paragraph in 100th mm. More...
 
long ParaBottomMargin
 determines the bottom margin of the paragraph in 100th mm. More...
 
boolean ParaContextMargin
 determines if contextual spacing is used. More...
 
sequence< com::sun::star::beans::PropertyValueParaInteropGrabBag
 Grab bag of paragraph properties, used as a string-any map for interim interop purposes. More...
 
boolean ParaLineNumberCount
 determines if the paragraph is included in the line numbering. More...
 
long ParaLineNumberStartValue
 contains the start value for the line numbering. More...
 
string PageDescName
 If this property is set, it creates a page break before the paragraph it belongs to and assigns the value as the name of the new page style sheet to use. More...
 
short PageNumberOffset
 If a page break property is set at a paragraph, this property contains the new value for the page number. More...
 
boolean ParaRegisterModeActive
 determines if the register mode is applied to a paragraph. More...
 
sequence< com::sun::star::style::TabStopParaTabStops
 specifies the positions and kinds of the tab stops within this paragraph. More...
 
string ParaStyleName
 contains the name of the current paragraph style. More...
 
string PageStyleName
 contains the name of the current page style. More...
 
com::sun::star::style::DropCapFormat DropCapFormat
 specifies whether the first characters of the paragraph are displayed in capital letters and how they are formatted. More...
 
boolean DropCapWholeWord
 specifies if the property DropCapFormat is applied to the whole first word. More...
 
boolean ParaKeepTogether
 Setting this property to TRUE prevents page or column breaks between this and the following paragraph. More...
 
boolean ParaSplit
 Setting this property to FALSE prevents the paragraph from getting split into two pages or columns. More...
 
short NumberingLevel
 specifies the numbering level of the paragraph. More...
 
com::sun::star::container::XIndexReplace NumberingRules
 contains the numbering rules applied to this paragraph. More...
 
short NumberingStartValue
 specifies the start value for numbering if a new numbering starts at this paragraph. More...
 
boolean ParaIsNumberingRestart
 determines if the numbering rules restart, counting at the current paragraph. More...
 
string NumberingStyleName
 specifies the name of the style for the numbering. More...
 
byte ParaOrphans
 specifies the minimum number of lines of the paragraph that have to be at bottom of a page if the paragraph is spread over more than one page. More...
 
byte ParaWidows
 specifies the minimum number of lines of the paragraph that have to be at top of a page if the paragraph is spread over more than one page. More...
 
com::sun::star::table::ShadowFormat ParaShadowFormat
 determines the type, color, and size of the shadow. More...
 
com::sun::star::table::BorderLine LeftBorder
 contains the left border of the object. More...
 
com::sun::star::table::BorderLine RightBorder
 contains the right border of the object. More...
 
com::sun::star::table::BorderLine TopBorder
 contains the top border of the object. More...
 
com::sun::star::table::BorderLine BottomBorder
 contains the bottom border of the object. More...
 
long BorderDistance
 contains the distance from the border to the object. More...
 
long LeftBorderDistance
 contains the distance from the left border to the object. More...
 
long RightBorderDistance
 contains the distance from the right border to the object. More...
 
long TopBorderDistance
 contains the distance from the top border to the object. More...
 
long BottomBorderDistance
 contains the distance from the bottom border to the object. More...
 
com::sun::star::style::BreakType BreakType
 determines the type of break that is applied at the beginning of the table. More...
 
string DropCapCharStyleName
 specifies the character style name for drop caps. More...
 
long ParaFirstLineIndent
 specifies the indent for the first line. More...
 
boolean ParaIsAutoFirstLineIndent
 determines if the first line should be indented automatically. More...
 
boolean ParaIsHyphenation
 specifies if automatic hyphenation is applied. More...
 
short ParaHyphenationMaxHyphens
 specifies the maximum number of consecutive hyphens. More...
 
short ParaHyphenationMaxLeadingChars
 specifies the maximum number of characters to remain before the hyphen character (when hyphenation is applied). More...
 
short ParaHyphenationMaxTrailingChars
 specifies the maximum number of characters to remain after the hyphen character (when hyphenation is applied). More...
 
short ParaVertAlignment
 specifies the vertical alignment of a paragraph. More...
 
com::sun::star::container::XNameContainer ParaUserDefinedAttributes
 this property stores xml attributes. More...
 
boolean NumberingIsNumber
 returns FALSE if the paragraph is part of a numbering, but has no numbering label. More...
 
boolean ParaIsConnectBorder
 the property determines if borders set at a paragraph are merged with the next paragraph. More...
 
string ListId
 specifies the id of the list to which the paragraph belongs More...
 
short OutlineLevel
 specifies the outline level to which the paragraph belongs More...
 
- Protected Member Functions inherited from XCellRangeFormula
sequence< sequence< string > > getFormulaArray ()
 gets an array from the contents of the cell range. More...
 
void setFormulaArray ([in] sequence< sequence< string > > aArray)
 fills the cell range with values from an array. More...
 
- Protected Member Functions inherited from XCellRangeAddressable
com::sun::star::table::CellRangeAddress getRangeAddress ()
 returns the address of the cell range in the spreadsheet document. More...
 
- Protected Member Functions inherited from XSheetOperation
double computeFunction ([in] com::sun::star::sheet::GeneralFunction nFunction) raises ( com::sun::star::uno::Exception )
 computes a general function based on all cells in the current cell range(s). More...
 
void clearContents ([in] long nContentFlags)
 unnecessary More...
 
- Protected Member Functions inherited from XCellSeries
void fillSeries ([in] com::sun::star::sheet::FillDirection nFillDirection, [in] com::sun::star::sheet::FillMode nFillMode, [in] com::sun::star::sheet::FillDateMode nFillDateMode, [in] double fStep, [in] double fEndValue)
 fills all cells in the range based on the specified settings. More...
 
void fillAuto ([in] com::sun::star::sheet::FillDirection nFillDirection, [in] long nSourceCount)
 fills all cells in the range in a way that is specified by the first cell(s) in the range. More...
 
- Protected Member Functions inherited from XArrayFormulaRange
string getArrayFormula ()
 returns the array formula of the range or an empty string, if the range does not contain an array formula. More...
 
void setArrayFormula ([in] string aFormula)
 applies the array formula to the entire cell range. More...
 
- Protected Member Functions inherited from XMultipleOperation
void setTableOperation ([in] com::sun::star::table::CellRangeAddress aFormulaRange, [in] com::sun::star::sheet::TableOperationMode nMode, [in] com::sun::star::table::CellAddress aColumnCell, [in] com::sun::star::table::CellAddress aRowCell)
 creates a table of formulas (a "Multiple Operations Table"). More...
 
- Protected Member Functions inherited from XSortable
sequence< com::sun::star::beans::PropertyValuecreateSortDescriptor ()
 
void sort ([in] sequence< com::sun::star::beans::PropertyValue > xDescriptor)
 sorts the contents of the object according to the specified properties. More...
 
- Protected Member Functions inherited from XImportable
sequence< com::sun::star::beans::PropertyValuecreateImportDescriptor ([in] boolean bEmpty)
 
void doImport ([in] sequence< com::sun::star::beans::PropertyValue > aDescriptor)
 imports data from an external database. More...
 
- Protected Member Functions inherited from XSubTotalCalculatable
com::sun::star::sheet::XSubTotalDescriptor createSubTotalDescriptor ([in] boolean bEmpty)
 creates a subtotal descriptor. More...
 
void applySubTotals ([in] com::sun::star::sheet::XSubTotalDescriptor xDescriptor, [in] boolean bReplace)
 creates subtotals using the settings of the passed descriptor. More...
 
void removeSubTotals ()
 removes the subtotals from the current object. More...
 
- Protected Member Functions inherited from XSheetFilterableEx
com::sun::star::sheet::XSheetFilterDescriptor createFilterDescriptorByObject ([in] com::sun::star::sheet::XSheetFilterable xObject)
 creates a filter descriptor for the specified filterable object from the contents of this object. More...
 
- Protected Member Functions inherited from XSheetFilterable
com::sun::star::sheet::XSheetFilterDescriptor createFilterDescriptor ([in] boolean bEmpty)
 creates a filter descriptor. More...
 
void filter ([in] com::sun::star::sheet::XSheetFilterDescriptor xDescriptor)
 performs a filter operation, using the settings of the passed filter descriptor. More...
 
- Protected Member Functions inherited from XCellFormatRangesSupplier
com::sun::star::container::XIndexAccess getCellFormatRanges ()
 returns a collection of equal-formatted cell ranges. More...
 
- Protected Member Functions inherited from XUniqueCellFormatRangesSupplier
com::sun::star::container::XIndexAccess getUniqueCellFormatRanges ()
 returns a collection of equal-formatted cell range collections. More...
 
- Protected Member Functions inherited from XChartDataArray
sequence< sequence< double > > getData ()
 retrieves the numerical data as a nested sequence of values. More...
 
void setData ([in] sequence< sequence< double > > aData)
 sets the chart data as an array of numbers. More...
 
sequence< string > getRowDescriptions ()
 retrieves the description texts for all rows. More...
 
void setRowDescriptions ([in] sequence< string > aRowDescriptions)
 sets the description texts for all rows. More...
 
sequence< string > getColumnDescriptions ()
 retrieves the description texts for all columns. More...
 
void setColumnDescriptions ([in] sequence< string > aColumnDescriptions)
 sets the description texts for all columns. More...
 
- Protected Member Functions inherited from XChartData
void addChartDataChangeEventListener ([in] com::sun::star::chart::XChartDataChangeEventListener aListener)
 allows a component supporting the XChartDataChangeEventListener interface to register as listener. More...
 
void removeChartDataChangeEventListener ([in] com::sun::star::chart::XChartDataChangeEventListener aListener)
 removes a previously registered listener. More...
 
double getNotANumber ()
 
boolean isNotANumber ([in] double nNumber)
 checks whether the value given is equal to the indicator value for a missing value. More...
 
- Protected Member Functions inherited from XTolerantMultiPropertySet
sequence< com::sun::star::beans::SetPropertyTolerantFailedsetPropertyValuesTolerant ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::lang::IllegalArgumentException )
 sets the values to the properties with the specified names. More...
 
sequence< com::sun::star::beans::GetPropertyTolerantResultgetPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
 retrieve the values of the specified properties More...
 
sequence< com::sun::star::beans::GetDirectPropertyTolerantResultgetDirectPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
 retrieve only those values of the specified properties which are direct values. More...
 
- Protected Member Functions inherited from XModifyBroadcaster
void addModifyListener ([in] com::sun::star::util::XModifyListener aListener)
 adds the specified listener to receive events "modified." More...
 
void removeModifyListener ([in] com::sun::star::util::XModifyListener aListener)
 removes the specified listener. More...
 

Detailed Description

represents a cursor in a spreadsheet.

A cursor is a cell range which provides additional methods to move through the table (i.e. to find specific cell ranges).

Exported Interfaces

provides the complete functionality of a cell range in a spreadsheet document.

provides common methods to control the position of the cursor.

Exported Interfaces

provides advanced methods to control the position of the cursor.

provides methods to find the used area of the entire sheet.


The documentation for this service was generated from the following file: