NSTextStorage Class

Definition

Namespace:: AppKit

Assembly:: Microsoft.macOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A subclass of NSMutableAttributedString that supports Core Text layout management.

[Foundation.Register("NSTextStorage", true)]
public class NSTextStorage : Foundation.NSMutableAttributedString, IDisposable

[<Foundation.Register("NSTextStorage", true)>]
type NSTextStorage = class
    inherit NSMutableAttributedString
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface INSSecureCoding

Inheritance: Object

NSObject

NSAttributedString

NSMutableAttributedString
NSTextStorage

Attributes: RegisterAttribute

Implements: INSCoding INSSecureCoding INativeObject IDisposable

Remarks

iOS 7 introduced "Text Kit," a broad set of APIs and modifications of existing classes, built on CoreText, that greatly expands the typographical flexibility of iOS.

An NSTextStorage object holds the text that is to be displayed. As with NSMutableAttributedString, application developers can manipulate text styles using AddAttribute(NSString, NSObject, NSRange) or AddAttributes(NSDictionary, NSRange). The key addition to NSTextStorage is that it maintains references to one or more NSLayoutManagers (LayoutManagers) , which are responsible for converting text characters into glyphs and laying them out in accordance with the NSLayoutManagers' associated NSTextView and NSTextContainer objects.

If you subclass NSTextStorage, you must override four methods. Two from NSAttributedString (LowLevelValue and LowLevelGetAttributes(IntPtr, NSRange)) and two from NSMutableAttributedString (LowLevelSetAttributes(IntPtr, NSRange) and Replace(NSRange, String)).

The reason why you must override the low-level methods is because NSTextStorage is a very chatty interface that likes to call those methods up to thousands of times for each character that the user enters. So it important to use the low-level interface. You can review some of Xamarin's samples to see how to implement those if you have questions on how to do this.

Constructors

