GrapeCity.Documents.Imaging.IcoFrame

Class IcoFrame

Namespace

GrapeCity.Documents.Imaging

Assembly

GcDocs.Imaging.dll

Represents a single frame in ICO file.

public class IcoFrame : IDisposable

Inheritance

object

IcoFrame

Implements

System.IDisposable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

IcoFrame(GcBitmap, IcoFrameEncoding)

Initializes a new instance of IcoFrame class.

public IcoFrame(GcBitmap bitmap, IcoFrameEncoding encoding)

Parameters

bitmap GcBitmap

The source bitmap for the ICO frame.

encoding IcoFrameEncoding

Encoding of the frame image.

Properties

Encoding

Gets the encoding of the frame image.

public IcoFrameEncoding Encoding { get; }

Property Value

IcoFrameEncoding

Height

Gets the height of the image, in pixels.

public int Height { get; }

Property Value

int

IsDisposed

Gets a value indicating whether the IcoFrame has been disposed of.

public bool IsDisposed { get; }

Property Value

bool

Width

Gets the width of the image, in pixels.

public int Width { get; }

Property Value

int

Methods

Dispose()

Clean up any resources being used.

public void Dispose()

Dispose(bool)

Performs cleanup operations on managed and unmanaged resources.

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

~IcoFrame()

Performs cleanup operations on unmanaged resources.

protected ~IcoFrame()

ToGcBitmap(GcBitmap)

Reads the frame image into an existing GcBitmap.

public void ToGcBitmap(GcBitmap bmp)

Parameters

bmp GcBitmap

The target GcBitmap object.

ToGcBitmap(bool)

Gets the frame image as a GcBitmap.

public GcBitmap ToGcBitmap(bool detachFromIco = true)

Parameters

detachFromIco bool

Indicates if the returned image should be a copy of the frame image.

Returns

GcBitmap

ToImage()

Creates an Image object for the frame.

public Image ToImage()

Returns

Image

The newly created Image object.