- 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
Security
DsPdfJS API / Security
Class: Security
Provides security and encryption services and manages permissions for PdfDocument objects.
Extends
Accessors
decryptHandler
Get Signature
get decryptHandler():
SecurityHandlerBase|null
Gets the SecurityHandlerBase used to decrypt PDF document during loading.
Returns
SecurityHandlerBase | null
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
doc
Get Signature
get doc():
PdfDocument
Gets the PdfDocument object owning this object.
Returns
encryptHandler
Get Signature
get encryptHandler():
SecurityHandlerBase|null
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 | null
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
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
Methods
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
Inherited from
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
The tp.EncryptOptions object.
Returns
void