Spreadsheet specific interfaces. More...

Modules
module	opencl

Constant Groups
constants	AddressConvention
	These constants specify which address convention to use in the formula parser.

constants	CellFlags
	These constants select different types of cell contents.

constants	ColorScaleEntryType

constants	ConditionEntryType

constants	ConditionFormatOperator

constants	ConditionOperator2
	is used to specify the type of XSheetCondition2.

constants	DataBarAxis

constants	DataBarEntryType

constants	DataPilotFieldGroupBy
	These constants select different types for grouping members of a DataPilot field by date or time.

constants	DataPilotFieldLayoutMode
	describes the layout mode of the data field

constants	DataPilotFieldReferenceItemType
	is used to select the reference item

constants	DataPilotFieldReferenceType
	These constants select different types of References to calculate the data fields.

constants	DataPilotFieldShowItemsMode
	These constants select different types of showing a selection of items.

constants	DataPilotFieldSortMode
	describes the sort mode of the data field

constants	DataPilotOutputRangeType
	specifies region type of DataPilot table range

constants	DataPilotTablePositionType
	specifies in which sub-area a cell is positioned within a DataPilot table.

constants	DataResultFlags
	used to specify the result type of one element in the data pilot data array.

constants	DateType

constants	DimensionFlags
	used to specify flags for a dimension in a data pilot source.

constants	ExternalLinkType
	Constants designating the link type in ExternalLinkInfo, used with FormulaParser::ExternalLinks.

constants	FilterFieldType

constants	FilterOperator2
	specifies the type of a single condition in a filter descriptor.

constants	FormulaLanguage
	Constants designating the formula language used with XFormulaOpCodeMapper methods.

constants	FormulaMapGroup
	Constants of bit masks used with XFormulaOpCodeMapper::getAvailableMappings() to specify for which group of symbols the mappings are to be obtained.

constants	FormulaMapGroupSpecialOffset
	Constants designating the offsets within the sequence returned by XFormulaOpCodeMapper::getAvailableMappings() when called for group FormulaMapGroup::SPECIAL.

constants	FormulaResult
	used to select different result types of cell formulas.

constants	FunctionCategory
	used to specify the category of a spreadsheet function.

constants	GeneralFunction2
	used to specify a function to be calculated from values.

constants	IconSetFormatEntry

constants	IconSetType

constants	MemberResultFlags
	used to give information about elements in data pilot member results.

constants	MoveDirection
	used to specify the direction of moving the current selection i.e.

constants	NamedRangeFlag
	used to specify the purpose of a named range.

constants	ReferenceFlags
	defines flags for references.

constants	SpreadsheetViewObjectsMode
	Constants that control how embedded objects are shown in the view.

constants	StatusBarFunction
	used to specify the function used to calculate a result in the spreadsheet's status bar.

constants	TableValidationVisibility
	These constants specify whether and how a list of possible values of a cell should be shown.

Classes
service	AccessibleCell
	The accessible view of a spreadsheet document. More...

service	AccessibleCsvCell
	The accessible object of a cell in the CSV import dialog. More...

service	AccessibleCsvRuler
	The accessible object of the ruler in the CSV import dialog. More...

service	AccessibleCsvTable
	The accessible object of the data table in the CSV import dialog. More...

service	AccessiblePageHeaderFooterAreasView
	The accessible view of the Header/Footer in a spreadsheet page preview. More...

service	AccessibleSpreadsheet
	The accessible view of a spreadsheet document. More...

service	AccessibleSpreadsheetDocumentView
	The accessible view of a spreadsheet document. More...

service	AccessibleSpreadsheetPageView
	The accessible view of a spreadsheet page preview. More...

struct	ActivationEvent
	describes a change of the active sheet. More...

service	AddIn
	is the base for AddIn services that supply functions which can be called by other components. More...

service	CellAnnotation
	represents a cell annotation object attached to a spreadsheet cell. More...

service	CellAnnotations
	represents a collection of cell annotations. More...

service	CellAnnotationsEnumeration
	represents an enumeration of cell annotations in a spreadsheet document. More...

service	CellAnnotationShape
	represents the shape of a cell annotation object attached to a spreadsheet cell. More...

service	CellAreaLink
	represents a linked cell range. More...

service	CellAreaLinks
	represents a collection of area links. More...

service	CellAreaLinksEnumeration
	represents an enumeration of cell area links. More...

service	CellFormatRanges
	represents a collection of equal-formatted cell ranges. More...

service	CellFormatRangesEnumeration
	represents an enumeration of equal-formatted cell ranges. More...

service	Cells
	represents a collection of used cells in a spreadsheet document. More...

service	CellsEnumeration
	represents an enumeration of spreadsheet cells. More...

service	ColorScale

struct	ComplexReference
	contains a reference to a cell range. More...

service	ConditionalFormat
	represents a conditional format More...

service	ConditionFormatEntry

service	ConsolidationDescriptor
	contains all settings of a data consolidation in a spreadsheet document. More...

service	DataBar

service	DatabaseImportDescriptor
	represents a description of how data from an external database is imported. More...

service	DatabaseRange
	represents a database range in a spreadsheet document. More...

