rvico TRichView Reference | TRichViewEdit

TCustomRichViewEdit.SetCurrentItemExtraStrProperty, SetCurrentItemExtraStrPropertyEx

Top  Previous  Next

The methods change a value of a string property for the item at the position of caret

procedure SetCurrentItemExtraStrProperty(Prop: TRVExtraItemStrProperty;

  const Value: String; AutoReformat: Boolean);

procedure SetCurrentItemExtraStrPropertyEx(Prop: Integer;

  const Value: String; AutoReformat: Boolean);

(introduced in versions 1.9 and 15)

SetCurrentItemExtraStrProperty[Ex](...) is equivalent to TopLevelEditor.SetItemExtraStrProperty[Ex]Ed(TopLevelEditor.CurItemNo, ...).

This method sets a new Value of the item's property identified by Prop.

In SetCurrentItemExtraStrProperty, Prop's type is TRVExtraItemStrProperty. See information about this type for the list of properties.

In SetCurrentItemExtraStrPropertyEx, Prop's type is Integer. If Prop can be converted to TRVExtraItemStrProperty, SetCurrentItemExtraStrPropertyEx works like SetCurrentItemExtraStrProperty. In addition, it supports properties identified by rvespc*** constants

If AutoReformat=True, these methods automatically reformat the document and call OnChange.

If AutoReformat=False (this can be useful if you set several properties of an item at once), call Change and reformat the document after it yourself. A reformatting depends on the property:

some properties do not require reformatting or repainting;

some properties require a local reformatting (for example, "format string" of numbered sequences) (change properties between calls of BeginItemModify and EndItemModify);

some properties require a complete reformatting (for example, "sequence name" of numbered sequences) (call Reformat).

Method type: editstyle editing-style.

unicode Unicode note: string properties are Unicode strings for Delphi/C++Builder 2009 or newer, and ANSI strings for older versions of Delphi/C++Builder.

 

See also methods:

GetCurrentItemExtraStrProperty[Ex];

SetItemExtraStrProperty[Ex]Ed;

SetCurrentItemExtraIntProperty[Ex].

See also methods of TCustomRichView:

SetItemExtraStrProperty[Ex].


TRichView © trichview.com