StandardSecurityHandlerRev2

Class: StandardSecurityHandlerRev2

Defines Standard Security Handler Revision 2. This handler uses RC4 encryption with key 40 bit length.

Extends

StandardSecurityHandler

Extended by

StandardSecurityHandlerRev3

Accessors

accessType

Get Signature

get accessType(): AccessType;

Gets the access type granted by this StandardSecurityHandler, or null. This property is initialized when a document is loaded.

Returns

AccessType

Inherited from

StandardSecurityHandler.accessType

allowCopyContent

Get Signature

get allowCopyContent(): boolean;

Gets or sets whether the user can copy contents from the PDF document.

Returns

boolean

Set Signature

set allowCopyContent(value): void;

Gets or sets whether the user can copy contents from the PDF document.

Parameters

value

boolean

Returns

void

allowEditAnnotations

Get Signature

get allowEditAnnotations(): boolean;

Gets or sets whether the user can edit annotations in the PDF document.

Returns

boolean

Set Signature

set allowEditAnnotations(value): void;

Gets or sets whether the user can edit annotations in the PDF document.

Parameters

value

boolean

Returns

void

allowEditContent

Get Signature

get allowEditContent(): boolean;

Gets or sets whether the user can edit the contents of the PDF document.

Returns

boolean

Set Signature

set allowEditContent(value): void;

Gets or sets whether the user can edit the contents of the PDF document.

Parameters

value

boolean

Returns

void

allowPrint

Get Signature

get allowPrint(): boolean;

Gets or sets whether the user can print the PDF document.

Returns

boolean

Set Signature

set allowPrint(value): void;

Gets or sets whether the user can print the PDF document.

Parameters

value

boolean

Returns

void

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

StandardSecurityHandler.id

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

StandardSecurityHandler.om

ownerPassword

Get Signature

get ownerPassword(): string;

Gets or sets the password required to change permissions of a PDF document as a string. The two properties ownerPassword and ownerPasswordBytes allow to define the password as a string or as an array of bytes. According to the PDF specification, a string password should be converted to an array of bytes using the system code page (if the standard security handler with revision 4 or less is used). In some environments the system code page is unavailable, so DsPdfJS cannot perform this conversion. If the password string only contains ASCII chars, this does not present a problem. But if the password string contains non-ASCII Unicode characters, it is up to the developer to perform the conversion and set the password using this property.

Returns

string

Set Signature

set ownerPassword(value): void;

Parameters

value

string

Returns

void

Inherited from

StandardSecurityHandler.ownerPassword

ownerPasswordBytes

Get Signature

get ownerPasswordBytes(): Uint8Array;

Gets or sets the password required to change permissions of a PDF document as a byte array. The two properties ownerPassword and ownerPasswordBytes allow to define the password as a string or as an array of bytes. According to the PDF specification, a string password should be converted to an array of bytes using the system code page (if the standard security handler with revision 4 or less is used). In some environments the system code page is unavailable, so DsPdfJS cannot perform this conversion. If the password string only contains ASCII chars, this does not present a problem. But if the password string contains non-ASCII Unicode characters, it is up to the developer to perform the conversion and set the password using this property.

Returns

Uint8Array

Set Signature

set ownerPasswordBytes(value): void;

Parameters

value

Uint8Array

Returns

void

Inherited from

StandardSecurityHandler.ownerPasswordBytes

passwordMatches

Get Signature

get passwordMatches(): PasswordMatches;

Gets a combination of flags that indicate how the password specified when loading the PDF matches the document's User and Owner passwords.

Returns

PasswordMatches

Inherited from

StandardSecurityHandler.passwordMatches

revision

Get Signature

get revision(): number;

Gets the revision of this StandardSecurityHandler.

Returns

number

Inherited from

StandardSecurityHandler.revision

userPassword

Get Signature

get userPassword(): string;

Gets or sets the password required to open a PDF document as a string. The two properties userPassword and userPasswordBytes allow to define the password as a string or as an array of bytes. According to the PDF specification, a string password should be converted to an array of bytes using the system code page (if the standard security handler with revision 4 or less is used). In some environments the system code page is unavailable, so DsPdf cannot perform this conversion. If the password string only contains ASCII chars, this does not present a problem. But if the password string contains non-ASCII Unicode characters, it is up to the developer to perform the conversion and set the password using userPasswordBytes.

Returns

string

Set Signature

set userPassword(value): void;

Parameters

value

string

Returns

void

Inherited from

StandardSecurityHandler.userPassword

userPasswordBytes

Get Signature

get userPasswordBytes(): Uint8Array;

Gets or sets the password required to open a PDF document as a byte array. The two properties userPassword and userPasswordBytes allow to define the password as a string or as an array of bytes. According to the PDF specification, a string password should be converted to an array of bytes using the system code page (if the standard security handler with revision 4 or less is used). In some environments the system code page is unavailable, so DsPdfJS cannot perform this conversion. If the password string only contains ASCII chars, this does not present a problem. But if the password string contains non-ASCII Unicode characters, it is up to the developer to perform the conversion and set the password using this property.

Returns

Uint8Array

Set Signature

set userPasswordBytes(value): void;

Parameters

value

Uint8Array

Returns

void

Inherited from

StandardSecurityHandler.userPasswordBytes

Methods

create()

static create(om?): StandardSecurityHandlerRev2;

Creates a new StandardSecurityHandlerRev2.

Parameters

om?

ObjectManager

ObjectManager that controls the lifetime of the StandardSecurityHandlerRev2.

Returns

StandardSecurityHandlerRev2

assignFrom()

assignFrom(source): void;

Copies all property values from another object.

Parameters

source

SecurityHandlerBase

The source object.

Returns

void

Inherited from

StandardSecurityHandler.assignFrom

clone()

clone(): SecurityHandlerBase;

Create copy of this SecurityHandlerBase.

Returns

SecurityHandlerBase

The clone of this object.

Inherited from

StandardSecurityHandler.clone

free()

free(): void;

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

Returns

void

Inherited from

StandardSecurityHandler.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

StandardSecurityHandler.rebind