NSAttributedString 类

定义

命名空间:

Foundation

程序集:

Xamarin.iOS.dll

可以使用一组属性进行批注的字符串。

[Foundation.Register("NSAttributedString", true)]
public class NSAttributedString : Foundation.NSObject, AppKit.INSPasteboardReading, AppKit.INSPasteboardWriting, Foundation.INSMutableCopying, Foundation.INSSecureCoding, IDisposable

type NSAttributedString = class
    inherit NSObject
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface INSCopying
    interface INSMutableCopying
    interface INSSecureCoding
    interface INSPasteboardReading
    interface INSPasteboardWriting

继承

Object

NSObject

NSAttributedString

派生

Foundation.NSMutableAttributedString

属性

RegisterAttribute

实现

INSPasteboardReading INSPasteboardWriting INSCoding INSCopying INSMutableCopying INSSecureCoding INativeObject IDisposable

注解

NSAttributedString 类型表示具有统一应用的一系列属性的字符串。

配套 NSMutableAttributedString 类型可用于创建具有重叠属性且可在创建后修改其内容的属性化字符串。

这些类型通常用于将信息附加到指示要使用的字体和颜色的字符串元素，以及呈现属性（如字距调整或如何在特定代码运行中呈现连字）。

这些类不规定字符串中属性的含义或行为，它们只是跟踪属性。 这些属性的实际含义由这些对象的使用者解释。

NSAttributedStrings 是使用字符串和一组属性创建的。 默认构造函数采用字符串和 NSDictionary 对象，其中键表示属性，每个元素上的值表示该特性的值。

为了简化许多常见方案，MonoTouch 提供了具有强类型的构造函数，以轻松创建用于 CoreText 或 UIKit 的属性化字符串。 这些构造函数提供类型安全性，并消除了意外创建后端无法识别的属性而导致的编程错误。

若要创建可用于 CoreText 呈现的 NSAttributedStrings，请创建 类的 CTStringAttributes 实例，将其属性设置为所需的属性，然后使用它调用 NSAttributedString 构造函数。

若要创建可用于 UIKit 呈现的 NSAttributedStrings，请创建 类的 UIStringAttributes 实例，将其属性设置为所需的属性，然后使用它调用 NSAttributedString 构造函数。

以下示例演示如何使用 C# 对象初始值设定项语法初始化 CTStringAttributes 和 UIStringAttributes 来设置属性。 以后可以多次将这些属性用于不同的特性化字符串：

// 
// Using NSAttributedString with CoreText
//
var attributedString = new NSAttributedString ("Hello, world",
       new CTStringAttributes () {
              ForegroundColorFromContext =  true,
              Font = new CTFont ("Arial", 24)
       });

// Pass the NSAttributedString to a CTLine and draw the CTLine.
using (var textLine = new CTLine (attributedString)) {
       textLine.Draw (gctx);
}

// 
// Using NSAttributedString with UIKit
//
var myText = new NSAttributedString ("Hello, world",
       new UIStringAttributes () {
              ForegroundColor =  UIColor.Red,
	      KerningAdjustment = 3
       });
label.AttributedText = myText;

