Version

Features Overview (xamRichTextEditor)

Topic Overview

Purpose

This topic provides an overview of the features supported by the control.

In this topic

This topic contains the following sections:

Introduction

Control summary

The xamRichTextEditor™ is a cross platform control providing displaying and editing capabilities of rich text content, which includes but is not limited to text, lists, images and tables.

The xamRichTextEditor provides you with the ability to display and edit the RichTextDocument’s content. The RichTextDocument class allows you to import and export rich content from and to different formats (plain text, RTF, DOCX).

The following screen shot shows the xamRichTextEditor , in split mode editing rich content :

xamRichTextEditor Features01.png

User Interactions and Usability

User interactions summary chart

The following table summarizes the user interaction capabilities of the xamRichTextEditor control. Additional details are available after the table.

Feature Description Configurable?

The context menu allows the users to perform clipboard operations and create tables.

Clipboard operations are available to the user using keyboard shortcuts.

Allows the user to click and open hyperlinks.

The control supports displaying of images of different formats.

This feature allows the user to navigate the document content using the keyboard.

No.png

This feature allows the user to select single or multiple ranges of the document content.

This feature allows the user to resize table columns and rows.

No.png

This feature allows the user to modify the format of the text content.

No.png

This feature allows the user to rollback recent changes or reapplies them.

This feature allows the user to split the document view in two.

This feature allows the user to increase or decrease the rendering size of the view’s content.

Context Menu

The xamRichTextEditor control supports a context menu allowing users to perform clipboard operations and create tables. You can customize the content of the context menu or even hide it.

Clipboard

The xamRichTextEditor control provides Cut, Copy and Paste clipboard support that allows the user to edit the rich content of their document by moving or copying parts of the content at different places. It is also possible to paste rich text content from other application and copy content to other applications.

You must select the content in the xamRichTextEditor in order to use the Cut and Copy operations. You can execute the Paste operation whether or not you have content selected.

  • If no content is selected the clipboard content will be inserted after the current caret position.

  • If content is selected the clipboard content will replace the current selection.

The following table lists the operations available for the clipboard support using the keyboard.

Operation Keyboard Shortcuts

Clipboard Cut

Ctrl + X

Clipboard Copy

Ctrl + C, Ctrl + Insert

Clipboard Paste

Ctrl + V, Shift + Insert

Hyperlinks

The xamRichTextEditor supports hyperlinks in the document’s content. The user is able open the URI in the default system browser by clicking on the links.

Images

The control supports displaying images of different formats – BMP, DIB, EMF, GIF, JPEG, PNG, TIFF and WMF.

Keyboard Navigation

The keyboard navigation feature allows the user to navigate through the rich text document’s content.

The following table maps the lists all available user shortcuts:

Shortcut Description

Up arrow

Move caret one line up or scroll up document.

Down arrow

Move caret one line down or scroll down document.

Left arrow

Move caret on previous character.

Right arrow

Move caret on next character.

Ctrl + left arrow

Move caret over the start of the previous word.

Ctrl + right arrow

Move caret over the start of the next word.

Page up

Scroll one page up.

Page down

Scroll one page down.

Home

Move the caret to the beginning of the current line.

End

Move the caret to the end of the current line.

Ctrl + Home

Move the caret to the beginning of the document.

Ctrl + End

Move the caret to the end of the document.

Selection

The selection feature allows the user to select single or multiple ranges from the content of the xamRichTextEditor .

Keyboard single selection

The keyboard single selection allows the user to select a single range of the content of the xamRichTextEditor using the keyboard.

  1. Move the caret to the start of the range you want to select.

  2. Press and hold the shift key and start moving the caret to the end of the range you want to select.

  3. When reaching the end of the selection range, release the shift key.

Mouse single selection

The mouse single selection allows the user to select a single range of the content of the xamRichTextEditor using the mouse.

  1. Move the mouse pointer over the start of the range you want to select.

  2. Press and hold the left mouse button and start moving the mouse over the end of the range you want to select.

  3. When reaching the end of the selection range, release the mouse left button.

Mouse multiple selection

The mouse multiple selection allows the user to select multiple ranges of the content of the xamRichTextEditor using the mouse.

  1. Move the mouse pointer over the start of the range you want to select.

  2. Press and hold the left mouse button and start moving the mouse toward the end of the range you want to select.

  3. When reaching the end of the selection range, release the mouse left button.

  4. Hold the Ctrl key on the keyboard.

  5. Repeat steps 1 to3 for each additional range you want to select while holding the Ctrl key on the keyboard.

Note
Note

The user can select words from the content with double clicking on words (for both single and multiple selections).

Note
Note

Mouse multiple selection will work only if the IsMultiSelectEnabled property is set to true.

Table Resizing

The table-resizing feature allows the user to resize all cells on a single column or on a single row or resize the entire table hover the mouse over the lower right corner of the table and dragging it.

Text Formatting

The text styling feature allows the user to modify some of the text content’s properties.

Note
Note

Not all text content styling have shortcuts. However, all of them are available to you through the public API.

The following table maps the desired operation to its respective keyboard shortcut:

Operation Shortcut Description

Toggle Bold

Ctrl + B

Toggles the bold formatting of the selected text on and off.

Toggle Italic

Ctrl + I

Toggles the italic formatting of the selected text on and off.

Toggle Underline

Ctrl + U

Toggles the underline formatting of the selected text on and off.

Toggle Subscript

Ctrl + =

Toggles the subscript formatting of the selected text on and off.

Toggle Superscript

Ctrl + Shift + =

Toggles the superscript formatting of the selected text on and off.

Toggle All Caps

Ctrl + Shift + A

Toggles the capitalization of the characters of the selected text on and off.

Toggle Small Caps

Ctrl + Shift + K

Toggles the small caps formatting of the characters of the selected text on and off. The small caps feature replaces all lower case characters with capital characters however their height is the same as the lower case characters.

Undo/Redo

This feature allows the user to rollback recent changes or reapplies them.

The following table lists the operations available for the Undo/Redo feature using the keyboard:

Operation Keyboard Shortcut

Undo

Ctrl + Z

Redo

Ctrl + Y

View Splitting

The splitting feature allows the user to split the document view horizontally. When split the xamRichTextEditor can display different parts of the document’s content in the two different views. This feature is configurable, and you may disable the user to split the document view.

View Zooming

This feature allows the user to increase or decrease the rendering size of the view’s content. The view zoom feature is available to the user by holding the Control key and rotating the mouse wheel.

Related Content

Topics

The following topics provide additional information related to this topic.

Topic Purpose

This topic explains the document’s content logical structure you can use to edit the contents in the xamRichTextEditor programmatically.

This topic provides detailed instructions to help you get up and running as quickly as possible with the xamRichTextEditor .