service	DatabaseRanges
	represents a collection of database ranges in a spreadsheet document. More...

service	DatabaseRangesEnumeration
	represents an enumeration of database ranges. More...

service	DataPilotDescriptor
	represents the description of the layout of a data pilot table. More...

service	DataPilotField
	represents a single field in a data pilot table. More...

struct	DataPilotFieldAutoShowInfo
	contains the auto show information of a DataPilotField. More...

struct	DataPilotFieldFilter

service	DataPilotFieldGroup
	represents a collection of members in a data pilot field group. More...

service	DataPilotFieldGroupEnumeration
	represents an enumeration of members in a DataPilot field group. More...

struct	DataPilotFieldGroupInfo
	contains the grouping information of a DataPilotField. More...

service	DataPilotFieldGroupItem
	represents the member in a data pilot field group. More...

service	DataPilotFieldGroups
	represents a collection of groups in a data pilot field. More...

service	DataPilotFieldGroupsEnumeration
	represents an enumeration of member groups in a DataPilot field. More...

struct	DataPilotFieldLayoutInfo
	contains the layout information of a DataPilotField. More...

struct	DataPilotFieldReference
	controls how a data pilot field's results are shown in relation to a selected reference result. More...

service	DataPilotFields
	represents a collection of fields in a data pilot table. More...

service	DataPilotFieldsEnumeration
	represents an enumeration of data pilot fields. More...

struct	DataPilotFieldSortInfo
	describes how to sort a single DataPilotField More...

service	DataPilotItem
	represents a single item in a data pilot field. More...

service	DataPilotItems
	represents a collection of items in a data pilot field. More...

service	DataPilotItemsEnumeration
	represents an enumeration of data pilot items. More...

service	DataPilotSource
	represents a data pilot source. More...

service	DataPilotSourceDimension
	represents a dimension in a data pilot source. More...

service	DataPilotSourceDimensions
	represents the collection of dimensions in a data pilot source. More...

service	DataPilotSourceHierarchies
	represents the collection of hierarchies in a data pilot source dimension. More...

service	DataPilotSourceHierarchy
	represents a hierarchy in a data pilot source dimension. More...

service	DataPilotSourceLevel
	represents a level in a data pilot source hierarchy. More...

service	DataPilotSourceLevels
	represents the collection of levels in a data pilot source hierarchy. More...

service	DataPilotSourceMember
	represents a member in a data pilot source level. More...

service	DataPilotSourceMembers
	represents the collection of members in a data pilot source level. More...

service	DataPilotTable
	represents a data pilot table on a spreadsheet. More...

struct	DataPilotTableHeaderData
	information about a cell within the column or row header area of a DataPilot table. More...

struct	DataPilotTablePositionData
	This structure contains information on a cell within a DataPilot table. More...

struct	DataPilotTableResultData
	information about a cell positioned within the result area of a DataPilot table. More...

service	DataPilotTables
	represents a collection of data pilot tables. More...

service	DataPilotTablesEnumeration
	represents an enumeration of data pilot tables. More...

struct	DataResult
	contains the result of one element in the data pilot data array. More...

service	DateCondition

struct	DDEItemInfo
	describes an item of a DDE connection. More...

service	DDELink
	represents a DDE link. More...

struct	DDELinkInfo
	describes all items of a DDE connection used in formulas. More...

service	DDELinks
	represents a collection of DDE links. More...

service	DDELinksEnumeration
	represents an enumeration of DDE links. More...

service	DocumentSettings
	describes properties that apply to the whole spreadsheet document. More...

service	ExternalDocLink
	Represents a single external document link. More...

service	ExternalDocLinks
	Represents a collection of external document links. More...

struct	ExternalLinkInfo
	describes an external link in a formula. More...

struct	ExternalReference
	Data structure to store information about an external reference. More...

service	ExternalSheetCache
	A single sheet cache for an external document. More...

struct	FilterFieldValue

service	FilterFormulaParser
	A service used to implement parsing and printing formula strings in a specific formula language. More...

struct	FormulaOpCodeMapEntry
	contains a mapping from a formula name (function name, operator, ...) to the OpCode used by the formula compiler. More...

service	FormulaOpCodeMapper

service	FormulaParser

struct	FormulaToken
	contains a single token within a formula. More...

service	FunctionAccess
	allows generic access to all spreadsheet functions. More...

struct	FunctionArgument
	contains the description of a single argument within a spreadsheet function. More...

service	FunctionDescription
	collects all properties used to describe a function. More...

service	FunctionDescriptionEnumeration
	represents an enumeration of Function Descriptions. More...

service	FunctionDescriptions
	represents a collection of function descriptions for all built-in functions as well as add-in functions available in the spreadsheet application. More...

service	GlobalSheetSettings
	contributes properties to access the settings for all spreadsheets of a spreadsheet document. More...

struct	GoalResult
	is the result of a goal seek operation. More...

service	HeaderFooterContent
	represents the contents of a header or footer line in a page style. More...

service	IconSet

service	LabelRange
	represents a cell area that contains labels and values related to the labels. More...

service	LabelRanges
	represents a collection of label ranges in a spreadsheet document. More...

