←Select platform

TagsSupported Method

Summary

Checks whether the given file format supports tags

Syntax

C#
VB
Java
Objective-C
WinRT C#
C++
public static bool TagsSupported( 
   RasterImageFormat format 
) 
Public Shared Function TagsSupported( _ 
   ByVal format As Leadtools.RasterImageFormat _ 
) As Boolean 
public static bool TagsSupported(  
   Leadtools.RasterImageFormat format 
) 
+ (BOOL)tagsSupported:(LTRasterImageFormat)format 
public static boolean tagsSupported(RasterImageFormat format) 
 function Leadtools.Codecs.RasterCodecs.TagsSupported(  
   format  
) 
public: 
static bool TagsSupported(  
   Leadtools.RasterImageFormat format 
)  

Parameters

format
The RasterImageFormat to check

Return Value

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

Remarks

This is a helper method that can be used to detect if a certain raster file format supports tags. For example, ReadTag, ReadTags 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 determine whether 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 determine whether the file supports tags when the CodecsLoadOptions.Tags is set to true and only read the file tags if the file format supports them.

Example

For an example, refer to ReadTags.

Requirements

Target Platforms

Help Version 19.0.2017.10.18
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Codecs Assembly