Name	Description
NSTextStorage()	Creates a new NSTextStorage with default values.
NSTextStorage(NativeHandle)	A constructor used when creating managed representations of unmanaged objects. Called by the runtime.
NSTextStorage(NSAttributedString)
NSTextStorage(NSCoder)	A constructor that initializes the object from the data stored in the unarchiver object.
NSTextStorage(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.
NSTextStorage(String, CTStringAttributes)
NSTextStorage(String, NSDictionary)
NSTextStorage(String)

Properties

Name	Description
AttributedStringByInflectingString	(Inherited from NSAttributedString)
ChangeInLength	The change in length for the pending changes.
Class	(Inherited from NSObject)
ClassHandle	The Objective-C class handle for this class.
ContainsAttachments	(Inherited from NSAttributedString)
DebugDescription	(Inherited from NSObject)
Delegate	An instance of the UIKit.INSTextStorageDelegate model class which acts as the class delegate.
Description	(Inherited from NSObject)
EditedMask	The kinds of edits pending for this NSTextStorage.
EditedRange	The range in this NSTextStorage in which pending changes have been made.
ExposedBindings	(Inherited from NSObject)
FixesAttributesLazily	Whether this NSTextStorage fixes attributes lazily. Read-only.
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
IsDirectBinding	(Inherited from NSObject)
IsProxy	(Inherited from NSObject)
LayoutManagers	The NSLayoutManagers associated with this NSTextStorage. Read-only.
Length	(Inherited from NSAttributedString)
LowLevelValue	(Inherited from NSAttributedString)
MutableString	(Inherited from NSMutableAttributedString)
RetainCount	(Inherited from NSObject)
Self	(Inherited from NSObject)
Size	(Inherited from NSAttributedString)
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
TextStorageObserver
Value	Contents of the object as a string. (Inherited from NSAttributedString)
WeakDelegate
Zone	(Inherited from NSObject)

Methods

Name	Description
AddAttribute(NSString, NSObject, NSRange)	(Inherited from NSMutableAttributedString)
AddAttributes(CTStringAttributes, NSRange)	Adds an attribute and its value to the specified range of characters in the string. (Inherited from NSMutableAttributedString)
AddAttributes(NSDictionary, NSRange)	(Inherited from NSMutableAttributedString)
AddAttributes(NSStringAttributes, NSRange)	(Inherited from NSMutableAttributedString)
AddLayoutManager(NSLayoutManager)	Adds an NSLayoutManager to this NSTextStorage.
AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
Append(NSAttributedString, Object[])	(Inherited from NSMutableAttributedString)
Append(NSAttributedString)	(Inherited from NSMutableAttributedString)
AwakeFromNib()	(Inherited from NSObject)
BeginEditing()	(Inherited from NSMutableAttributedString)
BeginInvokeOnMainThread(Action)	(Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject)
Bind(NSString, NSObject, String, NSBindingOptions)	(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary)	(Inherited from NSObject)
BoundingRectWithSize(CGSize, NSStringDrawingOptions)	(Inherited from NSAttributedString)
CommitEditing()	(Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr)	(Inherited from NSObject)
ConformsToProtocol(NativeHandle)	(Inherited from NSObject)
ContainsAttachmentsInRange(NSRange)	(Inherited from NSAttributedString)
Copy()	(Inherited from NSObject)
Copy(NSZone)	Performs a copy of the underlying Objective-C object. (Inherited from NSAttributedString)
DangerousAutorelease()	Calls the 'autorelease' selector on this object. (Inherited from NSObject)
DangerousRelease()	Calls the 'release' selector on this object. (Inherited from NSObject)
DangerousRetain()	Calls the 'retain' selector on this object. (Inherited from NSObject)
DeleteRange(NSRange)	(Inherited from NSMutableAttributedString)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	(Inherited from NSObject)
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)
DoesNotRecognizeSelector(Selector)	(Inherited from NSObject)
DoubleClick(UIntPtr)	(Inherited from NSAttributedString)
DrawString(CGPoint)	Draws the string at the specified point. (Inherited from NSAttributedString)
DrawString(CGRect, NSStringDrawingOptions)	(Inherited from NSAttributedString)
DrawString(CGRect)	(Inherited from NSAttributedString)
Edited(NSTextStorageEditActions, NSRange, IntPtr)	Indicates a change.
EncodeTo(NSCoder)	Encodes the state of the object using the provided encoder.
EndEditing()	(Inherited from NSMutableAttributedString)
EnsureAttributesAreFixed(NSRange)	Ensures that attributes have been fixed in the given range.
EnumerateAttribute(NSString, NSRange, NSAttributedStringEnumeration, NSAttributedStringCallback)	(Inherited from NSAttributedString)
EnumerateAttributes(NSRange, NSAttributedStringEnumeration, NSAttributedRangeCallback)	(Inherited from NSAttributedString)
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
GetAppKitAttributes(IntPtr, NSRange, NSRange)	(Inherited from NSAttributedString)
GetAppKitAttributes(IntPtr, NSRange)	(Inherited from NSAttributedString)
GetAttribute(String, IntPtr, NSRange, NSRange)	(Inherited from NSAttributedString)
GetAttribute(String, IntPtr, NSRange)	(Inherited from NSAttributedString)
GetAttributes(IntPtr, NSRange, NSRange)	(Inherited from NSAttributedString)
GetAttributes(IntPtr, NSRange)	(Inherited from NSAttributedString)
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetCoreTextAttributes(IntPtr, NSRange, NSRange)	(Inherited from NSAttributedString)
GetCoreTextAttributes(IntPtr, NSRange)	(Inherited from NSAttributedString)
GetData(NSRange, NSAttributedStringDocumentAttributes, NSError)	(Inherited from NSAttributedString)
GetData(NSRange, NSDictionary, NSError)	(Inherited from NSAttributedString)
GetDictionaryOfValuesFromKeys(NSString[])	(Inherited from NSObject)
GetDocFormat(NSRange, NSAttributedStringDocumentAttributes)	(Inherited from NSAttributedString)
GetDocFormat(NSRange, NSDictionary)	(Inherited from NSAttributedString)
GetFileWrapper(NSRange, NSAttributedStringDocumentAttributes, NSError)	(Inherited from NSAttributedString)
GetFileWrapper(NSRange, NSDictionary, NSError)	(Inherited from NSAttributedString)
GetFontAttributes(NSRange)	(Inherited from NSAttributedString)
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetItemNumber(NSTextList, UIntPtr)	(Inherited from NSAttributedString)
GetLineBreak(UIntPtr, NSRange)	(Inherited from NSAttributedString)
GetLineBreakByHyphenating(UIntPtr, NSRange)	(Inherited from NSAttributedString)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
GetNextWord(UIntPtr, Boolean)	(Inherited from NSAttributedString)
GetPasteboardPropertyListForType(String)	(Inherited from NSAttributedString)
GetRange(NSTextBlock, UIntPtr)	(Inherited from NSAttributedString)
GetRange(NSTextList, UIntPtr)	(Inherited from NSAttributedString)
GetRange(NSTextTable, UIntPtr)	(Inherited from NSAttributedString)
GetRtf(NSRange, NSAttributedStringDocumentAttributes)	(Inherited from NSAttributedString)
GetRtf(NSRange, NSDictionary)	(Inherited from NSAttributedString)
GetRtfd(NSRange, NSAttributedStringDocumentAttributes)	(Inherited from NSAttributedString)
GetRtfd(NSRange, NSDictionary)	(Inherited from NSAttributedString)
GetRtfdFileWrapper(NSRange, NSAttributedStringDocumentAttributes)	(Inherited from NSAttributedString)
GetRtfdFileWrapper(NSRange, NSDictionary)	(Inherited from NSAttributedString)
GetRulerAttributes(NSRange)	(Inherited from NSAttributedString)
GetUrl(UIntPtr, NSRange)	(Inherited from NSAttributedString)
GetWritableTypesForPasteboard(NSPasteboard)	(Inherited from NSAttributedString)
GetWritingOptionsForType(String, NSPasteboard)	(Inherited from NSAttributedString)
Init()	(Inherited from NSObject)
InitializeHandle(NativeHandle, String)	(Inherited from NSObject)
InitializeHandle(NativeHandle)	(Inherited from NSObject)
Insert(NSAttributedString, IntPtr)	Inserts an attributed string into the current string. (Inherited from NSMutableAttributedString)
InvalidateAttributes(NSRange)	Invalidates attributes in the specified range.
Invoke(Action, Double)	(Inherited from NSObject)
Invoke(Action, TimeSpan)	(Inherited from NSObject)
InvokeOnMainThread(Action)	(Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject)
IsEqual(NSAttributedString)	(Inherited from NSAttributedString)
IsEqual(NSObject)	(Inherited from NSObject)
IsKindOfClass(Class)	(Inherited from NSObject)
IsMemberOfClass(Class)	(Inherited from NSObject)
LowLevelGetAttributes(IntPtr, IntPtr)	(Inherited from NSAttributedString)
LowLevelGetAttributes(IntPtr, NSRange)	Low-level version that provides an NSDictionary for the attributes in the specified range. (Inherited from NSAttributedString)
LowLevelSetAttributes(IntPtr, NSRange)	(Inherited from NSMutableAttributedString)
MarkDirty()	Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject)
MutableCopy()	(Inherited from NSObject)
MutableCopy(NSZone)	(Inherited from NSAttributedString)
ObjectDidEndEditing(NSObject)	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	(Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PrefersRtfdInRange(NSRange)	(Inherited from NSAttributedString)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
ProcessEditing()	Activates post-editing operations.
ReadFromUrl(NSUrl, NSAttributedStringDocumentAttributes, NSDictionary<NSString,NSObject>, NSError)	(Inherited from NSMutableAttributedString)
ReadFromUrl(NSUrl, NSDictionary<NSString,NSObject>, NSDictionary<NSString,NSObject>, NSError)	(Inherited from NSMutableAttributedString)
RemoveAttribute(String, NSRange)	(Inherited from NSMutableAttributedString)
RemoveLayoutManager(NSLayoutManager)	Removes an NSLayoutManager from this NSTextStorage's LayoutManagers collection.
RemoveObserver(NSObject, NSString, IntPtr)	(Inherited from NSObject)
RemoveObserver(NSObject, NSString)	(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	(Inherited from NSObject)
RemoveObserver(NSObject, String)	(Inherited from NSObject)
Replace(NSRange, NSAttributedString)	(Inherited from NSMutableAttributedString)
Replace(NSRange, String)	(Inherited from NSMutableAttributedString)
RespondsToSelector(Selector)	(Inherited from NSObject)
SetAttributes(CTStringAttributes, NSRange)	Sets the attributes for the specified ranges. Any previous attributes in that range are replaces with the new values. (Inherited from NSMutableAttributedString)
SetAttributes(NSDictionary, NSRange)	Sets the attributes for the specified ranges. Any previous attributes in that range are replaces with the new values. (Inherited from NSMutableAttributedString)
SetNilValueForKey(NSString)	(Inherited from NSObject)
SetString(NSAttributedString)	(Inherited from NSMutableAttributedString)
SetValueForKey(NSObject, NSString)	(Inherited from NSObject)
SetValueForKeyPath(NativeHandle, NSString)	(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	(Inherited from NSObject)
Substring(IntPtr, IntPtr)	(Inherited from NSAttributedString)
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
Unbind(NSString)	(Inherited from NSObject)
ValueForKey(NSString)	(Inherited from NSObject)
ValueForKeyPath(NSString)	(Inherited from NSObject)
ValueForUndefinedKey(NSString)	(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	(Inherited from NSObject)

Events

Name	Description
DidProcessEditing	Event raised by the object.
TextStorageDidProcessEditing
TextStorageWillProcessEditing
WillProcessEditing	Event raised by the object.

Extension Methods

Name	Description
BoundingRectWithSize(NSAttributedString, CGSize, NSStringDrawingOptions, NSStringDrawingContext)
DrawWithRect(NSAttributedString, CGRect, NSStringDrawingOptions, NSStringDrawingContext)
ApplyFontTraits(NSMutableAttributedString, NSFontTraitMask, NSRange)
FixAttachmentAttributeInRange(NSMutableAttributedString, NSRange)
FixFontAttributeInRange(NSMutableAttributedString, NSRange)
FixParagraphStyleAttributeInRange(NSMutableAttributedString, NSRange)
ReadFromData(NSMutableAttributedString, NSData, NSAttributedStringDocumentAttributes, NSDictionary, NSError)
ReadFromData(NSMutableAttributedString, NSData, NSAttributedStringDocumentAttributes, NSDictionary)
ReadFromData(NSMutableAttributedString, NSData, NSDictionary, NSDictionary, NSError)
ReadFromData(NSMutableAttributedString, NSData, NSDictionary, NSDictionary)
ReadFromURL(NSMutableAttributedString, NSUrl, NSAttributedStringDocumentAttributes, NSDictionary, NSError)
ReadFromURL(NSMutableAttributedString, NSUrl, NSAttributedStringDocumentAttributes, NSDictionary)
ReadFromURL(NSMutableAttributedString, NSUrl, NSDictionary, NSDictionary, NSError)
ReadFromURL(NSMutableAttributedString, NSUrl, NSDictionary, NSDictionary)
SetAlignment(NSMutableAttributedString, NSTextAlignment, NSRange)
SetBaseWritingDirection(NSMutableAttributedString, NSWritingDirection, NSRange)
SubscriptRange(NSMutableAttributedString, NSRange)
SuperscriptRange(NSMutableAttributedString, NSRange)
UnscriptRange(NSMutableAttributedString, NSRange)
UpdateAttachmentsFromPath(NSMutableAttributedString, String)
ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
GetWritingOptionsForType(INSPasteboardWriting, String, NSPasteboard)
DrawAtPoint(NSAttributedString, CGPoint)
DrawInRect(NSAttributedString, CGRect)
GetSize(NSAttributedString)
BrowserAccessibilityDeleteTextAtCursor(NSObject, IntPtr)
BrowserAccessibilityInsertTextAtCursor(NSObject, String)
GetAccessibilityLineEndPositionFromCurrentSelection(NSObject)
GetAccessibilityLineRangeForPosition(NSObject, IntPtr)
GetAccessibilityLineStartPositionFromCurrentSelection(NSObject)
GetBrowserAccessibilityAttributedValue(NSObject, NSRange)
GetBrowserAccessibilityContainerType(NSObject)
GetBrowserAccessibilityCurrentStatus(NSObject)
GetBrowserAccessibilityHasDomFocus(NSObject)
GetBrowserAccessibilityIsRequired(NSObject)
GetBrowserAccessibilityPressedState(NSObject)
GetBrowserAccessibilityRoleDescription(NSObject)
GetBrowserAccessibilitySelectedTextRange(NSObject)
GetBrowserAccessibilitySortDirection(NSObject)
GetBrowserAccessibilityValue(NSObject, NSRange)
SetBrowserAccessibilityContainerType(NSObject, BEAccessibilityContainerType)
SetBrowserAccessibilityCurrentStatus(NSObject, String)
SetBrowserAccessibilityHasDomFocus(NSObject, Boolean)
SetBrowserAccessibilityIsRequired(NSObject, Boolean)
SetBrowserAccessibilityPressedState(NSObject, BEAccessibilityPressedState)
SetBrowserAccessibilityRoleDescription(NSObject, String)
SetBrowserAccessibilitySelectedTextRange(NSObject, NSRange)
SetBrowserAccessibilitySortDirection(NSObject, String)
ProvideImageData(NSObject, IntPtr, UIntPtr, UIntPtr, UIntPtr, UIntPtr, UIntPtr, NSObject)
ProvideImageToMTLTexture(NSObject, IMTLTexture, IMTLCommandBuffer, UIntPtr, UIntPtr, UIntPtr, UIntPtr, NSObject)
SetSharedObservers(NSObject, NSKeyValueSharedObserversSnapshot)
GetDebugDescription(INSObjectProtocol)
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)

Applies to

Share via