Back to Devexpress

TdxGetEncryptionPasswordEvent Type

vcl-dxrichedit-dot-documentserver-9b031350.md

latest1.7 KB
Original Source

TdxGetEncryptionPasswordEvent Type

An encryption password request event type.

Declaration

delphi
TdxGetEncryptionPasswordEvent = procedure(Sender: TObject; var APassword: string; var AHandled: Boolean) of object;

Parameters

NameType
SenderTObject
APasswordstring
AHandledBoolean

Remarks

This event occurs every time a document server‘s LoadDocument or LoadDocumentTemplate method accepts an encrypted document file as a parameter.

The Sender parameter provides access to the document server component that raised a TdxGetEncryptionPasswordEvent event. Cast the parameter value to the TdxRichEditDocumentServer class to access the document server component’s public API members.

Use the APassword parameter to specify a password required to open an encrypted document.

A document server component’s OnGetEncryptionPassword event references the TdxGetEncryptionPasswordEvent procedural type.

See Also

dxRichEdit.DocumentServer Unit