An ordered collection of VisionPro tools that raises events whenever
a change is made.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.Implementation CogSerializableCollectionBase
Cognex.VisionPro CogToolCollection
Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro (in Cognex.VisionPro.dll) Version: 65.1.0.0 (65.1.0.0)
Syntax
The CogToolCollection type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogToolCollection |
Constructs a new instance of the CogToolCollection class.
|
| CogToolCollection(Object) |
Constructs a new instance of the CogToolCollection class.
|
| CogToolCollection(CogToolCollection) |
Constructs a new instance of the CogToolCollection class.
|
| CogToolCollection( ICogTool ) |
Constructs a new instance of the CogToolCollection class.
|
 | CogToolCollection(SerializationInfo, StreamingContext) |
Constructs a new instance of the CogToolCollection class.
|
| CogToolCollection(CogToolCollection, Object) |
Constructs a new instance of the CogToolCollection class.
|
| CogToolCollection( ICogTool , Object) |
Constructs a new instance of the CogToolCollection class.
|
Methods
| Name | Description | |
|---|---|---|
| Add |
Adds an item to the CogToolCollection.
|
| Clear |
Removes all objects from the collection.
(Inherited from CogSerializableCollectionBase.) |
| Clone |
Creates a deep copy of the tool collection.
(Overrides CogSerializableCollectionBase Clone .) |
| Contains(String) |
Determines whether the CogToolCollection contains an ICogTool with the
specified key.
|
| Contains(ICogTool) |
Determines whether the CogToolCollection contains a specific ICogTool.
|
| CopyTo |
Copies the contents of the collection to an array.
(Inherited from CogSerializableCollectionBase.) |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| Equals | (Inherited from Object.) |
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetAttributes |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetClassName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetComponentName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetConverter |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultEvent |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultProperty |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEditor |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEnumerator |
Returns an enumerator that can iterate through the CogToolCollection's
elements.
|
| GetEvents |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetObjectData |
Implements the GetObjectData method of the ISerializable interface.
(Inherited from CogSerializableObjectBase.) |
| GetProperties |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetProperties( Attribute ) |
Returns a collection containing all PropertyDescriptors found in the
standard fasion, augmented with property descriptors for each ICogTool
that can be obtained using the string overload of the item indexer.
(Overrides CogObjectBase GetProperties( Attribute ).) |
| GetPropertyOwner |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf(String) |
Determines the index of the ICogTool with the specified key.
|
| IndexOf(ICogTool) |
Determines the index of a specific ICogTool in the CogToolCollection.
|
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| Insert |
Inserts an ICogTool into the CogToolCollection at the specified position.
|
| InsertFromToolboxItem |
Insert one or more tools from a toolbox item.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| Move |
Moves an item from one position to another.
(Inherited from CogSerializableCollectionBase.) |
| OnChanged(Int64) |
This method should be called internally whenever the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
| OnChanged(CogChangedEventArgs) |
This method may be called internally whenever a derived object's state
may have changed and the derived object expresses this change via a
derived CogChangedEventArgs class.
(Inherited from CogSerializableChangedEventBase.) |
| OnCleared |
Raises the Cleared event.
(Inherited from CogSerializableCollectionBase.) |
| OnClearing |
Raises the Clearing event.
(Overrides CogSerializableCollectionBase OnClearing .) |
| OnDeserialization | |
| OnInsertedItem |
Raises the InsertedItem event.
(Inherited from CogSerializableCollectionBase.) |
| OnInsertingItem |
Raises the InsertingItem event.
(Overrides CogSerializableCollectionBase OnInsertingItem(Int32, Object).) |
| OnMovedItem |
Raises the MovedItem event.
(Inherited from CogSerializableCollectionBase.) |
| OnMovingItem |
Raises the MovingItem event.
(Inherited from CogSerializableCollectionBase.) |
| OnRemovedItem |
Raises the RemovedItem event.
(Overrides CogSerializableCollectionBase OnRemovedItem(Int32, Object).) |
| OnRemovingItem |
Raises the RemovingItem event.
(Inherited from CogSerializableCollectionBase.) |
| OnReplacedItem |
Raises the ReplacedItem event.
(Inherited from CogSerializableCollectionBase.) |
| OnReplacingItem |
Raises the ReplacingItem event.
(Overrides CogSerializableCollectionBase OnReplacingItem(Int32, Object, Object).) |
| Remove(String) |
Removes the first occurrence of a specific ICogTool from the
CogToolCollection.
|
| Remove(ICogTool) |
Removes the first occurrence of a specific ICogTool from the
CogToolCollection.
|
| RemoveAt |
Removes the element at the specified index.
(Inherited from CogSerializableCollectionBase.) |
| ResumeAndRaiseChangedEvent |
Re-enables raising of the Changed event after SuspendChangedEvent
has been called, and raises the Changed event 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.
(Inherited from CogSerializableChangedEventBase.) |
| SuspendChangedEvent |
Temporarily suspends the raising of the Changed event. May be called
more than once, and a corresponding call to ResumeAndRaiseChangedEvent
must be made for each call to SuspendChangedEvent.
(Inherited from CogSerializableChangedEventBase.) |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfNextSf |
Next state flag to be used in derived classes.
|
 | SfParent |
State flag for the Parent property.
|
Properties
| Name | Description | |
|---|---|---|
 | ChangedEventSuspended |
If nonzero, indicates that the raising of the Changed event has been
suspended. This value is incremented when SuspendChangedEvent is called
and decremented when ResumeAndRaiseChangedEvent is called.
(Inherited from CogSerializableChangedEventBase.) |
| Count |
Gets the number of elements contained in the collection.
(Inherited from CogSerializableCollectionBase.) |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
 | InnerList |
Gets the internal ArrayList containing the list of elements.
(Inherited from CogSerializableCollectionBase.) |
| IsFixedSize | (Inherited from CogSerializableCollectionBase.) |
| Item Int32 |
Gets or sets the ICogTool at the specified index. In C#, this property
is the indexer for the CogToolCollection class.
|
| Item String |
Gets or sets the ICogTool with the specified key. In C#, this property
is the indexer for the CogToolCollection class.
|
| List |
Gets an the IList interface of this collection.
(Inherited from CogSerializableCollectionBase.) |
| Parent |
Gets or sets the parent object of this CogToolCollection.
|
| StateFlags |
Returns the complete set of state flags supported on this object. The
flags may be indexed by name as shown in the following C# code snippet:
if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... }
(Inherited from CogSerializableChangedEventBase.) |
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
| Cleared |
Raised after the collection is cleared.
(Inherited from CogSerializableCollectionBase.) |
| Clearing |
Raised before the collection is cleared.
(Inherited from CogSerializableCollectionBase.) |
| InsertedItem |
Raised after an item is inserted.
(Inherited from CogSerializableCollectionBase.) |
| InsertingItem |
Raised before an item is inserted.
(Inherited from CogSerializableCollectionBase.) |
| MovedItem |
Raised after an item is moved to a new index.
(Inherited from CogSerializableCollectionBase.) |
| MovingItem |
Raised before an item is moved to a new index.
(Inherited from CogSerializableCollectionBase.) |
| RemovedItem |
Raised after an item is removed.
(Inherited from CogSerializableCollectionBase.) |
| RemovingItem |
Raised before an item is removed.
(Inherited from CogSerializableCollectionBase.) |
| ReplacedItem |
Raised after an item is replaced.
(Inherited from CogSerializableCollectionBase.) |
| ReplacingItem |
Raised before an item is replaced.
(Inherited from CogSerializableCollectionBase.) |
See Also