Remove Method (McFrames)
      
 

Description

Remove frames from this collection

Return Type

None  

Syntax

object.Remove [FramesToRemove]

The Remove Method syntax has these parts:

PartDescription
objectAn expression evaluating to an object of type McFrames.
FramesToRemoveOptional. A Variant value.

VARIANT : An optional selector for the frames to be removed from the collection. If missing or a scalar -1, all frames in the collection are removed. This selector may be an array of VARIANT, in which case the contents of each VARIANT are removed from the collection. Each VARIANT may be a single scalar index value (if negative, then all frames are removed), or it may be a single scalar LONGRANGE giving Start and End collection indices, or it may be an array of collection index values or an array of LONGRANGE collection index ranges. In addition, it may be an McFrame object instance or an array of them; the first occurrance of each of these McFrame instances in the collection is removed. Finally, the FramesSelector argument may be an McFrames collection (or an array of them) with a ParentImage the same as this one's. In this case matching frames from the source McFrames collection(s) are removed from this McFrames collection.

Remarks

The McFrame instances to be removed from the collection can be specified in a number of ways based on the optional FramesToRemove argument. If the FramesToRemove argument is missing, then all frames are removed from the collection.

You usually do not need to call this method, because the collection is automatically emptied when it is fully released. Frames are also automatically removed when they are moved to another image (via McImage.MoveFrames) or are removed from the image altogether (via McImage.RemoveFrames or by the McImage being fully released).

Exceptions

Frames added must have the same ParentImage as this one's. Frame indices specified must be within the range from 0 to Count-1.

Notes

Indices specified in the FramesToRemove argument are collection indices, not FrameIndex values for the position of the frame in its ParentImage.

An McFrame instance may appear in an McFrames collection more than once. If it does so then you must also specify its removal more than once as well; specifying a particular McFrame instance to remove will remove only the first such instance in the collection.

If a frame is moved to another image (via McImage.MoveFrames) or is removed from the image altogether (via McImage.RemoveFrames), then that frame is automatically removed from any McFrames collection holding it.