rvico TRichView Reference | TRichViewEdit

TCustomRichViewEdit.GetCurrentControlInfo

Top  Previous  Next

Returns main properties for the item of inserted control type at position of caret.

procedure GetCurrentControlInfo(out AName: TRVUnicodeString;

  out Actrl: TControl; out AVAlign: TRVVAlign;

  out ATag: TRVTag);

(changed in version 18)

GetCurrentControlInfo(...) is equivalent to TopLevelEditor.GetControlInfo(TopLevelEditor.CurItemNo, ...).

Output parameters:

AName – name of control item. Do not confuse with Actrl.Name property! This value can also be read using GetCurrentItemText 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!. Use SetCurrentTag or SetCurrentControlInfo to change tag of item as an editing operation. This value can also be read using GetCurrentTag method.

 

This method must be called only when the document is formatted.

Additional properties of item at the position of caret are returned by the methods GetCurrentItemExtraIntProperty and GetCurrentItemExtraStrProperty.

 

See also methods:

SetCurrentControlInfo (changes properties of control item at the position of caret, as an editing operation);

GetControlInfo (returns properties of the specified control item).

See also properties:

CurItemNo;

CurItemStyle.

See also:

Obtaining RichView items;

Item types;

"Tags".


TRichView © trichview.com