Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: sheet ::
interface XAddIn
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-::com::sun::star::lang::XLocalizable
          |
          +-XAddIn
Description gives access to function descriptions and user-visible names.

Methods' Summary
getProgrammaticFuntionName | returns the internal function name for an user-visible name.
getDisplayFunctionName | returns the user-visible function name for an internal name.
getFunctionDescription | returns the description of a function.
getDisplayArgumentName | returns the user-visible name of the specified argument.
getArgumentDescription | returns the description of the specified argument.
getProgrammaticCategoryName | returns the programmatic name of the category the function belongs to.
getDisplayCategoryName | returns the user-visible name of the category the function belongs to.

Methods' Details
getProgrammaticFuntionName
string getProgrammaticFuntionName( | [in] string | aDisplayName );
Description returns the internal function name for an user-visible name. 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. Attention: The method name contains a spelling error. Due to compatibility reasons the name cannot be changed. Parameter aDisplayName the user-visible name of a function. Returns the exact name of the method within its interface.
getDisplayFunctionName
string getDisplayFunctionName( | [in] string | aProgrammaticName );
Description returns the user-visible function name for an internal name. 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. Parameter aProgrammaticName is the exact name of a method within its interface. Returns the user-visible name of the specified function.
getFunctionDescription
string getFunctionDescription( | [in] string | aProgrammaticName );
Description returns the description of a function. The description is shown to the user when selecting functions. It may be translated to the current language of the AddIn. Parameter aProgrammaticName is the exact name of a method within its interface. Returns the description of the specified function.
getDisplayArgumentName
string getDisplayArgumentName( | [in] string [in] long | aProgrammaticFunctionName, nArgument );
Description returns the user-visible name of the specified argument. 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. Parameter aProgrammaticFunctionName is the exact name of a method within its interface. Parameter nArgument the index of the argument (0-based). Returns the user-visible name of the specified argument.
getArgumentDescription
string getArgumentDescription( | [in] string [in] long | aProgrammaticFunctionName, nArgument );
Description returns the description of the specified argument. The argument description is shown to the user when prompting for arguments. It may be translated to the current language of the AddIn. Parameter aProgrammaticFunctionName is the exact name of a method within its interface. Parameter nArgument the index of the argument (0-based). Returns the description of the specified argument.
getProgrammaticCategoryName
string getProgrammaticCategoryName( | [in] string | aProgrammaticFunctionName );
Description returns the programmatic name of the category the function belongs to. 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. Database for functions that operate with data organized in tabular form like databases. Date&Time for functions that deal with date or time values. Financial for functions that solve financial problems. Information for functions that provide information about cells. Logical for functions that deal with logical expressions. Mathematical for mathematical functions. Matrix for matrix functions. Statistical for statistical functions. Spreadsheet for functions that deal with cell ranges. Text for functions that deal with text strings. Add-In for additional functions. Parameter aProgrammaticFunctionName is the exact name of a method within its interface. Returns the category name the specified function belongs to.
getDisplayCategoryName
string getDisplayCategoryName( | [in] string | aProgrammaticFunctionName );
Description returns the user-visible name of the category the function belongs to. This is used when category names are shown to the user. Parameter aProgrammaticFunctionName is the exact name of a method within its interface. Returns the user-visible category name the specified function belongs to.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.