Gets a value that indicates whether this document is encrypted.
public bool IsEncrypted {get;}
Public ReadOnly Property IsEncrypted() As Boolean
Get
public:
property bool IsEncrypted
{
bool get()
}
public boolean isEncrypted()
true if this document is encrypted; otherwise, false.
In most cases, the LEADDocument is ready to use after it has been obtained. However, some documents such as PDF can be encrypted, and require a password before it can be parsed and used. Most of the properties and methods of LEADDocument will throw an error if the document has not been decrypted. IsEncrypted can be used to check whether the document is encrypted and if so, Decrypt must be called with a password obtained from the user to unlock the document. When that happens, the value of IsDecrypted becomes true and the document is ready to be used. Note that IsEncrypted will stay true to indicate the original state of the document.
For more information, refer to Loading Encrypted Files Using the Document Library.
This example will show how to open an encrypted document.
using Leadtools;
using Leadtools.Codecs;
using Leadtools.Document.Writer;
using Leadtools.Svg;
using LeadtoolsExamples.Common;
using Leadtools.Document;
using Leadtools.Caching;
using Leadtools.Annotations.Engine;
using Leadtools.Ocr;
using Leadtools.Barcode;
using Leadtools.Document.Converter;
public static void DocumentIsEncryptedExample()
{
// This is the password for this encrypted document
string password = "lead";
var options = new LoadDocumentOptions();
using (var document = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "Protected.pdf"), options))
{
if (document.IsEncrypted && !document.IsDecrypted)
{
Console.WriteLine("Encrypted Document, decrypting it...");
// Decrypt it now
document.Decrypt("lead");
}
// Should not be encrypted anymore
System.Diagnostics.Debug.Assert(!document.IsEncrypted);
}
// Or, set the password directly in the load options
options.Password = password;
using (var document = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "Protected.pdf"), options))
{
// Should not be encrypted
System.Diagnostics.Debug.Assert(!document.IsEncrypted);
}
}
Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.Document.Writer
Imports Leadtools.Svg
Imports Leadtools.Document
Imports Leadtools.Caching
Imports Leadtools.Annotations.Engine
Imports Leadtools.Barcode
Imports Leadtools.Ocr
Imports LeadtoolsDocumentExamples.LeadtoolsExamples.Common
Imports Leadtools.Document.Converter
Public Shared Sub DocumentIsEncryptedExample()
' This Is the password for this encrypted document
Dim password As String = "lead"
Dim options As New LoadDocumentOptions()
Using document As Leadtools.Document.LEADDocument = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "Protected.pdf"), options)
If document.IsEncrypted AndAlso (Not document.IsDecrypted) Then
Console.WriteLine("Encrypted Document, decrypting it...")
' Decrypt it now
document.Decrypt("lead")
End If
' Should Not be encrypted anymore
System.Diagnostics.Debug.Assert(Not document.IsEncrypted)
End Using
' Or, set the password directly in the load options
options.Password = password
Using document As Leadtools.Document.LEADDocument = DocumentFactory.LoadFromFile(Path.Combine(ImagesPath.Path, "Protected.pdf"), options)
' Should Not be encrypted
System.Diagnostics.Debug.Assert(Not document.IsEncrypted)
End Using
End Sub
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document