TRichView

TRichView Reference | TRichView

TRichView

Properties Methods Events

Top Previous Next

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

Unit RichView;

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

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TRVScroller

TCustomRichView

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

Information about items

Working in palette mode

Other properties, methods and events

Obsolete properties and methods

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;

▪	AddBreakEx adds break (horizontal line);

▪	AddBulletEx adds bullet (image from ImageList);

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

▪	AddPictureEx adds picture;

▪	AddHotPicture adds picture - hypertext link;

▪	AddControlEx adds Delphi/C++Builder control;

▪	AddTab adds tabulator;

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

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

"Tagged" analogs of the methods above (Add***Tag methods) (the same methods, but have additional Tag parameter):

▪

AddNLTag;

▪	AddBreakExTag;

▪	AddBulletExTag;

▪	AddHotspotExTag;

▪	AddPictureExTag;

▪	AddHotPictureTag;

▪	AddControlExTag;

▪	also AddNamedCheckpointExTag and AddNLATag, AddNLWTag.

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, AddTextNLA add several text items from text, separated by CR+LF characters;

▪	AddTextBlockNL – the same, but always adds one paragraph;

▪	AddBreak provides a subset of functionality of AddBreakEx;

▪	also: AddCheckpoint provides subset of functionality of AddNamedCheckpointEx;

▪	also Unicode-enabled methods.

"Tagged" analogs of the methods above:

▪

AddTag;

▪	AddBreakTag;

▪	also AddCheckpointTag.

Also

▪	AppendFrom copies content from another RichView;

▪	InsertRVFFromStream,

▪	AppendRVFFromStream.

See also

▪	Clear clears document;

▪	SetAddParagraphMode;

▪	Format, FormatTail format the document;

▪	Reformat reformats the document.

Hypertext

▪	event OnJump occurs when user clicks hyperlink;

▪	event OnRVMouseMove occurs when mouse pointer moves over hyperlink;

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

▪	GetJumpPointItemNo (deprecated) returns index of item with the specified hypertext id;

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

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

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;

▪	CopyText 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.

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:

▪	LoadFromStream loads document in RVF, RTF or text formats;

▪	LoadText appends text form the file;

▪	LoadTextW appends text from the file in Unicode encoding;

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

▪	SaveHTML saves the document in the HTML file;

▪	SaveHTMLEx saves the document in the HTML file using CSS;

▪	SaveHTMLToStream, SaveHTMLToStreamEx – the same as the methods above, but save HTML to the stream;

▪	SaveText saves the document in the text file;

▪	SaveTextW saves the Unicode file;

▪	SaveTextToStream, SaveTextToStreamW – the same for streams (can save selection only);

▪	SaveRTF saves the document (or selection) in the RTF file;

▪	SaveRTFToStream saves the document (or selection) in the RTF stream.

Properties:

▪	RTFOptions – options for RTF export.

Events:

▪	OnSaveComponentToFile allows to save inserted controls in HTML and text files;

▪	OnWriteHyperlink, OnReadHyperlink allow to save/load hypertext links in HTML and RTF files;

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

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

▪	OnImportPicture allows custom processing of external images when importing RTF.

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, GetItemExtraStrProperty return value of extra item property;

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

▪	GetItemCheckpoint – about item's "checkpoint";

▪	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;

▪	property PageBreaksBeforeItems.

Modifying items (Set***Info methods)

▪	SetBreakInfo changes break;

▪	SetBulletInfo changes bullet;

▪	SetHotspotInfo changes hotspot;

▪	SetPictureInfo changes picture or hot-picture;

▪	SetControlInfo changes inserted control; also

▪	SetItemTag changes item's "tag";

▪	SetItemText changes text/name of item;

▪	SetItemExtraIntProperty, SetItemExtraStrProperty sets value of extra item property;

▪	SetCheckpointInfo sets or changes item's "checkpoint";

▪	RemoveCheckpoint removes item's "checkpoint";

▪	see also property PageBreaksBeforeItems.

Working with checkpoints

Obtaining checkpoint data:

▪	GetFirstCheckpoint, GetNextCheckpoint allow to receive full list of checkpoints;

▪	GetLastCheckpoint, GetPrevCheckpoint – the same in backward direction;

▪	GetCheckPointByNo returns a checkpoint with the specified index;

▪	GetItemCheckpoint returns the item's checkpoint;

▪	event OnCheckPointVisible occurs when checkpoint (or "section", marked by this checkpoint) becomes visible as a result of vertical scrolling;

▪	FindCheckPointByName searches for checkpoint with the specified name;

▪	FindCheckPointByTag searches for checkpoint with the specified tag.

Extracting properties from checkpoint data:

▪	GetCheckpointInfo returns main properties of the checkpoint;

▪	GetCheckpointItemNo returns an index of item which owns the checkpoint;

▪	GetCheckpointNo returns an index of the checkpoint;

▪	GetCheckpointYEx, GetCheckpointXY returns coordinates of the checkpoint.

Also:

▪	GetCheckPointY returns Y coordinate of checkpoint by its index.

See also methods for obtaining information about items and for modifying document.

Mouse events

▪	OnRVDblClick occurs on double click;

▪	OnRVMouseDown occurs when user presses mouse button;

▪	OnRVMouseUp occurs when user releases mouse button;

▪	OnRVRightClick occurs on right click.