OverlayDictionary Class

CVB.Net Documentation

Dictionary that provides access to the list of installed CVB overlay plugins.

Inheritance Hierarchy

SystemObject
Stemmer.Cvb.Forms.OverlaysOverlayDictionary

Namespace: Stemmer.Cvb.Forms.Overlays
Assembly: Stemmer.Cvb.Forms (in Stemmer.Cvb.Forms.dll) Version: 14.0.0.0

Syntax

public sealed class OverlayDictionary : IDictionary<string, OverlayPluginInfo>, 
	ICollection<KeyValuePair<string, OverlayPluginInfo>>, IEnumerable<KeyValuePair<string, OverlayPluginInfo>>, 
	IEnumerable

Public NotInheritable Class OverlayDictionary
	Implements IDictionary(Of String, OverlayPluginInfo), 
	ICollection(Of KeyValuePair(Of String, OverlayPluginInfo)), IEnumerable(Of KeyValuePair(Of String, OverlayPluginInfo)), 
	IEnumerable

public ref class OverlayDictionary sealed : IDictionary<String^, OverlayPluginInfo>, 
	ICollection<KeyValuePair<String^, OverlayPluginInfo>>, IEnumerable<KeyValuePair<String^, OverlayPluginInfo>>, 
	IEnumerable

[<SealedAttribute>]
type OverlayDictionary =  
    class
        interface IDictionary<string, OverlayPluginInfo>
        interface ICollection<KeyValuePair<string, OverlayPluginInfo>>
        interface IEnumerable<KeyValuePair<string, OverlayPluginInfo>>
        interface IEnumerable
    end

The OverlayDictionary type exposes the following members.

Constructors

	Name	Description
	OverlayDictionary	Initializes a new instance of the OverlayDictionary class

Top

Properties

	Name	Description
	Count	Number of available overlay plugins.
	IsReadOnly	This collection is read-only
	ItemInt32	Access overlay plugin by means of a numerical index
	ItemString	Retrieve overlay plugin information by means of a string key containing the plugin's friendly name
	Keys	Get the collection of keys in the dictionary
	Values	Get the collection of values in the dictionary

Top

Methods

	Name	Description
	Add(KeyValuePairString, OverlayPluginInfo)	Will raise a NotSupportedException because this dictionary is read only.
	Add(String, OverlayPluginInfo)	Add a new entry.
	Clear	Will raise a NotSupportedException because this dictionary is readonly.
	Contains	Check if a specific entry is part of the collection
	ContainsKey	Check if a specific key exists in the collection
	CopyTo	copy the contents of the collection into an array
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetEnumerator	Enumeration implementation
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Remove(KeyValuePairString, OverlayPluginInfo)	Remove an entry from the dictionary
	Remove(String)	Remove a value with the specified key.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetValue	Try to get a value from the collection. Will not raise and exception if the specified key does not exist.

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableGetEnumerator	Enumeration implementation.

Top

Remarks

Not to be used directly; access through the property Display.InstalledOverlays instead!

Reference

Stemmer.Cvb.Forms.Overlays Namespace