TRichView Reference | TRichView

TCustomRichView.SetControlInfo

Changes main properties of the item of control type.

function SetControlInfo(ItemNo: Integer; const AName: String;

  AVAlign: TRVVAlign; ATag: Integer): Boolean;

Parameters:

ItemNo – index of the item. The item must be of control type (rvsComponent), otherwise the method raises ERichViewError exception. Items are indexed from 0 to ItemCount-1, GetItemStyle returns type of item. Items of subdocuments (table cells) are not included in the items range of the main document; for items in cells, use Cell.GetRVData.SetControlInfo.

AName – name of the item, any string without line break (CR, LF) characters. It can also be set using SetItemText method. This is not a Name property of the control!

AVAlign – vertical alignment of this item, see TRVVAlign for possible options.

ATag – tag of the item. Do not confuse with Tag property of the control! If tags are pointers to dynamically allocated strings (rvoTagsArePChars in Options), this parameter must be set to value returned by StrNew of StrAlloc functions, typecasted to integer. You can use value returned by GetControlInfo or GetItemTag for this item. The tag can also be set by SetItemTag method.

Return value: "is reformatting needed? (i.e., is the new vertical align not equal to the old one?)"

Method type: viewer-style.

Additional item properties are assigned by the methods SetItemExtraIntProperty and SetItemExtraStrProperty.

Unicode note: names of non-text items are ANSI strings.

Note: As you can see, current version of TRichView does not allow to change the control itself.

Example

// if not (rvoTagsArePChars in RichView1.Options)

RichView1.SetControlInfo(ItemNo, 'my control', rvvaBaseline, 1)

// if rvoTagsArePChars in RichView2.Options

RichView1.SetControlInfo(ItemNo, 'my control', rvvaBaseline, Integer(StrNew('control tag')));

See also methods:

See also properties:

See also methods of RichViewEdit:

See also: