Show / Hide Table of Contents

Output tags

Function print.it supports links, colors, images, etc. For it use tags in text. Similar to HTML tags. Also text must start with <>. It works only when text is displayed in the editor's output panel, not when in console.

For most tags use this format: <tag>text<> or <tag attribute>text<>.

For these tags use <tag>text</tag>: <code>, <_>, <\a>, <fold>.

These tags don't have a closing tag: <image "attribute">, <nonl>.

Attribute can be enclosed in ' or ". If attribute omitted, text is used as attribute if need for that tag.

Tags can be nested, like <b><c green>text<><> or <b>text <c green>text<> text<>.

Examples:

print.it("<>Text <i>italic<>, <c green>color<>, <link http://www.example.com>Link<>.");
print.it("<>Code example:\r\n<code>mouse.click(10, 20); //comments</code>");

Simple formatting tags

Examples Comments
<b>text<> Bold text.
<i>text<> Italic text.
<bi>text<> Bold italic.
<u>text<> Underline.
<c 0xE0A000>text<>
<c #E0A000>text<>
<c green>text<>
Text color.
Can be 0xRRGGBB, #RRGGBB or .NET color name.
<bc yellow>text<> Text background color.
<lc wheat>line text<> Line background color.
<size 10>text<> Font height.
Note: it can increase height of all lines.
<mono>text<> Monospace font.

Links

Examples Comments
<link http://www.example.com>text<>
<link C:\files\example.exe>text<>
<link>http://www.example.com<>
<link>C:\files\example.exe<>
<link C:\example.exe|args>text<>
Opens a web page or runs a program, file, folder.
Calls function run.itSafe.
<explore>C:\files\example<> Selects a file or folder in File Explorer.
Calls function run.selectInExplorer.
<google s1>text<>
<google>s1<>
<google s1|s2>text<>
Google. Opens this URL:
$"http://www.google.com/search?q={s1}{s2}"
Don't need to URL-encode.
<help>Class.Function<>
<help Au.Namespace.Class>text<>
<help articles/Output tags>text<>
Opens a help page of this library.
<open>Script5.cs<>
<open \Folder\Script5.cs>text<>
<open Script5.cs|10>text<>
<open Script5.cs|10|15>text<>
<open Script5.cs||100>text<>
<open Script5.cs|||word>text<>
<open Folder|expand>text<>
Opens a script or other file of current workspace in the code editor. Optionally moves the text cursor.
Can be file name, relative path in workspace, or full path.
10 is 1-based line index.
15 is 1-based character index in line.
100 is 0-based character index in text.
The word is text to find, whole word(s).
Selects and expands a folder.
<script>Script5.cs<>
<script \Folder\Script5.cs>text<>
<script Script5.cs|args0|args1>text<>
Runs a script.

Other tags

Examples Comments
<_>text</_> or <\a>text</\a> Literal text. Tags in it are ignored.
Here \a is escape sequence for character code 7.
<code>var s="example";</code> Colored C# code. Tags in it are ignored.
<fold>text</fold> Folded (hidden) lines. Adds a link to unfold (show).
<fold link text>text</fold> Folded lines with custom link text.
<nonl> No new line. Next time will write in the same line.
Must be at the end of string.

Images

Images are displayed below current line. Examples:

<image "c:\images\example.png">
<image "c:\files\example.txt">
<image "image:PngBase64">

Note: image path must be enclosed in "".

Supports images of formats: png, bmp, jpg, gif, ico (only 16x16). For other file types and folders displays small file icon.

Supports icon names (see menu Tools > Icons) and XAML images.

Supports Base64 encoded image file data. To create such string use dialog Find image or color in window or function Au.Controls.KImageUtil.ImageToString (in Au.Controls.dll).