ImageLoadOptions Class

Namespace:
GemBox.Pdf
Assembly:
GemBox.Pdf.dll

Represents options used for loading a PdfImage from a file or a stream.

public sealed class ImageLoadOptions
Public NotInheritable Class ImageLoadOptions
Inheritance:
System.Object
ImageLoadOptions

Properties

AutoOrient

Gets or sets a value indicating whether to automatically orient the PdfImageContent when drawing the loaded PdfImage using any of the DrawImage(PdfImage, PdfMatrix) overloads based on the orientation stored in the encoded image Exif metadata.

Default value: true.

public bool AutoOrient { get; set; }
Public Property AutoOrient As Boolean
Property Value
System.Boolean

true to automatically orient the PdfImageContent when drawing the loaded PdfImage using any of the DrawImage(PdfImage, PdfMatrix) overloads based on the orientation stored in the encoded image Exif metadata; otherwise, false.

Remarks

Reading the orientation from the encoded image is supported for the following image formats:

Default

Gets the default options used for loading any PdfImage from an image file.

public static ImageLoadOptions Default { get; }
Public Shared ReadOnly Property Default As ImageLoadOptions
Property Value
ImageLoadOptions

The default options used for loading any PdfImage from an image file.

FrameIndex

Gets or sets the zero-based index of the frame that should be loaded.

If the frame at the specified index does not exist in the image file, then Load(String, ImageLoadOptions) and Load(Stream, ImageLoadOptions) methods return null.

public int FrameIndex { get; set; }
Public Property FrameIndex As Integer
Property Value
System.Int32

The zero-based index of the frame that should be loaded.

Version

Gets or sets the name of the PDF version to which the file applies.

public PdfVersion? Version { get; set; }
Public Property Version As PdfVersion?
Property Value
System.Nullable<PdfVersion>

The name of the PDF version to which the file applies.