interface XAddIn in module com::sun::star::sheet::

(Global Index)

Syntax

interface XAddIn : com::sun::star::lang::XLocalizable ;

Description

gives access to function descriptions and user-visible names.

Method Summary

getProgrammaticFuntionName returns the programmatic name for a specified user-visible function name.

getDisplayFunctionName returns the user-visible name of the function.

getFunctionDescription returns the description of the 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.

Known Services Which Export this Interface

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

Method Details



getProgrammaticFuntionName

Syntax

string getProgrammaticFuntionName (
string aDisplayName );

Description

returns the programmatic name for a specified user-visible function name.

The programmatic name must be the exact name of the method within its interface.


getDisplayFunctionName

Syntax

string getDisplayFunctionName (
string aProgrammaticName );

Description

returns the user-visible name of the function.

This is the name for the function that is 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.


getFunctionDescription

Syntax

string getFunctionDescription (
string aProgrammaticName );

Description

returns the description of the function.

The description is shown to the user when selecting functions. It may be translated to the current language of the AddIn.


getDisplayArgumentName

Syntax

string getDisplayArgumentName (
string aProgrammaticFunctionName,
long 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.


getArgumentDescription

Syntax

string getArgumentDescription (
string aProgrammaticFunctionName,
long 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.


getProgrammaticCategoryName

Syntax

string getProgrammaticCategoryName (
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.

getDisplayCategoryName

Syntax

string getDisplayCategoryName (
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.

Top of Page