service	LabelRangesEnumeration
	represents an enumeration of label ranges. More...

struct	LocalizedName
	A name that is valid for a specified locale. More...

struct	MemberResult
	describes a result of a DataPilot member. More...

service	NamedRange
	represents a named range in a spreadsheet document. More...

service	NamedRanges
	represents a collection of named ranges in a spreadsheet document. More...

service	NamedRangesEnumeration
	represents an enumeration of named ranges. More...

struct	NameToken
	contains the information regarding named tokens More...

exception	NoConvergenceException
	Thrown by a Calc Add-In function this exception indicates the function's algorithm did not converge to a meaningful result. More...

service	RangeSelectionArguments
	contains the arguments for starting the range selection. More...

struct	RangeSelectionEvent
	specifies an event from range selection. More...

service	RecentFunctions
	contains the list of recently used spreadsheet functions. More...

struct	ResultEvent
	contains the new value of a volatile function result. More...

service	Scenario
	represents a scenario in a spreadsheet document. More...

service	Scenarios
	represents a collection of scenarios. More...

service	ScenariosEnumeration
	represents an enumeration of scenarios. More...

service	Shape
	specifies the service of shapes in a spreadsheet document More...

service	SheetCell
	represents a single addressable cell in a spreadsheet document. More...

service	SheetCellCursor
	represents a cursor in a spreadsheet. More...

service	SheetCellRange
	represents a rectangular range of cells in a spreadsheet document. More...

service	SheetCellRanges
	represents a collection of cell ranges in a spreadsheet document. More...

service	SheetCellRangesEnumeration
	represents an enumeration of cell ranges in a spreadsheet document. More...

service	SheetFilterDescriptor
	represents a description of how a cell range is to be filtered. More...

service	SheetLink
	represents a sheet link. More...

service	SheetLinks
	represents a collection of sheet links. More...

service	SheetLinksEnumeration
	represents an enumeration of sheet links. More...

service	SheetRangesQuery
	provides interfaces to find cells with specific properties. More...

service	SheetSortDescriptor
	a description of how a cell range is to be sorted. More...

service	SheetSortDescriptor2
	a description of how a cell range is to be sorted. More...

struct	SingleReference
	contains a reference to a single cell. More...

service	Solver
	A solver for a model that is defined by spreadsheet cells. More...

struct	SolverConstraint
	is used to specify a constraint for a solver model. More...

service	Spreadsheet
	represents a complete spreadsheet in a spreadsheet document. More...

service	SpreadsheetDocument
	represents a model component which consists of some settings and one or more spreadsheets. More...

service	SpreadsheetDocumentSettings
	contributes properties to control the configuration which is global for all views of a spreadsheet document. More...

service	SpreadsheetDrawPage
	This abstract service is implemented by every page of a SpreadsheetDocument. More...

service	Spreadsheets
	represents the collection of spreadsheets in a spreadsheet document. More...

service	SpreadsheetsEnumeration
	represents an enumeration of spreadsheets in a spreadsheet document. More...

service	SpreadsheetView
	represents a view of a spreadsheet document. More...

service	SpreadsheetViewPane
	represents a single pane in a view of a spreadsheet document. More...

service	SpreadsheetViewPanesEnumeration
	represents an enumeration of spreadsheet view panes. More...

service	SpreadsheetViewSettings
	contains settings which are specific to each view of a spreadsheet More...

struct	SubTotalColumn
	describes how a single data column is treated when creating subtotals. More...

service	SubTotalDescriptor
	represents a description of how subtotals are created. More...

service	SubTotalField
	represents a single field in a subtotal descriptor. More...

service	SubTotalFieldsEnumeration
	represents an enumeration of sub total fields. More...

service	TableAutoFormat
	represents an AutoFormat, containing exactly 16 AutoFormat fields. More...

service	TableAutoFormatEnumeration
	represents an enumeration of AutoFormat fields in an AutoFormat. More...

service	TableAutoFormatField
	represents a field in an AutoFormat. More...

service	TableAutoFormats
	represents the collection of AutoFormats. More...

service	TableAutoFormatsEnumeration
	represents an enumeration of AutoFormats. More...

service	TableCellStyle
	contains the properties of a table cell style. More...

service	TableConditionalEntry
	represents a single condition in a conditional format. More...

service	TableConditionalEntryEnumeration
	represents an enumeration of conditional entries. More...

service	TableConditionalFormat
	represents a collection of conditional formatting settings for a cell or cell range. More...

struct	TableFilterField
	describes a single condition in a filter descriptor. More...

struct	TableFilterField2
	describes a single condition in a filter descriptor. More...

struct	TableFilterField3

struct	TablePageBreakData
	describes a page break in a spreadsheet. More...

service	TablePageStyle
	represents a page style for a spreadsheet. More...

service	TableValidation
	represents the data validation settings for a cell or cell range. More...

service	UniqueCellFormatRanges
	represents a collection of equal-formatted cell range collections. More...

service	UniqueCellFormatRangesEnumeration
	represents an enumeration of equal-formatted cell range collections. More...

service	VolatileResult
	represents a volatile function result. More...

interface	XActivationBroadcaster
	provides methods to add and remove XActivationEventListener More...

