NSMutableAttributedString Constructors

Definition

Namespace:

Foundation

Assembly:

Xamarin.iOS.dll

Overloads

NSMutableAttributedString()	Default constructor that initializes a new instance of this class with no parameters.
NSMutableAttributedString(String, UIFont, UIColor, UIColor, UIColor, NSParagraphStyle, NSLigatureType, Single, NSUnderlineStyle, NSShadow, Single, NSUnderlineStyle)
NSMutableAttributedString(String, NSDictionary)	Creates an NSMutableAttributedString from a C# string and applies the attributes contained in the NSDictionary to the entire string.
NSMutableAttributedString(String, CTStringAttributes)	Creates an NSMutableAttributedString from a C# string and applies the specified CoreText attributes to the entire string.
NSMutableAttributedString(String)	Creates an NSMutableAttributedString from a C# string, with no attributes attached to it.
NSMutableAttributedString(String, UIStringAttributes)
NSMutableAttributedString(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.
NSMutableAttributedString(NSCoder)	A constructor that initializes the object from the data stored in the unarchiver object.
NSMutableAttributedString(NSAttributedString)	Creates a NSMutableAttributedString from a NSAttributedString.
NSMutableAttributedString(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

NSMutableAttributedString()

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

[Foundation.Export("init")]
public NSMutableAttributedString ();

Attributes

ExportAttribute

NSMutableAttributedString(String, UIFont, UIColor, UIColor, UIColor, NSParagraphStyle, NSLigatureType, Single, NSUnderlineStyle, NSShadow, Single, NSUnderlineStyle)

public NSMutableAttributedString (string str, UIKit.UIFont font = null, UIKit.UIColor foregroundColor = null, UIKit.UIColor backgroundColor = null, UIKit.UIColor strokeColor = null, UIKit.NSParagraphStyle paragraphStyle = null, Foundation.NSLigatureType ligatures = Foundation.NSLigatureType.Default, float kerning = 0, Foundation.NSUnderlineStyle underlineStyle = Foundation.NSUnderlineStyle.PatternSolid, UIKit.NSShadow shadow = null, float strokeWidth = 0, Foundation.NSUnderlineStyle strikethroughStyle = Foundation.NSUnderlineStyle.PatternSolid);

new Foundation.NSMutableAttributedString : string * UIKit.UIFont * UIKit.UIColor * UIKit.UIColor * UIKit.UIColor * UIKit.NSParagraphStyle * Foundation.NSLigatureType * single * Foundation.NSUnderlineStyle * UIKit.NSShadow * single * Foundation.NSUnderlineStyle -> Foundation.NSMutableAttributedString

Parameters

str

String

font

UIFont

foregroundColor

UIColor

backgroundColor

UIColor

strokeColor

UIColor

paragraphStyle

NSParagraphStyle

ligatures

NSLigatureType

kerning

Single

underlineStyle

NSUnderlineStyle

shadow

NSShadow

strokeWidth

Single

strikethroughStyle

NSUnderlineStyle

NSMutableAttributedString(String, NSDictionary)

Creates an NSMutableAttributedString from a C# string and applies the attributes contained in the NSDictionary to the entire string.

[Foundation.Export("initWithString:attributes:")]
public NSMutableAttributedString (string str, Foundation.NSDictionary attributes);

new Foundation.NSMutableAttributedString : string * Foundation.NSDictionary -> Foundation.NSMutableAttributedString

Parameters

str

String

C# string.

attributes

NSDictionary

User-defined attributes as key/value pair dictionary.

This parameter can be null.

Attributes

ExportAttribute

NSMutableAttributedString(String, CTStringAttributes)

Creates an NSMutableAttributedString from a C# string and applies the specified CoreText attributes to the entire string.

public NSMutableAttributedString (string str, CoreText.CTStringAttributes attributes);

new Foundation.NSMutableAttributedString : string * CoreText.CTStringAttributes -> Foundation.NSMutableAttributedString

Parameters

str

String

C# string.

attributes

CTStringAttributes

CoreText attributes to be applied to the string.

NSMutableAttributedString(String)

Creates an NSMutableAttributedString from a C# string, with no attributes attached to it.

[Foundation.Export("initWithString:")]
public NSMutableAttributedString (string str);

new Foundation.NSMutableAttributedString : string -> Foundation.NSMutableAttributedString

Parameters

str

String

C# String

Attributes

ExportAttribute

NSMutableAttributedString(String, UIStringAttributes)

public NSMutableAttributedString (string str, UIKit.UIStringAttributes attributes);

new Foundation.NSMutableAttributedString : string * UIKit.UIStringAttributes -> Foundation.NSMutableAttributedString

Parameters

str

String

attributes

UIStringAttributes

NSMutableAttributedString(NSObjectFlag)

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

protected NSMutableAttributedString (Foundation.NSObjectFlag t);

new Foundation.NSMutableAttributedString : Foundation.NSObjectFlag -> Foundation.NSMutableAttributedString

Parameters

t

NSObjectFlag

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);
}

NSMutableAttributedString(NSCoder)

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

[Foundation.Export("initWithCoder:")]
[ObjCRuntime.DesignatedInitializer]
public NSMutableAttributedString (Foundation.NSCoder coder);

new Foundation.NSMutableAttributedString : Foundation.NSCoder -> Foundation.NSMutableAttributedString

Parameters

coder

NSCoder

The unarchiver object.

Attributes

ExportAttribute DesignatedInitializerAttribute

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 declaration.

The state of this object can also be serialized by using the companion method, EncodeTo.

NSMutableAttributedString(NSAttributedString)

Creates a NSMutableAttributedString from a NSAttributedString.

[Foundation.Export("initWithAttributedString:")]
public NSMutableAttributedString (Foundation.NSAttributedString other);

new Foundation.NSMutableAttributedString : Foundation.NSAttributedString -> Foundation.NSMutableAttributedString

Parameters

other

NSAttributedString

The source attributed string.

Attributes

ExportAttribute

NSMutableAttributedString(IntPtr)

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

protected internal NSMutableAttributedString (IntPtr handle);

new Foundation.NSMutableAttributedString : nativeint -> Foundation.NSMutableAttributedString

Parameters

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.