PdfSecurityOptions

PdfSecurityOptions class

Options for encrypting and access permissions for a PDF document. PDF/A does not allow security setting.

class PdfSecurityOptions;

Constructors

Constructor	Description
constructor()	The constructor of PdfSecurityOptions

Properties

Property	Type	Description
userPassword	string	Gets or sets the user password required for opening the encrypted PDF document.
ownerPassword	string	Gets or sets the owner password for the encrypted PDF document.
printPermission	boolean	Indicates whether to allow to print the document.
modifyDocumentPermission	boolean	Indicates whether to allow to modify the contents of the document by operations other than those controlled by AnnotationsPermission, FillFormsPermission and AssembleDocumentPermission.
annotationsPermission	boolean	Indicates whether to allow to add or modify text annotations, fill in interactive form fields.
fillFormsPermission	boolean	Indicates whether to allow to fill in existing interactive form fields (including signature fields), even if ModifyDocumentPermission is clear.
extractContentPermission	boolean	Indicates whether to allow to copy or otherwise extract text and graphics from the document by operations other than that controlled by AccessibilityExtractContent.
accessibilityExtractContent	boolean	Indicates whether to allow to extract text and graphics (in support of accessibility to users with disabilities or for other purposes).
assembleDocumentPermission	boolean	Indicates whether to allow to assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if ModifyDocumentPermission is clear.
fullQualityPrintPermission	boolean	Indicates whether to allow to print the document to a representation from which a faithful digital copy of the PDF content could be generated.

Methods

Method	Description
getUserPassword()	@deprecated. Please use the ‘userPassword’ property instead. Gets or sets the user password required for opening the encrypted PDF document.
setUserPassword(string)	@deprecated. Please use the ‘userPassword’ property instead. Gets or sets the user password required for opening the encrypted PDF document.
getOwnerPassword()	@deprecated. Please use the ‘ownerPassword’ property instead. Gets or sets the owner password for the encrypted PDF document.
setOwnerPassword(string)	@deprecated. Please use the ‘ownerPassword’ property instead. Gets or sets the owner password for the encrypted PDF document.
getPrintPermission()	@deprecated. Please use the ‘printPermission’ property instead. Indicates whether to allow to print the document.
setPrintPermission(boolean)	@deprecated. Please use the ‘printPermission’ property instead. Indicates whether to allow to print the document.
getModifyDocumentPermission()	@deprecated. Please use the ‘modifyDocumentPermission’ property instead. Indicates whether to allow to modify the contents of the document by operations other than those controlled by AnnotationsPermission, FillFormsPermission and AssembleDocumentPermission.
setModifyDocumentPermission(boolean)	@deprecated. Please use the ‘modifyDocumentPermission’ property instead. Indicates whether to allow to modify the contents of the document by operations other than those controlled by AnnotationsPermission, FillFormsPermission and AssembleDocumentPermission.
getAnnotationsPermission()	@deprecated. Please use the ‘annotationsPermission’ property instead. Indicates whether to allow to add or modify text annotations, fill in interactive form fields.
setAnnotationsPermission(boolean)	@deprecated. Please use the ‘annotationsPermission’ property instead. Indicates whether to allow to add or modify text annotations, fill in interactive form fields.
getFillFormsPermission()	@deprecated. Please use the ‘fillFormsPermission’ property instead. Indicates whether to allow to fill in existing interactive form fields (including signature fields), even if ModifyDocumentPermission is clear.
setFillFormsPermission(boolean)	@deprecated. Please use the ‘fillFormsPermission’ property instead. Indicates whether to allow to fill in existing interactive form fields (including signature fields), even if ModifyDocumentPermission is clear.
getExtractContentPermission()	@deprecated. Please use the ’extractContentPermission’ property instead. Indicates whether to allow to copy or otherwise extract text and graphics from the document by operations other than that controlled by AccessibilityExtractContent.
setExtractContentPermission(boolean)	@deprecated. Please use the ’extractContentPermission’ property instead. Indicates whether to allow to copy or otherwise extract text and graphics from the document by operations other than that controlled by AccessibilityExtractContent.
getAccessibilityExtractContent()	@deprecated. Please use the ‘accessibilityExtractContent’ property instead. Indicates whether to allow to extract text and graphics (in support of accessibility to users with disabilities or for other purposes).
setAccessibilityExtractContent(boolean)	@deprecated. Please use the ‘accessibilityExtractContent’ property instead. Indicates whether to allow to extract text and graphics (in support of accessibility to users with disabilities or for other purposes).
getAssembleDocumentPermission()	@deprecated. Please use the ‘assembleDocumentPermission’ property instead. Indicates whether to allow to assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if ModifyDocumentPermission is clear.
setAssembleDocumentPermission(boolean)	@deprecated. Please use the ‘assembleDocumentPermission’ property instead. Indicates whether to allow to assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if ModifyDocumentPermission is clear.
getFullQualityPrintPermission()	@deprecated. Please use the ‘fullQualityPrintPermission’ property instead. Indicates whether to allow to print the document to a representation from which a faithful digital copy of the PDF content could be generated.
setFullQualityPrintPermission(boolean)	@deprecated. Please use the ‘fullQualityPrintPermission’ property instead. Indicates whether to allow to print the document to a representation from which a faithful digital copy of the PDF content could be generated.
isNull()	Checks whether the implementation object is null.

