TCustomRichView.GetPictureInfo

<< Click to display table of contents >>

TCustomRichView.GetPictureInfo

Returns main properties for item of picture or hot-picture type

procedure GetPictureInfo(ItemNo: Integer; out AName: TRVUnicodeString;

  out Agr: TGraphic; out AVAlign: TRVVAlign;

  out ATag: TRVTag);

(changed in version 18)

Input parameter:

ItemNo index of the item. The item must be of picture or hot-picture type (rvsPicture), 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.GetPictureInfo.

 

Output parameters:

AName name of the item. This value can also be read using GetItemText method.

Agr graphic object. This method returns object owned by RichView, do not not destroy it.

AVAlign vertical alignment of the picture.

ATag tag of the item. Use SetItemTag or SetPictureInfo to change tag of item. This value can also be read using GetItemTag method.

 

Additional item properties (including stretching, transparency for bitmaps, link to file name, alternative text for saving to HTML) are returned by the methods GetItemExtraIntProperty and GetItemExtraStrProperty.

 

See also methods:

SetPictureInfo;

GetItemStyle;

GetItemExtraIntProperty;

GetItemExtraStrProperty.

See also properties:

ItemCount.

See also:

Obtaining RichView items;

Item types;

"Tags".