This documentation is archived and is not being maintained.

Image.SelectActiveFrame Method

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
public int SelectActiveFrame (
	FrameDimension dimension, 
	int frameIndex
public function SelectActiveFrame (
	dimension : FrameDimension, 
	frameIndex : int
) : int
Not applicable.



A FrameDimension that specifies the identity of the dimension type.


The index of the active frame.

Return Value

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.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0