Dictionary<T,U>
Overview
Dictionary implementation maps a given unique key of type T to a value of type U.
Location
- Reference: Island.fx
- Namespace: RemObjects.Elements.System
- Ancestry: ImmutableDictionary<T,U> | Dictionary<T,U>
constructor
constructor
Dictionary<T,U>()
init()
Dictionary<T,U>()
Sub New()
constructor (Int32)
constructor(aCapacity: Int32)
Dictionary<T,U>(Int32 aCapacity)
init(_ aCapacity: Int32)
Dictionary<T,U>(Int32 aCapacity)
Sub New(aCapacity As Int32)
Parameters:
- aCapacity:
constructor (Int32, nullable RemObjects.Elements.System.IEqualityComparer<T>)
Constructor with non default equality comparer and initial capacity.
constructor(aCapacity: Int32; aComparer: nullable RemObjects.Elements.System.IEqualityComparer<T>)
Dictionary<T,U>(Int32 aCapacity, RemObjects.Elements.System.IEqualityComparer<T>? aComparer)
init(_ aCapacity: Int32, _ aComparer: RemObjects.Elements.System.IEqualityComparer<T>?)
Dictionary<T,U>(Int32 aCapacity, RemObjects.Elements.System.IEqualityComparer<T> aComparer)
Sub New(aCapacity As Int32, aComparer As RemObjects.Elements.System.IEqualityComparer<T>?)
Parameters:
- aCapacity: The initial capacity.
- aComparer: The comparer to use.
constructor (nullable RemObjects.Elements.System.IEqualityComparer<T>)
constructor(aComparer: nullable RemObjects.Elements.System.IEqualityComparer<T>)
Dictionary<T,U>(RemObjects.Elements.System.IEqualityComparer<T>? aComparer)
init(_ aComparer: RemObjects.Elements.System.IEqualityComparer<T>?)
Dictionary<T,U>(RemObjects.Elements.System.IEqualityComparer<T> aComparer)
Sub New(aComparer As RemObjects.Elements.System.IEqualityComparer<T>?)
Parameters:
- aComparer:
constructor (NSDictionary<T, U>) iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, visionOS, visionOS Simulator, watchOS, watchOS Simulator
constructor(aDictionary: NSDictionary<T, U>)
Dictionary<T,U>(NSDictionary<T, U> aDictionary)
init(_ aDictionary: NSDictionary<T, U>)
Dictionary<T,U>(NSDictionary<T, U> aDictionary)
Sub New(aDictionary As NSDictionary<T, U>)
Parameters:
- aDictionary:
constructor (not nullable ImmutableDictionary<T, U>)
constructor(aDictionary: not nullable ImmutableDictionary<T, U>)
Dictionary<T,U>(ImmutableDictionary<T, U>! aDictionary)
init(_ aDictionary: ImmutableDictionary<T, U>)
Dictionary<T,U>(ImmutableDictionary<T, U> aDictionary)
Sub New(aDictionary As ImmutableDictionary<T, U>)
Parameters:
- aDictionary:
constructor (not nullable ImmutableDictionary<T, U>, nullable RemObjects.Elements.System.IEqualityComparer<T>)
Constructor with non default equality comparer and initial capacity.
constructor(aDictionary: not nullable ImmutableDictionary<T, U>; aComparer: nullable RemObjects.Elements.System.IEqualityComparer<T>)
Dictionary<T,U>(ImmutableDictionary<T, U>! aDictionary, RemObjects.Elements.System.IEqualityComparer<T>? aComparer)
init(_ aDictionary: ImmutableDictionary<T, U>, _ aComparer: RemObjects.Elements.System.IEqualityComparer<T>?)
Dictionary<T,U>(ImmutableDictionary<T, U> aDictionary, RemObjects.Elements.System.IEqualityComparer<T> aComparer)
Sub New(aDictionary As ImmutableDictionary<T, U>, aComparer As RemObjects.Elements.System.IEqualityComparer<T>?)
Parameters:
- aDictionary:
- aComparer: The comparer to use.
Add
Adds an item to the dictionary; Fails if Key is already present.
method Add(Key: T; Value: U)
void Add(T Key, U Value)
func Add(_ Key: T, _ Value: U)
void Add(T Key, U Value)
Sub Add(Key As T, Value As U)
Parameters:
- Key: The key for this item
- Value: The value for this item
Clear
method Clear
void Clear()
func Clear()
void Clear()
Sub Clear()
ContainsKey (declared in ImmutableDictionary<T,U>)
Returns true if this key is contained in this dictionary.
method ContainsKey(Key: T): Boolean
Boolean ContainsKey(T Key)
func ContainsKey(_ Key: T) -> Boolean
Boolean ContainsKey(T Key)
Function ContainsKey(Key As T) As Boolean
Parameters:
- Key:
ContainsValue (declared in ImmutableDictionary<T,U>)
Loops the dictionary and returns true if this value is contained in this dictionary.
method ContainsValue(Value: U): Boolean
Boolean ContainsValue(U Value)
func ContainsValue(_ Value: U) -> Boolean
Boolean ContainsValue(U Value)
Function ContainsValue(Value As U) As Boolean
Parameters:
- Value:
Count (declared in ImmutableDictionary<T,U>)
Returns the number of elements in this dictionary.
property Count: Int32 read;
Int32 Count { get; }
var Count: Int32 { get{} }
Int32 Count { __get; }
ReadOnly Property Count() As Int32
Equals virtual (declared in Object)
Default constructor.
Parameters:
- aOther: the reference to compare this with.
Finalize protected virtual (declared in Object)
method Finalize
void Finalize()
func Finalize()
void Finalize()
Sub Finalize()
ForEach (declared in ImmutableDictionary<T,U>)
method ForEach(Action: Action<RemObjects.Elements.System.KeyValuePair<T,U>>)
void ForEach(Action<RemObjects.Elements.System.KeyValuePair<T,U>> Action)
func ForEach(_ Action: Action<RemObjects.Elements.System.KeyValuePair<T,U>>)
void ForEach(Action<RemObjects.Elements.System.KeyValuePair<T,U>> Action)
Sub ForEach(Action As Action<RemObjects.Elements.System.KeyValuePair<T,U>>)
Parameters:
- Action:
GetEnumerator virtual (declared in ImmutableDictionary<T,U>)
Iterator.
method GetEnumerator: IEnumerator<RemObjects.Elements.System.KeyValuePair<T,U>>
IEnumerator<RemObjects.Elements.System.KeyValuePair<T,U>> GetEnumerator()
func GetEnumerator() -> IEnumerator<RemObjects.Elements.System.KeyValuePair<T,U>>
IEnumerator<RemObjects.Elements.System.KeyValuePair<T,U>> GetEnumerator()
Function GetEnumerator() As IEnumerator<RemObjects.Elements.System.KeyValuePair<T,U>>
GetHashCode virtual (declared in Object)
Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.
method GetHashCode: Int32
Int32 GetHashCode()
func GetHashCode() -> Int32
Int32 GetHashCode()
Function GetHashCode() As Int32
GetSequence (declared in ImmutableDictionary<T,U>)
Iterator.
method GetSequence: IEnumerable<RemObjects.Elements.System.KeyValuePair<T,U>>
IEnumerable<RemObjects.Elements.System.KeyValuePair<T,U>> GetSequence()
func GetSequence() -> IEnumerable<RemObjects.Elements.System.KeyValuePair<T,U>>
IEnumerable<RemObjects.Elements.System.KeyValuePair<T,U>> GetSequence()
Function GetSequence() As IEnumerable<RemObjects.Elements.System.KeyValuePair<T,U>>
GetType (declared in Object)
Returns the actual type of this class
method GetType: Type
Type GetType()
func GetType() -> Type
Type GetType()
Function GetType() As Type
Item override virtual
Indexer. Throws an exception if the item for Key is not present.
property Item[Key: T]: U read write;
U Item[T Key] { get; set; }
subscript Item(_ Key: T) -> U { get{} set{} }
U Item[T Key] { __get; __set; }
Property Item(Key As T) As U
Keys (declared in ImmutableDictionary<T,U>)
Iterator on the keys of this dictionary.
property Keys: IEnumerable<T> read;
IEnumerable<T> Keys { get; }
var Keys: IEnumerable<T> { get{} }
IEnumerable<T> Keys { __get; }
ReadOnly Property Keys() As IEnumerable<T>
ReferenceEquals (declared in Object)
Compares two references for equivalence (even if they have an equals operator)
Parameters:
- a: left value
- b: right value
Remove
Removes an item from the dictionary, returns true if it was there.
method Remove(Key: T): Boolean
Boolean Remove(T Key)
func Remove(_ Key: T) -> Boolean
Boolean Remove(T Key)
Function Remove(Key As T) As Boolean
Parameters:
- Key: The key to remove.
ToNSDictionary (declared in ImmutableDictionary<T,U>) iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, visionOS, visionOS Simulator, watchOS, watchOS Simulator
Converts a dictionary to NSDictionary.
method ToNSDictionary: NSDictionary<T, U>
NSDictionary<T, U> ToNSDictionary()
func ToNSDictionary() -> NSDictionary<T, U>
NSDictionary<T, U> ToNSDictionary()
Function ToNSDictionary() As NSDictionary<T, U>
ToNSMutableDictionary (declared in ImmutableDictionary<T,U>) iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, visionOS, visionOS Simulator, watchOS, watchOS Simulator
Converts a dictionary to NSMutableDictionary.
method ToNSMutableDictionary: NSMutableDictionary<T, U>
NSMutableDictionary<T, U> ToNSMutableDictionary()
func ToNSMutableDictionary() -> NSMutableDictionary<T, U>
NSMutableDictionary<T, U> ToNSMutableDictionary()
Function ToNSMutableDictionary() As NSMutableDictionary<T, U>
ToString virtual (declared in Object)
Gets the string representation of this method.
method ToString: String
String ToString()
func ToString() -> String
String ToString()
Function ToString() As String
TryGetValue (declared in ImmutableDictionary<T,U>)
Gets a value from the dictionary by key, or returns false if it's not in the dictionary.
method TryGetValue(aKey: T; out aValue: U): Boolean
Boolean TryGetValue(T aKey, out U aValue)
func TryGetValue(_ aKey: T, _ aValue: U) -> Boolean
Boolean TryGetValue(T aKey, __out U aValue)
Function TryGetValue(aKey As T, <OutAttribute> ByRef aValue As U) As Boolean
Parameters:
- aKey:
- aValue:
Values (declared in ImmutableDictionary<T,U>)
Value iterator.
property Values: IEnumerable<U> read;
IEnumerable<U> Values { get; }
var Values: IEnumerable<U> { get{} }
IEnumerable<U> Values { __get; }
ReadOnly Property Values() As IEnumerable<U>
Count (declared in ImmutableDictionary<T,U>)
Returns the number of elements in this dictionary.
property Count: Int32 read;
Int32 Count { get; }
var Count: Int32 { get{} }
Int32 Count { __get; }
ReadOnly Property Count() As Int32
Item override virtual
Indexer. Throws an exception if the item for Key is not present.
property Item[Key: T]: U read write;
U Item[T Key] { get; set; }
subscript Item(_ Key: T) -> U { get{} set{} }
U Item[T Key] { __get; __set; }
Property Item(Key As T) As U
Keys (declared in ImmutableDictionary<T,U>)
Iterator on the keys of this dictionary.
property Keys: IEnumerable<T> read;
IEnumerable<T> Keys { get; }
var Keys: IEnumerable<T> { get{} }
IEnumerable<T> Keys { __get; }
ReadOnly Property Keys() As IEnumerable<T>
Values (declared in ImmutableDictionary<T,U>)
Value iterator.
property Values: IEnumerable<U> read;
IEnumerable<U> Values { get; }
var Values: IEnumerable<U> { get{} }
IEnumerable<U> Values { __get; }
ReadOnly Property Values() As IEnumerable<U>
ReferenceEquals (declared in Object)
Compares two references for equivalence (even if they have an equals operator)
Parameters:
- a: left value
- b: right value
constructor
constructor
Dictionary<T,U>()
init()
Dictionary<T,U>()
Sub New()
constructor (Int32)
constructor(aCapacity: Int32)
Dictionary<T,U>(Int32 aCapacity)
init(_ aCapacity: Int32)
Dictionary<T,U>(Int32 aCapacity)
Sub New(aCapacity As Int32)
Parameters:
- aCapacity:
constructor (Int32, nullable RemObjects.Elements.System.IEqualityComparer<T>)
Constructor with non default equality comparer and initial capacity.
constructor(aCapacity: Int32; aComparer: nullable RemObjects.Elements.System.IEqualityComparer<T>)
Dictionary<T,U>(Int32 aCapacity, RemObjects.Elements.System.IEqualityComparer<T>? aComparer)
init(_ aCapacity: Int32, _ aComparer: RemObjects.Elements.System.IEqualityComparer<T>?)
Dictionary<T,U>(Int32 aCapacity, RemObjects.Elements.System.IEqualityComparer<T> aComparer)
Sub New(aCapacity As Int32, aComparer As RemObjects.Elements.System.IEqualityComparer<T>?)
Parameters:
- aCapacity: The initial capacity.
- aComparer: The comparer to use.
constructor (nullable RemObjects.Elements.System.IEqualityComparer<T>)
constructor(aComparer: nullable RemObjects.Elements.System.IEqualityComparer<T>)
Dictionary<T,U>(RemObjects.Elements.System.IEqualityComparer<T>? aComparer)
init(_ aComparer: RemObjects.Elements.System.IEqualityComparer<T>?)
Dictionary<T,U>(RemObjects.Elements.System.IEqualityComparer<T> aComparer)
Sub New(aComparer As RemObjects.Elements.System.IEqualityComparer<T>?)
Parameters:
- aComparer:
constructor (NSDictionary<T, U>) iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, visionOS, visionOS Simulator, watchOS, watchOS Simulator
constructor(aDictionary: NSDictionary<T, U>)
Dictionary<T,U>(NSDictionary<T, U> aDictionary)
init(_ aDictionary: NSDictionary<T, U>)
Dictionary<T,U>(NSDictionary<T, U> aDictionary)
Sub New(aDictionary As NSDictionary<T, U>)
Parameters:
- aDictionary:
constructor (not nullable ImmutableDictionary<T, U>)
constructor(aDictionary: not nullable ImmutableDictionary<T, U>)
Dictionary<T,U>(ImmutableDictionary<T, U>! aDictionary)
init(_ aDictionary: ImmutableDictionary<T, U>)
Dictionary<T,U>(ImmutableDictionary<T, U> aDictionary)
Sub New(aDictionary As ImmutableDictionary<T, U>)
Parameters:
- aDictionary:
constructor (not nullable ImmutableDictionary<T, U>, nullable RemObjects.Elements.System.IEqualityComparer<T>)
Constructor with non default equality comparer and initial capacity.
constructor(aDictionary: not nullable ImmutableDictionary<T, U>; aComparer: nullable RemObjects.Elements.System.IEqualityComparer<T>)
Dictionary<T,U>(ImmutableDictionary<T, U>! aDictionary, RemObjects.Elements.System.IEqualityComparer<T>? aComparer)
init(_ aDictionary: ImmutableDictionary<T, U>, _ aComparer: RemObjects.Elements.System.IEqualityComparer<T>?)
Dictionary<T,U>(ImmutableDictionary<T, U> aDictionary, RemObjects.Elements.System.IEqualityComparer<T> aComparer)
Sub New(aDictionary As ImmutableDictionary<T, U>, aComparer As RemObjects.Elements.System.IEqualityComparer<T>?)
Parameters:
- aDictionary:
- aComparer: The comparer to use.
Add
Adds an item to the dictionary; Fails if Key is already present.
method Add(Key: T; Value: U)
void Add(T Key, U Value)
func Add(_ Key: T, _ Value: U)
void Add(T Key, U Value)
Sub Add(Key As T, Value As U)
Parameters:
- Key: The key for this item
- Value: The value for this item
Clear
method Clear
void Clear()
func Clear()
void Clear()
Sub Clear()
ContainsKey (declared in ImmutableDictionary<T,U>)
Returns true if this key is contained in this dictionary.
method ContainsKey(Key: T): Boolean
Boolean ContainsKey(T Key)
func ContainsKey(_ Key: T) -> Boolean
Boolean ContainsKey(T Key)
Function ContainsKey(Key As T) As Boolean
Parameters:
- Key:
ContainsValue (declared in ImmutableDictionary<T,U>)
Loops the dictionary and returns true if this value is contained in this dictionary.
method ContainsValue(Value: U): Boolean
Boolean ContainsValue(U Value)
func ContainsValue(_ Value: U) -> Boolean
Boolean ContainsValue(U Value)
Function ContainsValue(Value As U) As Boolean
Parameters:
- Value:
Equals virtual (declared in Object)
Default constructor.
Parameters:
- aOther: the reference to compare this with.
Finalize protected virtual (declared in Object)
method Finalize
void Finalize()
func Finalize()
void Finalize()
Sub Finalize()
ForEach (declared in ImmutableDictionary<T,U>)
method ForEach(Action: Action<RemObjects.Elements.System.KeyValuePair<T,U>>)
void ForEach(Action<RemObjects.Elements.System.KeyValuePair<T,U>> Action)
func ForEach(_ Action: Action<RemObjects.Elements.System.KeyValuePair<T,U>>)
void ForEach(Action<RemObjects.Elements.System.KeyValuePair<T,U>> Action)
Sub ForEach(Action As Action<RemObjects.Elements.System.KeyValuePair<T,U>>)
Parameters:
- Action:
GetEnumerator virtual (declared in ImmutableDictionary<T,U>)
Iterator.
method GetEnumerator: IEnumerator<RemObjects.Elements.System.KeyValuePair<T,U>>
IEnumerator<RemObjects.Elements.System.KeyValuePair<T,U>> GetEnumerator()
func GetEnumerator() -> IEnumerator<RemObjects.Elements.System.KeyValuePair<T,U>>
IEnumerator<RemObjects.Elements.System.KeyValuePair<T,U>> GetEnumerator()
Function GetEnumerator() As IEnumerator<RemObjects.Elements.System.KeyValuePair<T,U>>
GetHashCode virtual (declared in Object)
Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.
method GetHashCode: Int32
Int32 GetHashCode()
func GetHashCode() -> Int32
Int32 GetHashCode()
Function GetHashCode() As Int32
GetSequence (declared in ImmutableDictionary<T,U>)
Iterator.
method GetSequence: IEnumerable<RemObjects.Elements.System.KeyValuePair<T,U>>
IEnumerable<RemObjects.Elements.System.KeyValuePair<T,U>> GetSequence()
func GetSequence() -> IEnumerable<RemObjects.Elements.System.KeyValuePair<T,U>>
IEnumerable<RemObjects.Elements.System.KeyValuePair<T,U>> GetSequence()
Function GetSequence() As IEnumerable<RemObjects.Elements.System.KeyValuePair<T,U>>
GetType (declared in Object)
Returns the actual type of this class
method GetType: Type
Type GetType()
func GetType() -> Type
Type GetType()
Function GetType() As Type
Remove
Removes an item from the dictionary, returns true if it was there.
method Remove(Key: T): Boolean
Boolean Remove(T Key)
func Remove(_ Key: T) -> Boolean
Boolean Remove(T Key)
Function Remove(Key As T) As Boolean
Parameters:
- Key: The key to remove.
ToNSDictionary (declared in ImmutableDictionary<T,U>) iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, visionOS, visionOS Simulator, watchOS, watchOS Simulator
Converts a dictionary to NSDictionary.
method ToNSDictionary: NSDictionary<T, U>
NSDictionary<T, U> ToNSDictionary()
func ToNSDictionary() -> NSDictionary<T, U>
NSDictionary<T, U> ToNSDictionary()
Function ToNSDictionary() As NSDictionary<T, U>
ToNSMutableDictionary (declared in ImmutableDictionary<T,U>) iOS, iOS Simulator, Mac Catalyst, macOS, tvOS, tvOS Simulator, visionOS, visionOS Simulator, watchOS, watchOS Simulator
Converts a dictionary to NSMutableDictionary.
method ToNSMutableDictionary: NSMutableDictionary<T, U>
NSMutableDictionary<T, U> ToNSMutableDictionary()
func ToNSMutableDictionary() -> NSMutableDictionary<T, U>
NSMutableDictionary<T, U> ToNSMutableDictionary()
Function ToNSMutableDictionary() As NSMutableDictionary<T, U>
ToString virtual (declared in Object)
Gets the string representation of this method.
method ToString: String
String ToString()
func ToString() -> String
String ToString()
Function ToString() As String
TryGetValue (declared in ImmutableDictionary<T,U>)
Gets a value from the dictionary by key, or returns false if it's not in the dictionary.
method TryGetValue(aKey: T; out aValue: U): Boolean
Boolean TryGetValue(T aKey, out U aValue)
func TryGetValue(_ aKey: T, _ aValue: U) -> Boolean
Boolean TryGetValue(T aKey, __out U aValue)
Function TryGetValue(aKey As T, <OutAttribute> ByRef aValue As U) As Boolean
Parameters:
- aKey:
- aValue: