Password Property

Summary

Gets or sets the password to use when loading encrypted files.

Syntax

C++/CLI

Python

public string Password {get; set;}

public:  
   property String^ Password 
   { 
      String^ get() 
      void set(String^ value) 
   }

Password # get and set (CodecsDecryptPasswordEventArgs)

Property Value

Set this property to the correct password necessary for loading this encrypted file. Default value is a null string.

Remarks

The RasterCodecs.DecryptPassword event might get fired again if the password is incorrect or if you try to open another encrypted file. The CodecsDecryptPasswordEventArgs.FileName property indicates which file triggered the event (and for which you need to provide the password).

For example, you attempt the sequence of operations below:

Registering a RasterCodecs.DecryptPassword event handler to be used for all loads and not setting the correct password using other means (RasterCodecs.Options.Load.Decrypt.Password or RasterCodecs.Pdf.Options.Load.Password)
Loading unencrypted.pdf
Loading encrypted-pass1.docx which fires the RasterCodecs.DecryptPassword event with CodecsDecryptPasswordEventArgs.FileName = "encrypted-pass1.docx". In this case, you need to set Password = pass1
Loading unencrypted.xlsx
Loading encrypted-pass2.xlsx which fires RasterCodecs.DecryptPassword event with CodecsDecryptPasswordEventArgs.FileName = "encrypted-pass2.xlsx". In this case, you need to set Password = pass2

The above sequence shows that it is important to pay attention to the FileName property as it will contain the file name without a password.

Refer to RasterCodecs.DecryptPassword event for more information.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
 
 
private static void DecryptPasswordExample() 
{ 
 
   /* This example loads an encrypted file using the Decrypt password event */ 
   using (RasterCodecs codecs = new RasterCodecs()) 
   { 
      string srcFile = @"Encrypted.docx"; 
 
      // Create a DecryptPassword handler  
      EventHandler<CodecsDecryptPasswordEventArgs> decryptPasswordHandler = (sender, e) => 
      { 
         /* You can also bring up a message box informing the user that the 'e.FileName' file is encrypted and needs a password */ 
         e.Password = "MyPassword"; 
         /* Or you can set 'e.Cancel = true' to cancel the load */ 
      }; 
 
      // Install the DecryptPassword event handler 
      codecs.DecryptPassword += decryptPasswordHandler; 
 
      codecs.Options.Load.AllPages = true; 
 
      using (RasterImage image = codecs.Load(srcFile)) 
      { 
         /* check that the image is not null to make sure the operation was not cancelled */ 
         if (image != null) 
            codecs.Save(image, srcFile + ".tif", RasterImageFormat.TifLzw, 0); 
      } 
   } 
}

 
import java.io.*; 
import java.net.*; 
import java.nio.file.Paths; 
import java.util.*; 
import java.time.Instant; 
import java.time.Duration; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.codecs.RasterCodecs.FeedCallbackThunk; 
import leadtools.drawing.internal.*; 
import leadtools.imageprocessing.*; 
import leadtools.imageprocessing.color.ChangeIntensityCommand; 
import leadtools.svg.*; 
 
 
public void decryptPasswordExample() { 
   // This example loads an encrypted file using the Decrypt password event // 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String srcFile = combine(LEAD_VARS_IMAGES_DIR, "Encrypted.pdf"); 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // Install the DecryptPassword event handler 
   codecs.addDecryptPasswordListener(decryptPasswordHandler); 
 
   codecs.getOptions().getLoad().setAllPages(true); 
 
   RasterImage image = codecs.load(srcFile); 
   // check that the image is not null to make sure the operation was not cancelled 
   // // 
   if (image != null) 
      codecs.save(image, srcFile + ".tif", RasterImageFormat.TIFLZW, 0); 
} 
 
// Create a DecryptPassword handler 
CodecsDecryptPasswordListener decryptPasswordHandler = new CodecsDecryptPasswordListener() { 
 
   @Override 
   public void onDecryptPassword(CodecsDecryptPasswordEvent e) { 
      // You can also bring up a message box informing the user that the 'e.FileName' 
      // file is encrypted and needs a password // 
      e.setPassword("MyPassword"); 
      // Or you can set 'e.Cancel = true' to cancel the load // 
 
   } 
 
};

Requirements

Target Platforms

Password Property

Property Value

Example

Requirements

See Also