ImageLoadOptions Class

Namespace:

GemBox.Pdf

Assembly:

GemBox.Pdf.dll

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

• C#
• VB.NET

public sealed class ImageLoadOptions : LoadOptions

Public NotInheritable Class ImageLoadOptions
    Inherits LoadOptions

Inheritance:

System.Object

LoadOptions

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.

• C#
• VB.NET

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:

• JPEG - the Exif APP1 application data segment.
• TIFF - the Orientation field.
• PNG - the eXIf chunk.

Default

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

• C#
• VB.NET

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.

FrameCount

Gets or sets the number of frames that should be loaded, starting from the frame specified by FrameIndex.

When loading a PdfDocument, each frame in the range will create a separate page.

Default value: 1.

• C#
• VB.NET

public int FrameCount { get; set; }

Public Property FrameCount As Integer

Property Value

System.Int32

The number of frames that should be loaded.

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.

• C#
• VB.NET

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.

• C#
• VB.NET

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.