Cancel Property

Summary

Cancels the RasterCodecs.DecryptPassword event.

Syntax

C++/CLI

Python

public bool Cancel {get; set;}

public:  
   property bool Cancel 
   { 
      bool get() 
      void set(bool value) 
   }

Cancel # get and set (CodecsDecryptPasswordEventArgs)

Property Value

true to Cancel the caller filter operation; otherwise, false. The default value is false.

Remarks

Setting this property to true cancels the info/load operation without throwing an exception. Refer to RasterCodecs.DecryptPassword 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

Reference

CodecsDecryptPasswordEventArgs Class

CodecsDecryptPasswordEventArgs Members

Leadtools.Codecs Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies