contains the result of an AddIn function together with the number formats of its values. More...

Public Types
typedef sequence< sequence< short > >	NumberFormatTypes
	contains the number format types of the values.

typedef sequence< sequence< string > >	NumberFormatCodes
	contains the number format codes of the values.

Public Attributes
any	Value
	contains the result.

Detailed Description

contains the result of an AddIn function together with the number formats of its values.

An AddIn function may declare this struct as its return type, or return it in an any, and the ResultEvent of a volatile result may carry it. Calc applies the formats to the cells that show the result as it does for the results of its own functions, such as a date format for the result of DATE(): a format the user applied to a cell is kept, and inside a larger formula the result is treated as the result of any function would be.

Each of NumberFormatTypes and NumberFormatCodes is either empty, for no formats, or holds one element, which applies to every value of the result, or has as many rows as the result and as many elements in each row as the result's longest row, one for each value. A single value counts as one row of one element. Formats apply to numeric values only; text values keep none. Any other size, an unknown type or a code that cannot be read makes the result an error.

See also: AddIn

Since: LibreOffice 27.2

Member Typedef Documentation

◆ NumberFormatCodes

sequence< sequence< string > > NumberFormatCodes

contains the number format codes of the values.

Each element is a format code written with the keywords of the en-US locale, which Calc converts to the cell's language, or an empty string, for no code. A code takes precedence over the type given for the same value.

◆ NumberFormatTypes

sequence< sequence< short > > NumberFormatTypes

contains the number format types of the values.

Each element is one of the constants DATE, TIME, DATETIME, DURATION, CURRENCY, NUMBER, SCIENTIFIC, FRACTION, PERCENT or LOGICAL, which selects the standard format of that type for the cell's language, or ALL, for no type.

See also: com::sun::star::util::NumberFormat

Member Data Documentation

◆ Value

any Value

contains the result.

This can be any of the return types described for the AddIn service, except XVolatileResult and FormattedResult.

The documentation for this struct was generated from the following file:

com/sun/star/sheet/FormattedResult.idl