interface	XActivationEventListener
	makes it possible to receive events when the active spreadsheet changes. More...

interface	XAddIn
	gives access to function descriptions and user-visible names. More...

interface	XAreaLink
	provides methods to change the settings of a linked cell range. More...

interface	XAreaLinks
	provides access via index to a collection of area links and inserting and removing area links. More...

interface	XArrayFormulaRange
	provides handling of array formulas in a cell range. More...

interface	XArrayFormulaTokens
	gives access to an array formula as token sequence. More...

interface	XCalculatable
	represents something that can recalculate. More...

interface	XCellAddressable
	represents a cell which can be addressed with a com::sun::star::table::CellAddress. More...

interface	XCellFormatRangesSupplier
	provides access to a collection of equal-formatted cell ranges. More...

interface	XCellRangeAddressable
	represents a cell which can be addressed with a com::sun::star::table::CellRangeAddress. More...

interface	XCellRangeData
	allows to get and set an array of data from a cell range. More...

interface	XCellRangeFormula
	allows to get and set cell contents (values, text or formulas) for a cell range. More...

interface	XCellRangeMovement
	provides methods for moving ranges of cells in a sheet. More...

interface	XCellRangeReferrer
	allows direct access to the cells in a named range or to the cells which are visible in a view, without the need to get the document object first. More...

interface	XCellRangesAccess
	provides access to the cells or to sub-ranges of all sheets. More...

interface	XCellRangesQuery
	provides methods to query for cell ranges with specific contents. More...

interface	XCellSeries
	provides methods to fill out a cell range automatically with values based on a start value, step count and fill mode. More...

interface	XColorScaleEntry

interface	XCompatibilityNames
	gives access to the sequence of compatibility names for an Addin function. More...

interface	XConditionalFormat

interface	XConditionalFormats

interface	XConditionEntry
	Abstract base interface for any conditional format. More...

interface	XConsolidatable
	provides methods to consolidate ranges in a spreadsheet document. More...

interface	XConsolidationDescriptor
	provides access to the settings of a consolidation descriptor. More...

interface	XDataBarEntry

interface	XDatabaseRange
	provides access to the settings and options of a database range. More...

interface	XDatabaseRanges
	provides functions to manage a collection of database ranges. More...

interface	XDataPilotDataLayoutFieldSupplier
	Provides access to the DataPilotField used to layout multiple data fields. More...

interface	XDataPilotDescriptor
	provides access to the layout settings of a data pilot table. More...

interface	XDataPilotField
	provides methods to control a data pilot field which has already been created. More...

interface	XDataPilotFieldGrouping
	Provides methods to create new DataPilot fields where some or all items of this DataPilot field are grouped in some way. More...

interface	XDataPilotMemberResults
	provides access to a sequence of results of a data pilot source level. More...

interface	XDataPilotResults
	provides access to a table of results of a data pilot source. More...

interface	XDataPilotTable
	provides methods to control a data pilot table which has already been created. More...

interface	XDataPilotTable2
	additional methods to extend com::sun::star::sheet::XDataPilotTable. More...

interface	XDataPilotTables
	provides access to the data pilot tables via name and inserting and removing data pilot tables. More...

interface	XDataPilotTablesSupplier
	grants access to a collection of data pilot tables. More...

interface	XDDELink
	provides methods to change the settings of a DDE link. More...

interface	XDDELinkResults
	provides access to the DDE link results. More...

interface	XDDELinks
	provides a method to add a DDE link to a spreadsheet. More...

interface	XDimensionsSupplier
	provides access to the collection of dimensions of a data pilot source. More...

interface	XDocumentAuditing
	provides auditing functions of a document. More...

interface	XDrillDownDataSupplier
	supplies a filtered subset of the original data source based on filtering criteria. More...

interface	XEnhancedMouseClickBroadcaster
	provides methods to add and remove EnhancedMouseClickHandler More...

interface	XExternalDocLink
	Primary interface for the com::sun::star::sheet::ExternalDocLink service. More...

interface	XExternalDocLinks
	Primary interface for the com::sun::star::sheet::ExternalDocLinks service. More...

interface	XExternalSheetCache
	Primary interface for the com::sun::star::sheet::ExternalSheetCache service. More...

interface	XExternalSheetName
	provides a method to set an external name at the sheet. More...

interface	XFillAcrossSheet

interface	XFilterFormulaParser
	Extends the interface XFormulaParser by an attribute that specifies the namespace URL of the supported formula language. More...

interface	XFormulaOpCodeMapper
	gives access to spreadsheet compiler token interns. More...

interface	XFormulaParser
	converts between text and token representations of formulas. More...

interface	XFormulaQuery
	provides methods to query cells for dependencies in formulas. More...

interface	XFormulaTokens
	gives access to a formula as token sequence. More...

interface	XFunctionAccess
	allows generic access to all spreadsheet functions. More...

interface	XFunctionDescriptions
	provides access to the property sequence of a function description via function index or identifier. More...

interface	XGlobalSheetSettings

interface	XGoalSeek
	provides seeking a goal value for a cell. More...

