ShowInsertFunctionDialog(TdxCustomSpreadSheet,TdxSpreadSheetFunctionInfo) Method
Invokes the “Insert Function” dialog for the specified spreadsheet control.
Declaration
function ShowInsertFunctionDialog(ASpreadSheet: TdxCustomSpreadSheet; out AInfo: TdxSpreadSheetFunctionInfo): Boolean;Parameters
| Name | Type | Description |
|---|---|---|
| ASpreadSheet | TdxCustomSpreadSheet | The target spreadsheet control. |
| AInfo | TdxSpreadSheetFunctionInfo | A signature of the selected function. |
Returns
| Type | Description |
|---|---|
| Boolean | The description below lists conditions under which the |
Remarks
Call this global function and pass a target spreadsheet control as the ASpreadSheet parameter to invoke the Insert Function dialog that allows a user to select and insert a function from the pre-populated list of function signatures registered in the spreadsheet function repository.
The ShowInsertFunctionDialog function returns True when the Insert Function dialog closes, provided that the following conditions are met:
There is a selected function in the Select a function list box.
A double-click within the list box, the Enter keystroke, or a click on the OK button closes the dialog.
Otherwise, the function returns False to indicate that no function has been selected.
The AInfo parameter returns the function signature corresponding to the list item successfully selected via the Insert Function dialog.
The Insert Function button in a Formula Bar control and the Shift+F3 key combination call the ShowInsertFunctionDialog function to invoke the dialog for an associated spreadsheet control.