rvico TRichView Reference | TRichViewEdit

TCustomRichViewEdit.InsertPicture

Top  Previous  Next

Inserts picture in the position of caret.

function InsertPicture(const Name: TRVUnicodeString; gr: TGraphic;

  VAlign: TRVVAlign): Boolean;

(changed in version 18)

Parameters:

Name – name of this picture item, any string. Name must not contain CR and LF characters. TRichView does not use items names itself, they are for your own use.

gr – picture to insert. By default, this picture will be owned by TRichView control, and you must not free it. However, you can specify nonzero rvepShared extra item property, and this graphic object will be shared (you need to free it yourself after TRichView is cleared).

Rarely used images may be "deactivated", i.e. stored in a memory stream and destroyed (see RichViewMaxPictureCount). Shared images are never deactivated.

VAlign – vertical align of this picture, relative to its line, see TRVVAlign for possible values.

 

Method type: editstyle editing-style method for insertion.

If you want this picture to be a hypertext link, use InsertHotPicture instead.

 

Return value

True if the insertion was successful (it can fail due to protection, or when inserting in table having multicell selection). If insertion failed, TRichViewEdit destroys gr.

 

Example (inserting icon from file)

var ico: TIcon;

...

ico := TIcon.Create;

ico.LoadFromFile('My Icon.ico');

MyRichViewEdit.InsertPicture('',ico, rvvaBaseline);

Example 2 (inserting picture of any supported format):

var gr: TGraphic;
...
if OpenPictureDialog1.Execute then
  gr := RVGraphicHandler.LoadFromFile(OpenPictureDialog1.FileName);
  if gr<>nil then
    MyRichViewEdit.InsertPicture('', gr, rvvaBaseline)
  else
    // process a picture loading error here
end;

See also methods of TCustomRichView:

AddPicture.

See also:

Inserting items in position of caret;

Hypertext in RichView;

Item types.


TRichView © trichview.com