FrameIndex Property

Summary

Gets the zero-based index of the requested frame.

Syntax

C++

public int FrameIndex { get; }

  
Public ReadOnly Property FrameIndex As Integer

            public: 
property int FrameIndex { 
   int get(); 
}

Property Value

A zero-based index of the requested frame. The user needs to provide the image with the specified index through Frame.

Remarks

When the user receives the frame index, he must provide the image with the provided index, and set it to the property Frame. The only property that the user must set is the Frame.

The user can also provide more information like InstanceNumber and CaptureDate, but they are optional. If the user did not set them, then the toolkit will use the default values.

Requirements

Target Platforms