IsIgnored 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 IsIgnored {get; set;}

Public Property IsIgnored As Boolean

public boolean getIsIgnored() 
public void setIsIgnored(boolean value)

public: 
property bool IsIgnored { 
   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 IsIgnored is false, the corresponding file codec is excluded from all three phases.

Set CodecsCodecInformation.CheckedByInformation to false to exclude a filter from the 3rd phase only. In earlier versions of the toolkit (v20 and earlier), setting CodecsCodecInformation.CheckedByInformation to false would have excluded the filter from all three phases instead of just the first two.

Example

For an example, refer to RasterCodecs.GetCodecInformation.

Requirements

Target Platforms