TRichView Reference | TRichView

TCustomRichView.GetControlInfo

Returns main properties of the item of  "inserted control" type

procedure GetControlInfo(ItemNo: Integer;

  var AName: String; var Actrl: TControl; 

  var AVAlign: TRVVAlign;

  var ATag: Integer);

Input parameter:

ItemNo – index of the item. The item must be of "inserted 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.GetControlInfo.

Output parameters:

AName – name of control item. Do not confuse with Actrl.Name property! This value can also be read using GetItemText method.

Actr – the control itself. This method returns control owned by RichView, do not not destroy it.

AVAlign – vertical alignment of the control.

ATag – tag of the item. Do not confuse with Actrl.Tag property! If tags are pointers to dynamically allocated strings (rvoTagsArePChars in Options), this procedure returns a pointer to this string (you can convert the returned ATag to PChar), not to the copy of it, so you should not free it. Use SetItemTag or SetControlInfo to change tag of item. This value can also be read using GetItemTag method.

Additional item properties are returned by the methods GetItemExtraIntProperty and GetItemExtraStrProperty.

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

See also methods:

See also properties:

See also: