LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XSheetCondition Interface Referencepublished

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

import"XSheetCondition.idl";

Inheritance diagram for XSheetCondition:
XInterface TableConditionalEntry TableValidation XSheetCondition2

Public Member Functions

com::sun::star::sheet::ConditionOperator getOperator ()
 returns the operator in the condition. More...
 
void setOperator ([in] com::sun::star::sheet::ConditionOperator nOperator)
 sets the operator in the condition. More...
 
string getFormula1 ()
 returns either the comparison value, which is used in the condition, or the first value if two values are needed for the operator. More...
 
void setFormula1 ([in] string aFormula1)
 sets either the comparison value, which is used in the condition, or the first value if two values are needed for the operator. More...
 
string getFormula2 ()
 if two values are needed for the operator, this method returns the second one. More...
 
void setFormula2 ([in] string aFormula2)
 if two values are needed for the operator, this method sets the second one. More...
 
com::sun::star::table::CellAddress getSourcePosition ()
 returns the position in the document which is used as a base for relative references in the formulas. More...
 
void setSourcePosition ([in] com::sun::star::table::CellAddress aSourcePosition)
 sets the position in the document which is used as a base for relative references in the formulas. 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...
 

Detailed Description

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

See also
com::sun::star::sheet::TableConditionalEntry
com::sun::star::sheet::TableValidation

Member Function Documentation

string getFormula1 ( )

returns either the comparison value, which is used in the condition, or the first value if two values are needed for the operator.

Returns
a formula, a numeric constant, or a string constant in quotes.
string getFormula2 ( )

if two values are needed for the operator, this method returns the second one.

Returns
a formula, a numeric constant, or a string constant in quotes.

returns the operator in the condition.

com::sun::star::table::CellAddress getSourcePosition ( )

returns the position in the document which is used as a base for relative references in the formulas.

void setFormula1 ( [in] string  aFormula1)

sets either the comparison value, which is used in the condition, or the first value if two values are needed for the operator.

Parameters
aFormula1a formula, a numeric constant, or a string constant in quotes.
void setFormula2 ( [in] string  aFormula2)

if two values are needed for the operator, this method sets the second one.

Parameters
aFormula2a formula, a numeric constant, or a string constant in quotes.
void setOperator ( [in] com::sun::star::sheet::ConditionOperator  nOperator)

sets the operator in the condition.

void setSourcePosition ( [in] com::sun::star::table::CellAddress  aSourcePosition)

sets the position in the document which is used as a base for relative references in the formulas.


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