Skip to main content

TdxGetEncryptionPasswordEvent Type

An encryption password request event type.

Declaration

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

Parameters

Name Type
Sender TObject
APassword string
AHandled Boolean

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