TdxSpreadSheetFunctionInfo.DescriptionPtr Field

Stores a pointer to the resource string that contains the function’s short description.

Declaration

DescriptionPtr: TcxResourceStringID

Field Value

Type	Description
TcxResourceStringID	The pointer to the source resource string.

Remarks

This field value defines the function short description designed for display in UI elements at runtime, such as the Element description box of the Expression Editor dialog, the Formula Bar control’s AutoComplete hints, etc.

The TdxSpreadSheetFunctionsRepository.Add procedure uses the ADescription parameter value to initialize the DescriptionPtr field for a newly created function signature.

Note

This field is optional. The function has no short description if the DescriptionPtr field stores nil (in Delphi) or nullptr (in C++Builder).