com::sun::star::sheet::FormulaMapGroupSpecialOffset Constant Group Reference

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

Variables
const long	PUSH = 0
	Formula tokens containing the op-code obtained from this offset describe a formula operand token that will be pushed onto the formula stack while the formula is interpreted. More...
const long	CALL = 1
const long	STOP = 2
	Formula tokens containing the op-code obtained from this offset instruct the formula interpreter to immediately stop interpreting the formula. More...
const long	EXTERNAL = 3
	Formula tokens containing the op-code obtained from this offset describe the reference to an external function (e.g. More...
const long	NAME = 4
	Formula tokens containing the op-code obtained from this offset describe the reference to a defined name (also known as named range) used in formulas. More...
const long	NO_NAME = 5
	Formula tokens containing the op-code obtained from this offset describe an invalid name that resolves to the NAME? error in formulas. More...
const long	MISSING = 6
	Formula tokens containing the op-code obtained from this offset describe an empty function parameter. More...
const long	BAD = 7
	Formula tokens containing the op-code obtained from this offset describe "bad" data in a formula, e.g. More...
const long	SPACES = 8
	Formula tokens containing the op-code obtained from this offset describe whitespace characters within the string representation of a formula. More...
const long	MAT_REF = 9
const long	DB_AREA = 10
	Formula tokens containing the op-code obtained from this offset describe the reference to a database range used in formulas. More...
const long	MACRO = 11
	Formula tokens containing the op-code obtained from this offset describe the reference to a macro function called in a formula. More...
const long	COL_ROW_NAME = 12
const long	WHITESPACE = 13
	Formula tokens containing the op-code obtained from this offset describe whitespace characters within the string representation of a formula. More...

Detailed Description

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

The number of constants may grow in future versions!

Variable Documentation

BAD

const long BAD = 7

Formula tokens containing the op-code obtained from this offset describe "bad" data in a formula, e.g.

data the formula parser was not able to parse.

The FormulaToken::Data member shall contain a string with the bad data. This string will be displayed literally in the formula.

CALL

const long CALL = 1

COL_ROW_NAME

const long COL_ROW_NAME = 12

DB_AREA

const long DB_AREA = 10

Formula tokens containing the op-code obtained from this offset describe the reference to a database range used in formulas.

The FormulaToken::Data member shall contain an integer value of type long specifying the index of the database range. This index can be obtained from the database range using its DatabaseRange::TokenIndex property.

See also

DatabaseRange

EXTERNAL

const long EXTERNAL = 3

Formula tokens containing the op-code obtained from this offset describe the reference to an external function (e.g.

add-in function) used in formulas.

The FormulaToken::Data member shall contain a string with the programmatic name of the function, e.g. "com.sun.star.sheet.addin.Analysis.getEomonth" for the EOMONTH function from the Analysis add-in.

MACRO

const long MACRO = 11

Formula tokens containing the op-code obtained from this offset describe the reference to a macro function called in a formula.

The FormulaToken::Data member shall contain a string specifying the name of the macro function.

MAT_REF

const long MAT_REF = 9

MISSING

const long MISSING = 6

Formula tokens containing the op-code obtained from this offset describe an empty function parameter.

Example: In the formula =SUM(1;;2) the second parameter is empty and represented by a formula token containing the "missing" op-code.

The FormulaToken::Data member is not used and should be empty.

NAME

const long NAME = 4

Formula tokens containing the op-code obtained from this offset describe the reference to a defined name (also known as named range) used in formulas.

The FormulaToken::Data member shall contain an integer value of type long specifying the index of the defined name. This index can be obtained from the defined name using its NamedRange::TokenIndex property.

See also

NamedRange

NO_NAME

const long NO_NAME = 5

Formula tokens containing the op-code obtained from this offset describe an invalid name that resolves to the NAME? error in formulas.

The FormulaToken::Data member is not used and should be empty.

PUSH

const long PUSH = 0

Formula tokens containing the op-code obtained from this offset describe a formula operand token that will be pushed onto the formula stack while the formula is interpreted.

The FormulaToken::Data member shall contain one of the following values:

• A value of type double for literal floating-point constants.
• A string for literal text.
• A any[][] for a literal array. The contained values shall be of type double or string. Floating-point values and strings may occur together in an array.
• A struct of type SingleReference for a reference to a single cell in the own document.
• A struct of type ComplexReference for a reference to a range of cells in the own document.
• A struct of type ExternalReference for a reference to a cell, a range of cells, or a defined name in an external document.

SPACES

const long SPACES = 8

Formula tokens containing the op-code obtained from this offset describe whitespace characters within the string representation of a formula.

Whitespace characters in formulas are used for readability and do not affect the result of the formula.

The FormulaToken::Data member shall contain a positive integer value of type long specifying the number of space characters.

STOP

const long STOP = 2

Formula tokens containing the op-code obtained from this offset instruct the formula interpreter to immediately stop interpreting the formula.

The FormulaToken::Data member is not used and should be empty.

WHITESPACE

const long WHITESPACE = 13

Formula tokens containing the op-code obtained from this offset describe whitespace characters within the string representation of a formula.

Whitespace characters in formulas are used for readability and do not affect the result of the formula.

The FormulaToken::Data member shall contain a string of one (repeated) whitespace character. The length of the string determines the number of repetitions.

Allowed whitespace characters are SPACE (U+0020), CHARACTER TABULATION (U+0009), LINE FEED (U+000A), and CARRIAGE RETURN (U+000D). See also ODF v1.3 OpenFormula 5.14 Whitespace.

Since

LibreOffice 7.3