NSDictionary Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| NSDictionary() |
Creates a new NSDictionary with default values. |
| NSDictionary(Object, Object, Object[]) |
Creates an NSDictionary from a list of keys and values. |
| NSDictionary(NSUrl, NSError) | |
| NSDictionary(NSDictionary, Boolean) | |
| NSDictionary(String) | |
| NSDictionary(NSObject, NSObject, NSObject[]) |
Creates an NSDictionary from a list of NSObject keys and NSObject values. |
| NSDictionary(NSUrl) | |
| NSDictionary(NSObjectFlag) |
Constructor to call on derived classes to skip initialization and merely allocate the object. |
| NSDictionary(NSDictionary) | |
| NSDictionary(NSCoder) |
A constructor that initializes the object from the data stored in the unarchiver object. |
| NSDictionary(NativeHandle) |
A constructor used when creating managed representations of unmanaged objects. Called by the runtime. |
NSDictionary()
Creates a new NSDictionary with default values.
[Foundation.Export("init")]
[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
[ObjCRuntime.DesignatedInitializer]
public NSDictionary();- Attributes
Applies to
NSDictionary(Object, Object, Object[])
Creates an NSDictionary from a list of keys and values.
public NSDictionary(object first, object second, params object[] args);new Foundation.NSDictionary : obj * obj * obj[] -> Foundation.NSDictionaryParameters
- first
- Object
First key.
- second
- Object
First value.
- args
- Object[]
Remaining pais of keys and values.
Remarks
Each C# object is boxed as an NSObject by calling FromObject(Object).
The list of keys and values are used to create the dictionary. The number of parameters passed to this function must be even.
//
// 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);
Applies to
NSDictionary(NSUrl, NSError)
[Foundation.Export("initWithContentsOfURL:error:")]
[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
public NSDictionary(Foundation.NSUrl url, out Foundation.NSError error);[<Foundation.Export("initWithContentsOfURL:error:")>]
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)>]
new Foundation.NSDictionary : Foundation.NSUrl * NSError -> Foundation.NSDictionaryParameters
- url
- NSUrl
- error
- NSError
- Attributes
Applies to
NSDictionary(NSDictionary, Boolean)
[Foundation.Export("initWithDictionary:copyItems:")]
[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
public NSDictionary(Foundation.NSDictionary other, bool copyItems);[<Foundation.Export("initWithDictionary:copyItems:")>]
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)>]
new Foundation.NSDictionary : Foundation.NSDictionary * bool -> Foundation.NSDictionaryParameters
- other
- NSDictionary
- copyItems
- Boolean
- Attributes
Applies to
NSDictionary(String)
[Foundation.Export("initWithContentsOfFile:")]
[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
public NSDictionary(string fileName);[<Foundation.Export("initWithContentsOfFile:")>]
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)>]
new Foundation.NSDictionary : string -> Foundation.NSDictionaryParameters
- fileName
- String
- Attributes
Applies to
NSDictionary(NSObject, NSObject, NSObject[])
Creates an NSDictionary from a list of NSObject keys and NSObject values.
public NSDictionary(Foundation.NSObject first, Foundation.NSObject second, params Foundation.NSObject[] args);new Foundation.NSDictionary : Foundation.NSObject * Foundation.NSObject * Foundation.NSObject[] -> Foundation.NSDictionaryParameters
- first
- NSObject
First key.
- second
- NSObject
First value.
- args
- NSObject[]
Remaining pais of keys and values.
Remarks
The list of keys and values are used to create the dictionary. The number of parameters passed to this function must be even.
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);
Applies to
NSDictionary(NSUrl)
[Foundation.Export("initWithContentsOfURL:")]
[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
public NSDictionary(Foundation.NSUrl url);[<Foundation.Export("initWithContentsOfURL:")>]
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)>]
new Foundation.NSDictionary : Foundation.NSUrl -> Foundation.NSDictionaryParameters
- url
- NSUrl
- Attributes
Applies to
NSDictionary(NSObjectFlag)
Constructor to call on derived classes to skip initialization and merely allocate the object.
[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
protected NSDictionary(Foundation.NSObjectFlag t);[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)>]
new Foundation.NSDictionary : Foundation.NSObjectFlag -> Foundation.NSDictionaryParameters
Unused sentinel value, pass NSObjectFlag.Empty.
- Attributes
Remarks
This constructor should be called by derived classes when they completely construct the object in managed code and merely want the runtime to allocate and initialize the NSObject. This is required to implement the two-step initialization process that Objective-C uses, the first step is to perform the object allocation, the second step is to initialize the object. When developers invoke this constructor, they take advantage of a direct path that goes all the way up to NSObject to merely allocate the object's memory and bind the Objective-C and C# objects together. The actual initialization of the object is up to the developer.
This constructor is typically used by the binding generator to allocate the object, but prevent the actual initialization to take place. Once the allocation has taken place, the constructor has to initialize the object. With constructors generated by the binding generator this means that it manually invokes one of the "init" methods to initialize the object.
It is the developer's responsibility to completely initialize the object if they chain up using this constructor chain.
In general, if the developer's constructor invokes the corresponding base implementation, then it should also call an Objective-C init method. If this is not the case, developers should instead chain to the proper constructor in their class.
The argument value is ignored and merely ensures that the only code that is executed is the construction phase is the basic NSObject allocation and runtime type registration. Typically the chaining would look like this:
//
// The NSObjectFlag constructor merely allocates the object and registers the C# class with the Objective-C runtime if necessary.
// No actual initXxx method is invoked, that is done later in the constructor
//
// This is taken from the iOS SDK's source code for the UIView class:
//
[Export ("initWithFrame:")]
public UIView (CGRect frame) : base (NSObjectFlag.Empty)
{
// Invoke the init method now.
var initWithFrame = new Selector ("initWithFrame:").Handle;
if (IsDirectBinding) {
Handle = ObjCRuntime.Messaging.IntPtr_objc_msgSend_CGRect (this.Handle, initWithFrame, frame);
} else {
Handle = ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_CGRect (this.SuperHandle, initWithFrame, frame);
}
}
Applies to
NSDictionary(NSDictionary)
[Foundation.Export("initWithDictionary:")]
[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
public NSDictionary(Foundation.NSDictionary other);[<Foundation.Export("initWithDictionary:")>]
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)>]
new Foundation.NSDictionary : Foundation.NSDictionary -> Foundation.NSDictionaryParameters
- other
- NSDictionary
- Attributes
Applies to
NSDictionary(NSCoder)
A constructor that initializes the object from the data stored in the unarchiver object.
[Foundation.Export("initWithCoder:")]
[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
[ObjCRuntime.DesignatedInitializer]
public NSDictionary(Foundation.NSCoder coder);[<Foundation.Export("initWithCoder:")>]
[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)>]
[<ObjCRuntime.DesignatedInitializer>]
new Foundation.NSDictionary : Foundation.NSCoder -> Foundation.NSDictionaryParameters
- coder
- NSCoder
The unarchiver object.
- Attributes
Remarks
This constructor is provided to allow the class to be initialized from an unarchiver (for example, during NIB deserialization). This is part of the NSCoding protocol.
If developers want to create a subclass of this object and continue to support deserialization from an archive, they should implement a constructor with an identical signature: taking a single parameter of type NSCoder and decorate it with the [Export("initWithCoder:"] attribute.
The state of this object can also be serialized by using the EncodeTo(NSCoder) companion method.
Applies to
NSDictionary(NativeHandle)
A constructor used when creating managed representations of unmanaged objects. Called by the runtime.
[ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)]
protected internal NSDictionary(ObjCRuntime.NativeHandle handle);[<ObjCRuntime.BindingImpl(ObjCRuntime.BindingImplOptions.GeneratedCode | ObjCRuntime.BindingImplOptions.Optimizable)>]
new Foundation.NSDictionary : ObjCRuntime.NativeHandle -> Foundation.NSDictionaryParameters
- handle
- NativeHandle
Pointer (handle) to the unmanaged object.
- Attributes
Remarks
This constructor is invoked by the runtime infrastructure (GetNSObject(IntPtr)) to create a new managed representation for a pointer to an unmanaged Objective-C object. Developers should not invoke this method directly, instead they should call GetNSObject(IntPtr) as it will prevent two instances of a managed object pointing to the same native object.