IOverlayPaneCollection Interface
Provides the base requirements of an IOverlayPane collection within an IEditorView.
public interface IOverlayPaneCollection : IList<IOverlayPane>, ICollection<IOverlayPane>, IEnumerable<IOverlayPane>, IEnumerable, INotifyCollectionChanged
Properties
Item[String]
Gets the IOverlayPane with the specified key.
[C#] In C#, this property is the indexer for the OverlayPaneCollection
interface.
IOverlayPane this[string key] { get; }
Parameter | Type | Description |
---|---|---|
key | String | The key of the IOverlayPane to return. |
Property Value
- IOverlayPane:
The IOverlayPane with the specified key.
Methods
Contains(String)
Determines whether a IOverlayPane with the specified key is in the collection.
bool Contains(string key)
Parameter | Type | Description |
---|---|---|
key | String | The key to locate in the collection. |
Returns
- Boolean:
true
if a IOverlayPane with the specified key is found in the collection; otherwise,false
.
IndexOf(String)
Searches for a IOverlayPane with the specified key and returns the zero-based index of the first occurrence within the entire collection.
int IndexOf(string key)
Parameter | Type | Description |
---|---|---|
key | String | The key to locate in the collection. |
Returns
- Int32:
The zero-based index of the first occurrence of a IOverlayPane with the specified key within the entire collection, if found; otherwise,
-1
.
Remove(String)
Removes the IOverlayPane with the specified key.
bool Remove(string key)
Parameter | Type | Description |
---|---|---|
key | String | The key to locate in the collection. |
Returns
- Boolean:
true
if a IOverlayPane was removed; otherwise,false
.