ClassItemCollection ClassCognex VisionPro 9.22

Class which holds a collection of ClassItem.

Inheritance Hierarchy

System Object
  Cognex.Vision ShareableBase
    Cognex.Vision ChangedEventShareableBase
      Cognex.Vision.ELCore.Implementation CollectionOfClassItemPtr
        Cognex.Vision.ELCore ClassItemCollection

Namespace: Cognex.Vision.ELCore
Assembly: Cognex.Vision.ELCore.Net (in Cognex.Vision.ELCore.Net.dll) Version: 9.22.2.0
Syntax

public sealed class ClassItemCollection : CollectionOfClassItemPtr, 
	IObject

The ClassItemCollection type exposes the following members.

Constructors

  NameDescription
Public methodClassItemCollection 

Constructs a new instance of the collection class.

Public methodClassItemCollection(Int64)

Constructs a new instance of the collection class with an initial capacity specified by the argument.

Top
Methods

  NameDescription
Public methodAdd

Add an item to the end of this collection.

(Overrides CollectionOfClassItemPtr Add(ClassItem).)
Public methodAddRange
Adds the elements of the specified collection to the end of the collection.
Public methodClear

Remove all items from this collection.

(Overrides CollectionOfClassItemPtr Clear .)
Public methodContains

Determine whether an item is in this collection.

(Overrides CollectionOfClassItemPtr Contains(ClassItem).)
Public methodCopyTo
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 CollectionOfClassItemPtr CopyTo( ClassItem , Int32).)
Public methodEquals
Compares the equality of this object with another.
(Overrides ChangedEventShareableBase Equals(Object).)
Public methodGetClassItem

Returns the class item associated with the provided identifier.

Public methodGetEnumerator
Returns an IEnumerator for the collection.
(Overrides CollectionOfClassItemPtr GetEnumerator .)
Public methodGetHashCode
Returns the hash code of this object.
(Overrides ChangedEventShareableBase GetHashCode .)
Public methodGetItem
Get the item at the specified index.
(Overrides CollectionOfClassItemPtr GetItem(Int32).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeMeta

Get the TypeMeta that describes the type of this object.

(Overrides CollectionOfClassItemPtr GetTypeMeta .)
Public methodIndexOf

Find the first item in this collection that matches the supplied item, and return its index.

(Overrides CollectionOfClassItemPtr IndexOf(ClassItem).)
Public methodInsert

Insert the given item at the specified index.

(Overrides CollectionOfClassItemPtr Insert(Int32, ClassItem).)
Public methodMove

Move the selected item to a new index in this collection.

(Overrides CollectionOfClassItemPtr Move(Int32, Int32).)
Public methodRemove

Remove the specified item from this collection.

(Overrides CollectionOfClassItemPtr Remove(ClassItem).)
Public methodRemoveAt

Remove the item at the specified index.

(Overrides CollectionOfClassItemPtr RemoveAt(Int32).)
Public methodReserve

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 CollectionOfClassItemPtr Reserve(Int64).)
Public methodResumeAndRaiseChangedEvent

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 CollectionOfClassItemPtr ResumeAndRaiseChangedEvent .)
Public methodsetItem

Replace the element at the specified index.

(Overrides CollectionOfClassItemPtr setItem(Int32, ClassItem).)
Public methodSuspendChangedEvent

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 CollectionOfClassItemPtr SuspendChangedEvent .)
Public methodToString

Returns a human readable string that represents the object.

(Overrides CollectionOfClassItemPtr ToString .)
Top
Operators

  NameDescription
Public operatorStatic memberEquality
Compares the equality of two ClassItemCollection objects.
Public operatorStatic memberInequality
Compares the inequality of two ClassItemCollection objects.
Top
Properties

  NameDescription
Public propertyCapacity

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 CollectionOfClassItemPtr Capacity.)
Public propertyChangedEventSuspended

Indicates if raising the ChangedEvent has been suspended.

(Overrides CollectionOfClassItemPtr ChangedEventSuspended.)
Public propertyCount

Get the number of elements contained in this collection.

(Overrides CollectionOfClassItemPtr Count.)
Public propertyHandle (Overrides CollectionOfClassItemPtr Handle.)
Public propertyIsReadOnly

Get whether or not this collection is read-only.

(Overrides CollectionOfClassItemPtr IsReadOnly.)
Public propertyItem (Overrides CollectionOfClassItemPtr Item Int32 .)
Top
Events

  NameDescription
Public eventChanged

The actual event.

(Overrides CollectionOfClassItemPtr Changed.)
Public eventCleared

Raised after the collection is cleared.

(Overrides CollectionOfClassItemPtr Cleared.)
Public eventClearing

Raised before the collection is cleared.

(Overrides CollectionOfClassItemPtr Clearing.)
Public eventInsertedItem

Raised after an item is inserted.

(Overrides CollectionOfClassItemPtr InsertedItem.)
Public eventInsertingItem

Raised before an item is inserted.

(Overrides CollectionOfClassItemPtr InsertingItem.)
Public eventMovedItem

Raised after an item is moved to a new index.

(Overrides CollectionOfClassItemPtr MovedItem.)
Public eventMovingItem

Raised before an item is moved to a new index.

(Overrides CollectionOfClassItemPtr MovingItem.)
Public eventRemovedItem

Raised after an item is removed.

(Overrides CollectionOfClassItemPtr RemovedItem.)
Public eventRemovingItem

Raised before an item is removed.

(Overrides CollectionOfClassItemPtr RemovingItem.)
Public eventReplacedItem

Raised after an item is replaced.

(Overrides CollectionOfClassItemPtr ReplacedItem.)
Public eventReplacingItem

Raised before an item is replaced.

(Overrides CollectionOfClassItemPtr ReplacingItem.)
Top
Remarks

The ClassItems in the ClassItemCollection must each have a unique identifier. Duplicate ClassItems are not allowed. ClassItems are allowed to have the same Class name.

See Also