Back to Devexpress

TdxSpreadSheetInsertFunctionDialogForm Class

vcl-dxspreadsheetinsertfunctiondialog-043c0e80.md

latest3.6 KB
Original Source

TdxSpreadSheetInsertFunctionDialogForm Class

The form class that implements the Insert Function dialog.

Declaration

delphi
TdxSpreadSheetInsertFunctionDialogForm = class(
    TdxForm
)

Remarks

The “Insert Function” dialog includes UI elements required to search, preview, and select Microsoft Excel-compatible functions stored in the spreadsheet function repository. The following dialog UI elements are arranged from top to bottom:

  • The Category combo box allows users to repopulate the list box below with functions from a specific category.

  • The Search box that filters out functions whose localizable public names and descriptions do not contain a search string occurrence. The F3 keystroke moves focus to the Search box.

  • The list box shows functions available for selection.

  • The function definition label shows a simple syntax prototype for a function selected in the list box.

  • The function description label displays the selected function’s description.

  • The OK and Cancel buttons.

The Insert Function button in a Formula Bar control and the Shift+F3 key combination call the ShowInsertFunctionDialog global function to invoke the dialog for an associated spreadsheet control.

If you need to adjust or customize the dialog’s UI elements, derive a custom dialog form from the TdxSpreadSheetInsertFunctionDialogForm class. Assign a reference to the custom Insert Function dialog form class to the dxSpreadSheetInsertFunctionDialogClass global variable to replace the standard dialog available in spreadsheet controls.

Inheritance

TObject TPersistent TComponent TControl TWinControl TScrollingWinControl TCustomForm TForm TdxForm TdxSpreadSheetInsertFunctionDialogForm

See Also

TdxSpreadSheetInsertFunctionDialogForm Members

dxSpreadSheetInsertFunctionDialog Unit