interface	XHeaderFooterContent
	provides access to the text contents of a header or footer on a page. More...

interface	XHierarchiesSupplier
	provides access to the collection of hierarchies of a data pilot source dimension. More...

interface	XIconSetEntry

interface	XLabelRange
	provides access to the settings of a label range in a spreadsheet document. More...

interface	XLabelRanges
	provides methods to access the members of a label range collection and to insert and remove them. More...

interface	XLevelsSupplier
	provides access to the collection of levels of a data pilot source hierarchy. More...

interface	XMembersAccess
	is used to access named members in a data pilot source level collection. More...

interface	XMembersSupplier
	provides access to the collection of members of a data pilot source level. More...

interface	XMultiFormulaTokens
	gives access to multiple sets of formula tokens. More...

interface	XMultipleOperation
	provides a method to apply a Multiple Operations Table to the cell range. More...

interface	XNamedRange
	provides access to the settings of a named range in a spreadsheet document. More...

interface	XNamedRanges
	provides access to the members in a collection of named ranges and to insert and remove them. More...

interface	XPrintAreas
	represents a sheet which has print areas. More...

interface	XRangeSelection
	allows to let the user to select a cell range. More...

interface	XRangeSelectionChangeListener
	allows notification when the selected range is changed. More...

interface	XRangeSelectionListener
	allows notification when range selection is completed or aborted. More...

interface	XRecentFunctions
	provides access to a list of recently used functions. More...

interface	XResultListener
	allows notification when a new volatile function result is available. More...

interface	XScenario
	provides access to the settings of a scenario sheet. More...

interface	XScenarioEnhanced
	provides enhanced access to the settings of a scenario sheet. More...

interface	XScenarios
	provides access via name to the scenarios in a collection and inserting and removing scenarios. More...

interface	XScenariosSupplier
	provides access to a collection of scenarios. More...

interface	XSelectedSheetsSupplier

interface	XSheetAnnotation
	provides methods to query data of the annotation and to show and hide it. More...

interface	XSheetAnnotationAnchor
	provides access to a cell annotation attached to a spreadsheet cell. More...

interface	XSheetAnnotations
	provides methods to access cell annotations via index and to insert and remove annotations. More...

interface	XSheetAnnotationShapeSupplier
	provides methods to get the shape of o annotation More...

interface	XSheetAnnotationsSupplier
	provides access to a collection of cell annotations. More...

interface	XSheetAuditing
	provides methods to access auditing (detective) features in a spreadsheet. More...

interface	XSheetCellCursor
	provides advanced methods to control the position of a cursor in a spreadsheet. More...

interface	XSheetCellRange
	provides access to the spreadsheet that contains a cell range. More...

interface	XSheetCellRangeContainer
	provides methods to access cell ranges in a collection via index and to add and remove cell ranges. More...

interface	XSheetCellRanges
	provides methods to access cell ranges in a collection via index and other helper methods. More...

interface	XSheetCondition
	provides methods to access the settings of a condition in a conditional format or data validation. More...

interface	XSheetCondition2
	provides methods to access the settings of a condition in a conditional format or data validation. More...

interface	XSheetConditionalEntries
	provides methods to add and remove conditions of a conditional format. More...

interface	XSheetConditionalEntry
	provides methods to access the cell style name for a condition in a conditional format. More...

interface	XSheetFilterable
	represents something that can be filtered using an XSheetFilterDescriptor. More...

interface	XSheetFilterableEx
	represents something from which criteria for filtering can be read. More...

interface	XSheetFilterDescriptor
	provides access to a collection of filter conditions (filter fields). More...

interface	XSheetFilterDescriptor2
	provides access to a collection of filter conditions (filter fields). More...

interface	XSheetFilterDescriptor3
	provides access to a collection of filter conditions (filter fields). More...

interface	XSheetLinkable
	enables a sheet to refer to another sheet in a different document. More...

interface	XSheetOperation
	provides methods to execute operations on a cell range or ranges. More...

interface	XSheetOutline
	provides methods to access the outlines of a sheet. More...

interface	XSheetPageBreak
	provides access to page breaks in a sheet. More...

interface	XSheetPastable
	represents a sheet into which contents of the clipboard can be pasted. More...

interface	XSolver
	allows to call a solver for a model that is defined by spreadsheet cells. More...

interface	XSolverDescription
	gives access to user-visible strings for a solver. More...

interface	XSpreadsheet
	provides methods to create a cell range cursor. More...

interface	XSpreadsheetDocument
	provides access to a collection of spreadsheets. More...

interface	XSpreadsheets
	provides methods to access the spreadsheets by name and to insert, copy, remove and rearrange spreadsheets. More...

interface	XSpreadsheets2
	extends XSpreadsheets interface to import external sheets. More...

interface	XSpreadsheetView
	is the main interface of a SpreadsheetView. More...

interface	XSubTotalCalculatable
	contains methods to handle a subtotal descriptor. More...

interface	XSubTotalDescriptor
	provides access to the collection of subtotal fields in a subtotal descriptor. More...

interface	XSubTotalField
	provides access to the settings of a field in a subtotal descriptor. More...

interface	XUniqueCellFormatRangesSupplier
	provides access to a collection of collections of equal-formatted cell ranges. More...

