CheckedByInformation Property

Summary

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

Syntax

C++

Java

public bool CheckedByInformation {get; set;}

Public Property CheckedByInformation As Boolean

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

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

Property Value

true if the filter codec is used; otherwise, 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

For an example, refer to RasterCodecs.GetCodecInformation.

Requirements

Target Platforms