<html> <head> <title>Service AddIn</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="navimain"><a href="AddIn-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Spreadsheet_Add-Ins" class="navimain">Devguide</a></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">Services' Summary</td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub">Properties' Summary</td> <td class="navisub">Services' Details</td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td> <td class="navisub">Properties' Details</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">service AddIn</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>is the base for AddIn services that supply functions which can be called by other components. </dd> <dd><p>Any AddIn implementation must implement a service describing its specific set of functions. That service must contain the <a href="AddIn.html">AddIn</a> service, and the functions that are implemented, in one or more interfaces. The ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XServiceName.html">XServiceName</a> interface must describe that service, and the <a href="XAddIn.html">XAddIn</a> interface must describe the individual functions.</p> <p>Each AddIn function can take parameters of the following types:</p> <dl> <dt><code>long</code></dt> <dd>for integer values.</dd> <dt><code>double</code></dt> <dd>for floating point values.</dd> <dt><code>string</code></dt> <dd>for text strings.</dd> <dt><code>long[][]</code></dt> <dd>for (two-dimensional) arrays of integer values.</dd> <dt><code>double[][]</code></dt> <dd>for (two-dimensional) arrays of floating point values.</dd> <dt><code>string[][]</code></dt> <dd>for (two-dimensional) arrays of text strings.</dd> <dt><code>any[][]</code></dt> <dd>for (two-dimensional) arrays of mixed contents. Each <code>any</code> will contain a <code>double</code> or a <code>string</code>, depending on the data.</dd> <dt><code>any</code></dt> <dd>Depending on the data, a <code>double</code>, a <code>string</code>, or an <code>any[][]</code> will be passed. If no argument is specified in the function call, <b>void</b> will be passed. This allows for optional parameters.</dd> <dt>::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/XCellRange.html">XCellRange</a></dt> <dd>for a ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/XCellRange.html">XCellRange</a> interface to the source data.</dd> <dt>::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></dt> <dd>for a ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a> interface to the <a href="SpreadsheetDocument.html">SpreadsheetDocument</a> making the function call. Only one parameter of this type is allowed in each function. It can be used to query document settings like <a href="SpreadsheetDocumentSettings.html">SpreadsheetDocumentSettings</a>::<a href="SpreadsheetDocumentSettings.html#NullDate">NullDate</a>.</dd> <dt><code>any[]</code></dt> <dd>for varying parameters. Only the last parameter of a function may have this type. It will be filled with the remaining arguments of the function call that were not used for the previous parameters. Each element of the sequence will be filled as in the case of <code>any</code> above.</dd> </dl> <p>Each AddIn function must have one of the following return types:</p> <ul> <li><code>long</code></li> <li><code>double</code></li> <li><code>string</code></li> <li><code>long[][]</code></li> <li><code>double[][]</code></li> <li><code>string[][]</code></li> <li><code>any[][]</code></li> <li><a href="XVolatileResult.html">XVolatileResult</a></li> <li><code>any</code></li> </ul> <p>The sequences must contain arrays as described above for the parameter types. An <a href="XVolatileResult.html">XVolatileResult</a> return value must contain an object implementing the <a href="VolatileResult.html">VolatileResult</a> service, that contains a volatile result. Subsequent calls with the same parameters must return the same object. An <code>any</code> return value can contain any of the other types.</p> </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Spreadsheet_Add-Ins">Spreadsheets - Spreadsheet Add-Ins</a></dd> </dl> </td> </tr> </table> <hr> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XServiceName.html">XServiceName</a></td> <td class="imsum_right"><p>contains a method that returns the service name of the add-in. </p> </td> </tr> <tr> <td class="imsum_left"><a href="XAddIn.html">XAddIn</a></td> <td class="imsum_right"><p>provides access to function descriptions and localized names and descriptions. </p> </td> </tr> <tr> <td class="imsum_left"><a href="XCompatibilityNames.html">XCompatibilityNames</a></td> <td class="imsum_right"><p>provides access to compatibility names for the functions. (<a href="#XCompatibilityNames">details</a>)</p> </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XServiceName" class="membertitle">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XServiceName.html">XServiceName</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>contains a method that returns the service name of the add-in. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XAddIn" class="membertitle"><a href="XAddIn.html">XAddIn</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides access to function descriptions and localized names and descriptions. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XCompatibilityNames" class="membertitle"><a href="XCompatibilityNames.html">XCompatibilityNames</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>provides access to compatibility names for the functions. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <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
>
5725
