NSTextViewControlMBS.BoundsChanged

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

The event called when the bounds, but not the frame, changed.

NSTextViewControlMBS.clickedOnLink(Link as Variant, charIndex as Integer) as Boolean   New in 24.5

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	24.5	✅ Yes	❌ No	❌ No	❌ No

Sent after the user clicks a link.

link: The link that was clicked; the value of NSLinkAttributeName.
charIndex: The character index where the click occurred, indexed within the text storage.

Return true if the click was handled; otherwise, false to allow the next responder to handle it.

The event can use this method to handle the click on the link. It is invoked by clickedOnLink().
The charIndex parameter is a character index somewhere in the range of the link attribute. If the user actually physically clicked the link, then it should be the character that was originally clicked. In some cases a link may be opened indirectly or programmatically, in which case a character index somewhere in the range of the link attribute is supplied.

NSTextViewControlMBS.Close

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No

The control is about to close.
In Xojo version 2021r3 and newer this event is named Closing.

NSTextViewControlMBS.Closing

Type	Topic	Version
event	Cocoa Controls	13.4

The control is about to close.
In older Xojo versions, this event is named Close.

NSTextViewControlMBS.ConstructContextualMenu(base as MenuItem, x as Integer, y as Integer) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	22.1	✅ Yes	❌ No	❌ No	❌ No

This event is called when it is appropriate to display a contextual menu for the control.

NSTextViewControlMBS.ContextualMenuAction(hitItem as MenuItem) as Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

Called when a menuitem is choosen.

This allows the control to react on its relevant menu items. Please return true if you handled it or false to give others a chance.

