- README
- globals
-
classes
- AcroForm
- ActionBase
- ActionFieldsBase
- ActionGoTo
- ActionGoToR
- ActionJavaScript
- ActionJavaScriptMap
- ActionNamed
- ActionResetForm
- ActionSubmitForm
- ActionUnknown
- ActionURI
- AnnotationBase
- AnnotationCollection
- AnnotationPagesCollection
- BilevelBitmap
- Bitmap
- BmpContext
- Border
- BorderEffect
- Brush
- ButtonAppearance
- CaretAnnotation
- CheckBoxField
- ChoiceField
- CircleAnnotation
- ComboBoxField
- CombTextField
- DefaultAppearance
- Destination
- DestinationBase
- DestinationFit
- DestinationFitB
- DestinationFitBH
- DestinationFitBV
- DestinationFitH
- DestinationFitR
- DestinationFitV
- DestinationRef
- DestinationUnknown
- DestinationXYZ
- DocAction
- DocumentDestinations
- DocumentInfo
- DrawingContext
- DsPdf
- DsPdfConfig
- EmbeddedFileStream
- Field
- FieldCollection
- FieldWidgetCollection
- FileAttachmentAnnotation
- FileSpecification
- FileSpecificationMap
- Font
- FontCollection
- FontHandler
- FontHandlerCollection
- Format
- FreeTextAnnotation
- GraphicsPath
- GrayscaleBitmap
- HatchBrush
- Image
- ImageBrush
- InkAnnotation
- Layout
- LineAnnotation
- LinearGradientBrush
- LinkAnnotation
- ListBoxField
- MarkupAnnotation
- Metadata
- ObjectBase
- ObjectManager
- OutlineNode
- OutlineNodeCollection
- PdfContext
- PdfDocument
- PdfImageHandler
- PdfImageHandlerCollection
- PdfPage
- PdfPageCollection
- Pen
- PolygonAnnotation
- PolygonAnnotationBase
- PolyLineAnnotation
- PopupAnnotation
- PushButtonField
- RadialGradientBrush
- RadioButtonField
- RedactAnnotation
- RichMediaAnnotation
- Security
- SecurityHandlerBase
- SignatureField
- SolidBrush
- SoundAnnotation
- SoundObject
- SplitOptions
- SquareAnnotation
- StampAnnotation
- StandardSecurityHandler
- StandardSecurityHandlerRev2
- StandardSecurityHandlerRev3
- StandardSecurityHandlerRev4
- StandardSecurityHandlerRev5
- StandardSecurityHandlerRev6
- SvgContext
- SvgDocument
- TextAnnotation
- TextField
- TextMarkupAnnotation
- Transform
- UnknownAnnotation
- UnknownSecurityHandler
- WatermarkAnnotation
- WidgetAnnotation
- enumerations
- functions
- type-aliases
StandardSecurityHandlerRev2
DsPdfJS API / StandardSecurityHandlerRev2
Class: StandardSecurityHandlerRev2
Defines Standard Security Handler Revision 2. This handler uses RC4 encryption with key 40 bit length.
Extends
Extended by
Accessors
accessType
Get Signature
get accessType():
AccessType|null
Gets the access type granted by this StandardSecurityHandler, or null. This property is initialized when a document is loaded.
Returns
AccessType | null
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
om
Get Signature
get om():
ObjectManager
Gets the owner ObjectManager instance.
Returns
Inherited from
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
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.
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
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.
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
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
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.
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
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.
Parameters
value
Uint8Array
Returns
void
Inherited from
StandardSecurityHandler.userPasswordBytes
Methods
create()
staticcreate(om?):StandardSecurityHandlerRev2
Creates a new StandardSecurityHandlerRev2.
Parameters
om?
ObjectManager that controls the lifetime of the StandardSecurityHandlerRev2.
Returns
StandardSecurityHandlerRev2
assignFrom()
assignFrom(
source):void
Copies all property values from another object.
Parameters
source
The source object.
Returns
void
Inherited from
StandardSecurityHandler.assignFrom
clone()
clone():
SecurityHandlerBase
Create copy of this SecurityHandlerBase.
Returns
The clone of this object.
Inherited from
free()
free():
void
Detaches the object from the ObjectManager and deallocates its memory, if possible.
Returns
void
Inherited from
rebind()
rebind(
omTo):void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
omTo
The new ObjectManager for the object.
Returns
void