Events and Commands (xamSyntaxEditor)

xamSyntaxEditor Overview

In this topic, you will find information to help you better understand the xamSyntaxEditor’s functions.

Editing Support Overview

This topic covers the text editing capabilities of the xamSyntaxEditor control from both the developer and user’s perspective.

XamSyntaxEditor Events

The x amSyntaxEditor is the main class providing text editing and syntax highlighting.

DocumentViewBase Events

This is the abstract base class for the EditorDocumentView class.

EditorDocumentView Events

Use this class to represent the editable areas of the xamSyntaxEditor (only one or two areas are supported).

TextDocument Events

This class represents the document and exposes methods for its manipulation.

ActiveDocumentViewChanged

Raised whenever the ActiveDocumentView changes.

DocumentChanged

Raised whenever the TextDocument assigned to the xamSyntaxEditor control changes.

SelectionChanged

Raised whenever the range or position of the selected text in the active view changes.

SplitStatusChanged

Raised whenever the number of views changes (for example adding or removing a split.).

ViewLoaded

Raised whenever a new DocumentViewBase loads because of a splitting.

ViewUnloaded

Raised whenever a DocumentViewBase is removed because of removing a split.

LayoutChanged

Raised whenever the view’s set of visible lines changes in anyway. The argument supplied to this event exposes properties that let you enumerate through the lists of lines that were deleted, added or translated (i.e., moved) during the last layout pass. You will most likely add handlers for this event in your custom margins so that you can adjust your content appropriately, should modification occur to the set of visible lines.

Activated

Raised whenever the view becomes the active view (that is to say, when the view receives focus).

Deactivated

Raised whenever a view loses the focus to the other view in a split.

SelectionChanged

Raised when the range or position of selected text in the view changes.

PropertyChanged

Raised whenever a property has been changed on the TextDocument, for example - CurrentSnapshot, Syntaxtree etc.

TextChanging

Raised before applying any changes to the document. This event may be canceled if its CanCancel property returns true (which it does unless the source of the change is an undo or redo operation). It exposes before and after snapshots along with a list of the changes.

TextChanged

Raised after applying changes to the document. It exposes the before and after snapshots as well as the list of changes.

TextLoaded

Raised whenever the Load or InitializeText methods are invoked. Changing the Language of a TextDocument that contains text will also raise this event.

Clipboard Commands

All available Clipboard support commands

Undo / Redo Commands

All available Undo / Redo commands.

Splitting Commands

All available Splitting commands.

Cut

Perform a Clipboard Cut operation.

Copy

Perform a Clipboard Copy operation.

Paste

Perform a Clipboard Paste operation.

Undo

Perform an Undo operation.

Redo

Perform a Redo operation.

SplitAreaVertically

Vertically splits the xamSyntaxEditor into two views.

SplitAreaHorizontally

Horizontally splits the xamSyntaxEditor into two views.

RemoveSplitFromEditArea

Removes the top or left view from the xamSyntaxEditor .

AllowEditAreaVerticalSplits

Only allows vertical splitting.

AllowEditAreaHorizontalSplits

Only allows horizontal splitting.

AllowEditAreaVerticalAndHorizontalSplits

Allow both horizontal and vertical splitting.

DontAllowEditAreaSplitting

Disallow all splitting.