Skip to main content

ShowCellsModificationDialog(TdxSpreadSheetCellsModification,Boolean,TdxCustomSpreadSheet) Method

Invokes the Insert or Delete dialog for a specified spreadsheet control.

Declaration

function ShowCellsModificationDialog(out ACellsModification: TdxSpreadSheetCellsModification; AIsDeletingMode: Boolean; ASpreadSheet: TdxCustomSpreadSheet = nil): Boolean;

Parameters

Name Type
ACellsModification TdxSpreadSheetCellsModification
AIsDeletingMode Boolean
ASpreadSheet TdxCustomSpreadSheet

Returns

Type
Boolean

Remarks

Call this global function and pass False or True as the AIsDeletingMode parameter to invoke the Insert or Delete dialog, respectively. Pass the target spreadsheet control as the ASpreadSheet optional parameter to use it to calculate the dialog’s base position, as well as the source of look & feel settings for the dialog.

The ShowCellsModificationDialog global function returns:

  • True if a user presses the Enter key or clicks the OK button to close the Insert or Delete dialog and confirm the current selection. In this case, the function additionally returns the selected cell operation (that is, the dialog form’s CellsModification property value) as the ACellsModification out parameter.

  • False if a user presses the Esc key or clicks the Cancel or Close button to close the dialog and discard the current selection.

Note

The Table View worksheet’s first overloaded DeleteCells and InsertCells procedure variants call the ShowCellsModificationDialog function internally and pass the parent control as the ASpreadSheet parameter to invoke the Delete and Insert dialogs if there is a single cell range selection that does not include full columns or rows.

See Also