[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Collapse]Reporting
 [Expand]Product Information
 [Expand]Get Started with DevExpress Reporting
 [Expand]Create Popular Reports
 [Expand]Detailed Guide to DevExpress Reporting
 [Expand]Visual Studio Report Designer
 [Expand]Create End-User Reporting Applications
 [Collapse]API Reference
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraPrinting.Caching
  [Expand]DevExpress.XtraReports
  [Expand]DevExpress.XtraReports.CodeCompletion
  [Expand]DevExpress.XtraReports.CodeCompletion.Storages
  [Expand]DevExpress.XtraReports.Configuration
  [Expand]DevExpress.XtraReports.Data
  [Expand]DevExpress.XtraReports.Design
  [Expand]DevExpress.XtraReports.Expressions
  [Expand]DevExpress.XtraReports.Extensions
  [Expand]DevExpress.XtraReports.FavoriteProperties
  [Expand]DevExpress.XtraReports.Localization
  [Expand]DevExpress.XtraReports.Native
  [Expand]DevExpress.XtraReports.ReportGallery
  [Expand]DevExpress.XtraReports.ReportGeneration
  [Expand]DevExpress.XtraReports.Security
  [Expand]DevExpress.XtraReports.Serialization
  [Expand]DevExpress.XtraReports.Service
  [Expand]DevExpress.XtraReports.Service.Extensions
  [Expand]DevExpress.XtraReports.Templates
  [Collapse]DevExpress.XtraReports.UI
   [Expand]Band Class
   [Expand]BandCollection Class
   [Expand]BandEventArgs Class
    BandEventHandler Delegate
   [Expand]BandFactory Class
    BandKind Enumeration
   [Expand]BandScripts Class
   [Expand]BestSizeEstimator Class
   [Expand]BindingEventArgs Class
    BindingEventHandler Delegate
   [Expand]BottomMarginBand Class
   [Expand]CalculatedField Class
   [Expand]CalculatedFieldCollection Class
   [Expand]CalculatedFieldScripts Class
   [Expand]ChangeEventArgs Class
    ChangeEventHandler Delegate
    ChartImageType Enumeration
   [Expand]CheckBoxGlyphOptions Class
   [Expand]CheckBoxGlyphs Class
   [Expand]CheckEditOptions Class
    ColumnDirection Enumeration
    DataBindingMode Enumeration
   [Expand]DataSourceRowEventArgs Class
    DataSourceRowEventHandler Delegate
   [Expand]DesignerOptions Class
    DesignWindowType Enumeration
   [Expand]DetailBand Class
   [Expand]DetailReportBand Class
   [Expand]DetailReportBandCollection Class
    DocumentExportMode Enumeration
   [Expand]DrawEventArgs Class
    DrawEventHandler Delegate
   [Expand]EditOptions Class
   [Expand]ExpressionBinding Class
   [Expand]ExpressionBindingCollection Class
    ExternalFileAccessSecurityLevel Enumeration
   [Expand]ExternalFileAccessSecurityLevelSettings Class
   [Expand]Formatting Class
   [Expand]FormattingRule Class
   [Expand]FormattingRuleCollection Class
   [Expand]FormattingRuleSheet Class
    GaugeImageType Enumeration
   [Expand]GetValueEventArgs Class
    GetValueEventHandler Delegate
   [Expand]GroupBand Class
   [Expand]GroupBandScripts Class
   [Expand]GroupField Class
   [Expand]GroupFieldCollection Class
   [Expand]GroupFooterBand Class
    GroupFooterUnion Enumeration
   [Expand]GroupHeaderBand Class
   [Expand]GroupHeaderBandScripts Class
   [Expand]GroupSortingSummaryGetResultEventArgs Class
    GroupSortingSummaryGetResultEventHandler Delegate
   [Expand]GroupSortingSummaryRowChangedEventArgs Class
    GroupSortingSummaryRowChangedEventHandler Delegate
    GroupUnion Enumeration
   [Expand]HierarchyPrintOptions Class
   [Expand]HtmlEventArgs Class
    HtmlEventHandler Delegate
   [Expand]ImageEditOptions Class
   [Expand]IReportDesignTool Interface
   [Expand]MarginBand Class
   [Expand]MultiColumn Class
    MultiColumnMode Enumeration
   [Expand]PageBand Class
    PageBreak Enumeration
   [Expand]PageFooterBand Class
   [Expand]PageHeaderBand Class
   [Expand]ParameterBinding Class
   [Expand]ParameterBindingCollection Class
   [Expand]PdfStreamingExporter Class
   [Expand]PreviewMouseEventArgs Class
    PreviewMouseEventHandler Delegate
   [Expand]PrintableComponentContainer Class
   [Expand]PrintOnPageEventArgs Class
    PrintOnPageEventHandler Delegate
    ProcessDuplicatesMode Enumeration
    ProcessDuplicatesTarget Enumeration
    ProcessHiddenCellMode Enumeration
    PromptBoolean Enumeration
   [Expand]ReportDesignTool Class
   [Expand]ReportFooterBand Class
   [Expand]ReportHeaderBand Class
   [Expand]ReportPrintOptions Class
    ReportUnit Enumeration
   [Expand]ReportUnitExtensions Class
    RestrictionLevel Enumeration
    RightToLeft Enumeration
    RightToLeftLayout Enumeration
   [Expand]SaveComponentsEventArgs Class
   [Expand]SerializableString Class
    SerializationFormat Enumeration
    SnappingMode Enumeration
   [Expand]SortingOptions Class
    SortingSummaryFunction Enumeration
    SparklineImageType Enumeration
   [Expand]StyleFlagsBase Class
   [Expand]StylePriority Class
   [Expand]StyleUsing Class
   [Expand]SubBand Class
   [Expand]SubBandCollection Class
   [Expand]SubreportBase Class
   [Expand]SubreportBaseScripts Class
    SummaryFunc Enumeration
   [Expand]SummaryGetResultEventArgs Class
    SummaryGetResultHandler Delegate
    SummaryRunning Enumeration
   [Expand]TextEditOptions Class
    TextFitMode Enumeration
   [Expand]TextFormatEventArgs Class
    TextFormatEventHandler Delegate
   [Expand]TopMarginBand Class
   [Expand]TruncatedControlScripts Class
   [Expand]ValueBinding Class
    ValueSuppressType Enumeration
   [Expand]VerticalBand Class
    VerticalBandLayout Enumeration
   [Expand]VerticalDetailBand Class
   [Expand]VerticalHeaderBand Class
   [Expand]VerticalTotalBand Class
   [Expand]WinControlContainer Class
    WinControlDrawMethod Enumeration
    WinControlImageType Enumeration
    WinControlPrintMode Enumeration
   [Expand]WindowControlOptions Class
   [Expand]XRAppearanceObject Class
   [Expand]XRBarCode Class
    XRBarCodeOrientation Enumeration
   [Expand]XRBinding Class
   [Expand]XRBindingCollection Class
   [Expand]XRCharacterComb Class
   [Expand]XRCharacterCombScripts Class
   [Expand]XRChart Class
   [Expand]XRChartScripts Class
   [Expand]XRCheckBox Class
    XRColumnSortOrder Enumeration
   [Expand]XRControl Class
   [Expand]XRControlCollection Class
   [Expand]XRControlCollectionBase Class
   [Expand]XRControlEvents Class
   [Expand]XRControlScripts Class
   [Expand]XRControlStyle Class
   [Expand]XRControlStyleSheet Class
   [Expand]XRCrossBandBox Class
   [Expand]XRCrossBandControl Class
   [Expand]XRCrossBandControlCollection Class
   [Expand]XRCrossBandLine Class
    XRDockStyle Enumeration
   [Expand]XRFieldEmbeddableControl Class
   [Expand]XRGauge Class
   [Expand]XRGaugeScripts Class
   [Expand]XRGroupSortingSummary Class
   [Expand]XRLabel Class
   [Expand]XRLabelScripts Class
   [Expand]XRLine Class
   [Expand]XRLineScripts Class
   [Expand]XRPageBreak Class
   [Expand]XRPageBreakScripts Class
   [Expand]XRPageInfo Class
   [Expand]XRPanel Class
   [Expand]XRPanelScripts Class
   [Collapse]XRPictureBox Class
     XRPictureBox Members
     XRPictureBox Constructor
    [Expand]XRPictureBox Properties
    [Expand]XRPictureBox Events
    [Expand]XRPictureBox Methods
   [Expand]XRPictureboxScripts Class
   [Expand]XRPivotGrid Class
   [Expand]XRPivotGridScripts Class
   [Expand]XRRichText Class
   [Expand]XRRichTextBase Class
   [Expand]XRRichTextBox Class
   [Expand]XRRichTextBoxBase Class
    XRRichTextStreamType Enumeration
   [Expand]XRScriptsBase Class
   [Expand]XRShape Class
   [Expand]XRShapeScripts Class
   [Expand]XRSparkline Class
   [Expand]XRSparklineScripts Class
   [Expand]XRSubreport Class
   [Expand]XRSummary Class
   [Expand]XRSummaryEvents Class
   [Expand]XRSummaryScripts Class
   [Expand]XRTable Class
   [Expand]XRTableCell Class
   [Expand]XRTableCellCollection Class
   [Expand]XRTableOfContents Class
   [Expand]XRTableOfContentsLevel Class
   [Expand]XRTableOfContentsLevelBase Class
   [Expand]XRTableOfContentsLevelCollection Class
   [Expand]XRTableOfContentsTitle Class
   [Expand]XRTableRow Class
   [Expand]XRTableRowCollection Class
   [Expand]XRTableScripts Class
   [Expand]XRWatermark Class
   [Expand]XRZipCode Class
   [Expand]XtraReport Class
   [Expand]XtraReportBase Class
   [Expand]XtraReportBaseScripts Class
   [Expand]XtraReportDesignerExtensions Class
   [Expand]XtraReportScripts Class
  [Expand]DevExpress.XtraReports.UI.BarCode
  [Expand]DevExpress.XtraReports.UI.PivotGrid
  [Expand]DevExpress.XtraReports.UserDesigner
  [Expand]DevExpress.XtraReports.Web
  [Expand]DevExpress.XtraReports.Web.Azure.ReportDesigner
  [Expand]DevExpress.XtraReports.Web.Azure.WebDocumentViewer
  [Expand]DevExpress.XtraReports.Web.ClientControls
  [Expand]DevExpress.XtraReports.Web.ClientControls.DataContracts
  [Expand]DevExpress.XtraReports.Web.DocumentViewer
  [Expand]DevExpress.XtraReports.Web.DocumentViewer.Ribbon
  [Expand]DevExpress.XtraReports.Web.Extensions
  [Expand]DevExpress.XtraReports.Web.Localization
  [Expand]DevExpress.XtraReports.Web.QueryBuilder
  [Expand]DevExpress.XtraReports.Web.QueryBuilder.Native
  [Expand]DevExpress.XtraReports.Web.QueryBuilder.Services
  [Expand]DevExpress.XtraReports.Web.ReportDesigner
  [Expand]DevExpress.XtraReports.Web.ReportDesigner.DataContracts
  [Expand]DevExpress.XtraReports.Web.ReportDesigner.Native
  [Expand]DevExpress.XtraReports.Web.ReportDesigner.Native.Services
  [Expand]DevExpress.XtraReports.Web.ReportDesigner.Services
  [Expand]DevExpress.XtraReports.Web.Scripts
  [Expand]DevExpress.XtraReports.Web.WebDocumentViewer
  [Expand]DevExpress.XtraReports.Web.WebDocumentViewer.DataContracts
  [Expand]DevExpress.XtraReports.Web.WebDocumentViewer.Native
  [Expand]DevExpress.XtraReports.Wizards
  [Expand]DevExpress.XtraReports.Wizards.Builder
  [Expand]DevExpress.XtraReports.Wizards.ColorSchemes
  [Expand]DevExpress.XtraReports.Wizards.Labels
  [Expand]DevExpress.XtraReports.Wizards.Presenters
  [Expand]DevExpress.XtraReports.Wizards.Templates
  [Expand]DevExpress.XtraReports.Wizards.Views
  [Expand]DevExpress.XtraReports.Wizards3
  [Expand]DevExpress.XtraReports.Wizards3.Presenters
  [Expand]DevExpress.XtraReports.Wizards3.Views
[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)

XRPictureBox Class

A Picture Box control that is used to display an image in a report.

Namespace:DevExpress.XtraReports.UI
Assembly:DevExpress.XtraReports.v19.1.dll

Expanded Syntax

Expanded Remarks

You can use the XRPictureBox control to embed static (stored with the report definition) or dynamic (obtained from a data source) images into a report. The images can have one of the following formats: BMP, JPG, JPEG, GIF, TIF, TIFF, PNG, ICO, DIB, RLE, JPE, JFIF, EMF, WMF, SVG.

To add the PictureBox control to a report, drag the XRPictureBox item from the DX:19.1: Report Controls Toolbox tab and drop it onto the report.

Specify the following properties to set an image:

  • ImageSource
    Use this property to save images along with a report definition.
  • ImageUrl
    Use this property to save only the path to the image.

Note

After the ImageUrl property is specified, the ImageSource property is set to null (Nothing in Visual Basic).

After the ImageSource property is specified, the ImageUrl property is set to Empty.

Expanded Bind a Picture Box to Data

Use one of the following techniques to add the XRPictureBox control that obtains an image from a data source.

  • Invoke the control's smart tag, expand the Expression drop-down list for the ImageSource property and select a data field.

    You can bind the ImageUrl property to data in a similar way. In this instance, the URL that specifies the image location is obtained from the data source.

    Click the Expression option's ellipsis button to invoke the Expression Editor. Use this editor to construct a binding expression that can include two or more data fields.

  • Drag an image data field from the report's Field List and drop it onto a report band.

  • Right-click a data field in the Field List and drop it onto a report band. Select the PictureBox item in the invoked context menu.

  • See the Bind Report Controls to Data topic for more information on the available data binding modes and how to create data-aware controls.

You can bind the XRPictureBox control to the following image types:

  • Image (see System.Drawing.Image)
  • DevExpress.Utils.Svg.SvgImage
  • XML-formatted SVG
  • Byte Array received from an SVG string or an Image (see System.Drawing.Image)

Expanded SVG Support Limitations

The XRPictureBox control does not support the following SVG content:

  • Gradient colors
  • Text (you can convert text to curves as a workaround)
  • Animations
  • External .css styles

Export (except for PDF) has the following limitations:

  • SVG images are converted to metafiles because document viewers may not support SVG format.

  • SVG images are exported as PNG in the Microsoft Azure environment.

The Medium Trust permission level does not support SVG.

Expanded Image Size Modes

Set the Sizing property to one of the available image size modes to specify how to position an image within the control.

Illustration

Description

DevExpress.XtraPrinting.ImageSizeMode.Normal

The image is displayed with its original dimensions.

DevExpress.XtraPrinting.ImageSizeMode.StretchImage

The image is stretched to fill both the control's width and height.

DevExpress.XtraPrinting.ImageSizeMode.AutoSize

The control's dimensions are auto-adjusted to the image size.

DevExpress.XtraPrinting.ImageSizeMode.ZoomImage

The image is proportionally resized, so that it fits the control.

DevExpress.XtraPrinting.ImageSizeMode.Squeeze

If the control's dimensions exceed the image size, the image is centered and shown full-size.

Otherwise, the image is resized to fit into the control's dimensions.

DevExpress.XtraPrinting.ImageSizeMode.Tile

The original image is replicated within the picture control starting from the upper-left corner.

The replicated image is clipped if it does not fit in the picture control which contains it.

To display the image in the middle of the control, set the Sizing property to DevExpress.XtraPrinting.ImageSizeMode.Normal and the ImageAlignment property to DevExpress.XtraPrinting.ImageAlignment.MiddleCenter.

Expanded Interactivity

You can add a possibility to load/change an image and/or draw a signature in a picture box when it is displayed in Print Preview. To do this, set the EditOptions.Enabled property to true.

Click the picture box in a previewed document and an editor invokes.

Tip

You can draw borders (see XRControl.Borders) for the picture box to make the editor visible in Print Preview, if an image is not specified.

Refer to the Content Editing in Print Preview topic for details and to the Create an Interactive E-Form tutorial to see how the E-Form demo report uses this picture box mode.

Expanded Example

This example demonstrates how to create an XRPictureBox object and set its properties.

Expanded Inheritance Hierarchy

System.Object
    System.MarshalByRefObject
       System.ComponentModel.Component
          XRControl
             XRPictureBox

Expanded See Also

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