Platforms to show: All Mac Windows Linux Cross-Platform

NSTextViewMBS class

Super class: NSTextMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
class Cocoa Controls MBS MacCocoa Plugin 7.8 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The cocoa text view class.

Like the editfield in Xojo.
Should be placed in a scrollview.

You can embed this view in a CustomNSViewMBS to get more events for mouse and keyboard.
Subclass of the NSTextMBS class.

Constants

Constant Value Description
NSFindPanelSubstringMatchTypeContains 0 One of the constants to specify the type of substring matching used by the Find panel. Finds a word containing the search string.
Available in Mac OS X v10.5 and later.
NSFindPanelSubstringMatchTypeEndsWith 3 One of the constants to specify the type of substring matching used by the Find panel. Finds a word ending with the search string.
Available in Mac OS X v10.5 and later.
NSFindPanelSubstringMatchTypeFullWord 2 One of the constants to specify the type of substring matching used by the Find panel. Finds a word exactly matching the search string.
Available in Mac OS X v10.5 and later.
NSFindPanelSubstringMatchTypeStartsWith 1 One of the constants to specify the type of substring matching used by the Find panel. Finds a word starting with the search string.
Available in Mac OS X v10.5 and later.
NSSelectByCharacter 0 One of the constants to specify how much the text view extends the selection when the user drags the mouse. Extends the selection character by character.
NSSelectByParagraph 2 One of the constants to specify how much the text view extends the selection when the user drags the mouse. Extends the selection paragraph by paragraph.
NSSelectByWord 1 One of the constants to specify how much the text view extends the selection when the user drags the mouse. Extends the selection word by word.
NSSelectionAffinityDownstream 1 One of the constants to specify the preferred direction of selection. The selection is moving toward the bottom of the document.
NSSelectionAffinityUpstream 0 One of the constants to specify the preferred direction of selection. The selection is moving toward the top of the document.

Writing Tools Behavior

Constant Value Description
NSWritingToolsBehaviorComplete 1 The complete inline-editing experience will be provided if possible.
NSWritingToolsBehaviorDefault 0 System-defined behavior, may resolve to `None`, `Complete`, or `Limited`
NSWritingToolsBehaviorLimited 2 The limited, overlay-panel experience will be provided if possible.
NSWritingToolsBehaviorNone -1 Writing Tools will ignore this view

Writing Tools Result

Constant Value Description
NSWritingToolsResultDefault 0 System—defined behavior
NSWritingToolsResultList 4 Lists. implies `RichText`, and Writing Tools may provide attributes for list layout
NSWritingToolsResultPlainText 1 Writing Tools will provide plain text in proofreading suggestions or rewrites
NSWritingToolsResultRichText 2 as well as plain text, Writing Tools will provide text attributes in proofreading suggestions or rewrites that are natively supported or known to be easily adopted (such as lists)
NSWritingToolsResultTable 8 Tables. implies `RichText`, and Writing Tools may provide attributes for tabular layout
Example

Super class NSTextMBS

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

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

Sub classes:

Some methods using this class:

Some properties using for this class:

Some events using this class:

Some examples using this class:

Blog Entries

Xojo Developer Magazine

Videos

Release notes

  • Version 24.5
    • Added isWritingToolsActive, writingToolsBehavior and allowedWritingToolsResultOptions properties for NSTextViewMBS class.
  • Version 19.5
    • Fixed insertText method in NSTextViewMBS to work for empty texts.
  • Version 18.5

The items on this page are in the following plugins: MBS MacBase Plugin, MBS MacCocoa Plugin, MBS MacExtras Plugin.


NSTextTabMBS   -   NSTimerMBS


The biggest plugin in space...