InsertPicture

Description

Inserts an image at the insertion point in a RichTextEdit control.

Applies to

RichTextEdit controls

Syntax

rtename.InsertPicture ( filename{, format } )

Argument

Description

rtename

The name of the RichTextEdit control in which you want to insert an image

filename

A string whose value is the name of the file that contains the image

format

An integer whose value determines the format in which the image is saved in the RTF file. Values are:

  • 1 -- BMP

  • 2 -- WMF (default)

  • 3 -- PNG

  • 4 -- JPG


Return value

Integer. Returns 1 if it succeeds. Returns -2 if the compression format of a .tif file is not supported and -1 if a different error occurs. If filename is null, InsertPicture returns null.

Usage

If there is a selection, InsertPicture inserts the image at the beginning of the selection. The following file types are supported: .bmp, .wmf, .jpeg, .png, and .gif. The .tif file type is also supported if it uses the LZW compression format.

Examples

This example inserts a PNG file at the insertion point in the RichTextEdit control rte_1. The PNG file will be saved in the RTF file in WMF format:

integer li_rtn
li_rtn = rte_1.InsertPicture("c:\windows\earth.png")

This example inserts a JPG file at the insertion point in the RichTextEdit control rte_1. The JPG file will be saved in the RTF file in JPG format:

integer li_rtn
li_rtn = rte_1.InsertPicture("c:\windows\earth.jpg", 4)

See also

InputFieldInsert

InsertDocument