NSTextViewControlMBS.didCloseContextualMenu(menu as NSMenuMBS, NSEvent as NSEventMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	24.1	✅ Yes	❌ No	❌ No	❌ No

Did close contextual menu.

Allows you to restart any animation you may have stopped in the willShowContextualMenu event.

NSTextViewControlMBS.EnableMenuItems

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

The event where you can enable menu items.
In Xojo version 2021r3 and newer this event is named MenuBarSelected.

NSTextViewControlMBS.FocusLost

Type	Topic	Version
event	Cocoa Controls	16.5

The control lost focus.
In older Xojo versions, this event is named LostFocus.

This only fires if the control itself lost focus and not a sub control.

NSTextViewControlMBS.FocusReceived

Type	Topic	Version
event	Cocoa Controls	16.5

The control itself got focus.
In older Xojo versions, this event is named GotFocus.

This only fires if the control itself got focus and not a sub control.

NSTextViewControlMBS.FrameChanged

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

The event called when the frame changed.

This event notifies you, that the control changed it's bounding frame, which is position and/or size.

NSTextViewControlMBS.GotFocus

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	16.5	✅ Yes	❌ No	❌ No	❌ No

The control itself got focus.
In Xojo version 2021r3 and newer this event is named FocusReceived.

This only fires if the control itself got focus and not a sub control.

NSTextViewControlMBS.LostFocus

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	16.5	✅ Yes	❌ No	❌ No	❌ No

The control lost focus.
In Xojo version 2021r3 and newer this event is named FocusLost.

This only fires if the control itself lost focus and not a sub control.

NSTextViewControlMBS.MenuBarSelected

Type	Topic	Version
event	Cocoa Controls	17.1

The event where you can enable menu items.
In older Xojo versions, this event is named EnableMenuItems.

NSTextViewControlMBS.MouseDown(x as Integer, y as Integer, Modifiers as Integer) As Boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

The mouse button was pressed inside the control’s region at the location passed in to x, y.

The coordinates x and y are local to the control, i.e. they represent the position of the mouse click relative to the upper-left corner or the Control.
Return True if you are going to handle the MouseDown. In such a case:

• The Action event, if any, will not execute and the state of the object will not change.
• You will receive the MouseDrag and MouseUp events.

If you return False, the system handles the MouseDown so the above event handlers do not get called.

NSTextViewControlMBS.MouseDrag(x as Integer, y as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

This event fires continuously after the mouse button was pressed inside the Control.

Mouse location is local to the control passed in to x, y.
As this event is fired continuously (hundreds of time per second), it is your responsibility to determine if the mouse has really moved.

NSTextViewControlMBS.MouseUp(x as Integer, y as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

The mouse button was released.

Use the x and y parameters to determine if the mouse button was released within the control's boundaries.

NSTextViewControlMBS.Open

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No

The control is about to was created and you can initialize it.
In Xojo version 2021r3 and newer this event is named Opening.

NSTextViewControlMBS.Opening

Type	Topic	Version
event	Cocoa Controls	13.4

The control is about to was created and you can initialize it.
In older Xojo versions, this event is named Open.

NSTextViewControlMBS.ScaleFactorChanged(NewFactor as Double)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	17.1	✅ Yes	❌ No	❌ No	❌ No

The backing store scale factor has changed.

Please invalidate any cached bitmaps or other relevant state.

NSTextViewControlMBS.shouldChangeTextInRange(affectedCharRange as NSRangeMBS, replacementString as string) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No

Sent when a text view needs to determine if text in a specified range should be changed.

affectedCharRange: The range of characters to be replaced.
replacementString: The characters that will replace the characters in affectedCharRange; nil if only text attributes are being changed.

Return true to allow the replacement, or false to reject the change.

NSTextViewControlMBS.textDidBeginEditing

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No

Informs you that the text object has begun editing (that the user has begun changing it).

NSTextViewControlMBS.textDidChange

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No

Informs you that the text object has changed its characters or formatting attributes.

NSTextViewControlMBS.textDidEndEditing

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No

Informs you that the text object has finished editing (that it has resigned first responder status).

NSTextViewControlMBS.textShouldBeginEditing as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No

Invoked when a text object begins to change its text, this method requests permission to begin editing.

If the delegate returns false, the text object proceeds to make changes. If the delegate returns true, the text object abandons the editing operation. This method is also invoked when the user drags and drops a file onto the text object.

NSTextViewControlMBS.textShouldEndEditing as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No

Invoked from a text object's implementation of resignFirstResponder, this method requests permission to end editing.

If the delegate returns false, the text object proceeds to finish editing and resign first responder status. If the delegate returns true, the text object selects all of its text and remains the first responder.

NSTextViewControlMBS.textViewDidChangeSelection

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	13.4	✅ Yes	❌ No	❌ No	❌ No

Sent when the selection changes in the text view.

NSTextViewControlMBS.textViewWritingToolsDidEnd   New in 24.5

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	24.5	✅ Yes	❌ No	❌ No	❌ No

Tells you that the current writing tools session ended.

Use this method to undo any actions you took at the start of a writing tools session to modify your app’s behavior. The text view calls this method after the writing session finishes. At this point, the text view contains the final text the person chose.

NSTextViewControlMBS.textViewWritingToolsWillBegin   New in 24.5

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	24.5	✅ Yes	❌ No	❌ No	❌ No

Tells you that an interaction with the writing tools interface is about to begin.

Use this method to take any necessary steps to prepare your app for writing tools interactions. During the course of a writing tools session, the writing tools UI suggests changes to the text view’s text. It also allows the person to toggle between the original and replacement text before choosing one. To avoid issues while these changes occur, save any current data to disk and and disable features that might modify your view’s text storage while the session is active. For example, disable iCloud synchronization until the session ends. Reenable those features when the session ends.

The text view calls this method when the person requests the writing tools interface, but before the interface makes any changes to your content. Because the session isn’t active yet, the writingToolsActive property of the text view is NO while this method executes. The value of that property resolves to YES only after the method returns.

NSTextViewControlMBS.willShowContextualMenu(menu as NSMenuMBS, NSEvent as NSEventMBS)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
event	Cocoa Controls	MBS MacCocoa Plugin	24.1	✅ Yes	❌ No	❌ No	❌ No

Will show contextual menu.

Your chance to modify the menu before it is shown, e.g. to add menu entries.