NSDictionary NSDictionary Class

Definition

Dictionary that provides mapping from keys to values.

[Foundation.Register("NSDictionary", true)]
public class NSDictionary : Foundation.NSObject, CoreData.INSFetchRequestResult, Foundation.INSMutableCopying, Foundation.INSSecureCoding, IDisposable, System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<Foundation.NSObject,Foundation.NSObject>>, System.Collections.Generic.IDictionary<Foundation.NSObject,Foundation.NSObject>, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<Foundation.NSObject,Foundation.NSObject>>, System.Collections.IDictionary
type NSDictionary = class
    inherit NSObject
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface INSCopying
    interface INSMutableCopying
    interface INSSecureCoding
    interface INSFetchRequestResult
    interface IDictionary
    interface ICollection
    interface IEnumerable
    interface IDictionary<NSObject, NSObject>
    interface ICollection<KeyValuePair<NSObject, NSObject>>
    interface seq<KeyValuePair<NSObject, NSObject>>
Inheritance
NSDictionaryNSDictionary
Derived
Attributes
Implements

Remarks

This is an immutable dictionary, to create mutable ones, use the NSMutableDictionary type.

There is a convenient constructor that takes at least one key and one value, with optional values that will create the dictionary by pairing each key with a value. If you use .NET objects, the keys and values will first be boxed into NSObjects using FromObject(Object).


//
// Using C# objects, strings and ints, produces
// a dictionary with 2 NSString keys, "key1" and "key2"
// and two NSNumbers with the values 1 and 2
//
var dict = new NSDictionary ("key1", 1, "key2", 2);

// // Using NSObjects directly, gives you fine control // var key1 = new NSString ("key1"); var value1 = new NSNumber ((byte) 1); var key2 = new NSString ("key2"); var value2 = new NSNumber ((byte) 2);

var dict2 = new NSDictionary (key1, value1, key2, value2);

Sometimes, you might have already an array of keys and values, so you can use the following factory methods:


var keys = new object [] { "key1", "key2" };
var values = new object [] { "value1", "value2" }:

var dict = NSDictionary.FromObjectsAndKeys (values, keys);

The NSDictionary type implements the ICollection, IDictionary and the generic ICollection and IDictionary interfaces, which makes it convenient to use with existing .NET APIs and also provides indexers that take an NSObject, an NSString or a C# string as well as an enumerator.

In some cases, where you might be iterating over a loop, or you have not surfaced a bound type, but you have the handle to the key, you can use the LowlevelObjectForKey(IntPtr) which takes a handle for the key and returns a handle for the returned object.

Constructors

NSDictionary() NSDictionary()

Default constructor that initializes a new instance of this class with no parameters.

