GAMBAS BOOK 3.19.5

The TextEdit control implements a RichText editor, whereby the term RichText in this context has nothing to do with the well-known RichText format.

How to create a new TextEdit editor:

Dim hTextEdit As TextEdit
hTextEdit = New TextEdit ( Parent As Container ) [ As "EventName" ]

Gambas RichText is a character string and is based on a special markup that uses a subset of HTML to mark up text.

The following HTML tags are allowed for Gambas RichText to mark up text elements:

<h1>, <h2>, <h3>, <h4>, <h5>, <h6> → headings
<b> → bold,
<i> → italic,
<s> → strikethrough,
<u> → underlined
<sub> → subscript,
<sup> → superscript,
<small> → small,
<p> → paragraph
<br> → line break,
<a> → link,
<font> → font

Information about the <font> tag is given in the following table. Please note that the <font> tag no longer exists under HTML5!

Table 16.15.1.1: Information on the <font> tag

These tags have also been tried and tested for marking up single or multi-line source text or for inserting a horizontal line or displaying an unsorted list with n entries:

<tt> → single-line source code,
<pre> → multi-line source code,
<hr> → horizontal line
<ul> → unsorted list,
<li> → list entry

Notes:

• Working with CSS is supported both internally and externally, but you should not expect that all design options offered by a browser can also be implemented with the TextEdit control.
• Even though Gambas-RichText primarily uses the HTML tags mentioned above as basic markup, you can use any HTML entity.
• You can use <a>…</a> to insert a link into the text. It is underlined and formatted in blue - as expected for a hyperlink - but it has no effect! After right-clicking on the link, you can copy the link address from the context menu.

The TextEdit class has these properties:

Table 16.15.2.1: Properties of the TextEdit class

Table 16.15.2.1.1: Properties of the TextEdit.Format class

Setting the 'TextEdit.Foreground' property has no effect on the text in the RichText editor.

You must either use HTML syntax to set text colors `inline` or set the text color using the TextEdit.Format.Color property of the TextEdit.Format virtual class:

TextEdit1.RichText = "<font color=red>This is some red text</font> and the text is default text color"

The same result can be achieved using inline CSS:

TextEdit1.RichText = "<span style=\"color: red;\">This is some red text</span> and the text is the default text color."   

Alternative without HTML syntax:

TextEdit1.Format.Color = Color.Red
TextEdit1.Insert("This is some red text")
TextEdit1.Format.Color = Color.Default
TextEdit1.Insert(" and the text is default text color")

Table 16.15.2.2.1: Properties of the TextEdit.Selection class

The TextEdit.Selection.Hide( ) method removes a selection of the currently selected text.

The TextEdit class has these methods:

Table 16.15.3.1: Methods of the TextEdit class

The TextEdit class has these two relevant events:

Table 16.15.4.1: Events of the TextEdit class

===== 16.15.5 Project <x h>======</x>

As an example of a TextEdit editor, reference is made to the project from the Gambas sources. You can also find the project archive in the download area.

Figure 16.15.5.1: GUI: TextEdit editor