Image.SelectActiveFrame(FrameDimension, Int32) Method

Reference

Definition

Namespace:: System.Drawing

Assembly:: System.Drawing.Common.dll

Assembly:: System.Drawing.dll

Package:: System.Drawing.Common v6.0.0

Package:: System.Drawing.Common v7.0.0

Package:: System.Drawing.Common v8.0.0

Package:: System.Drawing.Common v9.0.0-preview.2.24128.3

Source:: Image.cs

Source:: Image.cs

Source:: Image.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

A FrameDimension that specifies the identity of the dimension type.

frameIndex: Int32

The index of the active frame.

Returns

Int32

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