TdxSpreadSheetPasswordDialogForm.Execute(TComponent,TdxCustomSpreadSheet,TdxSpreadSheetPasswordDialogMode,string) Method

Invokes the Password Protection or Confirm Password dialog for a specified spreadsheet control.

Declaration

class function Execute(AOwner: TComponent; ASpreadSheet: TdxCustomSpreadSheet; AMode: TdxSpreadSheetPasswordDialogMode; out APassword: string): Boolean; overload;

Parameters

Name	Type	Description
AOwner	TComponent	The parent form of the ASpreadSheet control.
ASpreadSheet	TdxCustomSpreadSheet	The target spreadsheet control.
AMode	TdxSpreadSheetPasswordDialogMode	The required password dialog type.
APassword	string	Returns the entered password.

Returns

Type	Description
Boolean	True if a user clicks the OK button or presses the Enter key to close the password dialog; otherwise, False.

Remarks

The AOwner parameter specifies the parent form of a spreadsheet control passed as the ASpreadSheet parameter. The AMode parameter specifies the dialog type and password entry mode. Refer to the TdxSpreadSheetPasswordDialogMode type description for details.

If the Password Protection or Confirm Password dialog is closed with a click on the OK button or the Enter keystroke, the Execute function returns True as a result and the dialog field’s content as the APassword parameter. Otherwise, the function returns False.