<html> <head> <title>Interface XAddIn</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="XAddIn-xref.html" class="navimain">Use</a></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="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' 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">interface XAddIn</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XAddIn</strong> ┗ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XLocalizable.html">XLocalizable</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XLocalizable.html">XLocalizable</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>makes it possible to set a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a> to be used by the object. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>gives access to function descriptions and user-visible names. </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getProgrammaticFuntionName">getProgrammaticFuntionName</a></td> <td class="imsum_right">returns the internal function name for an user-visible name. </td> </tr> <tr> <td class="imsum_left"><a href="#getDisplayFunctionName">getDisplayFunctionName</a></td> <td class="imsum_right">returns the user-visible function name for an internal name. </td> </tr> <tr> <td class="imsum_left"><a href="#getFunctionDescription">getFunctionDescription</a></td> <td class="imsum_right">returns the description of a function. </td> </tr> <tr> <td class="imsum_left"><a href="#getDisplayArgumentName">getDisplayArgumentName</a></td> <td class="imsum_right">returns the user-visible name of the specified argument. </td> </tr> <tr> <td class="imsum_left"><a href="#getArgumentDescription">getArgumentDescription</a></td> <td class="imsum_right">returns the description of the specified argument. </td> </tr> <tr> <td class="imsum_left"><a href="#getProgrammaticCategoryName">getProgrammaticCategoryName</a></td> <td class="imsum_right">returns the programmatic name of the category the function belongs to. </td> </tr> <tr> <td class="imsum_left"><a href="#getDisplayCategoryName">getDisplayCategoryName</a></td> <td class="imsum_right">returns the user-visible name of the category the function belongs to. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getProgrammaticFuntionName" class="membertitle">getProgrammaticFuntionName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getProgrammaticFuntionName</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aDisplayName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the internal function name for an user-visible name. </dd> <dd><p>The user-visible name of a function is the name shown to the user. It may be translated to the current language of the AddIn, so it is never stored in files. It should be a single word and is used when entering or displaying formulas.</p> <p>Attention: The method name contains a spelling error. Due to compatibility reasons the name cannot be changed.</p> </dd> <dt><b>Parameter aDisplayName</b></dt> <dd>the user-visible name of a function. </dd> <dt><b>Returns</b></dt> <dd>the exact name of the method within its interface. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDisplayFunctionName" class="membertitle">getDisplayFunctionName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getDisplayFunctionName</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aProgrammaticName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the user-visible function name for an internal name. </dd> <dd><p>The user-visible name of a function is the name shown to the user. It may be translated to the current language of the AddIn, so it is never stored in files. It should be a single word and is used when entering or displaying formulas.</p> </dd> <dt><b>Parameter aProgrammaticName</b></dt> <dd>is the exact name of a method within its interface. </dd> <dt><b>Returns</b></dt> <dd>the user-visible name of the specified function. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getFunctionDescription" class="membertitle">getFunctionDescription</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getFunctionDescription</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aProgrammaticName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the description of a function. </dd> <dd><p>The description is shown to the user when selecting functions. It may be translated to the current language of the AddIn.</p> </dd> <dt><b>Parameter aProgrammaticName</b></dt> <dd>is the exact name of a method within its interface. </dd> <dt><b>Returns</b></dt> <dd>the description of the specified function. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDisplayArgumentName" class="membertitle">getDisplayArgumentName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getDisplayArgumentName</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aProgrammaticFunctionName,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nArgument );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the user-visible name of the specified argument. </dd> <dd><p>The argument name is shown to the user when prompting for arguments. It should be a single word and may be translated to the current language of the AddIn.</p> </dd> <dt><b>Parameter aProgrammaticFunctionName</b></dt> <dd>is the exact name of a method within its interface. </dd> <dt><b>Parameter nArgument</b></dt> <dd>the index of the argument (0-based). </dd> <dt><b>Returns</b></dt> <dd>the user-visible name of the specified argument. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getArgumentDescription" class="membertitle">getArgumentDescription</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getArgumentDescription</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aProgrammaticFunctionName,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nArgument );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the description of the specified argument. </dd> <dd><p>The argument description is shown to the user when prompting for arguments. It may be translated to the current language of the AddIn.</p> </dd> <dt><b>Parameter aProgrammaticFunctionName</b></dt> <dd>is the exact name of a method within its interface. </dd> <dt><b>Parameter nArgument</b></dt> <dd>the index of the argument (0-based). </dd> <dt><b>Returns</b></dt> <dd>the description of the specified argument. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getProgrammaticCategoryName" class="membertitle">getProgrammaticCategoryName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getProgrammaticCategoryName</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aProgrammaticFunctionName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the programmatic name of the category the function belongs to. </dd> <dd><p>The category name is used to group similar functions together. The programmatic category name should always be in English, it is never shown to the user. It should be one of the following names if the function falls into the corresponding category.</p> <dl> <dt>Database</dt> <dd>for functions that operate with data organized in tabular form like databases.</dd> <dt>Date&Time</dt> <dd>for functions that deal with date or time values.</dd> <dt>Financial</dt> <dd>for functions that solve financial problems.</dd> <dt>Information</dt> <dd>for functions that provide information about cells.</dd> <dt>Logical</dt> <dd>for functions that deal with logical expressions.</dd> <dt>Mathematical</dt> <dd>for mathematical functions.</dd> <dt>Matrix</dt> <dd>for matrix functions.</dd> <dt>Statistical</dt> <dd>for statistical functions.</dd> <dt>Spreadsheet</dt> <dd>for functions that deal with cell ranges.</dd> <dt>Text</dt> <dd>for functions that deal with text strings.</dd> <dt>Add-In</dt> <dd>for additional functions.</dd> </dl> </dd> <dt><b>Parameter aProgrammaticFunctionName</b></dt> <dd>is the exact name of a method within its interface. </dd> <dt><b>Returns</b></dt> <dd>the category name the specified function belongs to. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDisplayCategoryName" class="membertitle">getDisplayCategoryName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getDisplayCategoryName</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aProgrammaticFunctionName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the user-visible name of the category the function belongs to. </dd> <dd><p>This is used when category names are shown to the user.</p> </dd> <dt><b>Parameter aProgrammaticFunctionName</b></dt> <dd>is the exact name of a method within its interface. </dd> <dt><b>Returns</b></dt> <dd>the user-visible category name the specified function belongs to. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