NSDictionary(IntPtr) NSDictionary(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

NSDictionary(NSCoder) NSDictionary(NSCoder)

A constructor that initializes the object from the data stored in the unarchiver object.

NSDictionary(NSDictionary) NSDictionary(NSDictionary)

Creates a new NSDictionary from an existing NSDictionary.

NSDictionary(NSDictionary, Boolean) NSDictionary(NSDictionary, Boolean)
NSDictionary(NSObject, NSObject, NSObject[]) NSDictionary(NSObject, NSObject, NSObject[])

Creates an NSDictionary from a list of NSObject keys and NSObject values.

NSDictionary(NSObjectFlag) NSDictionary(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

NSDictionary(NSUrl) NSDictionary(NSUrl)

Creates a new dictionary from the contents of a PropertyList located at a specified URL.

NSDictionary(NSUrl, NSError) NSDictionary(NSUrl, NSError)
NSDictionary(Object, Object, Object[]) NSDictionary(Object, Object, Object[])

Creates an NSDictionary from a list of keys and values.

NSDictionary(String) NSDictionary(String)

Creates a new dictionary from the contents of a PropertyList located in the specified file.

Properties

Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.

Count Count

Returns the number of keys in the dictionary.

DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
DescriptionInStringsFileFormat DescriptionInStringsFileFormat

The contents of the dictionary, formatted in .strings file format.

Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
Item[NSObject] Item[NSObject]

Returns the value associated from a key in the dictionary, or null if the key is not found.

Item[NSString] Item[NSString]

Returns the value associated from a key in the dictionary, or null if the key is not found.

Item[String] Item[String]

Returns the value associated from a key in the dictionary, or null if the key is not found.

Keys Keys

The set of keys for the NSDictionary.

ObjectEnumerator ObjectEnumerator

An NSEnumerator of the values in the NSDictionary.

RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self Self Inherited from NSObject
Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
Values Values

The array of values in the NSDictionary.

Zone Zone Inherited from NSObject

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) Bind(NSString, NSObject, String, NSDictionary) Inherited from NSObject
Bind(String, NSObject, String, NSDictionary) Bind(String, NSObject, String, NSDictionary) Inherited from NSObject
BindingInfo(String) BindingInfo(String) Inherited from NSObject
BindingOptionDescriptions(String) BindingOptionDescriptions(String) Inherited from NSObject
BindingValueClass(String) BindingValueClass(String) Inherited from NSObject
CommitEditing() CommitEditing() Inherited from NSObject
CommitEditing(NSObject, Selector, IntPtr) CommitEditing(NSObject, Selector, IntPtr) Inherited from NSObject
ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
ContainsKey(NSObject) ContainsKey(NSObject)

Determines whether the specified key exists in the dictionary.

Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
Copy(NSZone) Copy(NSZone)

Performs a copy of the underlying Objective-C object.

DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
EncodeTo(NSCoder) EncodeTo(NSCoder)

Encodes the state of the object on the provided encoder

Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
ExposedBindings() ExposedBindings() Inherited from NSObject
FromDictionary(NSDictionary) FromDictionary(NSDictionary)

Factory method to create a new NSDictionary that is a copy of the specified source NSDictionary.

FromFile(String) FromFile(String)

Creates a new dictionary from the contents of a PropertyList located in the specified file.

FromObjectAndKey(NSObject, NSObject) FromObjectAndKey(NSObject, NSObject)

Factory method to create a new NSDictionary initialized with the specified obj (value) and key.

FromObjectsAndKeys(NSObject[], NSObject[]) FromObjectsAndKeys(NSObject[], NSObject[])

Creates a dictionary from a set of values and keys.

FromObjectsAndKeys(NSObject[], NSObject[], nint) FromObjectsAndKeys(NSObject[], NSObject[], nint)

Creates a dictionary from a set of values and keys.

FromObjectsAndKeys(Object[], Object[]) FromObjectsAndKeys(Object[], Object[])

Creates a dictionary from a set of values and keys.

FromObjectsAndKeys(Object[], Object[], nint) FromObjectsAndKeys(Object[], Object[], nint)

Creates a dictionary from a set of values and keys.

FromUrl(NSUrl) FromUrl(NSUrl)

Creates a new dictionary from the contents of a PropertyList located at a specified URL.

FromUrl(NSUrl, NSError) FromUrl(NSUrl, NSError)
GetBindingInfo(NSString) GetBindingInfo(NSString) Inherited from NSObject
GetBindingOptionDescriptions(NSString) GetBindingOptionDescriptions(NSString) Inherited from NSObject
GetBindingValueClass(NSString) GetBindingValueClass(NSString) Inherited from NSObject
GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetEnumerator() GetEnumerator()
GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
GetSharedKeySetForKeys(NSObject[]) GetSharedKeySetForKeys(NSObject[])

Creates a shared key set for the specified keys.

Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsEqualToDictionary(NSDictionary) IsEqualToDictionary(NSDictionary)

True if the dictionaries have the same number of entries and, for all keys, the values return true for Equals.

IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
KeysForObject(NSObject) KeysForObject(NSObject)

An array, possibly empty, of the keys whose value is equal to the specified obj.

LowlevelObjectForKey(IntPtr) LowlevelObjectForKey(IntPtr)

Low-level key lookup.

MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
MutableCopy(NSZone) MutableCopy(NSZone)

Performs a copy of the underlying Objective-C object.

ObjectDidEndEditing(NSObject) ObjectDidEndEditing(NSObject) Inherited from NSObject
ObjectForKey(NSObject) ObjectForKey(NSObject)

The object mapped to the specified key, or null.

ObjectsForKeys(NSArray, NSObject) ObjectsForKeys(NSArray, NSObject)

An array of objects for the specified keys. If the key is not found, the marker object is placed in the returned array at the appropriate index.

ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
RemoveObserver(NSObject, NSString) RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr) RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String) RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr) RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToFileAttributes() ToFileAttributes()
ToString() ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
TryGetValue(NSObject, NSObject) TryGetValue(NSObject, NSObject)
Unbind(NSString) Unbind(NSString) Inherited from NSObject
Unbind(String) Unbind(String) Inherited from NSObject
ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString) WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)
WriteToFile(String, Boolean) WriteToFile(String, Boolean)

