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

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

interface XSheetCondition

Base Interface
com::sun::star::uno::XInterface

Description
represents a condition in conditional formats or validation.
See also
com::sun::star::sheet::TableValidation
See also
com::sun::star::sheet::TableConditionalEntry


Known Services which Export this Interface

com::sun::star::sheet::TableValidation the validation settings for a cell or cell range.
com::sun::star::sheet::TableConditionalEntry a single entry in a TableConditionalFormat object.

Methods' Summary

getOperator returns the operator in the condition.
setOperator sets the operator in the condition.
getFormula1 returns either the comparison value, which is used in the condition, or the first value if two values are needed for the operator.
setFormula1 sets either the comparison value, which is used in the condition, or the first value if two values are needed for the operator.
getFormula2 if two values are needed for the operator, this method returns the second one.
setFormula2 if two values are needed for the operator, this method sets the second one.
getSourcePosition returns the position in the document which is used as a base for relative references in the formulas.
setSourcePosition sets the position in the document which is used as a base for relative references in the formulas.

Methods' Details

getOperator
 
com::sun::star::sheet::ConditionOperator
getOperator();
Description
returns the operator in the condition.
setOperator
 
void
setOperator(
[ in ] com::sun::star::sheet::ConditionOperator nOperator );

Description
sets the operator in the condition.
getFormula1
 
string
getFormula1();
Description
returns either the comparison value, which is used in the condition, or the first value if two values are needed for the operator.

This can be a formula, a numeric constant, or a string constant in quotes.

setFormula1
 
void
setFormula1(
[ in ] string aFormula1 );

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

This can be a formula, a numeric constant, or a string constant in quotes.

getFormula2
 
string
getFormula2();
Description
if two values are needed for the operator, this method returns the second one.

this can be a formula, a numeric constant, or a string constant in quotes. The operators ConditionOperator::BETWEEN and ConditionOperator::NOT_BETWEEN need two values each.

setFormula2
 
void
setFormula2(
[ in ] string aFormula2 );

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

This can be a formula, a numeric constant, or a string constant in quotes. The operators ConditionOperator::BETWEEN and ConditionOperator::NOT_BETWEEN need two values each.

getSourcePosition
 
com::sun::star::table::CellAddress
getSourcePosition();
Description
returns the position in the document which is used as a base for relative references in the formulas.
setSourcePosition
 
void
setSourcePosition(
[ in ] com::sun::star::table::CellAddress aSourcePosition );

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

Top of Page