NSAttributedString Clase

Definición

Espacio de nombres:

Foundation

Ensamblado:

Xamarin.iOS.dll

Cadenas que se pueden anotar con un conjunto de atributos.

[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

Herencia

Object

NSObject

NSAttributedString

Derivado

Foundation.NSMutableAttributedString

Atributos

RegisterAttribute

Implementaciones

INSPasteboardReading INSPasteboardWriting INSCoding INSCopying INSMutableCopying INSSecureCoding INativeObject IDisposable

Comentarios

El tipo NSAttributedString representa una cadena que tiene una serie de atributos aplicados uniformemente.

El tipo complementario NSMutableAttributedString se puede usar para crear cadenas con atributos con atributos superpuestos y cuyo contenido se puede modificar después de la creación.

Normalmente, estos tipos se usan para adjuntar información a los elementos de la cadena que dictan la fuente y los colores que se usarán, así como para representar atributos como kerning o cómo representar ligaduras en una ejecución específica de código.

Estas clases no dictan el significado ni el comportamiento de los atributos en una cadena, simplemente realizan un seguimiento de los atributos. El consumidor de estos objetos interpreta el significado real de estos atributos.

NSAttributedStrings se crean con una cadena y un conjunto de atributos. El constructor predeterminado toma una cadena y un objeto NSDictionary donde las claves representan los atributos y los valores de cada elemento representan el valor de ese atributo.

Para simplificar muchos escenarios comunes, MonoTouch proporciona constructores con tipos seguros para crear fácilmente cadenas con atributos para su uso con CoreText o UIKit. Estos constructores proporcionan seguridad de tipos y eliminan los errores de programación causados por la creación accidental de atributos que no reconoce un back-end.

Para crear NSAttributedStrings que puede usar con la representación de CoreText, cree una instancia de la CTStringAttributes clase , establezca sus propiedades en los atributos que desee y, a continuación, invoque el constructor NSAttributedString con él.

Para crear NSAttributedStrings que puede usar con la representación de UIKit, cree una instancia de la UIStringAttributes clase , establezca sus propiedades en los atributos que desee y, a continuación, invoque el constructor NSAttributedString con él.

En los ejemplos siguientes se muestra cómo usar la sintaxis del inicializador de objetos de C# para inicializar CTStringAttributes y UIStringAttributes para configurar los atributos. Más adelante puede usar estos atributos varias veces con cadenas con atributos diferentes:

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

Aunque tanto como CTStringAttributesUIStringAttributes son útiles para crear atributos que se pueden usar posteriormente con cadenas con atributos, también es posible usar C:Foundation.NSAttributedString(string,UIKit.UIFont,UIKit.UIColor,UIKit.UIColor,UIKit.UIColor,UIKit.NSParagraphStyle,Foundation.NSLigatureType,float,Foundation.NSUnderlineStyle,UIKit.NSShadow,float,Foundation.NSUnderlineStyle con parámetros con nombre de C# para crear rápidamente cadenas con atributos insertados.

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

También es posible crear NSAttributedStrings con la API de NSDictionary, aunque esto no ofrece ninguna seguridad de tipo ni evita errores comunes. Para usarlo, normalmente se usan las distintas propiedades de NSString que terminan en "AttributedName" que forman parte de esta clase.

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

Constructores

NSAttributedString()	Constructor predeterminado que inicializa una nueva instancia de esta clase sin parámetros.
NSAttributedString(IntPtr)	Constructor utilizado al crear representaciones administradas de objetos no administrados; Llamado por el entorno de ejecución.
NSAttributedString(NSAttributedString)	Cadenas que se pueden anotar con un conjunto de atributos.
NSAttributedString(NSCoder)	Constructor que inicializa el objeto a partir de los datos almacenados en el objeto unarchiver.
NSAttributedString(NSData, NSAttributedStringDocumentAttributes, NSDictionary, NSError)	Cadenas que se pueden anotar con un conjunto de atributos.
NSAttributedString(NSData, NSAttributedStringDocumentAttributes, NSError)	Cadenas que se pueden anotar con un conjunto de atributos.
NSAttributedString(NSData, NSDictionary, NSDictionary, NSError)	Cadenas que se pueden anotar con un conjunto de atributos.
NSAttributedString(NSData, NSError)	Cadenas que se pueden anotar con un conjunto de atributos.
NSAttributedString(NSObjectFlag)	Constructor para llamar a las clases derivadas para omitir la inicialización y simplemente asignar el objeto.
NSAttributedString(NSUrl, NSAttributedStringDocumentAttributes, NSDictionary, NSError)	Cadenas que se pueden anotar con un conjunto de atributos.
NSAttributedString(NSUrl, NSAttributedStringDocumentAttributes, NSError)	Cadenas que se pueden anotar con un conjunto de atributos.
NSAttributedString(NSUrl, NSDictionary, NSDictionary, NSError)	Cadenas que se pueden anotar con un conjunto de atributos.
NSAttributedString(NSUrl, NSError)	Cadenas que se pueden anotar con un conjunto de atributos.
NSAttributedString(String)	Cadenas que se pueden anotar con un conjunto de atributos.
NSAttributedString(String, CTStringAttributes)	Crea un NSAttributedString para su uso con funciones de representación de CoreText.
NSAttributedString(String, NSDictionary)	Crea un NSAttributedString con atributos definidos por el usuario especificados en un diccionario.
NSAttributedString(String, UIFont, UIColor, UIColor, UIColor, NSParagraphStyle, NSLigatureType, Single, NSUnderlineStyle, NSShadow, Single, NSUnderlineStyle)	Crea una cadena con atributos de UIKit con los atributos especificados en los parámetros.
NSAttributedString(String, UIStringAttributes)	Cadenas que se pueden anotar con un conjunto de atributos.

Propiedades

Class	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
ClassHandle	Identificador de esta clase.
DebugDescription	Descripción significativa para el desarrollador de este objeto. (Heredado de NSObject)
Description	Descripción del objeto, la versión objective-C de ToString. (Heredado de NSObject)
Handle	Identificador (puntero) a la representación del objeto no administrado. (Heredado de NSObject)
IsDirectBinding	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
IsProxy	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
Length	Número de caracteres de esta cadena.
LowLevelValue	Versión de bajo nivel de la propiedad Value, devuelve un identificador al NSString de Objective-C subyacente.
ReadableTypeIdentifiers	Cadenas que se pueden anotar con un conjunto de atributos.
RetainCount	Devuelve el recuento de retención actual de Objective-C para el objeto . (Heredado de NSObject)
Self	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
Size	Cadenas que se pueden anotar con un conjunto de atributos.
Superclass	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
SuperHandle	Identificador usado para representar los métodos de la clase base para este NSObject. (Heredado de NSObject)
TextLayoutSectionOrientation	Cadenas que se pueden anotar con un conjunto de atributos.
TextLayoutSectionRange	Cadenas que se pueden anotar con un conjunto de atributos.
TextLayoutSectionsAttribute	Cadenas que se pueden anotar con un conjunto de atributos.
Value	Contenido del objeto como una cadena.
WritableTypeIdentifiers	Cadenas que se pueden anotar con un conjunto de atributos.
WritableTypeIdentifiersForItemProvider	Cadenas que se pueden anotar con un conjunto de atributos.
Zone	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)

Métodos

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	Registra un objeto para que se observe externamente (mediante NSString keyPath).   Los cambios observados se envían al método de objeto ObserveValue(NSString, NSObject, NSDictionary, IntPtr) del observador. (Heredado de NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	Registra un objeto para que se observe externamente (mediante keyPath de cadena).   Los cambios observados se envían al método de objeto ObserveValue(NSString, NSObject, NSDictionary, IntPtr) del observador. (Heredado de NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registra un objeto para que se observe externamente mediante un método arbitrario. (Heredado de NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registra un objeto para que se observe externamente mediante un método arbitrario. (Heredado de NSObject)
AwakeFromNib()	Se llama después de cargar el objeto desde el archivo nib. Los invalidadores deben llamar a base. AwakeFromNib(). (Heredado de NSObject)
BeginInvokeOnMainThread(Action)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invoca de forma asincrónica el código especificado en el subproceso principal de la interfaz de usuario. (Heredado de NSObject)
Bind(NSString, NSObject, String, NSDictionary)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
Bind(String, NSObject, String, NSDictionary)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
BindingInfo(String)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
BindingOptionDescriptions(String)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
BindingValueClass(String)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
CommitEditing()	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
CommitEditing(NSObject, Selector, IntPtr)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
ConformsToProtocol(IntPtr)	Se invoca para determinar si este objeto implementa el protocolo especificado. (Heredado de NSObject)
ContainsAttachmentsInRange(NSRange)	Cadenas que se pueden anotar con un conjunto de atributos.
Copy()	Realiza una copia del objeto Objective-C subyacente. (Heredado de NSObject)
Copy(NSZone)	Realiza una copia del objeto Objective-C subyacente.
CreateFrom(NSTextAttachment)	Cadenas que se pueden anotar con un conjunto de atributos.
DangerousAutorelease()	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
DangerousRelease()	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
DangerousRetain()	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	Indica que se ha producido un cambio en los índices de una relación a varios. (Heredado de NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
DidChangeValue(String)	Indica que se ha producido un cambio en la clave especificada. (Heredado de NSObject)
Dispose()	Libera los recursos usados por el objeto NSObject. (Heredado de NSObject)
Dispose(Boolean)	Libera los recursos usados por el objeto NSObject. (Heredado de NSObject)
DoesNotRecognizeSelector(Selector)	Indica que este objeto no reconoce el selector especificado. (Heredado de NSObject)
DrawString(CGPoint)	Dibuja la cadena en el punto especificado.
DrawString(CGRect)	Cadenas que se pueden anotar con un conjunto de atributos.
DrawString(CGRect, NSStringDrawingOptions, NSStringDrawingContext)	Cadenas que se pueden anotar con un conjunto de atributos.
EncodeTo(NSCoder)	Codifica el estado del objeto en el codificador proporcionado.
EnumerateAttribute(NSString, NSRange, NSAttributedStringEnumeration, NSAttributedStringCallback)	Aplica la devolución de llamada al atributo especificado en el intervalo especificado.
EnumerateAttributes(NSRange, NSAttributedStringEnumeration, NSAttributedRangeCallback)	Aplica la devolución de llamada a todos los atributos del intervalo especificado.
Equals(NSObject)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
Equals(Object)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
ExposedBindings()	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
FromAttachment(NSTextAttachment)	Cadenas que se pueden anotar con un conjunto de atributos.
GetAttribute(String, nint, NSRange)	Cadenas que se pueden anotar con un conjunto de atributos.
GetAttribute(String, nint, NSRange, NSRange)	Cadenas que se pueden anotar con un conjunto de atributos.
GetAttributes(nint, NSRange)	Cadenas que se pueden anotar con un conjunto de atributos.
GetAttributes(nint, NSRange, NSRange)	Cadenas que se pueden anotar con un conjunto de atributos.
GetBindingInfo(NSString)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
GetBindingOptionDescriptions(NSString)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
GetBindingValueClass(NSString)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
GetBoundingRect(CGSize, NSStringDrawingOptions, NSStringDrawingContext)	Cadenas que se pueden anotar con un conjunto de atributos.
GetCoreTextAttributes(nint, NSRange)	Cadenas que se pueden anotar con un conjunto de atributos.
GetCoreTextAttributes(nint, NSRange, NSRange)	Cadenas que se pueden anotar con un conjunto de atributos.
GetDataFromRange(NSRange, NSAttributedStringDocumentAttributes, NSError)	Cadenas que se pueden anotar con un conjunto de atributos.
GetDataFromRange(NSRange, NSDictionary, NSError)	d| Agregar.
GetDictionaryOfValuesFromKeys(NSString[])	Recupera los valores de las claves especificadas. (Heredado de NSObject)
GetFileWrapperFromRange(NSRange, NSAttributedStringDocumentAttributes, NSError)	Cadenas que se pueden anotar con un conjunto de atributos.
GetFileWrapperFromRange(NSRange, NSDictionary, NSError)	Cadenas que se pueden anotar con un conjunto de atributos.
GetHashCode()	Genera un código hash para la instancia actual. (Heredado de NSObject)
GetItemProviderVisibilityForTypeIdentifier(String)	Cadenas que se pueden anotar con un conjunto de atributos.
GetMethodForSelector(Selector)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
GetNativeField(String)	Obsoletos. Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
GetNativeHash()	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
GetObject(NSData, String, NSError)	Cadenas que se pueden anotar con un conjunto de atributos.
GetUIKitAttributes(nint, NSRange)	Cadenas que se pueden anotar con un conjunto de atributos.
GetUIKitAttributes(nint, NSRange, NSRange)	Cadenas que se pueden anotar con un conjunto de atributos.
Init()	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
InitializeHandle(IntPtr)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
InitializeHandle(IntPtr, String)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
Invoke(Action, Double)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
Invoke(Action, TimeSpan)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
InvokeOnMainThread(Action)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
InvokeOnMainThread(Selector, NSObject)	Invoca sincrónicamente el código especificado en el subproceso principal de la interfaz de usuario. (Heredado de NSObject)
IsEqual(NSAttributedString)	Si es igual a la otra cadena.
IsEqual(NSObject)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
IsKindOfClass(Class)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
IsMemberOfClass(Class)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
LoadData(String, Action<NSData,NSError>)	Implemente este método para personalizar la carga de datos mediante .NSItemProvider
LoadDataAsync(String)	Cadenas que se pueden anotar con un conjunto de atributos.
LoadDataAsync(String, NSProgress)	Cadenas que se pueden anotar con un conjunto de atributos.
LowLevelGetAttributes(nint, NSRange)	Versión de bajo nivel que proporciona un NSDictionary para los atributos del intervalo especificado.
MarkDirty()	Promueve un objeto del mismo nivel normal (IsDirectBinding es true) en un objeto toggleref. (Heredado de NSObject)
MutableCopy()	Crea una copia mutable del objeto NSObject especificado. (Heredado de NSObject)
MutableCopy(NSZone)	Realiza una copia del objeto Objective-C subyacente.
ObjectDidEndEditing(NSObject)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	Indica que el valor de keyPath especificado con respecto a este objeto ha cambiado. (Heredado de NSObject)
PerformSelector(Selector)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
PerformSelector(Selector, NSObject)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
PerformSelector(Selector, NSObject, Double)	Invoca el selector en la instancia actual y, si no obj es NULL, lo pasa como su único parámetro. (Heredado de NSObject)
PerformSelector(Selector, NSObject, Double, NSString[])	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
PerformSelector(Selector, NSObject, NSObject)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
PrepareForInterfaceBuilder()	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
RemoveObserver(NSObject, NSString)	Impide que el observador especificado reciba más notificaciones de valores modificados para el keyPath especificado. (Heredado de NSObject)
RemoveObserver(NSObject, NSString, IntPtr)	Impide que el observador especificado reciba más notificaciones de valores modificados para el keyPath y el contexto especificados. (Heredado de NSObject)
RemoveObserver(NSObject, String)	Impide que el observador especificado reciba más notificaciones de valores modificados para el keyPath especificado. (Heredado de NSObject)
RemoveObserver(NSObject, String, IntPtr)	Impide que el observador especificado reciba más notificaciones de valores modificados para el keyPath y el contexto especificados. (Heredado de NSObject)
RespondsToSelector(Selector)	Si este objeto reconoce el selector especificado. (Heredado de NSObject)
SetNativeField(String, NSObject)	Obsoletos. Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
SetNilValueForKey(NSString)	Establece el valor de la clave especificada en NULL. (Heredado de NSObject)
SetValueForKey(NSObject, NSString)	Establece el valor de la propiedad especificada por la clave en el valor especificado. (Heredado de NSObject)
SetValueForKeyPath(IntPtr, NSString)	Constructor utilizado al crear representaciones administradas de objetos no administrados; Llamado por el entorno de ejecución. (Heredado de NSObject)
SetValueForKeyPath(NSObject, NSString)	Establece el valor de una propiedad que se puede alcanzar mediante una ruta de acceso de claves. (Heredado de NSObject)
SetValueForUndefinedKey(NSObject, NSString)	Indica un intento de escribir un valor en una clave no definida. Si no se reemplaza, genera una excepción NSUndefinedKeyException. (Heredado de NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	Establece los valores de este NSObject en los del diccionario especificado. (Heredado de NSObject)
Substring(nint, nint)	Cadenas que se pueden anotar con un conjunto de atributos.
ToString()	Devuelve una representación de cadena del valor de la instancia actual. (Heredado de NSObject)
Unbind(NSString)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
Unbind(String)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
ValueForKey(NSString)	Devuelve el valor de la propiedad asociada a la clave especificada. (Heredado de NSObject)
ValueForKeyPath(NSString)	Devuelve el valor de una propiedad que se puede alcanzar mediante una ruta de acceso de clave. (Heredado de NSObject)
ValueForUndefinedKey(NSString)	Indica un intento de leer un valor de una clave no definida. Si no se reemplaza, genera una excepción NSUndefinedKeyException. (Heredado de NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	Indica que los valores de los índices especificados en la clave especificada están a punto de cambiar. (Heredado de NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	Cadenas que se pueden anotar con un conjunto de atributos. (Heredado de NSObject)
WillChangeValue(String)	Indica que el valor de la clave especificada está a punto de cambiar. (Heredado de NSObject)

Métodos de extensión

GetDebugDescription(INSObjectProtocol)	Cadenas que se pueden anotar con un conjunto de atributos.
ContainsAttachments(NSAttributedString, NSRange)	Devuelve true si el objeto actual NSAttributedString contiene datos adjuntos en el especificado range.
GetAccessibilityCustomRotors(NSObject)	Obtiene la matriz de UIAccessibilityCustomRotor objetos adecuados para this el objeto .
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Establece la matriz de UIAccessibilityCustomRotor objetos adecuados para this el objeto .

Consulte también

• NSAttributedStringAttachmentConveniences
• SimpleTextInput
• Documentación de Apple para NSAttributedString