GrapeCity.Documents.Drawing.IImage

Interface IImage

Namespace

GrapeCity.Documents.Drawing

Assembly

GcDocs.Imaging.dll

Defines a common interface for images that can be drawn on a GcGraphics.

public interface IImage : IDisposable

Inherited Members

System.IDisposable.Dispose()

Properties

Disposed

Gets a value indicating whether the image was not initialized or has already been disposed.

bool Disposed { get; }

Property Value

bool

ExifProfile

If possible, gets an instance of ExifProfile with Exif metadata of the image.

ExifProfile ExifProfile { get; }

Property Value

ExifProfile

Height

Gets the height of the image, in pixels.

int Height { get; }

Property Value

int

HorizontalResolution

Gets the horizontal resolution of the image, in dots per inch.

float HorizontalResolution { get; }

Property Value

float

Rotation

Gets the flip and rotate transformations that must be applied to the image.

FlipRotateAction Rotation { get; }

Property Value

FlipRotateAction

VerticalResolution

Gets the vertical resolution of the image, in dots per inch.

float VerticalResolution { get; }

Property Value

float

Width

Gets the width of the image, in pixels.

int Width { get; }

Property Value

int

Methods

ToGcBitmap(GcBitmap)

Loads the image into an existing instance of GcBitmap.

void ToGcBitmap(GcBitmap bmp)

Parameters

bmp GcBitmap

The destination GcBitmap object.

ToGcBitmap(bool, out bool)

Retrieves the underlying GcBitmap object, or creates a new GcBitmap that contains the image data.

Note that you should dispose the returned GcBitmap if disposeAfterUse is true.

GcBitmap ToGcBitmap(bool applyExifOrientation, out bool disposeAfterUse)

Parameters

applyExifOrientation bool

Indicates whether the flip and rotate transformations should be applied to the returned GcBitmap if that is required by the Orientation property in the EXIF profile.

disposeAfterUse bool

OUT: Indicates whether the returned GcBitmap should be disposed by the user.

Returns

GcBitmap

A GcBitmap object containing the image.

ToGcBitmap(out bool)

Retrieves the underlying GcBitmap object, or creates a new GcBitmap that contains the image data.

Note that you should dispose the returned GcBitmap if disposeAfterUse is true.

GcBitmap ToGcBitmap(out bool disposeAfterUse)

Parameters

disposeAfterUse bool

OUT: Indicates whether the returned GcBitmap should be disposed by the user.

Returns

GcBitmap

A GcBitmap object containing the image.