Format Property (CodecsLoadOptions)

Gets or sets the load format.

Syntax

C#
Visual Basic
WinRT C#
Java
Objective-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;}

@property (nonatomic, assign) LTRasterImageFormat format

public RasterImageFormat getFormat()
public void setFormat(RasterImageFormat value)

 <br/>get_Format();<br/>set_Format(value);<br/>Object.defineProperty('Format');

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

Property Value

A 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 it's 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. Doing so will skip the format recognition process and speed up the load operation.

Example

For an example, refer to CodecsOptions.

Requirements

Target Platforms

Reference

CodecsLoadOptions Class
CodecsLoadOptions Members