Click or drag to resize

IMcImageActiveFrameRange Property

The range(s) of active frames.

Namespace:  MediaCy.IQL.Engine
Assembly:  MediaCy.IQL.Engine (in MediaCy.IQL.Engine.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Property ActiveFrameRange As Object
	Get
	Set

Property Value

Type: Object
Remarks
When the UseActiveFrameRange property is True, the active ranges are used in processing operators to automatically process all the active frames of an image. This property is exposed as VARIANT which may contain a 1D array the with FrameIndex values of the selected frames. If all frames are selected (because an Empty, Missing or scalar -1 VARIANT was assigned as the ActiveFrameRange), then a scalar -1 is returned to indicate that all frames are selected for processing in their natural order. On assignment, you specify the frames to be active by supplying a McFrames collection, by supplying one or more McFrame instances or by supplying FrameIndex values of the frames to be active. The source selector for an ActiveFrameRange assignment can be Empty or Missing VARIANT or a scalar value of -1 indicating that all frames are active. The selector may be an array of VARIANT, in which case the contents of each VARIANT are added to the ActiveFrameRange. Each VARIANT may be a single scalar index value (if negative, then all frames are added), or it may be a single scalar LONGRANGE giving Start and End frame indices, or it may be an array of index values or an array of LONGRANGE index ranges. In addition, it may be a McFrame object instance or an array of them; each of these McFrame instances must one of the frames in this McImage's frame list (see the Frame property). Finally, the assigning selector may be a McFrames collection (or an array of them) with a ParentImage the same as this one. In this case the entire contents of the IMcFrames collection(s) are added to the ActiveFrameRange.
Note Note
On assigment an OnPropertyChanged(ID_IMcImage_ActiveFrameRange) event is fired. The ActiveFrameRange property can be used as the FrameSelector argument to the Frames property to get a McFrames instance holding the active frames. If a frame in the ActiveFrameRange is moved to another image (via MoveFrames) or is removed from the image altogether (via RemoveFrames), then that frame is automatically removed from the ActiveFrameRange. When this happens, the FrameIndex of remaining frames is likely to change.
See Also