[]
        
(Showing Draft Content)

Security

Class: Security

Provides security and encryption services and manages permissions for PdfDocument objects.

Extends

Accessors

decryptHandler

Get Signature

get decryptHandler(): SecurityHandlerBase;

Gets the SecurityHandlerBase used to decrypt PDF document during loading.

Returns

SecurityHandlerBase


decryptionStatus

Get Signature

get decryptionStatus(): DecryptionStatus;

Gets the decryption status of the loaded document. This property has meaning only if a document has been loaded.

Returns

DecryptionStatus


doc

Get Signature

get doc(): PdfDocument;

Gets the PdfDocument object owning this object.

Returns

PdfDocument


encryptHandler

Get Signature

get encryptHandler(): SecurityHandlerBase;

Gets or sets the SecurityHandlerBase used to encrypt PDF document during saving. Same SecurityHandlerBase can not be used for Security#decryptHandler and Security#encryptHandler, use SecurityHandlerBase#clone.

Returns

SecurityHandlerBase

Set Signature

set encryptHandler(value): void;

Gets or sets the SecurityHandlerBase used to encrypt PDF document during saving. Same SecurityHandlerBase can not be used for Security#decryptHandler and Security#encryptHandler, use SecurityHandlerBase#clone.

Parameters
value

SecurityHandlerBase

Returns

void


id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

ObjectBase.id


om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ObjectBase.om

Methods

free()

free(): void;

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

ObjectBase.free


rebind()

rebind(omTo): void;

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

ObjectBase.rebind


setEncryptOptions()

setEncryptOptions(options): void;

Creates the StandardSecurityHandler object and assigns it to the encryptHandler property. The type and properties of the StandardSecurityHandler object is determined by the .options object.

Parameters

options

EncryptOptions

The tp.EncryptOptions object.

Returns

void