TdxSpreadSheetFunctionInfo.ToString Method
Returns the function’s simple syntax prototype as a string.
#Declaration
function ToString: string; override;
#Returns
Type |
---|
string |
#Remarks
This function generates a syntax prototype string from the function signature’s syntax specification routine. The string consists of the Name field value followed by the comma-delimited parameter list enclosed in brackets. The ToString function uses the sfnParamValue
and sfnParamArray
resource strings followed by the corresponding parameter’s ordinal number to designate single-value and array parameters in the resulting syntax prototype. Each designation of an optional function parameter is enclosed in square brackets, and an ellipsis indicates an open-ended parameter list.
For instance, the SUMIFS function accepts two arrays and a single criteria value as mandatory parameters, and an open-ended list of optional parameters. The ToString function returns the following string for the SUMIFS function signature:
'SUMIFS(array1, array2, value3, [value4], ...)'
The “Insert Function“ and “Expression Editor“ dialogs call the ToString function to display a simple syntax prototype for any selected function signature in addition to its localizable short description (that is, the resource string accessible via the DescriptionPtr pointer).
Note
The To