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 類型可用來建立具有重迭屬性的屬性字串，並在建立之後修改其內容。

這些類型通常用來將資訊附加至字串的專案，這些元素會指定要使用的字型和色彩，以及轉譯屬性，例如 kerning，或如何在特定程式碼執行時轉譯連字。

這些類別不會指定字串上屬性的意義或行為，它們只會追蹤屬性。 這些屬性的實際意義是由這些物件的取用者所解譯。

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)	建立 Unmanaged 物件的 Managed 標記法時所使用的建構函式;由執行時間呼叫。
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)	建立 NSAttributedString 以搭配 CoreText 轉譯函式使用。
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	處理 unmanaged 物件標記法) (指標。 (繼承來源 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)	使用字串 keyPath) ，註冊物件以供外部觀察 (。   觀察到的變更會分派至觀察者的 物件 ObserveValue(NSString, NSObject, NSDictionary, IntPtr) 方法。 (繼承來源 NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	註冊物件，以使用任意方法在外部觀察。 (繼承來源 NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	註冊物件，以使用任意方法在外部觀察。 (繼承來源 NSObject)
AwakeFromNib()	從 nib 檔案載入物件之後呼叫。 覆寫程式必須呼叫基底。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)	建立 Unmanaged 物件的 Managed 標記法時所使用的建構函式;由執行時間呼叫。 (繼承來源 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