Leadtools.Codecs Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
TagsSupported Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class : TagsSupported Method



format
The RasterImageFormat to check
Checks whether the given file format supports tags

Syntax

Visual Basic (Declaration) 
Public Shared Function TagsSupported( _
   ByVal format As RasterImageFormat _
) As Boolean
Visual Basic (Usage)Copy Code
Dim format As RasterImageFormat
Dim value As Boolean
 
value = RasterCodecs.TagsSupported(format)
C# 
public static bool TagsSupported( 
   RasterImageFormat format
)
C++/CLI 
public:
static bool TagsSupported( 
   RasterImageFormat format
) 

Parameters

format
The RasterImageFormat to check

Return Value

true if the format supports tags; otherwise it is false.

Example

For an example, refer to RasterCodecs.ReadTags(String,Int32).

Remarks

This is a helper method that can be used to detect if a certain raster file format supports tags. For example, ReadTag, RasterCodecs.ReadTags(String,Int32) and EnumTags can be used to read the tags stored in a file. If the file format supports tags, such as JPEG or TIFF, then these methods will successfully return the tags stored.

However, if the format does not support tags, such as BMP, an exception will be thrown by the RasterCodecs objects. You can use TagsSupported to check if the file supports tags and only call the read tags methods if the return value is true.

Note that the RasterCodecs option uses this method internally to check if the file supports tags when the CodecsLoadOptions.Tags is set to true and only read the file tags if the file format supports them.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also