TRichView

TRichView is a control for displaying documents with pictures, tables, Delphi controls, hyperlinks, footnotes and endnotes, etc.

Unit [VCL/FMX] RichView / fmxRichView.

Syntax

TCustomRichView = class(TRVScroller)

TRichView = class(TCustomRichView)

TRichView does not display its content if it is not linked to TRVStyle component via Style property.

The most important property settings can be done in the component editor for TRichView. In Delphi (C++Builder) IDE, right click the RichView object on the form, choose "Settings" in the context menu.

Hierarchy

Hierarchy (VCL and LCL)

Hierarchy (FireMonkey)

List of properties, events and methods

grouped in several categories (some entries can be in several groups)

Scrolling, margins, sizes

Selection and Clipboard

Saving and loading as RVF

Other methods for saving and loading

LiveBindings and DB

Information about items

Working in palette mode

Custom Drawing

Other properties, methods and events

General properties

▪Style – link to RVStyle component defining a lot of properties which can be used in several RichViews;

▪Options – some important options;

▪ItemCount – number of items in the document.

Properties defining background

▪BackgroundBitmap;

▪BackgroundStyle;

▪Color.

Appending items (Add*** methods)

Main methods for appending items:

▪AddNL adds one text item;

▪AddBreak adds break (horizontal line);

▪AddBullet adds bullet (image from ImageList);

▪AddHotspot adds hotspot (image from ImageList - hypertext link);

▪AddPicture adds picture;

▪AddHotPicture adds picture - hypertext link;

▪AddControl adds Delphi/C++Builder control;

▪AddTab adds tabulator;

▪AddItem – general method for appending items (usually used for tables);

▪also AddCheckpoint – adds checkpoint which will be associated with next added item.

Additional methods for appending items:

▪Add adds one text item in last paragraph;

▪AddFmt adds one formatted string assembled from a Pascal format string and an array arguments;

▪AddTextNL, -A -W add several text items from text, separated by CR+LF characters;

Also

▪AppendFrom copies content from another RichView;

▪InsertRVFFromStream,

▪AppendRVFFromStream.

Hypertext

▪event OnJump occurs when user clicks hyperlink;

▪event OnRVMouseMove occurs when mouse pointer moves over hyperlink;

▪events OnWriteHyperlink and OnReadHyperlink occur when document is saved or loaded as RTF, DocX or HTML.

▪property FirstJumpNo – use to set hypertext id for the first hypertext item;

▪GetJumpPointLocation should be used instead of GetJumpPointItemNo in applications working with tables;

▪GetJumpPointY returns Y coordinate of item with the specified hypertext id.

Style templates

Properties:

▪UseStyleTemplates allows or disallows using Style.StyleTemplates.

▪StyleTemplateInsertMode specifies how style templates are used when inserting RTF or RVF content.

Events:

▪OnStyleTemplatesChange occurs then the collection of style templates has been modified.

Scrolling, margins and sizes

Properties:

▪LeftMargin, RightMargin, TopMargin, BottomMargin – margins;

▪MaxTextWidth – maximal width for word wrapping;

▪MinTextWidth – minimal width for word wrapping (minimal width of scrollable area, not including margins);

▪DocumentHeight – height of document (height of scrollable area);

▪VAlign – vertical alignment of document;

▪VScrollVisible – hides/shows vertical scrollbar;

▪HScrollVisible – hides/shows horizontal scrollbar;

▪VSmallStep – number of pixels in one step of vertical scrollbar;

▪FirstItemVisible – the first visible item;

▪LastItemVisible – the last visible item;

▪MaxLength – maximal count of characters per line;

▪WordWrap allows to disable word wrapping;

▪Tracking – whether RichView repaints while its scrollbar thumb tab is dragged with the mouse.

Methods:

▪ClientToDocument converts client coordinates to document coordinates

Events:

▪OnVScrolled occurs when document is scrolled vertically

▪OnHScrolled occurs when document is scrolled horizontally

Also:

▪property CPEventKind

▪event OnCheckPointVisible

▪method GetItemCoords

Methods for working with selection and the Clipboard

▪SelectionExists returns "is something selected?"l

▪Copy copies selection to the Clipboard in all available formatsl

▪CopyDef copies selection to the Clipboard using formats specified in Options;

▪CopyImage copies selected image to the Clipboard;

▪CopyTextA copies selection as text to the Clipboard;

▪CopyTextW copies selection to the Clipboard as Unicode text;

▪CopyRVF copies selection as RVF to the Clipboard;

▪CopyRTF copies selection as RTF (Rich Text Format);

▪GetSelectedImage returns selected image

▪GetSelText returns selection as text

▪GetSelTextW returns selection as Unicode string;

▪GetOffsBeforeItem, GetOffsAfterItem return offset before/after the given item; useful with SetSelectionBounds;

▪SelectAll selects the whole document for copying to the Clipboard;

▪SetSelectionBounds selects the specified items;

▪SelectWordAt selects the word at (X,Y);

▪SelectControl selects a visual control;

▪Deselect clears selection (not contents, but bounds);

▪GetSelectionBounds returns bounds of selection;

▪event OnSelect occurs when selection bounds are changed;

▪event OnCopy allows to copy selection to the Clipboard in custom formats;

