ToolCollection Class

Cognex VisionPro 9.21 SR1

Class which holds a collection of Vision Tools.

Inheritance Hierarchy

System Object
  Cognex.Vision ShareableBase
    Cognex.Vision ChangedEventShareableBase
      Cognex.Vision.Implementation CollectionOfIToolPtr
        Cognex.Vision ToolCollection

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 ToolCollection : CollectionOfIToolPtr, 
	IObject

public sealed class ToolCollection : CollectionOfIToolPtr, 
	IObject

Public NotInheritable Class ToolCollection 
	Inherits CollectionOfIToolPtr 
	Implements IObject

Public NotInheritable Class ToolCollection 
	Inherits CollectionOfIToolPtr 
	Implements IObject

public ref class ToolCollection sealed : public CollectionOfIToolPtr, 
	IObject

public ref class ToolCollection sealed : public CollectionOfIToolPtr, 
	IObject

The ToolCollection type exposes the following members.

Constructors

	Name	Description
	ToolCollection	Constructs a new instance of the collection class.
	ToolCollection(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 CollectionOfIToolPtr Add(ITool).)
	AddRange	Adds the elements of the specified collection to the end of the collection.
	Clear	Remove all items from this collection. (Overrides CollectionOfIToolPtr Clear .)
	Contains	Determine whether an item is in this collection. (Overrides CollectionOfIToolPtr Contains(ITool).)
	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 CollectionOfIToolPtr CopyTo( ITool , Int32).)
	Equals	Compares the equality of this object with another. (Overrides ChangedEventShareableBase Equals(Object).)
	GetEnumerator	Returns an IEnumerator for the collection. (Overrides CollectionOfIToolPtr GetEnumerator .)
	GetHashCode	Returns the hash code of this object. (Overrides ChangedEventShareableBase GetHashCode .)
	GetItem	Get the item at the specified index. (Overrides CollectionOfIToolPtr 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 CollectionOfIToolPtr GetTypeMeta .)
	IndexOf	Find the first item in this collection that matches the supplied item, and return its index. (Overrides CollectionOfIToolPtr IndexOf(ITool).)
	Insert	Insert the given item at the specified index. (Overrides CollectionOfIToolPtr Insert(Int32, ITool).)
	Move	Move the selected item to a new index in this collection. (Overrides CollectionOfIToolPtr Move(Int32, Int32).)
	Remove	Remove the specified item from this collection. (Overrides CollectionOfIToolPtr Remove(ITool).)
	RemoveAt	Remove the item at the specified index. (Overrides CollectionOfIToolPtr 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 CollectionOfIToolPtr 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 CollectionOfIToolPtr ResumeAndRaiseChangedEvent .)
	setItem	Replace the element at the specified index. (Overrides CollectionOfIToolPtr setItem(Int32, ITool).)
	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 CollectionOfIToolPtr SuspendChangedEvent .)
	ToString	Returns a human readable string that represents the object. (Overrides CollectionOfIToolPtr ToString .)

Top

Operators

	Name	Description
	Equality	Compares the equality of two ToolCollection objects.
	Inequality	Compares the inequality of two ToolCollection 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 CollectionOfIToolPtr Capacity.)
	ChangedEventSuspended	Indicates if raising the ChangedEvent has been suspended. (Overrides CollectionOfIToolPtr ChangedEventSuspended.)
	Count	Get the number of elements contained in this collection. (Overrides CollectionOfIToolPtr Count.)
	Handle	(Overrides CollectionOfIToolPtr Handle.)
	IsReadOnly	Get whether or not this collection is read-only. (Overrides CollectionOfIToolPtr IsReadOnly.)
	Item	(Overrides CollectionOfIToolPtr Item Int32 .)

Top

Events

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

Top