Image.SelectActiveFrame Method (System.Drawing)

.NET Framework Class Library

Image..::.SelectActiveFrame Method

Selects the frame specified by the dimension and index.

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

Public Function SelectActiveFrame ( _
	dimension As FrameDimension, _
	frameIndex As Integer _
) As Integer

public int SelectActiveFrame(
	FrameDimension dimension,
	int frameIndex
)

public:
int SelectActiveFrame(
	FrameDimension^ dimension, 
	int frameIndex
)

member SelectActiveFrame : 
        dimension:FrameDimension * 
        frameIndex:int -> int

Parameters

dimension: Type: System.Drawing.Imaging..::.FrameDimension
A FrameDimension that specifies the identity of the dimension type.

frameIndex: Type: System..::.Int32
The index of the active frame.

Return Value

Type: System..::.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.

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

Image Class

System.Drawing Namespace