Image.GetFrameCount(FrameDimension) Method

Definition

Returns the number of frames of the specified dimension.

public:
 int GetFrameCount(System::Drawing::Imaging::FrameDimension ^ dimension);
public int GetFrameCount (System.Drawing.Imaging.FrameDimension dimension);
member this.GetFrameCount : System.Drawing.Imaging.FrameDimension -> int
Public Function GetFrameCount (dimension As FrameDimension) As Integer

Parameters

dimension
FrameDimension

A FrameDimension that specifies the identity of the dimension type.

Returns

The number of frames in the specified dimension.

Remarks

This method returns information about multiple-frame images, which come in two styles: multiple page and multiple resolution.

A multiple-page image is an image that contains more than one image. Each page contains a single image (or frame). These pages (or images, or frames) are typically displayed in succession to produce an animated sequence, such as an animated .gif file.

A multiple-resolution image is an image that contains more than one copy of an image at different resolutions. This is commonly used by MIP mapping where the displayed image size determines the resolution of the image used for drawing. GDI+ can support an arbitrary number of pages (or images, or frames), as well as an arbitrary number of resolutions. The defined dimensions are properties of the FrameDimension.

Applies to