Leadtools.CF Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.6.15
Format Property
See Also 
Leadtools.Codecs Namespace > CodecsOptions.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 CodecsOptions.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.

Remarks

By default, the value of this property is set to RasterImageFormat.Unknown. 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 recognition process and speed up the load operation.

For example, if you call RasterCodecs.GetInformation on a file, you will get the image format in the CodecsImageInfo.Format property. You can then pass this value to the Format property of the CodecsOptions.CodecsLoadOptions to speed up the loading process prior of calling RasterCodecs.Load.

Requirements

Target Platforms: Microsoft .NET CF Framework 2.0, Windows Mobile 5 PocketPC, Windows Mobile 5 Smartphone, Windows Mobile 6

See Also