<html> <head> <title>Constants' Group FormulaMapGroupSpecialOffset</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimainnone">Use</td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#Constants" class="navisub">Constants</a></td> <td class="navisub"><a href="#ConstantDetails" class="navisub">Constants' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sheet</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">constants group FormulaMapGroupSpecialOffset</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>Constants designating the offsets within the sequence returned by <a href="XFormulaOpCodeMapper.html">XFormulaOpCodeMapper</a>::<a href="XFormulaOpCodeMapper.html#getAvailableMappings">getAvailableMappings</a> when called for group <b>FormulaMapGroup::SPECIAL</b>. </dd> <dd><p>The number of constants may grow in future versions!</p> </dd> </dl> </td> </tr> </table> <hr> <a name="Constants"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Constants</td> </tr> <tr> <td class="imsum_left"><a href="#PUSH">PUSH</a></td> <td class="imsum_right">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. </td> </tr> <tr> <td class="imsum_left"><a href="#CALL">CALL</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#STOP">STOP</a></td> <td class="imsum_right">Formula tokens containing the op-code obtained from this offset instruct the formula interpreter to immediately stop interpreting the formula. </td> </tr> <tr> <td class="imsum_left"><a href="#EXTERNAL">EXTERNAL</a></td> <td class="imsum_right">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. </td> </tr> <tr> <td class="imsum_left"><a href="#NAME">NAME</a></td> <td class="imsum_right">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. </td> </tr> <tr> <td class="imsum_left"><a href="#NO_NAME">NO_NAME</a></td> <td class="imsum_right">Formula tokens containing the op-code obtained from this offset describe an invalid name that resolves to the #NAME? error in formulas. </td> </tr> <tr> <td class="imsum_left"><a href="#MISSING">MISSING</a></td> <td class="imsum_right">Formula tokens containing the op-code obtained from this offset describe an empty function parameter. </td> </tr> <tr> <td class="imsum_left"><a href="#BAD">BAD</a></td> <td class="imsum_right">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. </td> </tr> <tr> <td class="imsum_left"><a href="#SPACES">SPACES</a></td> <td class="imsum_right">Formula tokens containing the op-code obtained from this offset describe whitespace characters within the string representation of a formula. </td> </tr> <tr> <td class="imsum_left"><a href="#MAT_REF">MAT_REF</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#DB_AREA">DB_AREA</a></td> <td class="imsum_right">Formula tokens containing the op-code obtained from this offset describe the reference to a database range used in formulas. </td> </tr> <tr> <td class="imsum_left"><a href="#MACRO">MACRO</a></td> <td class="imsum_right">Formula tokens containing the op-code obtained from this offset describe the reference to a macro function called in a formula. </td> </tr> <tr> <td class="imsum_left"><a href="#COL_ROW_NAME">COL_ROW_NAME</a></td> <td class="imsum_right"> </td> </tr> </table> <a name="ConstantDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Constants' Details</td> </tr> <tr> <td class="imdetail"><a name="PUSH" class="membertitle">PUSH</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>PUSH</b> = 0;<hr> <dl> <dt><b>Description</b></dt> <dd>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. </dd> <dd><p>The <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#Data">Data</a> member shall contain one of the following values:</p> <ul> <li>A value of type <code>double</code> for literal floating-point constants.</li> <li>A <code>string</code> for literal text.</li> <li>A <code>any</code>[][] for a literal array. The contained values shall be of type <code>double</code> or atom>string</code>. Floating-point values and strings may occur together in an array.</li> <li>A struct of type <a href="SingleReference.html">SingleReference</a> for a reference to a single cell in the own document.</li> <li>A struct of type <a href="ComplexReference.html">ComplexReference</a> for a reference to a range of cells in the own document.</li> <li>A struct of type <a href="ExternalReference.html">ExternalReference</a> for a reference to a cell, a range of cells, or a defined name in an external document.</li> </ul> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CALL" class="membertitle">CALL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>CALL</b> = 1;<hr> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="STOP" class="membertitle">STOP</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>STOP</b> = 2;<hr> <dl> <dt><b>Description</b></dt> <dd>Formula tokens containing the op-code obtained from this offset instruct the formula interpreter to immediately stop interpreting the formula. </dd> <dd><p>The <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#Data">Data</a> member is not used and should be empty.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EXTERNAL" class="membertitle">EXTERNAL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>EXTERNAL</b> = 3;<hr> <dl> <dt><b>Description</b></dt> <dd>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. </dd> <dd><p>The <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#Data">Data</a> member shall contain a <code>string</code> 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.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="NAME" class="membertitle">NAME</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>NAME</b> = 4;<hr> <dl> <dt><b>Description</b></dt> <dd>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. </dd> <dd><p>The <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#Data">Data</a> member shall contain an integer value of type <code>long</code> specifying the index of the defined name. This index can be obtained from the defined name using its <a href="NamedRange.html">NamedRange</a>::<a href="NamedRange.html#TokenIndex">TokenIndex</a> property.</p> </dd> <dt><b>See also</b></dt> <dd><a href="NamedRange.html">NamedRange</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="NO_NAME" class="membertitle">NO_NAME</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>NO_NAME</b> = 5;<hr> <dl> <dt><b>Description</b></dt> <dd>Formula tokens containing the op-code obtained from this offset describe an invalid name that resolves to the #NAME? error in formulas. </dd> <dd><p>The <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#Data">Data</a> member is not used and should be empty.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MISSING" class="membertitle">MISSING</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>MISSING</b> = 6;<hr> <dl> <dt><b>Description</b></dt> <dd>Formula tokens containing the op-code obtained from this offset describe an empty function parameter. </dd> <dd><p>Example: In the formula <code>=SUM(1;;2)</code> the second parameter is empty and represented by a formula token containing the "missing" op-code.</p> <p>The <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#Data">Data</a> member is not used and should be empty.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BAD" class="membertitle">BAD</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>BAD</b> = 7;<hr> <dl> <dt><b>Description</b></dt> <dd>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. </dd> <dd><p>The <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#Data">Data</a> member shall contain a <code>string</string> with the bad data. This string will be displayed literally in the formula.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SPACES" class="membertitle">SPACES</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>SPACES</b> = 8;<hr> <dl> <dt><b>Description</b></dt> <dd>Formula tokens containing the op-code obtained from this offset describe whitespace characters within the string representation of a formula. </dd> <dd><p>Whitespace characters in formulas are used for readability and do not affect the result of the formula.</p> <p>The <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#Data">Data</a> member shall contain a positive integer value of type <code>long</code> specifying the number of space characters.</p> <p>Attention: This may change in next versions to support other characters than simple space characters (e.g. line feeds, horizontal tabulators, non-breakable spaces).</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MAT_REF" class="membertitle">MAT_REF</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>MAT_REF</b> = 9;<hr> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DB_AREA" class="membertitle">DB_AREA</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>DB_AREA</b> = 10;<hr> <dl> <dt><b>Description</b></dt> <dd>Formula tokens containing the op-code obtained from this offset describe the reference to a database range used in formulas. </dd> <dd><p>The <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#Data">Data</a> member shall contain an integer value of type <code>long</code> specifying the index of the database range. This index can be obtained from the database range using its <a href="DatabaseRange.html">DatabaseRange</a>::<a href="DatabaseRange.html#TokenIndex">TokenIndex</a> property.</p> </dd> <dt><b>See also</b></dt> <dd><a href="DatabaseRange.html">DatabaseRange</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MACRO" class="membertitle">MACRO</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>MACRO</b> = 11;<hr> <dl> <dt><b>Description</b></dt> <dd>Formula tokens containing the op-code obtained from this offset describe the reference to a macro function called in a formula. </dd> <dd><p>The <a href="FormulaToken.html">FormulaToken</a>::<a href="FormulaToken.html#Data">Data</a> member shall contain a <code>string</code> specifying the name of the macro function.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="COL_ROW_NAME" class="membertitle">COL_ROW_NAME</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const long <b>COL_ROW_NAME</b> = 12;<hr> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
5887