interface	XUnnamedDatabaseRanges
	provides functions to manage the sheet local databases More...

interface	XUsedAreaCursor
	provides methods to find the used area of the entire sheet. More...

interface	XViewFreezable
	enables a SpreadsheetView to freeze columns and rows of the view. More...

interface	XViewPane
	represents a pane in a view of a spreadsheet document. More...

interface	XViewPanesSupplier
	enables access to the panes in a view. More...

interface	XViewSplitable
	enables a SpreadsheetView to split the view. More...

interface	XVolatileResult
	provides methods to handle a volatile function result. More...

Enumerations
enum	Border { TOP, BOTTOM, RIGHT, LEFT }
	is used to select one of the four borders of a cell range. More...

enum	CellDeleteMode { NONE, UP, LEFT, ROWS, COLUMNS }
	is used to specify how remaining cells are moved when cells are deleted. More...

enum	CellInsertMode { NONE, DOWN, RIGHT, ROWS, COLUMNS }
	is used to specify how cells are moved when new cells are inserted. More...

enum	ConditionOperator { NONE, EQUAL, NOT_EQUAL, GREATER, GREATER_EQUAL, LESS, LESS_EQUAL, BETWEEN, NOT_BETWEEN, FORMULA }
	is used to specify the type of XSheetCondition. More...

enum	DataImportMode { NONE, SQL, TABLE, QUERY }
	used to specify which database contents are imported. More...

enum	DataPilotFieldOrientation { HIDDEN, COLUMN, ROW, PAGE, DATA }
	used to specify where a field in a data pilot table is laid out. More...

enum	DDELinkMode { DEFAULT, ENGLISH, TEXT }
	used to specify how the DDE server application converts its data into numbers. More...

enum	FillDateMode { FILL_DATE_DAY, FILL_DATE_WEEKDAY, FILL_DATE_MONTH, FILL_DATE_YEAR }
	used to specify how an arithmetic date series is calculated. More...

enum	FillDirection { TO_BOTTOM, TO_RIGHT, TO_TOP, TO_LEFT }
	used to specify the direction of filling cells, for example, with a series. More...

enum	FillMode { SIMPLE, LINEAR, GROWTH, DATE, AUTO }
	used to specify the series type used to fill cells. More...

enum	FilterConnection { AND, OR }
	used to specify how two conditions in a filter descriptor are connected. More...

enum	FilterOperator { EMPTY, NOT_EMPTY, EQUAL, NOT_EQUAL, GREATER, GREATER_EQUAL, LESS, LESS_EQUAL, TOP_VALUES, TOP_PERCENT, BOTTOM_VALUES, BOTTOM_PERCENT }
	specifies the type of a single condition in a filter descriptor. More...

enum	GeneralFunction { NONE, AUTO, SUM, COUNT, AVERAGE, MAX, MIN, PRODUCT, COUNTNUMS, STDEV, STDEVP, VAR, VARP }
	used to specify a function to be calculated from values. More...

enum	PasteOperation { NONE, ADD, SUBTRACT, MULTIPLY, DIVIDE }
	used to specify which operations are carried out when pasting cell values into a cell range. More...

enum	SheetLinkMode { NONE, NORMAL, VALUE }
	used to specify how a sheet is linked to another sheet. More...

enum	SolverConstraintOperator { LESS_EQUAL, EQUAL, GREATER_EQUAL, INTEGER, BINARY }
	is used to specify the type of SolverConstraint. More...

enum	TableOperationMode { COLUMN, ROW, BOTH }
	used to specify if a table operation is applied to columns, rows, or both columns and rows. More...

enum	ValidationAlertStyle { STOP, WARNING, INFO, MACRO }
	used to specify how invalid cell contents are treated. More...

enum	ValidationType { ANY, WHOLE, DECIMAL, DATE, TIME, TEXT_LEN, LIST, CUSTOM }
	used to specify which cell contents are treated as valid. More...

Detailed Description

Spreadsheet specific interfaces.

Enumeration Type Documentation

◆ Border

enum Border

published

is used to select one of the four borders of a cell range.

Enumerator
TOP	selects the top border.
BOTTOM	selects the bottom border.
RIGHT	selects the right border. the cells to the right of the inserted cells are moved right.
LEFT	selects the left border. the cells to the right of the deleted cells are moved left.

◆ CellDeleteMode

enum CellDeleteMode

published

is used to specify how remaining cells are moved when cells are deleted.

Enumerator
NONE	no cells are moved. sheet is not linked. new values are used without changes. nothing is calculated. nothing is imported. no condition is specified.
UP	the cells below the deleted cells are moved up.
LEFT	selects the left border. the cells to the right of the deleted cells are moved left.
ROWS	entire rows below the deleted cells are moved up. entire rows below the inserted cells are moved down.
COLUMNS	entire columns to the right of the deleted cells are moved left. entire columns to the right of the inserted cells are moved right.

◆ CellInsertMode

enum CellInsertMode

published

is used to specify how cells are moved when new cells are inserted.

