Skip to main content

TdxSpreadSheetFunctionInfo Class

A function signature in the spreadsheet function repository.

Declaration

TdxSpreadSheetFunctionInfo = class(
    TObject
)

Remarks

A function signature stores all information on any function available for use in equations that perform calculations against specified data in spreadsheet controls, a container control’s calculated fields, and expression-based conditional formatting rules (“Expression“ and “CellIs“). The signature also contains function tokens (identifiers) required to correctly load/save the expressions that contain the corresponding function from/to all compatible file formats, even if the function’s implementation is not yet available.

The TdxSpreadSheetFunctionInfo function provides the following members that allow you to:

  • Specify the function’s localizable public name and short description (NamePtr and DescriptionPtr).

  • Specify the function’s numeric and alternate XLS name tokens (Token and Name).

  • Specify whether the function signature implements a function introduced in Microsoft Excel® 2010 or later (PrefixID).

  • Obtain a prefix of the function’s XLSX name token (GetPrefix).

  • Identify whether the function signature has an implementation (IsValid).

  • Specify if the function signature is available for use in calculated field expressions (AvailableInContainerControls).

  • Specify the function signature’s implementation and syntax specification routines (Proc and ParamInfo).

  • Specify which result type the function is designed to return (ResultKind).

  • Specify the function category (TypeID).

The spreadsheet function repository’s Items property references a TdxSpreadSheetFunctionInfo object.

Inheritance

TObject
TdxSpreadSheetFunctionInfo
See Also