虽然 和 UIStringAttributes 都CTStringAttributes可用于创建以后可与特性化字符串一起使用的属性， 还可以使用 C：Foundation.NSAttributedString (string，UIKit.UIFont，UIKit.UIColor，UIKit.UIColor，UIKit.UIColor，UIKit.NSParagraphStyle，Foundation. NSLigatureType，float，Foundation.NSUnderlineStyle，UIKit.NSShadow，float，Foundation.NSUnderlineStyle 构造函数，具有 C# 命名参数，用于快速创建内联属性化字符串。

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

也可以使用 NSDictionary API 创建 NSAttributedStrings，尽管这不提供任何类型的安全性，也不会防止常见错误。 若要使用它，通常使用以“AttributedName”结尾的各种 NSString 属性，这些属性属于此类。

//
// 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()	不带参数初始化此类的新实例的默认构造函数。
NSAttributedString(IntPtr)	创建非托管对象的托管表示形式时使用的构造函数;由运行时调用。
NSAttributedString(NSAttributedString)	可以使用一组属性进行批注的字符串。
NSAttributedString(NSCoder)	从 unarchiver 对象中存储的数据初始化 对象的构造函数。
NSAttributedString(NSData, NSAttributedStringDocumentAttributes, NSDictionary, NSError)	可以使用一组属性进行批注的字符串。
NSAttributedString(NSData, NSAttributedStringDocumentAttributes, NSError)	可以使用一组属性进行批注的字符串。
NSAttributedString(NSData, NSDictionary, NSDictionary, NSError)	可以使用一组属性进行批注的字符串。
NSAttributedString(NSData, NSError)	可以使用一组属性进行批注的字符串。
NSAttributedString(NSObjectFlag)	用于调用派生类的构造函数，以跳过初始化并仅分配 对象。
NSAttributedString(NSUrl, NSAttributedStringDocumentAttributes, NSDictionary, NSError)	可以使用一组属性进行批注的字符串。
NSAttributedString(NSUrl, NSAttributedStringDocumentAttributes, NSError)	可以使用一组属性进行批注的字符串。
NSAttributedString(NSUrl, NSDictionary, NSDictionary, NSError)	可以使用一组属性进行批注的字符串。
NSAttributedString(NSUrl, NSError)	可以使用一组属性进行批注的字符串。
NSAttributedString(String)	可以使用一组属性进行批注的字符串。
NSAttributedString(String, CTStringAttributes)	创建用于 CoreText 呈现函数的 NSAttributedString。
NSAttributedString(String, NSDictionary)	使用字典中指定的用户定义的属性创建 NSAttributedString。
NSAttributedString(String, UIFont, UIColor, UIColor, UIColor, NSParagraphStyle, NSLigatureType, Single, NSUnderlineStyle, NSShadow, Single, NSUnderlineStyle)	使用参数中的指定属性创建 UIKit 特性化字符串。
NSAttributedString(String, UIStringAttributes)	可以使用一组属性进行批注的字符串。

属性

Class	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
ClassHandle	此类的句柄。
DebugDescription	此对象的开发人员有意义的说明。 (继承自 NSObject)
Description	对象的说明，即 ToString 的 Objective-C 版本。 (继承自 NSObject)
Handle	处理指向非托管对象表示形式的 (指针) 。 (继承自 NSObject)
IsDirectBinding	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
IsProxy	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
Length	此字符串中的字符数。
LowLevelValue	Value 属性的低级别版本返回基础 Objective-C NSString 的句柄。
ReadableTypeIdentifiers	可以使用一组属性进行批注的字符串。
RetainCount	返回对象的当前 Objective-C 保留计数。 (继承自 NSObject)
Self	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
Size	可以使用一组属性进行批注的字符串。
Superclass	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
SuperHandle	用于表示此 NSObject 基类中方法的句柄。 (继承自 NSObject)
TextLayoutSectionOrientation	可以使用一组属性进行批注的字符串。
TextLayoutSectionRange	可以使用一组属性进行批注的字符串。
TextLayoutSectionsAttribute	可以使用一组属性进行批注的字符串。
Value	对象的内容作为字符串。
WritableTypeIdentifiers	可以使用一组属性进行批注的字符串。
WritableTypeIdentifiersForItemProvider	可以使用一组属性进行批注的字符串。
Zone	可以使用一组属性进行批注的字符串。 (继承自 NSObject)

方法

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	使用 NSString keyPath) 注册在外部 (观察到的对象。   观察到的更改将调度到观察者的 对象 ObserveValue(NSString, NSObject, NSDictionary, IntPtr) 方法。 (继承自 NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	使用 string keyPath) 注册在外部 (观察到的对象。   观察到的更改将调度到观察者的 对象 ObserveValue(NSString, NSObject, NSDictionary, IntPtr) 方法。 (继承自 NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	注册一个对象，以便使用任意方法在外部观察到。 (继承自 NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	注册一个对象，以便使用任意方法在外部观察到。 (继承自 NSObject)
AwakeFromNib()	从 nib 文件加载对象后调用。 重写程序必须调用 base。AwakeFromNib () 。 (继承自 NSObject)
BeginInvokeOnMainThread(Action)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	在主 UI 线程上异步调用指定的代码。 (继承自 NSObject)
Bind(NSString, NSObject, String, NSDictionary)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
Bind(String, NSObject, String, NSDictionary)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
BindingInfo(String)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
BindingOptionDescriptions(String)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
BindingValueClass(String)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
CommitEditing()	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
CommitEditing(NSObject, Selector, IntPtr)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
ConformsToProtocol(IntPtr)	调用 以确定此对象是否实现指定的协议。 (继承自 NSObject)
ContainsAttachmentsInRange(NSRange)	可以使用一组属性进行批注的字符串。
Copy()	执行基础 Objective-C 对象的副本。 (继承自 NSObject)
Copy(NSZone)	执行基础 Objective-C 对象的副本。
CreateFrom(NSTextAttachment)	可以使用一组属性进行批注的字符串。
DangerousAutorelease()	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
DangerousRelease()	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
DangerousRetain()	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	指示对多关系的索引发生了更改。 (继承自 NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
DidChangeValue(String)	指示在指定的键上发生了更改。 (继承自 NSObject)
Dispose()	释放 NSObject 对象使用的资源。 (继承自 NSObject)
Dispose(Boolean)	释放 NSObject 对象使用的资源。 (继承自 NSObject)
DoesNotRecognizeSelector(Selector)	指示此对象无法识别指定的选择器。 (继承自 NSObject)
DrawString(CGPoint)	在指定点绘制字符串。
DrawString(CGRect)	可以使用一组属性进行批注的字符串。
DrawString(CGRect, NSStringDrawingOptions, NSStringDrawingContext)	可以使用一组属性进行批注的字符串。
EncodeTo(NSCoder)	在提供的编码器上对对象的状态进行编码
EnumerateAttribute(NSString, NSRange, NSAttributedStringEnumeration, NSAttributedStringCallback)	将回调应用于指定区域中的指定属性。
EnumerateAttributes(NSRange, NSAttributedStringEnumeration, NSAttributedRangeCallback)	将回调应用于指定范围中的所有属性。
Equals(NSObject)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
Equals(Object)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
ExposedBindings()	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
FromAttachment(NSTextAttachment)	可以使用一组属性进行批注的字符串。
GetAttribute(String, nint, NSRange)	可以使用一组属性进行批注的字符串。
GetAttribute(String, nint, NSRange, NSRange)	可以使用一组属性进行批注的字符串。
GetAttributes(nint, NSRange)	可以使用一组属性进行批注的字符串。
GetAttributes(nint, NSRange, NSRange)	可以使用一组属性进行批注的字符串。
GetBindingInfo(NSString)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
GetBindingOptionDescriptions(NSString)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
GetBindingValueClass(NSString)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
GetBoundingRect(CGSize, NSStringDrawingOptions, NSStringDrawingContext)	可以使用一组属性进行批注的字符串。
GetCoreTextAttributes(nint, NSRange)	可以使用一组属性进行批注的字符串。
GetCoreTextAttributes(nint, NSRange, NSRange)	可以使用一组属性进行批注的字符串。
GetDataFromRange(NSRange, NSAttributedStringDocumentAttributes, NSError)	可以使用一组属性进行批注的字符串。
GetDataFromRange(NSRange, NSDictionary, NSError)	d|要添加。
GetDictionaryOfValuesFromKeys(NSString[])	检索指定键的值。 (继承自 NSObject)
GetFileWrapperFromRange(NSRange, NSAttributedStringDocumentAttributes, NSError)	可以使用一组属性进行批注的字符串。
GetFileWrapperFromRange(NSRange, NSDictionary, NSError)	可以使用一组属性进行批注的字符串。
GetHashCode()	为当前实例生成哈希代码。 (继承自 NSObject)
GetItemProviderVisibilityForTypeIdentifier(String)	可以使用一组属性进行批注的字符串。
GetMethodForSelector(Selector)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
GetNativeField(String)	已过时. 可以使用一组属性进行批注的字符串。 (继承自 NSObject)
GetNativeHash()	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
GetObject(NSData, String, NSError)	可以使用一组属性进行批注的字符串。
GetUIKitAttributes(nint, NSRange)	可以使用一组属性进行批注的字符串。
GetUIKitAttributes(nint, NSRange, NSRange)	可以使用一组属性进行批注的字符串。
Init()	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
InitializeHandle(IntPtr)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
InitializeHandle(IntPtr, String)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
Invoke(Action, Double)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
Invoke(Action, TimeSpan)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
InvokeOnMainThread(Action)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
InvokeOnMainThread(Selector, NSObject)	在主 UI 线程上同步调用指定的代码。 (继承自 NSObject)
IsEqual(NSAttributedString)	这是否等于另一个字符串。
IsEqual(NSObject)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
IsKindOfClass(Class)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
IsMemberOfClass(Class)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
LoadData(String, Action<NSData,NSError>)	实现此方法以自定义 通过 NSItemProvider加载数据。
LoadDataAsync(String)	可以使用一组属性进行批注的字符串。
LoadDataAsync(String, NSProgress)	可以使用一组属性进行批注的字符串。
LowLevelGetAttributes(nint, NSRange)	为指定范围中的属性提供 NSDictionary 的低级别版本。
MarkDirty()	将常规对等对象 (IsDirectBinding 为 true) 提升为 toggleref 对象。 (继承自 NSObject)
MutableCopy()	创建指定 NSObject 的可变副本。 (继承自 NSObject)
MutableCopy(NSZone)	执行基础 Objective-C 对象的副本。
ObjectDidEndEditing(NSObject)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	指示指定 keyPath 相对于此对象的值已更改。 (继承自 NSObject)
PerformSelector(Selector)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
PerformSelector(Selector, NSObject)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
PerformSelector(Selector, NSObject, Double)	在当前实例上调用选择器，如果 obj 不为 null，则将其作为单个参数传递。 (继承自 NSObject)
PerformSelector(Selector, NSObject, Double, NSString[])	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
PerformSelector(Selector, NSObject, NSObject)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
PrepareForInterfaceBuilder()	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
RemoveObserver(NSObject, NSString)	阻止指定的观察程序接收指定 keyPath 的更改值的进一步通知。 (继承自 NSObject)
RemoveObserver(NSObject, NSString, IntPtr)	阻止指定的观察程序接收指定 keyPath 和上下文的更改值的进一步通知。 (继承自 NSObject)
RemoveObserver(NSObject, String)	阻止指定的观察程序接收指定 keyPath 的更改值的进一步通知。 (继承自 NSObject)
RemoveObserver(NSObject, String, IntPtr)	阻止指定的观察程序接收指定 keyPath 和上下文的更改值的进一步通知。 (继承自 NSObject)
RespondsToSelector(Selector)	此对象是否识别指定的选择器。 (继承自 NSObject)
SetNativeField(String, NSObject)	已过时. 可以使用一组属性进行批注的字符串。 (继承自 NSObject)
SetNilValueForKey(NSString)	将指定键的值设置为 null。 (继承自 NSObject)
SetValueForKey(NSObject, NSString)	将键指定的属性的值设置为指定值。 (继承自 NSObject)
SetValueForKeyPath(IntPtr, NSString)	创建非托管对象的托管表示形式时使用的构造函数;由运行时调用。 (继承自 NSObject)
SetValueForKeyPath(NSObject, NSString)	设置可使用键路径访问的属性的值。 (继承自 NSObject)
SetValueForUndefinedKey(NSObject, NSString)	指示尝试将值写入未定义的键。 如果未重写，则引发 NSUndefinedKeyException。 (继承自 NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	将此 NSObject 的值设置为指定字典中的值。 (继承自 NSObject)
Substring(nint, nint)	可以使用一组属性进行批注的字符串。
ToString()	返回当前实例值的字符串表示形式。 (继承自 NSObject)
Unbind(NSString)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
Unbind(String)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
ValueForKey(NSString)	返回与指定键关联的属性的值。 (继承自 NSObject)
ValueForKeyPath(NSString)	返回可使用键路径访问的属性的值。 (继承自 NSObject)
ValueForUndefinedKey(NSString)	指示尝试读取未定义键的值。 如果未重写，则引发 NSUndefinedKeyException。 (继承自 NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	指示指定键中指定索引的值即将更改。 (继承自 NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	可以使用一组属性进行批注的字符串。 (继承自 NSObject)
WillChangeValue(String)	指示指定键的值即将更改。 (继承自 NSObject)

扩展方法

GetDebugDescription(INSObjectProtocol)	可以使用一组属性进行批注的字符串。
ContainsAttachments(NSAttributedString, NSRange)	true如果当前NSAttributedString包含指定的 range中的附件，则返回 。
GetAccessibilityCustomRotors(NSObject)	获取适用于 this 对象的 对象的数组UIAccessibilityCustomRotor。
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	设置适用于 this 对象的 对象数组UIAccessibilityCustomRotor。

另请参阅

• NSAttributedStringAttachmentConveniences
• SimpleTextInput
• Apple 文档 NSAttributedString