NSAttributedString Constructors

Definition

Namespace:

Foundation

Assembly:

Xamarin.iOS.dll

Overloads

NSAttributedString()	Default constructor that initializes a new instance of this class with no parameters.
NSAttributedString(NSData, NSDictionary, NSDictionary, NSError)
NSAttributedString(NSUrl, NSDictionary, NSDictionary, NSError)
NSAttributedString(NSUrl, NSAttributedStringDocumentAttributes, NSDictionary, NSError)
NSAttributedString(NSData, NSAttributedStringDocumentAttributes, NSDictionary, NSError)
NSAttributedString(NSUrl, NSAttributedStringDocumentAttributes, NSError)
NSAttributedString(NSData, NSAttributedStringDocumentAttributes, NSError)
NSAttributedString(String, UIStringAttributes)
NSAttributedString(String, UIFont, UIColor, UIColor, UIColor, NSParagraphStyle, NSLigatureType, Single, NSUnderlineStyle, NSShadow, Single, NSUnderlineStyle)	Creates a UIKit attributed string with the specified attributes in the parameters.
NSAttributedString(String, NSDictionary)	Creates an NSAttributedString with user defined attributes specified in a dictionary.
NSAttributedString(NSUrl, NSError)
NSAttributedString(NSData, NSError)
NSAttributedString(String)
NSAttributedString(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
NSAttributedString(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.
NSAttributedString(NSCoder)	A constructor that initializes the object from the data stored in the unarchiver object.
NSAttributedString(NSAttributedString)
NSAttributedString(String, CTStringAttributes)	Creates an NSAttributedString for use with CoreText rendering functions.

NSAttributedString()

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

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

Attributes

ExportAttribute

NSAttributedString(NSData, NSDictionary, NSDictionary, NSError)

[Foundation.Export("initWithData:options:documentAttributes:error:")]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 7, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public NSAttributedString (Foundation.NSData data, Foundation.NSDictionary options, out Foundation.NSDictionary resultDocumentAttributes, ref Foundation.NSError error);

new Foundation.NSAttributedString : Foundation.NSData * Foundation.NSDictionary *  *  -> Foundation.NSAttributedString

Parameters

data

NSData

options

NSDictionary

To be added.

This parameter can be null.

resultDocumentAttributes

NSDictionary

error

NSError

Attributes

ExportAttribute IntroducedAttribute

NSAttributedString(NSUrl, NSDictionary, NSDictionary, NSError)

public NSAttributedString (Foundation.NSUrl url, Foundation.NSDictionary options, out Foundation.NSDictionary resultDocumentAttributes, out Foundation.NSError error);

new Foundation.NSAttributedString : Foundation.NSUrl * Foundation.NSDictionary *  *  -> Foundation.NSAttributedString

Parameters

url

NSUrl

options

NSDictionary

To be added.

This parameter can be null.

resultDocumentAttributes

NSDictionary

error

NSError

NSAttributedString(NSUrl, NSAttributedStringDocumentAttributes, NSDictionary, NSError)

[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 7, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public NSAttributedString (Foundation.NSUrl url, Foundation.NSAttributedStringDocumentAttributes options, out Foundation.NSDictionary resultDocumentAttributes, out Foundation.NSError error);

new Foundation.NSAttributedString : Foundation.NSUrl * Foundation.NSAttributedStringDocumentAttributes *  *  -> Foundation.NSAttributedString

Parameters

url

NSUrl

options

NSAttributedStringDocumentAttributes

resultDocumentAttributes

NSDictionary

error

NSError

Attributes

IntroducedAttribute

NSAttributedString(NSData, NSAttributedStringDocumentAttributes, NSDictionary, NSError)

[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 7, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public NSAttributedString (Foundation.NSData data, Foundation.NSAttributedStringDocumentAttributes options, out Foundation.NSDictionary resultDocumentAttributes, out Foundation.NSError error);

new Foundation.NSAttributedString : Foundation.NSData * Foundation.NSAttributedStringDocumentAttributes *  *  -> Foundation.NSAttributedString

Parameters

data

NSData

options

NSAttributedStringDocumentAttributes

resultDocumentAttributes

NSDictionary

error

NSError

Attributes

IntroducedAttribute

NSAttributedString(NSUrl, NSAttributedStringDocumentAttributes, NSError)

public NSAttributedString (Foundation.NSUrl url, Foundation.NSAttributedStringDocumentAttributes documentAttributes, ref Foundation.NSError error);

new Foundation.NSAttributedString : Foundation.NSUrl * Foundation.NSAttributedStringDocumentAttributes *  -> Foundation.NSAttributedString

Parameters

url

NSUrl

documentAttributes

NSAttributedStringDocumentAttributes

error

NSError

NSAttributedString(NSData, NSAttributedStringDocumentAttributes, NSError)

public NSAttributedString (Foundation.NSData data, Foundation.NSAttributedStringDocumentAttributes documentAttributes, ref Foundation.NSError error);

new Foundation.NSAttributedString : Foundation.NSData * Foundation.NSAttributedStringDocumentAttributes *  -> Foundation.NSAttributedString

Parameters

data

NSData

documentAttributes

NSAttributedStringDocumentAttributes

error

NSError

NSAttributedString(String, UIStringAttributes)

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

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

Parameters

str

String

attributes

UIStringAttributes

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

Creates a UIKit attributed string with the specified attributes in the parameters.

public NSAttributedString (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.NSAttributedString : string * UIKit.UIFont * UIKit.UIColor * UIKit.UIColor * UIKit.UIColor * UIKit.NSParagraphStyle * Foundation.NSLigatureType * single * Foundation.NSUnderlineStyle * UIKit.NSShadow * single * Foundation.NSUnderlineStyle -> Foundation.NSAttributedString

Parameters

str

String

String to create.

font

UIFont

Desired font (or null, if none is desired).

foregroundColor

UIColor

Desired foreground color (or null if none is desired).

backgroundColor

UIColor

Desired background color (or null if none is desired)..

strokeColor

UIColor

Desired stroke color (or null if none is desired).

paragraphStyle

NSParagraphStyle

ligatures

NSLigatureType

kerning

Single

underlineStyle

NSUnderlineStyle

shadow

NSShadow

Desired shadow.

strokeWidth

Single

Desired stroked width..

strikethroughStyle

NSUnderlineStyle

Remarks

This is the recommended constructor for NSAttributedString objects that are intended to be unique.

The advantage of this constructor is that other than the string, every parameter is optional. It provides a convenient way of creating the objects

//
// This example shows how to create an NSAttributedString for
// use with UIKit without creating the attributes separately
//
var text = new NSAttributedString (
    "Hello, World",
    font: UIFont.FromName ("HoeflerText-Regular", 24.0f),
    foregroundColor: UIColor.Red,
    strokeWidth: 4
);

For cases where the same attributes will be reused across multiple attributed strings, it is best to create the attributes using the UIStringAttributes class as that will share the same dictionary across multiple uses while this constructor creates a dictionary on demand for the specified attributes in the constructor.

NSAttributedString(String, NSDictionary)

Creates an NSAttributedString with user defined attributes specified in a dictionary.

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

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

Parameters

str

String

Strings

attributes

NSDictionary

Dictionary containing the attributes (keys) and their values attached to the strings.

This parameter can be null.

Attributes

ExportAttribute

Remarks

//
// This example shows how to create an NSAttributedString for
// use with UIKit using NSDictionaries
//
var dict = new NSMutableDictionary () {
    { NSAttributedString.FontAttributeName, UIFont.FromName ("HoeflerText-Regular", 24.0f), },
    { NSAttributedString.ForegroundColorAttributeName, UIColor.Black }
};

var text = new NSAttributedString (
	"Hello, World", dict);

NSAttributedString(NSUrl, NSError)

public NSAttributedString (Foundation.NSUrl url, ref Foundation.NSError error);

new Foundation.NSAttributedString : Foundation.NSUrl *  -> Foundation.NSAttributedString

Parameters

url

NSUrl

error

NSError

NSAttributedString(NSData, NSError)

public NSAttributedString (Foundation.NSData data, ref Foundation.NSError error);

new Foundation.NSAttributedString : Foundation.NSData *  -> Foundation.NSAttributedString

Parameters

data

NSData

error

NSError

NSAttributedString(String)

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

new Foundation.NSAttributedString : string -> Foundation.NSAttributedString

Parameters

str

String

Attributes

ExportAttribute

NSAttributedString(IntPtr)

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

protected internal NSAttributedString (IntPtr handle);

new Foundation.NSAttributedString : nativeint -> Foundation.NSAttributedString

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.

NSAttributedString(NSObjectFlag)

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

protected NSAttributedString (Foundation.NSObjectFlag t);

new Foundation.NSAttributedString : Foundation.NSObjectFlag -> Foundation.NSAttributedString

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

NSAttributedString(NSCoder)

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

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

new Foundation.NSAttributedString : Foundation.NSCoder -> Foundation.NSAttributedString

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.

NSAttributedString(NSAttributedString)

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

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

Parameters

other

NSAttributedString

Attributes

ExportAttribute

NSAttributedString(String, CTStringAttributes)

Creates an NSAttributedString for use with CoreText rendering functions.

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

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

Parameters

str

String

String.

attributes

CTStringAttributes

CoreText string attributes.