CheckedByInformation Property

Summary

Identifies whether a particular file codec is used when processing a call to RasterCodecs.GetInformation or RasterCodecs.GetInformationAsync.

Syntax

C++/CLI

Java

Python

public bool CheckedByInformation {get; set;}

public boolean getCheckedByInformation() 
public void setCheckedByInformation(boolean value)

public: 
property bool CheckedByInformation { 
   bool get(); 
   void set (    bool ); 
}

CheckedByInformation # get and set (CodecsCodecInformation)

Property Value

true if the filter codec is used; otherwise, false. The default value is false.

Remarks

A call has three phases used in identifying a file format. The first phase checks the first few bytes. The second phase checks the file extension. The third phase tries all available codec filters. When this value is false, the corresponding file codec is excluded from the third phase.

In other words, if CheckedByInformation is set to false for a certain codec (for example RTF), the codec would be used to identify RTF files if:

The file starts with the RTF file signature
The file has the ".rtf" extension

It would not be used in the third phase.

In earlier versions of the toolkit (v20 and earlier), setting CheckedByInformation to false would have excluded the filter from all three phases instead of just the first two.

Starting with v21, to exclude the codec from all three phases set CodecsCodecInformation.IsIgnored to false.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
 
 
public void GetCodecInformationExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   CodecsCodecInformation codecInfo = codecs.GetCodecInformation("Tif"); 
   Debug.WriteLine("CheckedByInformation : {0}", codecInfo.CheckedByInformation); 
   Debug.WriteLine("ExtensionList : {0}", codecInfo.ExtensionList); 
   Debug.WriteLine("IsIgnored : {0}", codecInfo.IsIgnored.ToString()); 
   Debug.WriteLine("IsPresent : {0}", codecInfo.IsPresent.ToString()); 
   Debug.WriteLine("IsSlowInformation : {0}", codecInfo.IsSlowInformation.ToString()); 
   Debug.WriteLine("LoadMode : {0}", codecInfo.LoadMode.ToString()); 
   Debug.WriteLine("Name : {0}", codecInfo.Name); 
 
   // Parse the load modes 
   CodecsCodecLoadMode[] loadModes = (CodecsCodecLoadMode[])Enum.GetValues(typeof(CodecsCodecLoadMode)); 
   foreach(var loadMode in loadModes) 
   { 
      codecs.SetCodecsInformation(codecs.GetCodecsInformation()); 
      Debug.WriteLine($"Load mode: {loadMode}"); 
   } 
 
   // change the extensions that the ptk filter tries to handle 
   codecInfo.ExtensionList = "ptk;ptoka;ptoca;ptca;ptka"; 
   codecs.SetCodecInformation(codecInfo); 
 
   // re-display the new settings 
   codecInfo = codecs.GetCodecInformation("tif"); 
   Debug.WriteLine("ExtensionList : {0}", codecInfo.ExtensionList); 
 
   // Clean up 
   codecs.Dispose(); 
}

Requirements

Target Platforms

Reference

CodecsCodecInformation Structure

CodecsCodecInformation Members

CodecsCodecInformation.IsIgnored

Download our FREE evaluation

Help Version 22.0.2023.5.5

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies