[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand].NET Core 3 Support
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Collapse]Controls and Libraries
   Reporting
  [Expand]Data Grid
  [Expand]Ribbon, Bars and Menu
  [Expand]Charts Suite
  [Expand]Pivot Grid
  [Expand]Scheduler
  [Expand]Spreadsheet
  [Collapse]Rich Text Editor
   [Expand]Product Information
    Product Class Structure
    Supported Formats
   [Expand]Getting Started
   [Expand]RichEditControl Document
   [Collapse]Fields
    [Collapse]Field Codes
      AUTHOR
      COMMENTS
      CREATEDATE
      DATE
      DOCPROPERTY
      DOCVARIABLE
      HYPERLINK
      IF
      INCLUDEPICTURE
      KEYWORDS
      LASTSAVEDBY
      MERGEFIELD
      NUMPAGES
      PAGE
      PRINTDATE
      REVNUM
      SAVEDATE
      SEQ
      SUBJECT
      SYMBOL
      TC
      TIME
      TITLE
      TOC
    [Expand]Format Switches
    Text Formatting
    Import and Export
   [Expand]Page Layout
    Printing
    Hyphenation
    AutoCorrect
    Track Changes
    Mail Merge
    Restrictions and Protection
   [Expand]Visual Elements
    Services
    Events
    Commands
    HTML Tag Support
   [Expand]Examples
  [Expand]Tree List
  [Expand]Gauge Controls
  [Expand]Map Control
  [Expand]Layout Management
  [Expand]Windows Modern UI
  [Expand]Printing-Exporting
  [Expand]Data Editors
  [Expand]Navigation Controls
  [Expand]Spell Checker
  [Expand]Property Grid
  [Expand]PDF Viewer
  [Expand]TreeMap Control
  [Expand]Gantt Control
  [Expand]Diagram Control
  [Expand]Windows and Utility Controls
   Dialogs, Notifications and Panels
  [Expand]Scheduler (legacy)
 [Expand]Scaffolding Wizard
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

INCLUDEPICTURE

INCLUDEPICTURE

Mixed field

{ INCLUDEPICTURE "picture's URI" [\d] }

Inserts the picture retrieved from the specified URI.

The \d switch enables you to not store the image in a document file. For 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.

Is this topic helpful?​​​​​​​