Enumerator
NONE	no cells are moved. sheet is not linked. new values are used without changes. nothing is calculated. nothing is imported. no condition is specified.
DOWN	the cells below the inserted cells are moved down.
RIGHT	selects the right border. the cells to the right of the inserted cells are moved right.
ROWS	entire rows below the deleted cells are moved up. entire rows below the inserted cells are moved down.
COLUMNS	entire columns to the right of the deleted cells are moved left. entire columns to the right of the inserted cells are moved right.

◆ ConditionOperator

enum ConditionOperator

published

is used to specify the type of XSheetCondition.

Developers Guide: Spreadsheet Documents - Conditional Formats

Enumerator
NONE	no cells are moved. sheet is not linked. new values are used without changes. nothing is calculated. nothing is imported. no condition is specified.
EQUAL	value has to be equal to the specified value. The cell value is equal to the specified value.
NOT_EQUAL	the value must not be equal to the specified value. value must not be equal to the specified value.
GREATER	the value has to be greater than the specified value. value has to be greater than the specified value.
GREATER_EQUAL	the value has to be greater than or equal to the specified value. The cell value is greater or equal to the specified value. value has to be greater than or equal to the specified value.
LESS	the value has to be less than the specified value. value has to be less than the specified value.
LESS_EQUAL	the value has to be less than or equal to the specified value. The cell value is less or equal to the specified value. value has to be less than or equal to the specified value.
BETWEEN	the value has to be between the two specified values.
NOT_BETWEEN	the value has to be outside of the two specified values.
FORMULA	the specified formula has to give a non-zero result.

◆ DataImportMode

enum DataImportMode

published

used to specify which database contents are imported.

Enumerator
NONE	no cells are moved. sheet is not linked. new values are used without changes. nothing is calculated. nothing is imported. no condition is specified.
SQL	a SQL query string is supplied.
TABLE	the name of a database table is supplied.
QUERY	the name of a database query is supplied.

◆ DataPilotFieldOrientation

enum DataPilotFieldOrientation

published

used to specify where a field in a data pilot table is laid out.

Developers Guide: Spreadsheet Documents - Creating a New DataPilot Table

Enumerator
HIDDEN	the field is not used in the table.
COLUMN	the field is used as a column field. is applied to the columns. In this mode, the column contains values and the row contains formulas.
ROW	the field is used as a row field. is applied to the rows. In this mode, the row contains values and the column contains formulas.
PAGE	the field is used as a page field.
DATA	the field is used as a data field.

◆ DDELinkMode

enum DDELinkMode

published

used to specify how the DDE server application converts its data into numbers.

See also: com::sun::star::sheet::XDDELinks

Since: OOo 3.0

Enumerator
DEFAULT	numbers are converted into the default format.
ENGLISH	numbers are converted into the English default format.
TEXT	numbers are not converted, but treated as text.

◆ FillDateMode

enum FillDateMode

published

used to specify how an arithmetic date series is calculated.

See also: com::sun::star::sheet::FillMode

Enumerator
FILL_DATE_DAY	for every new value a single day is added.
FILL_DATE_WEEKDAY	for every new value a single day is added, but Saturdays and Sundays are skipped.
FILL_DATE_MONTH	for every new value one month is added (day keeps unchanged).
FILL_DATE_YEAR	for every new value one year is added (day and month keep unchanged).

◆ FillDirection

enum FillDirection

published

used to specify the direction of filling cells, for example, with a series.

Enumerator
TO_BOTTOM	specifies that rows are filled from top to bottom.
TO_RIGHT	specifies that columns are filled from left to right.
TO_TOP	specifies that rows are filled from bottom to top.
TO_LEFT	specifies that columns are filled from right to left.

◆ FillMode

enum FillMode

published

used to specify the series type used to fill cells.

Enumerator
SIMPLE	specifies a constant series. All cells are filled with the same value.
LINEAR	specifies an arithmetic series. Cell by cell, the value used to fill the cells is increased by an additive value.
GROWTH	specifies a geometric series. Cell by cell, the value used to fill the cells is multiplied by a specified value.
DATE	specifies an arithmetic series for date values. any date value matching the specified condition is valid. Cell by cell, the value used to fill the cells is increased by a specified number of days See also com::sun::star::sheet::FillDateMode
AUTO	specifies the use of a user-defined list. function is determined automatically. The cells are filled using a user-defined series. If the values are all numerical, SUM is used, otherwise COUNT.

◆ FilterConnection

enum FilterConnection

published

used to specify how two conditions in a filter descriptor are connected.

Enumerator
AND	both conditions have to be fulfilled.
OR	at least one of the conditions has to be fulfilled.

◆ FilterOperator

enum FilterOperator

published

specifies the type of a single condition in a filter descriptor.

