Image.SelectActiveFrame Method (FrameDimension, Int32)


Selects the frame specified by the dimension and index.

Namespace:   System.Drawing
Assembly:  System.Drawing (in System.Drawing.dll)

public int SelectActiveFrame(
	FrameDimension dimension,
	int frameIndex


Type: System.Drawing.Imaging.FrameDimension

A FrameDimension that specifies the identity of the dimension type.

Type: System.Int32

The index of the active frame.

Return Value

Type: System.Int32

Always returns 0.

The possible values of the dimensionID parameter are properties of the FrameDimension. These can be used to identify an image by its time, resolution, or page number.

Calling this method causes all changes made to the previous frame to be discarded. Before selecting another frame, save all changes made to the current frame, including changes to pixel values and properties. If the call to the SelectActiveFrame method is successful (an exception does not occur), the method will return 0.

.NET Framework
Available since 1.1
Return to top