INCLUDEPICTURE
- 2 minutes to read
Mixed field
{ INCLUDEPICTURE “picture’s URI“ [\d] }
Inserts the picture retrieved from the specified URI.
The INCLUDEPICTURE field supports the following switch:
| Switch | Description |
|---|---|
| \d | Enables you to not store the image in a document file. |
Example:
The {INCLUDEPICTURE "C:\\TMP\\Mypicture.png" \d} field retains a link to the picture, but the picture itself is not included in the saved document. This switch is useful for storing document templates, which retrieve images from an external source, such as a database.
Use this field to insert images in the mail merge report. If the template requires mail merging different images, make sure that images have the same name as the contents of a field in the database (e.g. as the “FirstName” field), and insert the INCLUDEPICTURE as follows: { INCLUDEPICTURE "C:\\TMP\\{ MERGEFIELD "FieldName" }.jpg" \d }.
When a field is updated, the IUriStreamService.GetStream method is called. This method calls the IUriStreamProvider.GetStream methods of registered providers to obtain a stream of image data. Subsequent calls are made until a successful result is obtained. The order of calls is the order in which providers registered. By default, there is only one provider that enables you to load an image from the specified URI by performing a web request.
This stream is used by internal RichEdit objects to create a OfficeImage instance via the OfficeImage.CreateImage method.
You can create a class implementing the IUriStreamProvider interface and define the IUriStreamProvider.GetStream method as required to provide image data for a custom URI, which can be a string in your own arbitrary format.