[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

GrapeCity.Documents.Pdf.Security.StandardSecurityHandler

StandardSecurityHandler Class

Defines base class for Standard Security Handlers. These security handlers allow access permissions and up to two passwords to be specified for a document: an owner password and a user password.

Inheritance
object
PdfWrapperBase
PdfWrapper<IPdfDict>
PdfDictWrapper
SecurityHandlerBase
StandardSecurityHandler
StandardSecurityHandlerRev2
StandardSecurityHandlerRev3
Implements
Namespace: GrapeCity.Documents.Pdf.Security
Assembly: DS.Documents.Pdf.dll
Syntax
public abstract class StandardSecurityHandler : SecurityHandlerBase, IPdfDict, IDisposable
Public MustInherit Class StandardSecurityHandler
    Inherits SecurityHandlerBase
    Implements IPdfDict, IDisposable

Constructors

Name Description
StandardSecurityHandler()

Initializes a new instance of the StandardSecurityHandler class.

Properties

Name Description
AccessType

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

Gets a value indicating whether the PDF has an owner password that is required to edit the document.

This property is initialized when the document is loaded.

Note that a document may be encrypted with an empty password, in which case HasUserPassword and HasOwnerPassword properties return false.

Note also that, according to the PDF specification, if an owner password is not specified, then the user password should be used. GcPdf follows this rule, so if a PDF that was created using GcPdf with only a user password is loaded into GcPdfDocument, its AccessType will be Owner, HasOwnerPassword will be true and HasUserPassword will also be true.
HasUserPassword

Gets a value indicating whether the PDF has a user password that is required to open the document.

This property is initialized when the document is loaded.

Note that a document may be encrypted with an empty password, in which case HasUserPassword and HasOwnerPassword properties return false.

Note also that, according to the PDF specification, if an owner password is not specified, then the user password should be used. GcPdf follows this rule, so if a PDF that was created using GcPdf with only a user password is loaded into GcPdfDocument, its AccessType will be Owner, HasOwnerPassword will be true and HasUserPassword will also be true.
OwnerPassword

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 GcPdf 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.
OwnerPasswordBytes

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 GcPdf 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.
PasswordMatches

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

Gets the revision of this StandardSecurityHandler.
UserPassword

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 GcPdf 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.
UserPasswordBytes

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

Methods

Name Description
AssignFrom(SecurityHandlerBase)

Copies all property values from another object.
Dispose(bool)

Releases the unmanaged resources used by the SecurityHandlerBase and optionally releases the managed resources.

Extension Methods