constructor()

The constructor of PdfSecurityOptions

constructor();

userPassword

Gets or sets the user password required for opening the encrypted PDF document.

userPassword : string;

Remarks

The owner password or user password will be required to open an encrypted PDF document for viewing.

The user password can be null or empty string, in this case no password will be required from the user when opening the PDF document.

Opening the document with the correct owner password allows full access to the document.

Opening the document with the correct user password (or opening a document that does not have a user password) allows limited access as the permissions specified.

ownerPassword

Gets or sets the owner password for the encrypted PDF document.

ownerPassword : string;

Remarks

The owner password allows the user to open an encrypted PDF document without any access restrictions specified.

printPermission

Indicates whether to allow to print the document.

printPermission : boolean;

Remarks

Possibly not at the highest quality level, depending on whether FullQualityPrintPermission is also set.

modifyDocumentPermission

Indicates whether to allow to modify the contents of the document by operations other than those controlled by AnnotationsPermission, FillFormsPermission and AssembleDocumentPermission.

modifyDocumentPermission : boolean;

annotationsPermission

Indicates whether to allow to add or modify text annotations, fill in interactive form fields.

annotationsPermission : boolean;

Remarks

if ModifyDocumentPermission is also set, create or modify interactive form fields (including signature fields).

fillFormsPermission

Indicates whether to allow to fill in existing interactive form fields (including signature fields), even if ModifyDocumentPermission is clear.

fillFormsPermission : boolean;

extractContentPermission

Indicates whether to allow to copy or otherwise extract text and graphics from the document by operations other than that controlled by AccessibilityExtractContent.

extractContentPermission : boolean;

accessibilityExtractContent

Indicates whether to allow to extract text and graphics (in support of accessibility to users with disabilities or for other purposes).

accessibilityExtractContent : boolean;

assembleDocumentPermission

Indicates whether to allow to assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if ModifyDocumentPermission is clear.

assembleDocumentPermission : boolean;

fullQualityPrintPermission

Indicates whether to allow to print the document to a representation from which a faithful digital copy of the PDF content could be generated.

fullQualityPrintPermission : boolean;

Remarks

When it is clear (and PrintPermission is set), printing is limited to a low level representation of the appearance, possibly of degraded quality.

getUserPassword()

@deprecated. Please use the ‘userPassword’ property instead. Gets or sets the user password required for opening the encrypted PDF document.

getUserPassword() : string;

Remarks

The owner password or user password will be required to open an encrypted PDF document for viewing.

The user password can be null or empty string, in this case no password will be required from the user when opening the PDF document.

Opening the document with the correct owner password allows full access to the document.

Opening the document with the correct user password (or opening a document that does not have a user password) allows limited access as the permissions specified.

setUserPassword(string)

@deprecated. Please use the ‘userPassword’ property instead. Gets or sets the user password required for opening the encrypted PDF document.

