A container that stores a non-ordered collection of key-and-value pairs, and
raises events whenever any change is made.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.Implementation CogSerializableDictionaryBase
Cognex.VisionPro CogDictionary
Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro (in Cognex.VisionPro.dll) Version: 73.0.0.0 (73.0.0.0)
Syntax
The CogDictionary type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogDictionary |
Constructs a new instance of the CogDictionary class.
|
| CogDictionary(CogDictionary) |
Constructs a new instance of the CogDictionary class.
|
| CogDictionary(SerializationInfo, StreamingContext) |
Constructs a new instance of the CogDictionary class.
|
Methods
| Name | Description | |
|---|---|---|
| Add | |
| AddRange | |
| Clear | (Inherited from CogSerializableDictionaryBase.) |
 | Clone |
Creates a deep copy of the dictionary.
(Overrides CogSerializableDictionaryBase Clone .) |
| Contains | (Inherited from CogSerializableDictionaryBase.) |
| CopyTo |
Copies the contents of the dictionary to an array.
(Inherited from CogSerializableDictionaryBase.) |
| 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.) |
| 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 ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| 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.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| 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.) |
| 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 | (Inherited from CogSerializableDictionaryBase.) |
| OnClearing | (Inherited from CogSerializableDictionaryBase.) |
| OnDeserialization | (Inherited from CogSerializableDictionaryBase.) |
| OnInsertedItem | (Inherited from CogSerializableDictionaryBase.) |
| OnInsertingItem | (Inherited from CogSerializableDictionaryBase.) |
| OnRemovedItem | (Inherited from CogSerializableDictionaryBase.) |
| OnRemovingItem | (Inherited from CogSerializableDictionaryBase.) |
| OnReplacedItem | (Inherited from CogSerializableDictionaryBase.) |
| OnReplacingItem | (Inherited from CogSerializableDictionaryBase.) |
| Remove | (Inherited from CogSerializableDictionaryBase.) |
| 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.) |
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 |
Returns the number of items in the dictionary.
(Inherited from CogSerializableDictionaryBase.) |
 | Dictionary |
Gets the IDictionary interface of this instance.
(Inherited from CogSerializableDictionaryBase.) |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| InnerHashtable |
Gets a Hashtable containg the elements.
(Inherited from CogSerializableDictionaryBase.) |
| Item | |
| Keys |
Gets a collection of all keys in the dictionary.
(Inherited from CogSerializableDictionaryBase.) |
| 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.) |
| Values |
Gets a collection of all values in the dictionary.
(Inherited from CogSerializableDictionaryBase.) |
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 dictionary is cleared.
(Inherited from CogSerializableDictionaryBase.) |
| Clearing |
Raised before the dictionary is cleared.
(Inherited from CogSerializableDictionaryBase.) |
| InsertedItem |
Raised after an item is inserted.
(Inherited from CogSerializableDictionaryBase.) |
| InsertingItem |
Raised before an item is inserted.
(Inherited from CogSerializableDictionaryBase.) |
| RemovedItem |
Raised after an item is removed.
(Inherited from CogSerializableDictionaryBase.) |
| RemovingItem |
Raised before an item is removed.
(Inherited from CogSerializableDictionaryBase.) |
| ReplacedItem |
Raised before an item is replaced.
(Inherited from CogSerializableDictionaryBase.) |
| ReplacingItem |
Raised after an item is replaced.
(Inherited from CogSerializableDictionaryBase.) |
See Also