Attempts to write the NSDictionary to the specified path. If useAuxiliaryFile is true, the file is written atomically. Returns success or failure.

WriteToUrl(NSUrl, Boolean) WriteToUrl(NSUrl, Boolean)

Attemps to write the NSDictionary to the specified url, and whether to do so atomically. Returns success or failure.

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32)
ICollection.Count ICollection.Count
ICollection.IsSynchronized ICollection.IsSynchronized
ICollection.SyncRoot ICollection.SyncRoot
ICollection<KeyValuePair<NSObject,NSObject>>.Add(KeyValuePair<NSObject,NSObject>) ICollection<KeyValuePair<NSObject,NSObject>>.Add(KeyValuePair<NSObject,NSObject>)
ICollection<KeyValuePair<NSObject,NSObject>>.Clear() ICollection<KeyValuePair<NSObject,NSObject>>.Clear()
ICollection<KeyValuePair<NSObject,NSObject>>.Contains(KeyValuePair<NSObject,NSObject>) ICollection<KeyValuePair<NSObject,NSObject>>.Contains(KeyValuePair<NSObject,NSObject>)
ICollection<KeyValuePair<NSObject,NSObject>>.CopyTo(KeyValuePair<NSObject,NSObject>[], Int32) ICollection<KeyValuePair<NSObject,NSObject>>.CopyTo(KeyValuePair<NSObject,NSObject>[], Int32)

Creates a copy of this object, allocating memory from the specified zone or from the default zone if the argument is null.

ICollection<KeyValuePair<NSObject,NSObject>>.Count ICollection<KeyValuePair<NSObject,NSObject>>.Count
ICollection<KeyValuePair<NSObject,NSObject>>.IsReadOnly ICollection<KeyValuePair<NSObject,NSObject>>.IsReadOnly
ICollection<KeyValuePair<NSObject,NSObject>>.Remove(KeyValuePair<NSObject,NSObject>) ICollection<KeyValuePair<NSObject,NSObject>>.Remove(KeyValuePair<NSObject,NSObject>)
IDictionary.Add(Object, Object) IDictionary.Add(Object, Object)
IDictionary.Clear() IDictionary.Clear()
IDictionary.Contains(Object) IDictionary.Contains(Object)
IDictionary.GetEnumerator() IDictionary.GetEnumerator()
IDictionary.IsFixedSize IDictionary.IsFixedSize
IDictionary.IsReadOnly IDictionary.IsReadOnly
IDictionary.Item[Object] IDictionary.Item[Object]
IDictionary.Keys IDictionary.Keys
IDictionary.Remove(Object) IDictionary.Remove(Object)
IDictionary.Values IDictionary.Values
IDictionary<NSObject,NSObject>.Add(NSObject, NSObject) IDictionary<NSObject,NSObject>.Add(NSObject, NSObject)
IDictionary<NSObject,NSObject>.Keys IDictionary<NSObject,NSObject>.Keys
IDictionary<NSObject,NSObject>.Remove(NSObject) IDictionary<NSObject,NSObject>.Remove(NSObject)
IDictionary<NSObject,NSObject>.Values IDictionary<NSObject,NSObject>.Values
IEnumerable.GetEnumerator() IEnumerable.GetEnumerator()

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor) ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor) ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel) GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem) ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel) AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel) BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel) EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also