Enumerator
EMPTY	selects empty entries.
NOT_EMPTY	selects non-empty entries.
EQUAL	value has to be equal to the specified value. The cell value is equal to the specified value.
NOT_EQUAL	the value must not be equal to the specified value. value must not be equal to the specified value.
GREATER	the value has to be greater than the specified value. value has to be greater than the specified value.
GREATER_EQUAL	the value has to be greater than or equal to the specified value. The cell value is greater or equal to the specified value. value has to be greater than or equal to the specified value.
LESS	the value has to be less than the specified value. value has to be less than the specified value.
LESS_EQUAL	the value has to be less than or equal to the specified value. The cell value is less or equal to the specified value. value has to be less than or equal to the specified value.
TOP_VALUES	selects a specified number of entries with the greatest values.
TOP_PERCENT	selects a specified percentage of entries with the greatest values.
BOTTOM_VALUES	selects a specified number of entries with the lowest values.
BOTTOM_PERCENT	selects a specified percentage of entries with the lowest values.

◆ GeneralFunction

enum GeneralFunction

published

used to specify a function to be calculated from values.

Enumerator
NONE	no cells are moved. sheet is not linked. new values are used without changes. nothing is calculated. nothing is imported. no condition is specified.
AUTO	specifies the use of a user-defined list. function is determined automatically. The cells are filled using a user-defined series. If the values are all numerical, SUM is used, otherwise COUNT.
SUM	sum of all numerical values is calculated.
COUNT	all values, including non-numerical values, are counted.
AVERAGE	average of all numerical values is calculated.
MAX	maximum value of all numerical values is calculated.
MIN	minimum value of all numerical values is calculated.
PRODUCT	product of all numerical values is calculated.
COUNTNUMS	numerical values are counted.
STDEV	standard deviation is calculated based on a sample.
STDEVP	standard deviation is calculated based on the entire population.
VAR	variance is calculated based on a sample.
VARP	variance is calculated based on the entire population.

◆ PasteOperation

enum PasteOperation

published

used to specify which operations are carried out when pasting cell values into a cell range.

Enumerator
NONE	no cells are moved. sheet is not linked. new values are used without changes. nothing is calculated. nothing is imported. no condition is specified.
ADD	old and new values are added.
SUBTRACT	new values are subtracted from the old values.
MULTIPLY	old and new values are multiplied.
DIVIDE	new values are divided by the new values.

◆ SheetLinkMode

enum SheetLinkMode

published

used to specify how a sheet is linked to another sheet.

See also: com::sun::star::sheet::SheetLinks; com::sun::star::sheet::SheetLink; com::sun::star::sheet::XSheetLinkable

Enumerator

NONE

no cells are moved.

sheet is not linked.

new values are used without changes.

nothing is calculated.

nothing is imported.

no condition is specified.

NORMAL

all contents (values and formulas) are copied.

VALUE

instead of using formulas, the result values are copied.

◆ SolverConstraintOperator

enum SolverConstraintOperator

is used to specify the type of SolverConstraint.

Enumerator
LESS_EQUAL	the value has to be less than or equal to the specified value. The cell value is less or equal to the specified value. value has to be less than or equal to the specified value.
EQUAL	value has to be equal to the specified value. The cell value is equal to the specified value.
GREATER_EQUAL	the value has to be greater than or equal to the specified value. The cell value is greater or equal to the specified value. value has to be greater than or equal to the specified value.
INTEGER	The cell value is an integer value.
BINARY	The cell value is a binary value (0 or 1).

◆ TableOperationMode

enum TableOperationMode

published

used to specify if a table operation is applied to columns, rows, or both columns and rows.

Enumerator

COLUMN

the field is used as a column field.

is applied to the columns.

In this mode, the column contains values and the row contains formulas.

ROW

the field is used as a row field.

is applied to the rows.

In this mode, the row contains values and the column contains formulas.

BOTH

is applied to rows and columns.

In this mode, the row and the column contain values. A formula using both row and column values is specified separately.

◆ ValidationAlertStyle

enum ValidationAlertStyle

published

used to specify how invalid cell contents are treated.

Enumerator
STOP	error message is shown and the change is rejected.
WARNING	warning message is shown and the user is asked whether the change will be accepted (defaulted to "No").
INFO	information message is shown and the user is asked whether the change will be accepted (defaulted to "Yes").
MACRO	macro is executed.

◆ ValidationType

enum ValidationType

published

used to specify which cell contents are treated as valid.

Enumerator
ANY	any cell content is valid; no conditions are used.
WHOLE	any whole number matching the specified condition is valid.
DECIMAL	any number matching the specified condition is valid.
DATE	specifies an arithmetic series for date values. any date value matching the specified condition is valid. Cell by cell, the value used to fill the cells is increased by a specified number of days See also com::sun::star::sheet::FillDateMode
TIME	any time value matching the specified condition is valid.
TEXT_LEN	string is valid if its length matches the specified condition.
LIST	Only strings from a specified list are valid.
CUSTOM	The specified formula determines which contents are valid.

Modules

Constant Groups

Classes

Enumerations

Detailed Description

Enumeration Type Documentation

◆ Border

◆ CellDeleteMode

◆ CellInsertMode

◆ ConditionOperator

◆ DataImportMode

◆ DataPilotFieldOrientation

◆ DDELinkMode

◆ FillDateMode

◆ FillDirection

◆ FillMode

◆ FilterConnection

◆ FilterOperator

◆ GeneralFunction

◆ PasteOperation

◆ SheetLinkMode

◆ SolverConstraintOperator

◆ TableOperationMode

◆ ValidationAlertStyle

◆ ValidationType