Interface IDictionary<TKey, TValue>

Represents a generic collection of key/value pairs.

interface IDictionary<TKey, TValue> {
    constructor: any;
    Item: PropertyGet<TKey | JsType<TKey>, JsType<TValue>> & PropertySet<TKey | JsType<TKey>, TValue | JsType<TValue>>;
    get Count(): number;
    get IsReadOnly(): boolean;
    get Keys(): System.Collections.Generic.ICollection<TKey>;
    get Values(): System.Collections.Generic.ICollection<TValue>;
    Add(item: KeyValuePair<TKey, TValue>): void;
    Add(key: TKey | JsType<TKey>, value: TValue | JsType<TValue>): void;
    Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1;
    Clear(): void;
    Contains(item: KeyValuePair<TKey, TValue>): boolean;
    ContainsKey(key: TKey | JsType<TKey>): boolean;
    Remove(item: KeyValuePair<TKey, TValue>): boolean;
    Remove(key: TKey | JsType<TKey>): boolean;
    TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1;
    [iterator](): Iterator<KeyValuePair<TKey, TValue>, any, undefined>;
}

Type Parameters

TKey
TValue

Hierarchy (view full)

IInterfaceBase
System.Collections.Generic.ICollection<KeyValuePair<TKey, TValue>>
System.Collections.Generic.IEnumerable<KeyValuePair<TKey, TValue>>
System.Collections.IEnumerable
- IDictionary

Index

Constructors

constructor

Properties

`Readonly`Item

Item: PropertyGet<TKey | JsType<TKey>, JsType<TValue>> & PropertySet<TKey | JsType<TKey>, TValue | JsType<TValue>>

Gets or sets the element with the specified key.

Param: key

The key of the element to get or set.

Returns

The element with the specified key.

Accessors

Count

get Count(): number
Gets the number of elements contained in the System.Collections.Generic.ICollection.

Returns number
The number of elements contained in the System.Collections.Generic.ICollection.

Inherited from ICollection.Count

IsReadOnly

get IsReadOnly(): boolean
Gets a value indicating whether the System.Collections.Generic.ICollection is read-only.

Returns boolean
true if the System.Collections.Generic.ICollection is read-only; otherwise, false.

Inherited from ICollection.IsReadOnly

Keys

get Keys(): System.Collections.Generic.ICollection<TKey>
Gets an System.Collections.Generic.ICollection containing the keys of the System.Collections.Generic.IDictionary.

Returns System.Collections.Generic.ICollection<TKey>
An System.Collections.Generic.ICollection containing the keys of the object that implements System.Collections.Generic.IDictionary.

Values

get Values(): System.Collections.Generic.ICollection<TValue>
Gets an System.Collections.Generic.ICollection containing the values in the System.Collections.Generic.IDictionary.

Returns System.Collections.Generic.ICollection<TValue>
An System.Collections.Generic.ICollection containing the values in the object that implements System.Collections.Generic.IDictionary.

Methods

Add

Add(item): void
Adds an item to the System.Collections.Generic.ICollection.
Parameters
- item: KeyValuePair<TKey, TValue>
  The object to add to the System.Collections.Generic.ICollection.
Returns void
Overrides ICollection.Add
Add(key, value): void
Adds an element with the provided key and value to the System.Collections.Generic.IDictionary.
Parameters
- key: TKey | JsType<TKey>
  The object to use as the key of the element to add.
- value: TValue | JsType<TValue>
  The object to use as the value of the element to add.
Returns void
Overrides ICollection.Add

Cast

Cast<T1, T2>(this, type): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from IEnumerable.Cast

Clear

Clear(): void
Removes all items from the System.Collections.Generic.ICollection.

Returns void
Inherited from ICollection.Clear

Contains

Contains(item): boolean
Determines whether the System.Collections.Generic.ICollection contains a specific value.
Parameters
- item: KeyValuePair<TKey, TValue>
  The object to locate in the System.Collections.Generic.ICollection.
Returns boolean
true if item is found in the System.Collections.Generic.ICollection; otherwise, false.

Inherited from ICollection.Contains

ContainsKey

ContainsKey(key): boolean
Determines whether the System.Collections.Generic.IDictionary contains an element with the specified key.
Parameters
- key: TKey | JsType<TKey>
  The key to locate in the System.Collections.Generic.IDictionary.
Returns boolean
true if the System.Collections.Generic.IDictionary contains an element with the key; otherwise, false.

Remove

Remove(item): boolean
Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection.
Parameters
- item: KeyValuePair<TKey, TValue>
  The object to remove from the System.Collections.Generic.ICollection.
Returns boolean
true if item was successfully removed from the System.Collections.Generic.ICollection; otherwise, false. This method also returns false if item is not found in the original System.Collections.Generic.ICollection.

Overrides ICollection.Remove
Remove(key): boolean
Removes the element with the specified key from the System.Collections.Generic.IDictionary.
Parameters
- key: TKey | JsType<TKey>
  The key of the element to remove.
Returns boolean
true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original System.Collections.Generic.IDictionary.

Overrides ICollection.Remove

TryCast

TryCast<T1, T2>(this, type): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from IEnumerable.TryCast

[iterator]

[iterator](): Iterator<KeyValuePair<TKey, TValue>, any, undefined>
Returns Iterator<KeyValuePair<TKey, TValue>, any, undefined>
Overrides IEnumerable.[iterator]

Interface IDictionary<TKey, TValue>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

ReadonlyItem

Param: key

Returns

Accessors

Count

Returns number

IsReadOnly

Returns boolean

Keys

Returns System.Collections.Generic.ICollection<TKey>

Values

Returns System.Collections.Generic.ICollection<TValue>

Methods

Add

Parameters

Returns void

Parameters

Returns void

Cast

Type Parameters

Parameters

Returns T1

Clear

Returns void

Contains

Parameters

Returns boolean

ContainsKey

Parameters

Returns boolean

Remove

Parameters

Returns boolean

Parameters

Returns boolean

TryCast

Type Parameters

Parameters

Returns null | T1

[iterator]

Returns Iterator<KeyValuePair<TKey, TValue>, any, undefined>

Settings

On This Page

`Readonly`Item