setUserPassword(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

Remarks

The owner password or user password will be required to open an encrypted PDF document for viewing.

The user password can be null or empty string, in this case no password will be required from the user when opening the PDF document.

Opening the document with the correct owner password allows full access to the document.

Opening the document with the correct user password (or opening a document that does not have a user password) allows limited access as the permissions specified.

getOwnerPassword()

@deprecated. Please use the ‘ownerPassword’ property instead. Gets or sets the owner password for the encrypted PDF document.

getOwnerPassword() : string;

Remarks

The owner password allows the user to open an encrypted PDF document without any access restrictions specified.

setOwnerPassword(string)

@deprecated. Please use the ‘ownerPassword’ property instead. Gets or sets the owner password for the encrypted PDF document.

setOwnerPassword(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

Remarks

The owner password allows the user to open an encrypted PDF document without any access restrictions specified.

getPrintPermission()

@deprecated. Please use the ‘printPermission’ property instead. Indicates whether to allow to print the document.

getPrintPermission() : boolean;

Remarks

Possibly not at the highest quality level, depending on whether FullQualityPrintPermission is also set.

setPrintPermission(boolean)

@deprecated. Please use the ‘printPermission’ property instead. Indicates whether to allow to print the document.

setPrintPermission(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Possibly not at the highest quality level, depending on whether FullQualityPrintPermission is also set.

getModifyDocumentPermission()

@deprecated. Please use the ‘modifyDocumentPermission’ property instead. Indicates whether to allow to modify the contents of the document by operations other than those controlled by AnnotationsPermission, FillFormsPermission and AssembleDocumentPermission.

getModifyDocumentPermission() : boolean;

setModifyDocumentPermission(boolean)

setModifyDocumentPermission(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getAnnotationsPermission()

@deprecated. Please use the ‘annotationsPermission’ property instead. Indicates whether to allow to add or modify text annotations, fill in interactive form fields.

getAnnotationsPermission() : boolean;

Remarks

if ModifyDocumentPermission is also set, create or modify interactive form fields (including signature fields).

setAnnotationsPermission(boolean)

@deprecated. Please use the ‘annotationsPermission’ property instead. Indicates whether to allow to add or modify text annotations, fill in interactive form fields.

setAnnotationsPermission(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

if ModifyDocumentPermission is also set, create or modify interactive form fields (including signature fields).

getFillFormsPermission()

@deprecated. Please use the ‘fillFormsPermission’ property instead. Indicates whether to allow to fill in existing interactive form fields (including signature fields), even if ModifyDocumentPermission is clear.

getFillFormsPermission() : boolean;

setFillFormsPermission(boolean)

setFillFormsPermission(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getExtractContentPermission()

@deprecated. Please use the ’extractContentPermission’ property instead. Indicates whether to allow to copy or otherwise extract text and graphics from the document by operations other than that controlled by AccessibilityExtractContent.

getExtractContentPermission() : boolean;

setExtractContentPermission(boolean)

setExtractContentPermission(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getAccessibilityExtractContent()

@deprecated. Please use the ‘accessibilityExtractContent’ property instead. Indicates whether to allow to extract text and graphics (in support of accessibility to users with disabilities or for other purposes).

getAccessibilityExtractContent() : boolean;

setAccessibilityExtractContent(boolean)

setAccessibilityExtractContent(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getAssembleDocumentPermission()

@deprecated. Please use the ‘assembleDocumentPermission’ property instead. Indicates whether to allow to assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if ModifyDocumentPermission is clear.

getAssembleDocumentPermission() : boolean;

setAssembleDocumentPermission(boolean)

setAssembleDocumentPermission(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getFullQualityPrintPermission()

@deprecated. Please use the ‘fullQualityPrintPermission’ property instead. Indicates whether to allow to print the document to a representation from which a faithful digital copy of the PDF content could be generated.

getFullQualityPrintPermission() : boolean;

Remarks

When it is clear (and PrintPermission is set), printing is limited to a low level representation of the appearance, possibly of degraded quality.

setFullQualityPrintPermission(boolean)

setFullQualityPrintPermission(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

When it is clear (and PrintPermission is set), printing is limited to a low level representation of the appearance, possibly of degraded quality.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;