IImageCollection Class

Cognex VisionPro 9.21 SR1

This class holds a collection of IImage.

Inheritance Hierarchy

System Object
  Cognex.Vision ShareableBase
    Cognex.Vision ChangedEventShareableBase
      Cognex.Vision.Implementation CollectionOfIImagePtr
        Cognex.Vision IImageCollection

Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.21.1.1

Syntax

C++

Copy to Clipboard Print

public sealed class IImageCollection : CollectionOfIImagePtr, 
	IObject

public sealed class IImageCollection : CollectionOfIImagePtr, 
	IObject

Public NotInheritable Class IImageCollection 
	Inherits CollectionOfIImagePtr 
	Implements IObject

Public NotInheritable Class IImageCollection 
	Inherits CollectionOfIImagePtr 
	Implements IObject

public ref class IImageCollection sealed : public CollectionOfIImagePtr, 
	IObject

public ref class IImageCollection sealed : public CollectionOfIImagePtr, 
	IObject

The IImageCollection type exposes the following members.

Constructors

	Name	Description
	IImageCollection	Constructs a new instance of the collection class.
	IImageCollection(Int64)	Constructs a new instance of the collection class with an initial capacity specified by the argument.

Top

Methods

	Name	Description
	Add	Add an item to the end of this collection. (Overrides CollectionOfIImagePtr Add(IImage).)
	AddRange	Adds the elements of the specified collection to the end of the collection.
	Clear	Remove all items from this collection. (Overrides CollectionOfIImagePtr Clear .)
	Contains	Determine whether an item is in this collection. (Overrides CollectionOfIImagePtr Contains(IImage).)
	CopyTo	Copies all the elements of the collection to the specified one-dimensional array starting at the specified destination array index. The index is specified as a 32-bit integer. (Overrides CollectionOfIImagePtr CopyTo( IImage , Int32).)
	Equals	Compares the equality of this object with another. (Overrides ChangedEventShareableBase Equals(Object).)
	GetEnumerator	Returns an IEnumerator for the collection. (Overrides CollectionOfIImagePtr GetEnumerator .)
	GetHashCode	Returns the hash code of this object. (Overrides ChangedEventShareableBase GetHashCode .)
	GetItem	Get the item at the specified index. (Overrides CollectionOfIImagePtr GetItem(Int32).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetTypeMeta	Get the TypeMeta that describes the type of this object. (Overrides CollectionOfIImagePtr GetTypeMeta .)
	IndexOf	Find the first item in this collection that matches the supplied item, and return its index. (Overrides CollectionOfIImagePtr IndexOf(IImage).)
	Insert	Insert the given item at the specified index. (Overrides CollectionOfIImagePtr Insert(Int32, IImage).)
	Move	Move the selected item to a new index in this collection. (Overrides CollectionOfIImagePtr Move(Int32, Int32).)
	Remove	Remove the specified item from this collection. (Overrides CollectionOfIImagePtr Remove(IImage).)
	RemoveAt	Remove the item at the specified index. (Overrides CollectionOfIImagePtr RemoveAt(Int32).)
	Reserve	Set the collection capacity be at least the specified number of items. If minimumCapacity is greater than the current collection capacity, this method will cause the collection to reallocate its storage, increasing its capacity to at least minimumCapacity. Attempts to set capacity to a value less than or equal to the current value are ignored. (Overrides CollectionOfIImagePtr Reserve(Int64).)
	ResumeAndRaiseChangedEvent	Re-enables raising of the ChangedEvent after SuspendChangedEvent has been called, and raises the ChangedEvent if the ChangedEventSuspended count is reduced to zero and any changes were made while events were suspended. Must be called once for each call to SuspendChangedEvent. (Overrides CollectionOfIImagePtr ResumeAndRaiseChangedEvent .)
	setItem	Replace the element at the specified index. (Overrides CollectionOfIImagePtr setItem(Int32, IImage).)
	SuspendChangedEvent	Temporarily suspends the raising of the ChangedEvent. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent. (Overrides CollectionOfIImagePtr SuspendChangedEvent .)
	ToString	Returns a human readable string that represents the object. (Overrides CollectionOfIImagePtr ToString .)

Top

Operators

	Name	Description
	Equality	Compares the equality of two IImageCollection objects.
	Inequality	Compares the inequality of two IImageCollection objects.

Top

Properties

	Name	Description
	Capacity	Get the capacity of this collection. This is the maximum number of items that may be stored in this collection without reallocation. Capacity is increased automatically as needed to hold added items. (Overrides CollectionOfIImagePtr Capacity.)
	ChangedEventSuspended	Indicates if raising the ChangedEvent has been suspended. (Overrides CollectionOfIImagePtr ChangedEventSuspended.)
	Count	Get the number of elements contained in this collection. (Overrides CollectionOfIImagePtr Count.)
	Handle	(Overrides CollectionOfIImagePtr Handle.)
	IsReadOnly	Get whether or not this collection is read-only. (Overrides CollectionOfIImagePtr IsReadOnly.)
	Item	(Overrides CollectionOfIImagePtr Item Int32 .)

Top

Events

	Name	Description
	Changed	The actual event. (Overrides CollectionOfIImagePtr Changed.)
	Cleared	Raised after the collection is cleared. (Overrides CollectionOfIImagePtr Cleared.)
	Clearing	Raised before the collection is cleared. (Overrides CollectionOfIImagePtr Clearing.)
	InsertedItem	Raised after an item is inserted. (Overrides CollectionOfIImagePtr InsertedItem.)
	InsertingItem	Raised before an item is inserted. (Overrides CollectionOfIImagePtr InsertingItem.)
	MovedItem	Raised after an item is moved to a new index. (Overrides CollectionOfIImagePtr MovedItem.)
	MovingItem	Raised before an item is moved to a new index. (Overrides CollectionOfIImagePtr MovingItem.)
	RemovedItem	Raised after an item is removed. (Overrides CollectionOfIImagePtr RemovedItem.)
	RemovingItem	Raised before an item is removed. (Overrides CollectionOfIImagePtr RemovingItem.)
	ReplacedItem	Raised after an item is replaced. (Overrides CollectionOfIImagePtr ReplacedItem.)
	ReplacingItem	Raised before an item is replaced. (Overrides CollectionOfIImagePtr ReplacingItem.)

Top