▪property SelectionHandlesVisible shows or hides selection handles for a touch screen.

Properties, methods and events for loading and saving RVF

Properties:

▪RVFOptions – options for saving and loading RVF;

▪RVFWarnings describes warnings or errors occurred during the last reading of RVF.

Events:

▪OnRVFControlNeeded requests inserted control when reading RVF, if RVF was saved without controls' "bodies";

▪OnRVFImageListNeeded requests ImageList when reading bullet or hotspotfrom RVF;

▪OnRVFPictureNeeded requests image when reading RVF, if RVF was saved without images' "bodies".

Methods:

▪SaveRVF saves document or selection as RVF to the file;

▪SaveRVFToStream saves document or selection as RVF to the stream;

▪LoadRVF loads RVF from the file;

▪LoadRVFFromStream loads RVF from the stream;

▪CopyRVF copies selection as RVF to the Clipboard;

▪InsertRVFFromStream inserts RVF from the stream;

▪AppendRVFFromStream appends RVF from the stream using the specified paragraph style for the first RVF item.

Also:

▪methods Copy, CopyDef.

Other saving and loading

Methods:

▪SetHeader, SetFooter specify documents for using as headers and footers; they are used to load and save headers and footers to files (RVF, RTF, DocX)

▪LoadFromStream, LoadFromStreamEx load document in RVF, RTF, HTML, DocX, Markdown or text format (format detection) from a stream;

▪LoadFromFile, LoadFromFileEx load document in RVF, RTF, HTML, DocX, Markdown or text format (format detection) from a file;

▪LoadHTML, LoadHTMLFromStream appends a file or a stream in HTML format;

▪LoadText appends text form a file;

▪LoadTextW appends text from a file in Unicode (UTF-16) encoding;

▪LoadRTF, LoadRTFFromStream appends a file or a stream in RTF (Rich Text Format);

▪LoadMarkdown, LoadMarkdownFromStream appends a file or a stream in Markdown format;

▪SaveHTML, SaveHTMLToStream save the document in an HTML file/stream;

▪SaveText, SaveTextToStream save the document in a file/stream as ANSI text;

▪SaveTextW, SaveTextToStreamW save the document in a file/stream as a Unicode text;

▪SaveDocX, SaveDocXToStream save the document (or selection) in a file/stream as DocX (Microsoft Word format);

▪SaveRTF, SaveRTFToStream save the document (or selection) in a file/stream as RTF.

▪SaveMarkdown, SaveMarkdownToStream save the document (or selection) in a file/stream as Markdown.

Properties:

▪RTFOptions – options for DocX and RTF export.

▪RTFReadProperties – properties for DocX and RTF import.

▪HTMLReadProperties – properties for HTML import.

▪HTMLSaveProperties – properties for HTML export.

▪MarkdownProperties – properties for Markdown import and export.

Events:

▪OnSaveComponentToFile allows to save inserted controls in DocX, RTF, Markdown, HTML, and text files;

▪OnWriteHyperlink, OnReadHyperlink allow to customize saving/loading of hypertext links in HTML, Markdown, RTF and DocX files;

▪OnWriteObjectProperties allows saving additional properties of non-text objects in HTML, RTF and DocX files;

▪OnReadMergeField allow importing merge fields from RTF;

▪OnHTMLSaveImage, OnSaveImage2 allow to save images with HTML in custom formats and with custom file names;

▪OnSaveItemToFile allows to save any item in RTF, DocX, Markdown, HTML or text files in your own format;

▪OnImportPicture allows custom processing of external images when importing RTF, DocX, Markdown, HTML;

▪OnImportFile allows custom processing of external files when importing HTML;

▪OnAssignImageFileName allows changing file names assigned to inserted images when importing RTF, DocX or Markdown.

LiveBindings and Databases

Properties:

▪Document allows linking this TRichView control to TBlobField field of DB (in Delphi XE2+)

Events:

▪OnNewDocument occurs when creating or before loading a document from a DB field

▪OnLoadDocument occurs after loading a document from a DB field

▪OnLoadCustomFormat allows loading documents from a DB field in custom formats

Information about items (Get***Info methods)

▪GetItemStyle returns a type of item;

▪GetTextInfo – information about text item;

▪GetBreakInfo – about "break";

▪GetBulletInfo – about "bullet";

▪GetHotspotInfo – about "hotspot";

▪GetPictureInfo – about picture or "hot-picture";

▪GetControlInfo – about inserted control;

▪GetItemExtraIntProperty[Ex],
GetItemExtraStrProperty[Ex] return value of extra item property;

▪GetItem – general method for obtaining items (usually used for tables);

▪GetItemCheckpoint – about item's "checkpoint";

▪GetItemVAlign – about item's position relative to line;

▪GetItemTag – about item's "tag";

▪GetItemText – about text/name of item;

▪IsParaStart returns "is this item a first item in paragraph?";

▪IsFromNewLine returns "is this item a first item in paragraph?";

▪GetItemPara returns an index of paragraph containing a specified item;

▪GetItemNo returns item index for object representing item (usually used for tables);

▪GetItemCoords returns coordinates of item relative to document area, GetItemClientCoords returns coordinates of item relative to client area of RichView window;

▪properties PageBreaksBeforeItems, ClearLeft, ClearRight.