StringDictionary ClassCognex VisionPro 9.10

Class which holds a keyed collection of strings.

Inheritance Hierarchy

System Object
  Cognex.Vision ShareableBase
    Cognex.Vision ChangedEventShareableBase
      Cognex.Vision.Implementation DictionaryOfstring
        Cognex.Vision StringDictionary

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

public sealed class StringDictionary : DictionaryOfstring, 
	IObject

The StringDictionary type exposes the following members.

Constructors

  NameDescription
Public methodStringDictionary

Constructs a new instance of this class.

Top
Methods

  NameDescription
Public methodAdd(KeyValuePair String, String )

Adds the specified item from this collection.

(Overrides DictionaryOfstring Add(KeyValuePair String, String ).)
Public methodAdd(String, String)

Add an item to the end of this collection.

(Overrides DictionaryOfstring Add(String, String).)
Public methodClear

Remove all items from this dictionary.

(Overrides DictionaryOfstring Clear .)
Public methodContains (Overrides DictionaryOfstring Contains(KeyValuePair String, String ).)
Public methodContainsKey

Determines whether this dictionary contains the specified key.

(Overrides DictionaryOfstring ContainsKey(String).)
Public methodCopyTo (Overrides DictionaryOfstring CopyTo( KeyValuePair String, String  , Int32).)
Public methodEquals
Compares the equality of this object with another.
(Overrides DictionaryOfstring Equals(Object).)
Public methodGetHashCode
Returns the hash code of this object.
(Overrides DictionaryOfstring GetHashCode .)
Public methodGetItemByKey
Get the item at the specified index.
(Overrides DictionaryOfstring GetItemByKey(String).)
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 DictionaryOfstring GetTypeMeta .)
Public methodKey

Get the key at the specified index.

(Overrides DictionaryOfstring Key(Int32).)
Public methodRemove(KeyValuePair String, String )

Remove the specified item from this collection.

(Overrides DictionaryOfstring Remove(KeyValuePair String, String ).)
Public methodRemove(String)

Remove the item with the specified key from this dictionary.

(Overrides DictionaryOfstring Remove(String).)
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 DictionaryOfstring ResumeAndRaiseChangedEvent .)
Public methodsetItem

Replace the element with the specified key. If the key is not a member of this dictionary, insert the key/value pair.

(Overrides DictionaryOfstring setItem(String, String).)
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 DictionaryOfstring SuspendChangedEvent .)
Public methodToString

Returns a human readable string that represents the object.

(Overrides DictionaryOfstring ToString .)
Public methodTryGetByIndex

Get the key and value associated with the specified index.

(Overrides DictionaryOfstring TryGetByIndex(Int32, String , String ).)
Public methodTryGetValue

Get the item associated with the specified key.

(Overrides DictionaryOfstring TryGetValue(String, String ).)
Top
Operators

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

  NameDescription
Public propertyChangedEventSuspended

Indicates if raising the ChangedEvent has been suspended.

(Overrides DictionaryOfstring ChangedEventSuspended.)
Public propertyCount

Get the number of elements contained in this collection.

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

Get whether or not this collection is read-only.

(Overrides DictionaryOfstring IsReadOnly.)
Public propertyItem (Overrides DictionaryOfstring Item String .)
Public propertyKeys (Inherited from DictionaryOfstring.)
Public propertyValues (Inherited from DictionaryOfstring.)
Top
Events

  NameDescription
Public eventChanged

The actual event.

(Overrides DictionaryOfstring Changed.)
Public eventCleared

Raised after the collection is cleared.

(Overrides DictionaryOfstring Cleared.)
Public eventClearing

Raised before the collection is cleared.

(Overrides DictionaryOfstring Clearing.)
Public eventInsertedItem

Raised after an item is inserted.

(Overrides DictionaryOfstring InsertedItem.)
Public eventInsertingItem

Raised before an item is inserted.

(Overrides DictionaryOfstring InsertingItem.)
Public eventRemovedItem

Raised after an item is removed.

(Overrides DictionaryOfstring RemovedItem.)
Public eventRemovingItem

Raised before an item is removed.

(Overrides DictionaryOfstring RemovingItem.)
Public eventReplacedItem

Raised after an item is replaced.

(Overrides DictionaryOfstring ReplacedItem.)
Public eventReplacingItem

Raised before an item is replaced.

(Overrides DictionaryOfstring ReplacingItem.)
Top
Remarks

You can retrieve a string from the collection by specifying its key or zero-based index position.

See Also