NSUserDefaults 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
| NSUserDefaults() |
Default constructor that initializes a new instance of this class with no parameters. |
| NSUserDefaults(NSObjectFlag) |
Constructor to call on derived classes to skip initialization and merely allocate the object. |
| NSUserDefaults(IntPtr) |
A constructor used when creating managed representations of unmanaged objects; Called by the runtime. |
| NSUserDefaults(String) |
Developers should not use this deprecated constructor. |
| NSUserDefaults(String, NSUserDefaultsType) |
Returns a new NSUserDefaults for the specific suite name when passing SuiteName as the type. |
NSUserDefaults()
Default constructor that initializes a new instance of this class with no parameters.
[Foundation.Export("init")]
public NSUserDefaults ();- Attributes
Applies to
NSUserDefaults(NSObjectFlag)
Constructor to call on derived classes to skip initialization and merely allocate the object.
protected NSUserDefaults (Foundation.NSObjectFlag t);new Foundation.NSUserDefaults : Foundation.NSObjectFlag -> Foundation.NSUserDefaultsParameters
Unused sentinel value, pass NSObjectFlag.Empty.
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 the constructor that takes the NSObjectFlag.Empty 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 the NSObjectFlag.Empty path.
In general, if the developer's constructor invokes the NSObjectFlag.Empty base implementation, then it should be calling 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 merely allocates the object and registers the
// C# class with the Objective-C runtime if necessary, but no actual
// initXxx method is invoked, that is done later in the constructor
//
// This is taken from Xamarin.iOS's source code:
//
[Export ("initWithFrame:")]
public UIView (System.Drawing.RectangleF 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
NSUserDefaults(IntPtr)
A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
protected internal NSUserDefaults (IntPtr handle);new Foundation.NSUserDefaults : nativeint -> Foundation.NSUserDefaultsParameters
- handle
-
IntPtr
nativeint
Pointer (handle) to the unmanaged object.
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 the GetNSObject method as it will prevent two instances of a managed object to point to the same native object.
Applies to
NSUserDefaults(String)
Developers should not use this deprecated constructor.
[ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.iOS, 7, 0, ObjCRuntime.PlatformArchitecture.None, null)]
[ObjCRuntime.Deprecated(ObjCRuntime.PlatformName.MacOSX, 10, 10, ObjCRuntime.PlatformArchitecture.None, null)]
public NSUserDefaults (string name);new Foundation.NSUserDefaults : string -> Foundation.NSUserDefaultsParameters
- name
- String
The user name.
- Attributes
Remarks
This method has been deprecated, avoid.
Applies to
NSUserDefaults(String, NSUserDefaultsType)
Returns a new NSUserDefaults for the specific suite name when passing SuiteName as the type.
public NSUserDefaults (string name, Foundation.NSUserDefaultsType type);new Foundation.NSUserDefaults : string * Foundation.NSUserDefaultsType -> Foundation.NSUserDefaultsParameters
- name
- String
The name for your suite (application group)
- type
- NSUserDefaultsType
The type to create. Notice that the UserName is no longer supported.
Remarks
Use this method to create an NSUserDefaults that can be used to share information across applications in a suite, or between an application and its extensions.