Dictionary that provides access to the list of installed CVB overlay plugins. More...
Inherits IDictionary< string, OverlayPluginInfo >.
Public Member Functions | |
void | Add (string key, OverlayPluginInfo value) |
Add a new entry. More... | |
bool | ContainsKey (string key) |
Check if a specific key exists in the collection More... | |
bool | Remove (string key) |
Remove a value with the specified key. More... | |
bool | TryGetValue (string key, out OverlayPluginInfo value) |
Try to get a value from the collection. Will not raise and exception if the specified key does not exist. More... | |
bool | Remove (KeyValuePair< string, OverlayPluginInfo > entry) |
Remove an entry from the dictionary More... | |
void | CopyTo (KeyValuePair< string, OverlayPluginInfo >[] entries, int index) |
copy the contents of the collection into an array More... | |
bool | Contains (KeyValuePair< string, OverlayPluginInfo > entry) |
Check if a specific entry is part of the collection More... | |
void | Clear () |
Will raise a NotSupportedException because this dictionary is readonly. | |
void | Add (KeyValuePair< string, OverlayPluginInfo > entry) |
Will raise a NotSupportedException because this dictionary is read only. More... | |
IEnumerator< KeyValuePair< string, OverlayPluginInfo > > | GetEnumerator () |
Enumeration implementation More... | |
Properties | |
int | Count Software\Common Vision Blox\Image Manager\AvailableOverlayPlugIns" [get] |
Number of available overlay plugins. | |
OverlayPluginInfo | this[int index] [get] |
Access overlay plugin by means of a numerical index More... | |
OverlayPluginInfo | this[string key] [get, set] |
Retrieve overlay plugin information by means of a string key containing the plugin's friendly name More... | |
ICollection< string > | Keys [get] |
Get the collection of keys in the dictionary | |
ICollection< OverlayPluginInfo > | Values [get] |
Get the collection of values in the dictionary | |
bool | IsReadOnly [get] |
This collection is read-only | |
Dictionary that provides access to the list of installed CVB overlay plugins.
Not to be used directly; access through the property Display.InstalledOverlays instead!
void Add | ( | KeyValuePair< string, OverlayPluginInfo > | entry | ) |
Will raise a NotSupportedException because this dictionary is read only.
entry | ignored |
void Add | ( | string | key, |
OverlayPluginInfo | value | ||
) |
Add a new entry.
As this dictionary is read-only, Add will always raise a NotSupportedException.
key | ignored |
value | ignored |
bool Contains | ( | KeyValuePair< string, OverlayPluginInfo > | entry | ) |
Check if a specific entry is part of the collection
entry | entry to be checked for |
bool ContainsKey | ( | string | key | ) |
Check if a specific key exists in the collection
key | key to be checked |
void CopyTo | ( | KeyValuePair< string, OverlayPluginInfo >[] | entries, |
int | index | ||
) |
copy the contents of the collection into an array
entries | entries array into which to copy |
index | index at which to start copying |
ArgumentNullException | If entries is null |
ArgumentOutOfRangeException | If index is less than 0 |
ArgumentException | If the number of elements in this collection is greater than the available space from index to the end of the destination entries |
IEnumerator< KeyValuePair< string, OverlayPluginInfo > > GetEnumerator | ( | ) |
Enumeration implementation
bool Remove | ( | KeyValuePair< string, OverlayPluginInfo > | entry | ) |
Remove an entry from the dictionary
As this dictionary is read-only, Remove will always raise a NotSupportedException.
entry | ignored |
NotSupportedException | Will always be raised as this dictionary is read only. |
bool Remove | ( | string | key | ) |
Remove a value with the specified key.
As this dictionary is read-only, Remove will always raise a NotSupportedException.
key | ignored |
bool TryGetValue | ( | string | key, |
out OverlayPluginInfo | value | ||
) |
Try to get a value from the collection. Will not raise and exception if the specified key does not exist.
key | key of the entry to be retrieved |
value | retrieved value |
|
get |
Access overlay plugin by means of a numerical index
index | index of the item to get |
ArgumentOutOfRangeException | If index is out of range. |
|
getset |
Retrieve overlay plugin information by means of a string key containing the plugin's friendly name
key |
NotSupportedException | when trying to invoke the set accessor of the indexer (this collection is strictly read-only). |