Platforms to show: All Mac Windows Linux Cross-Platform
NSTextMBS class
Super class: NSViewMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | Cocoa Text | MBS MacCocoa Plugin | 7.8 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
You may prefer to use the NSTextViewMBS class which is a subclass from NSTextMBS.
You can embed this view in a CustomNSViewMBS to get more events for mouse and keyboard.
Subclass of the NSViewMBS class.
- 5 events
- event textDidBeginEditing
- event textDidChange
- event textDidEndEditing
- event textShouldBeginEditing as boolean
- event textShouldEndEditing as boolean
- 17 properties
- property alignment as Integer
- property backgroundColor as NSColorMBS
- property baseWritingDirection as Integer
- property drawsBackground as boolean
- property Enabled as boolean
- property font as NSFontMBS
- property importsGraphics as boolean
- property isEditable as boolean
- property isFieldEditor as boolean
- property isHorizontallyResizable as boolean
- property isRichText as boolean
- property isSelectable as boolean
- property isVerticallyResizable as boolean
- property selectedRange as NSRangeMBS
- property text as string
- property textColor as NSColorMBS
- property usesFontPanel as boolean
- 42 methods
- method alignCenter
- method alignLeft
- method alignRight
- method changeFont
- method checkSpelling
- method Constructor
- method Constructor(Handle as Integer)
- method Constructor(left as Double, top as Double, width as Double, height as Double)
- method copy
- method copyFont
- method copyRuler
- method cut
- method delete
- method isRulerVisible as boolean
- method maxSizeHeight as Double
- method maxSizeWidth as Double
- method minSizeHeight as Double
- method minSizeWidth as Double
- method paste
- method pasteFont
- method pasteRuler
- method readRTFDFromFile(file as folderitem) as boolean
- method replaceCharactersInRangeWithRTF(start as Integer, length as Integer, rtfData as MemoryBlock)
- method replaceCharactersInRangeWithRTFD(start as Integer, length as Integer, rtfdData as MemoryBlock)
- method replaceCharactersInRangeWithString(start as Integer, length as Integer, text as string)
- method RTFDFromRange(start as Integer, length as Integer) as MemoryBlock
- method RTFFromRange(start as Integer, length as Integer) as MemoryBlock
- method scrollRangeToVisible(start as Integer, length as Integer)
- method selectAll
- method setFontForRange(font as NSFontMBS, start as Integer, length as Integer)
- method setMaxSize(width as Double, height as Double)
- method setMinSize(width as Double, height as Double)
- method setTextColorForRange(colorValue as NSColorMBS, start as Integer, length as Integer)
- method showGuessPanel
- method sizeToFit
- method subscript
- method superscript
- method textLength as Integer
- method toggleRuler
- method underline
- method unscript
- method writeRTFDToFile(file as folderitem, atomically as boolean) as boolean
- 2 shared methods
- shared method NSCenterTextAlignment as Integer
- shared method NSRightTextAlignment as Integer
- 28 constants
Constants
Constant | Value | Description |
---|---|---|
NSBackspaceCharacter | 8 | One of the constants to specify commonly used Unicode characters. |
NSBackTabCharacter | &h19 | One of the constants to specify commonly used Unicode characters. |
NSBacktabTextMovement | &h12 |
One of the constants used to specify the reason for a change of editing focus among text fields, in essence answering the question "why am I leaving the field?"
The Backtab (Shift-Tab) key was pressed. |
NSCancelTextMovement | &h17 |
One of the constants used to specify the reason for a change of editing focus among text fields, in essence answering the question "why am I leaving the field?"
The user cancelled the completion. Available in Mac OS X v10.3 and later. |
NSCarriageReturnCharacter | 13 | One of the constants to specify commonly used Unicode characters. |
NSDeleteCharacter | &h7F | One of the constants to specify commonly used Unicode characters. |
NSDownTextMovement | &h16 |
One of the constants used to specify the reason for a change of editing focus among text fields, in essence answering the question "why am I leaving the field?"
The down arrow key was pressed. |
NSEnterCharacter | 3 | One of the constants to specify commonly used Unicode characters. |
NSFormFeedCharacter | 12 | One of the constants to specify commonly used Unicode characters. |
NSIllegalTextMovement | 0 |
One of the constants used to specify the reason for a change of editing focus among text fields, in essence answering the question "why am I leaving the field?"
Currently unused. |
NSLeftTextMovement | &h13 |
One of the constants used to specify the reason for a change of editing focus among text fields, in essence answering the question "why am I leaving the field?"
The left arrow key was pressed. |
NSLineSeparatorCharacter | &h2028 | One of the constants to specify commonly used Unicode characters. |
NSNewlineCharacter | 10 | One of the constants to specify commonly used Unicode characters. |
NSOtherTextMovement | 0 |
One of the constants used to specify the reason for a change of editing focus among text fields, in essence answering the question "why am I leaving the field?"
The user performed some undefined action. Available in Mac OS X v10.3 and later. |
NSParagraphSeparatorCharacter | &h2029 | One of the constants to specify commonly used Unicode characters. |
NSReturnTextMovement | &h10 |
One of the constants used to specify the reason for a change of editing focus among text fields, in essence answering the question "why am I leaving the field?"
The Return key was pressed. |
NSRightTextMovement | &h14 |
One of the constants used to specify the reason for a change of editing focus among text fields, in essence answering the question "why am I leaving the field?"
The right arrow key was pressed. |
NSTabCharacter | 9 | One of the constants to specify commonly used Unicode characters. |
NSTabTextMovement | &h11 |
One of the constants used to specify the reason for a change of editing focus among text fields, in essence answering the question "why am I leaving the field?"
The Tab key was pressed. |
NSTextWritingDirectionEmbedding | 0 |
An additional constant to specify the writing direction.
Direction is embedded. Available in Mac OS X v10.6 and later. |
NSTextWritingDirectionOverride | 1 |
An additional constant to specify the writing direction.
Direction override Available in Mac OS X v10.6 and later. |
NSUpTextMovement | &h15 |
One of the constants used to specify the reason for a change of editing focus among text fields, in essence answering the question "why am I leaving the field?"
The up arrow key was pressed. |
Alignment Modes
Constant | Value | Description |
---|---|---|
NSJustifiedTextAlignment | 3 |
Fully-justified. The last line in a paragraph is natural-aligned. |
NSLeftTextAlignment | 0 |
Visually left aligned |
NSNaturalTextAlignment | 4 |
Indicates the default alignment for script. |
Writing Direction
Constant | Value | Description |
---|---|---|
NSWritingDirectionLeftToRight | 0 |
The writing direction is left to right. Available in Mac OS X v10.2 and later. |
NSWritingDirectionNatural | -1 |
The writing direction is determined using the Unicode Bidi Algorithm rules P2 and P3. Default. Available in Mac OS X v10.4 and later. |
NSWritingDirectionRightToLeft | 1 |
The writing direction is right to left. Available in Mac OS X v10.2 and later. Example |
Super class NSViewMBS
- 43 properties
- property acceptsTouchEvents as boolean
- property allowsVibrancy as Boolean
- property alphaValue as Double
- property autoresizesSubviews as boolean
- property autoresizingMask as Integer
- property bounds as NSRectMBS
- property boundsRotation as Double
- property canBecomeKeyView as boolean
- property canDraw as boolean
- property canDrawConcurrently as boolean
- property className as string
- property classPath as string
- property clipsToBounds as Boolean
- property focusRingType as Integer
- property frame as NSRectMBS
- property frameCenterRotation as Double
- property frameHeight as Double
- property frameLeft as Double
- property frameRotation as Double
- property frameTop as Double
- property frameWidth as Double
- property identifier as string
- property isFlipped as Boolean
- property isHidden as Boolean
- property isHiddenOrHasHiddenAncestor as Boolean
- property isOpaque as Boolean
- property isRotatedFromBase as Boolean
- property isRotatedOrScaledFromBase as Boolean
- property layer as Variant
- property layerUsesCoreImageFilters as Boolean
- property needsDisplay as Boolean
- property nextKeyView as NSViewMBS
- property opaqueAncestor as NSViewMBS
- property RetainCount as Integer
- property superview as NSViewMBS
- property toolTip as string
- property userInteractionEnabled as Boolean
- property visibleRect as NSRectMBS
- property wantsDefaultClipping as boolean
- property wantsLayer as Boolean
- property wantsRestingTouches as boolean
- property window as NSWindowMBS
- property compositingFilter as variant
- 62 methods
- method addSubview(subview as NSViewMBS)
- method addSubview(subview as NSViewMBS, positioned as Integer, relativeToView as NSViewMBS)
- method addToolTipRect(rect as NSRectMBS, tooltip as NSViewTooltipMBS)
- method adjustScroll(rect as NSRectMBS) as NSRectMBS New in 24.5
- method ancestorSharedWithView(view as NSViewMBS) as NSViewMBS
- method animator as NSViewMBS
- method autoscroll(e as NSEventMBS) as Boolean New in 24.5
- method backgroundFilters as variant()
- method beginDraggingSessionWithItems(items() as Variant, e as NSEventMBS, source as NSViewMBS) as Variant
- method Constructor
- method Constructor(Handle as Integer)
- method Constructor(left as Double, top as Double, width as Double, height as Double)
- method contentFilters as variant()
- method convertPointFromView(point as NSPointMBS, View as NSViewMBS) as NSPointMBS
- method convertPointToView(point as NSPointMBS, View as NSViewMBS) as NSPointMBS
- method convertRectFromView(rect as NSRectMBS, View as NSViewMBS) as NSRectMBS
- method convertRectToView(rect as NSRectMBS, View as NSViewMBS) as NSRectMBS
- method convertSizeFromView(Size as NSSizeMBS, View as NSViewMBS) as NSSizeMBS
- method convertSizeToView(Size as NSSizeMBS, View as NSViewMBS) as NSSizeMBS
- method dataWithEPSInsideRect(left as Double, top as Double, width as Double, height as Double) as Memoryblock
- method dataWithPDFInsideRect(left as Double, top as Double, width as Double, height as Double) as Memoryblock
- method dataWithPDFInsideRect(r as NSRectMBS) as Memoryblock
- method dragImage(image as NSImageMBS, viewLocation as NSPointMBS, offset as NSSizeMBS, NSEvent as NSEventMBS, pboard as NSPasteboardMBS, source as NSViewMBS, slideFlag as boolean)
- method drawFocusRingMask
- method enclosingMenuItem as Variant
- method enclosingScrollView as Variant
- method focusRingMaskBounds as NSRectMBS
- method hitTest(x as double, y as double) as NSViewMBS New in 24.4
- method isDescendantOf(view as NSViewMBS) as boolean
- method makeBackingLayer as Variant
- method nextValidKeyView as NSViewMBS
- method noteFocusRingMaskChanged
- method pageFooter as NSAttributedStringMBS
- method pageHeader as NSAttributedStringMBS
- method previousKeyView as NSViewMBS
- method previousValidKeyView as NSViewMBS
- method print
- method registeredDraggedTypes as string()
- method registerForDraggedTypes(Types() as string)
- method removeAllToolTips
- method removeFromSuperview
- method removeFromSuperviewWithoutNeedingDisplay
- method RenderImage(subviews as boolean = false, flipped as boolean = false) as variant
- method replaceSubview(oldView as NSViewMBS, newView as NSViewMBS)
- method rotateByAngle(angle as Double)
- method scaleUnitSquareToSize(size as NSSizeMBS)
- method Screenshot as Picture
- method scrollPoint(x as double, y as double) New in 24.5
- method scrollRectToVisible(rect as NSRectMBS) as Boolean New in 24.5
- method setBackgroundFilters(Filters() as variant)
- method setBoundsOrigin(origin as NSPointMBS)
- method setBoundsOrigin(x as Double, y as Double)
- method setBoundsSize(size as NSSizeMBS)
- method setBoundsSize(width as Double, height as Double)
- method setContentFilters(Filters() as variant)
- method setFocus
- method setFrameOrigin(origin as NSPointMBS)
- method setFrameOrigin(x as Double, y as Double)
- method setFrameSize(size as NSSizeMBS)
- method setFrameSize(width as Double, height as Double)
- method subviews(recursive as boolean = false) as NSViewMBS()
- method unregisterDraggedTypes
- 5 shared methods
- shared method NSViewBoundsDidChangeNotification as string
- shared method NSViewDidUpdateTrackingAreasNotification as string
- shared method NSViewFocusDidChangeNotification as string
- shared method NSViewFrameDidChangeNotification as string
- shared method NSViewGlobalFrameDidChangeNotification as string
- 21 constants
Constants
Constant | Value | Description |
---|---|---|
NSBezelBorder | 2 |
One of the constants to specify the type of a view's border.
A concave border that makes the view look sunken. |
NSFocusRingTypeDefault | 0 |
One of the constants for the focusringtype property.
The default focus ring type for NSView or NSCell. |
NSFocusRingTypeExterior | 2 |
One of the constants for the focusringtype property.
The standard Aqua focus ring. |
NSFocusRingTypeNone | 1 |
One of the constants for the focusringtype property.
No focus ring. If you set the focus ring type to this value, NSView and NSCell will not draw any focus ring. |
NSGrooveBorder | 3 |
One of the constants to specify the type of a view's border.
A thin border that looks etched around the image. |
NSLineBorder | 1 |
One of the constants to specify the type of a view's border.
A black line border around the view. |
NSNoBorder | 0 |
One of the constants to specify the type of a view's border.
No border. |
NSViewHeightSizable | 16 |
One of the constants for the autoresizingMask property.
The receiver's height is flexible. |
NSViewLayerContentsRedrawBeforeViewResize | 3 | One of the view layer content redraw policy constants. |
NSViewLayerContentsRedrawDuringViewResize | 2 | One of the view layer content redraw policy constants. |
NSViewLayerContentsRedrawNever | 0 | One of the view layer content redraw policy constants. |
NSViewLayerContentsRedrawOnSetNeedsDisplay | 1 | One of the view layer content redraw policy constants. |
NSViewMaxXMargin | 4 |
One of the constants for the autoresizingMask property.
The right margin between the receiver and its superview is flexible. |
NSViewMaxYMargin | 32 |
One of the constants for the autoresizingMask property.
The top margin between the receiver and its superview is flexible. |
NSViewMinXMargin | 1 |
One of the constants for the autoresizingMask property.
The left margin between the receiver and its superview is flexible. |
NSViewMinYMargin | 8 |
One of the constants for the autoresizingMask property.
The bottom margin between the receiver and its superview is flexible. |
NSViewNotSizable | 0 |
One of the constants for the autoresizingMask property.
The receiver cannot be resized. |
NSViewWidthSizable | 2 |
One of the constants for the autoresizingMask property.
The receiver's width is flexible. |
Window Order Constants
Constant | Value | Description |
---|---|---|
NSWindowAbove | 1 |
Moves the window above the indicated window. |
NSWindowBelow | -1 |
Moves the window below the indicated window. |
NSWindowOut | 0 |
Moves the window off the screen. |
Super class NSResponderMBS
- 3 properties
- property Handle as Integer
- property menu as NSMenuMBS
- property nextResponder as NSResponderMBS
- 123 methods
- method beginGestureWithEvent(e as NSEventMBS)
- method cancelOperation
- method capitalizeWord
- method centerSelectionInVisibleArea
- method changeCaseOfLetter
- method complete
- method Constructor Private
- method cursorUpdate(e as NSEventMBS)
- method deleteBackward
- method deleteBackwardByDecomposingPreviousCharacter
- method deleteForward
- method deleteToBeginningOfLine
- method deleteToBeginningOfParagraph
- method deleteToEndOfLine
- method deleteToEndOfParagraph
- method deleteToMark
- method deleteWordBackward
- method deleteWordForward
- method endGestureWithEvent(e as NSEventMBS)
- method flagsChanged(e as NSEventMBS)
- method flushBufferedKeyEvents
- method helpRequested(e as NSEventMBS)
- method indent
- method insertBacktab
- method insertContainerBreak
- method insertDoubleQuoteIgnoringSubstitution
- method insertLineBreak
- method insertNewline
- method insertNewlineIgnoringFieldEditor
- method insertParagraphSeparator
- method insertSingleQuoteIgnoringSubstitution
- method insertTab
- method insertTabIgnoringFieldEditor
- method keyDown(e as NSEventMBS)
- method keyUp(e as NSEventMBS)
- method lowercaseWord
- method magnifyWithEvent(e as NSEventMBS)
- method makeBaseWritingDirectionLeftToRight
- method makeBaseWritingDirectionNatural
- method makeBaseWritingDirectionRightToLeft
- method makeTextWritingDirectionLeftToRight
- method makeTextWritingDirectionNatural
- method makeTextWritingDirectionRightToLeft
- method mouseDown(e as NSEventMBS)
- method mouseDragged(e as NSEventMBS)
- method mouseEntered(e as NSEventMBS)
- method mouseExited(e as NSEventMBS)
- method mouseMoved(e as NSEventMBS)
- method mouseUp(e as NSEventMBS)
- method moveBackward
- method moveBackwardAndModifySelection
- method moveDown
- method moveDownAndModifySelection
- method moveForward
- method moveForwardAndModifySelection
- method moveLeft
- method moveLeftAndModifySelection
- method moveParagraphBackwardAndModifySelection
- method moveParagraphForwardAndModifySelection
- method moveRight
- method moveRightAndModifySelection
- method moveToBeginningOfDocument
- method moveToBeginningOfDocumentAndModifySelection
- method moveToBeginningOfLine
- method moveToBeginningOfLineAndModifySelection
- method moveToBeginningOfParagraph
- method moveToBeginningOfParagraphAndModifySelection
- method moveToEndOfDocument
- method moveToEndOfDocumentAndModifySelection
- method moveToEndOfLine
- method moveToEndOfLineAndModifySelection
- method moveToEndOfParagraph
- method moveToEndOfParagraphAndModifySelection
- method moveToLeftEndOfLine
- method moveToLeftEndOfLineAndModifySelection
- method moveToRightEndOfLine
- method moveToRightEndOfLineAndModifySelection
- method moveUp
- method moveUpAndModifySelection
- method moveWordBackward
- method moveWordBackwardAndModifySelection
- method moveWordForward
- method moveWordForwardAndModifySelection
- method moveWordLeft
- method moveWordLeftAndModifySelection
- method moveWordRight
- method moveWordRightAndModifySelection
- method otherMouseDown(e as NSEventMBS)
- method otherMouseDragged(e as NSEventMBS)
- method otherMouseUp(e as NSEventMBS)
- method pageDown
- method pageDownAndModifySelection
- method pageUp
- method pageUpAndModifySelection
- method performMnemonic(theString as string) as boolean
- method presentError(e as NSErrorMBS) as boolean
- method rightMouseDown(e as NSEventMBS)
- method rightMouseDragged(e as NSEventMBS)
- method rightMouseUp(e as NSEventMBS)
- method rotateWithEvent(e as NSEventMBS)
- method scrollLineDown
- method scrollLineUp
- method scrollPageDown
- method scrollPageUp
- method scrollToBeginningOfDocument
- method scrollToEndOfDocument
- method scrollWheel(e as NSEventMBS)
- method selectAll
- method selectLine
- method selectParagraph
- method selectToMark
- method selectWord
- method setMark
- method showContextHelp
- method swapWithMark
- method swipeWithEvent(e as NSEventMBS)
- method tabletPoint(e as NSEventMBS)
- method tabletProximity(e as NSEventMBS)
- method transpose
- method transposeWords
- method undoManager as NSUndoManagerMBS
- method uppercaseWord
- method yank
Sub classes:
Some methods using this class:
- NSTextFieldCellMBS.setUpFieldEditorAttributes(textobj as NSTextMBS) as NSTextMBS
Some properties using for this class:
- NSControlMBS.currentEditor as NSTextMBS
Some events using this class:
- DesktopNSComboBoxControlMBS.TextDidChange(fieldEditor as NSTextMBS, notification as NSNotificationMBS)
- DesktopNSOutlineControlMBS.textShouldBeginEditing(control as NSControlMBS, fieldEditor as NSTextMBS) as Boolean
- DesktopNSSecureTextFieldControlMBS.textShouldBeginEditing(fieldEditor as NSTextMBS) as boolean
- DesktopNSTableControlMBS.textShouldEndEditing(control as NSControlMBS, fieldEditor as NSTextMBS) as boolean
- DesktopNSTokenFieldControlMBS.textShouldBeginEditing(fieldEditor as NSTextMBS) as boolean
- NSComboBoxControlMBS.TextDidChange(fieldEditor as NSTextMBS, notification as NSNotificationMBS)
- NSSearchFieldControlMBS.TextDidBeginEditing(fieldEditor as NSTextMBS, notification as NSNotificationMBS)
- NSTableControlMBS.textShouldBeginEditing(control as NSControlMBS, fieldEditor as NSTextMBS) as boolean
- NSTextFieldControlMBS.textShouldEndEditing(fieldEditor as NSTextMBS) as boolean
- NSTokenFieldControlMBS.tokenFieldTextShouldBeginEditing(fieldEditor as NSTextMBS) as boolean
Some examples using this class:
- /MacControls/Listbox and TableView Demos/ListboxTV drop-in/Flat Only/ListBoxTV Database with DataSource
- /MacControls/Listbox and TableView Demos/ListboxTV drop-in/Flat Only/ListBoxTV Simple Demo with DataSource
- /MacControls/Listbox and TableView Demos/ListboxTV drop-in/Flat Only/ListBoxTV TableView
- /MacControls/Listbox and TableView Demos/ListboxTV drop-in/Flat Only/ListboxTV with ContainerControl Cells
- /MacControls/Listbox and TableView Demos/ListboxTV drop-in/Hierarchical & Flat/ListBoxTV OutlineView
- /MacControls/Search Field/CustomSearchField with menu
- /MacControls/TokenField/NSTokenFieldControl
- /MacFrameworks/Cocoa Controls/NSComboBox Example
- /MacFrameworks/CustomNSTextFieldMBS test
- /MacFrameworks/TokenField
Blog Entries
- RTF functions in MBS Plugins
- MBS Xojo Plugins, version 22.1pr3
- MBS Xojo / Real Studio Plugins, version 16.5pr6
- MBS Xojo / Real Studio Plugins, version 13.2pr7
Release notes
- Version 22.1
- Changed NSCenterTextAlignment and NSRightTextAlignment to from constants to shared methods to return correct values for PDFAnnotationTextWidgetMBS, NSParagraphStyleMBS, NSTextMBS and PDFAnnotationFreeTextMBS classes.
The items on this page are in the following plugins: MBS MacBase Plugin, MBS MacCocoa Plugin.
NSTextListMBS - NSTextStorageMBS