Format Property

Summary

Gets or sets the load format.

Syntax

Objective-C

C++

Java

public RasterImageFormat Format { get; set; }

Public Property Format As RasterImageFormat

@property (nonatomic, assign) LTRasterImageFormat format

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

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

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 is trying to load to 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