rvico TRichView Reference | TRichView

TCustomRichView.Options

Top  Previous  Next

Options

type

  TRVOption = (rvoAllowSelection, rvoSingleClick, rvoScrollToEnd,

    rvoClientTextWidth, 

    rvoShowCheckpoints, rvoShowPageBreaks,

    rvoShowSpecialCharacters, rvoShowHiddenText,

    rvoTagsArePChars,

    rvoAutoCopyText,  rvoAutoCopyUnicodeText

    rvoAutoCopyRVF, rvoAutoCopyImage,

    rvoAutoCopyRTF,

    rvoFormatInvalidate,

    rvoDblClickSelectsWord, rvoRClickDeselects,

    rvoDisallowDrag, rvoShowItemHints, rvoShowGridLines,

    rvoFastFormatting, rvoPercentEncodedURL, rvoAssignImageFileNames);

  TRVOptions = set of TRVOption;

 

property Options: TRVOptions;

Note: TRVOption and TRVOptions are declared in RVScroll unit.

Default value

For Delphi/C++Builder 2009 or newer: [rvoAllowSelection, rvoScrollToEnd, rvoAutoCopyUnicodeText, rvoAutoCopyImage, rvoAutoCopyRVF, rvoAutoCopyRTF, rvoDblClickSelectsWord, rvoRClickDeselects, rvoFormatInvalidate, rvoShowPageBreaks, rvoShowGridLines, rvoFastFormatting]

For older versions: the same, but with rvoAutoCopyText instead of rvoAutoCopyUnicodeText.

General Options

Option

Meaning

rvoTagsArePChars

Obsolete, does nothing.

rvoClientTextWidth

If set, text always wraps to fit client width of RichView.

Also affects breaks and tables.

See details.

Can be changed: any time, but you need to reformat and repaint RichView after changing this option, if the document was already formatted.

rvoScrollToEnd

If set (default), RichView scrolls to the end of document when FormatTail method is called.

If cleared, document does not scroll in this case

Can be changed: any time.

rvoSingleClick

If set, OnRVDblClick event is generated on single mouse click

If cleared (default), it is generated on double mouse click

Can be changed: any time.

rvoFormatInvalidate

If set (default), Format and FormatTail methods repaint component.

Can be changed: any time.

rvoDisallowDrag

If set, dragging from this TRichView is not allowed.

Can be changed: any time.

rvoFastFormatting

Increase performance in WinNT-based OS at the cost of some resources

rvoPercentEncodedURL

If set, it is assumed that URLs (stored in tags or provided in OnWriteHyperlink event) are %-encoded, so no additional encoding/decoding is necessary when working with RTF, HTML, and DocX.

By default (if not set), the component %-encodes hyperlink targets saved to RTF, HTML, DocX, and %-decodes when loading RTF.

rvoAssignImageFileNames

If set, the component assigns file names of images, when possible.

This option affects: RTF loading (reading external images), HTML loading (using importer components), pasting files, accepting files and links to images as a result of drag&drop, RichViewActions (actions for inserting images and assigning background images of tables).

The following properties are set:

table.BackgroundImageFileName

cell.BackgroundImageFileName

rvespImageFileName item property

See also: OnAssignImageFileName event.

 

Selection Options

Can be changed: any time.

Option

Meaning

rvoAllowSelection

If set (default), user can select content of RichView using mouse or keyboard.

Please do not clear this option for TRichViewEditor!

See: working with selection.

rvoDblClickSelectsWord

If set (default), double click on word selects it (and double click on non-text item selects this item)

rvoRClickDeselects

If set (default), right click outside the selected area deselects (and moves caret to the clicked position in TRichViewEdit)

 

Show/Hide Options

Option

Meaning

rvoShowCheckpoints

If set, all checkpoints are shown (as dotted horizontal lines, or by OnDrawCheckpoint). See details.

Can be changed: any time, you need to repaint RichView after changing this option

rvoShowPageBreaks

If set (default), page breaks are shown as horizontal lines.

Can be changed: any time, you need to repaint RichView after changing this option

rvoShowSpecialCharacters

If set, nonprinting characters are displayed as special marks: spaces, nonbreaking spaces, paragraph breaks, line breaks, tabs, soft hyphens in Unicode text, lines to left- and right-aligned items, places of insertion of text boxes.

Can be changed: any time, you need to reformat RichView after changing this option, if the document is already formatted.

See also: RVVisibleSpecialCharacters, RichViewShowGhostSpaces typed constants.

rvoShowHiddenText

If set, hidden items are displayed.

Can be changed: any time, you need to reformat RichView after changing this option, if the document is already formatted.

rvoShowItemHints

If set, items' hints are shown. Popup hints are shown only if ShowHints property is set to True. See item properties and OnItemHint event.

rvoShowGridLines

If set, table grid lines are shown.

 

Clipboard Options (See Details)

If set , RichView copies the selection to the Clipboard in the specified formats when the user presses  Ctrl + Insert  or  Ctrl + C . These options also affect CopyDef. These options can be changed at any time.

Option

Format to Copy

rvoAutoCopyText

ANSI text

rvoAutoCopyUnicodeText

Unicode text

rvoAutoCopyRVF

RVF (RichView Format)

rvoAutoCopyRTF

RTF (Rich Text Format)

rvoAutoCopyImage

Bitmap or metafile (if the image is selected)


TRichView © trichview.com