The Free and Open Productivity Suite
Follow us on Twitter: @ApacheOO

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

unpublished constants group FormulaMapGroupSpecialOffset
Usage Restrictions
not published
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!


Constants
PUSH 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.  
CALL  
STOP Formula tokens containing the op-code obtained from this offset instruct the formula interpreter to immediately stop interpreting the formula.  
EXTERNAL 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.  
NAME 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.  
NO_NAME Formula tokens containing the op-code obtained from this offset describe an invalid name that resolves to the #NAME? error in formulas.  
MISSING Formula tokens containing the op-code obtained from this offset describe an empty function parameter.  
BAD 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.  
SPACES Formula tokens containing the op-code obtained from this offset describe whitespace characters within the string representation of a formula.  
MAT_REF  
DB_AREA Formula tokens containing the op-code obtained from this offset describe the reference to a database range used in formulas.  
MACRO Formula tokens containing the op-code obtained from this offset describe the reference to a macro function called in a formula.  
COL_ROW_NAME  
Constants' Details
PUSH
const long PUSH = 0;
Description
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.
CALL
const long CALL = 1;
STOP
const long STOP = 2;
Description
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.

EXTERNAL
const long EXTERNAL = 3;
Description
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 programmatical name of the function, e.g. "com.sun.star.sheet.addin.Analysis.getEomonth" for the EOMONTH function from the Analsysis add-in.

NAME
const long NAME = 4;
Description
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;
Description
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.

MISSING
const long MISSING = 6;
Description
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.

BAD
const long BAD = 7;
Description
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.

SPACES
const long SPACES = 8;
Description
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.

Attention: This may change in next versions to support other characters than simple space characters (e.g. line feeds, horizontal tabulators, non-breakable spaces).

MAT_REF
const long MAT_REF = 9;
DB_AREA
const long DB_AREA = 10;
Description
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
MACRO
const long MACRO = 11;
Description
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.

COL_ROW_NAME
const long COL_ROW_NAME = 12;
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.