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



Gets or sets the load format.

Syntax

Visual Basic (Declaration) 
Public Property Format As RasterImageFormat
Visual Basic (Usage)Copy Code
Dim instance As CodecsLoadOptions
Dim value As RasterImageFormat
 
instance.Format = value
 
value = instance.Format
C# 
public RasterImageFormat Format {get; set;}
C++/CLI 
public:
property RasterImageFormat Format {
   RasterImageFormat get();
   void set (RasterImageFormat value);
}

Return Value

A RasterImageFormat enumeration value that specifies the load format.

Example

For an example, refer to CodecsOptions.

Remarks

By default, the value of this property is set to false. This means that the RasterCodecs object should try and recognize the format of the image its trying to load itself. If you know the format of the file, pass it to this member prior to calling RasterCodecs.Load, this will skip the format recognation process and speed up the load operation.

Requirements

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

See Also