Format Property (CodecsLoadOptions)

Gets or sets the load format.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public RasterImageFormat Format {get; set;}

'Declaration
 
Public Property Format As RasterImageFormat

'Usage
 
Dim instance As CodecsLoadOptions
Dim value As RasterImageFormat
 
instance.Format = value
 
value = instance.Format

public RasterImageFormat Format {get; set;}

 get_Format();
 set_Format(value);

public:
property RasterImageFormat Format {
   RasterImageFormat get();
   void set (    RasterImageFormat value);
}

Property Value

A Leadtools.RasterImageFormat enumeration value that specifies the load format.

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 or RasterCodecs.LoadAsync, this will skip the format recognition process and speed up the load operation.

Example

For an example, refer to CodecsOptions.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

CodecsLoadOptions Class
CodecsLoadOptions Members