Image.SelectActiveFrame(FrameDimension, Int32) Image.SelectActiveFrame(FrameDimension, Int32) Image.SelectActiveFrame(FrameDimension, Int32) Image.SelectActiveFrame(FrameDimension, Int32) Method

Definition

Selects the frame specified by the dimension and index.

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

Parameters

dimension
FrameDimension FrameDimension FrameDimension FrameDimension

A FrameDimension that specifies the identity of the dimension type.

frameIndex
Int32 Int32 Int32 Int32

The index of the active frame.

Returns

Always returns 0.

Remarks

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.

Applies to