WinControlContainer.WinControl Property

Gets or sets a Control class instance that is placed inside the WinControlContainer.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Reporting.Core

Declaration

C#

[Browsable(false)]
[DefaultValue(null)]
public virtual object WinControl { get; set; }

VB.NET

<Browsable(False)>
<DefaultValue(Nothing)>
Public Overridable Property WinControl As Object

Property Value

Type	Default	Description
Object	null	A Control class instance or descendant.

Example

The code sample below creates a DataGridView control instance and adds this instance to a report. The sample specifies that the DataGridView control is printed as a bitmap image.

C#

using DevExpress.XtraReports.UI;
using System.Windows.Forms;
// ...
// Create an XtraReport instance.
XtraReport report = new XtraReport()
{
    Bands = {
        new DetailBand()
    }
};
// Create a DataGrid control instance.
DataGridView dataGridView = new DataGridView();
// Create a PrintableComponentContainer instance for the data grid.
PrintableComponentContainer printableComponentContainer = new PrintableComponentContainer();
// Place the data grid inside the printable component container.
printableComponentContainer.WinControl = dataGridView;
// Specify that the control inside the printable component container is always printed as an image.
printableComponentContainer.PrintMode = WinControlPrintMode.AsImage;
// Specify that the control inside the printable component container is always printed as a bitmap.
printableComponentContainer.WindowControlOptions.ImageType = WinControlImageType.Bitmap;
// Add the printable component container to the report.
report.Bands[BandKind.Detail].Controls.Add(printableComponentContainer);

VB.NET

Imports DevExpress.XtraReports.UI
' ...
' Create an XtraReport instance.
Dim report = New XtraReport()
Dim band = New DetailBand()
report.Bands.Add(band)
' Create a DataGrid control instance.
Dim dataGridView As New DataGridView()
' Create a PrintableComponentContainer instance for the data grid.
Dim printableComponentContainer As New PrintableComponentContainer()
' Place the data grid inside the printable component container.
printableComponentContainer.WinControl = dataGridView
' Specify that the control inside the printable component container is always printed as an image.
printableComponentContainer.PrintMode = WinControlPrintMode.AsImage
' Specify that the control inside the printable component container is always printed as a bitmap.
printableComponentContainer.WindowControlOptions.ImageType = WinControlImageType.Bitmap
' Add the printable component container to the report.
report.Bands(BandKind.Detail).Controls.Add(printableComponentContainer)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the WinControl property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_how-to-bind-a-windows-forms-control-in-a-report-to-a-data-field-e2/CS/XtraReport1.cs#L12

private void winControlContainer1_BeforePrint(object sender, PrintEventArgs e) {
    Button control = ((WinControlContainer)sender).WinControl as Button;
    control.Text = GetCurrentColumnValue("CategoryName").ToString();

Reporting_how-to-embed-the-xtratreelist-into-a-report-via-scripts-e1339/CS/XtraReport1.cs#L25

this.ReportHeader.Controls.Add(wcc);
wcc.WinControl = tree;
tree.KeyFieldName = "Oid";

Reporting_how-to-embed-treelist-control-to-a-report-at-runtime-e3239/CS/Reports/TreeReport.cs#L37

Detail.Controls.Add(wcc);
wcc.WinControl = treeList;

Reporting_how-to-embed-a-gaugecontrol-into-the-end-user-designers-toolbox-e1177/CS/WindowsApplication1/MyGaugeControl.cs#L12

public MyGaugeControl() : base() {
    this.WinControl = gauge;
    this.DrawMethod = WinControlDrawMethod.UseWMPaintRecursive;

VB.NET

Reporting_how-to-bind-a-windows-forms-control-in-a-report-to-a-data-field-e2/VB/XtraReport1.vb#L14

Private Sub winControlContainer1_BeforePrint(ByVal sender As Object, ByVal e As PrintEventArgs) Handles winControlContainer1.BeforePrint
    Dim control As Button = TryCast((CType(sender, WinControlContainer)).WinControl, Button)
    control.Text = GetCurrentColumnValue("CategoryName").ToString()

Reporting_how-to-embed-the-xtratreelist-into-a-report-via-scripts-e1339/VB/XtraReport1.vb#L27

Me.ReportHeader.Controls.Add(wcc)
wcc.WinControl = tree
tree.KeyFieldName = "Oid"

Reporting_how-to-embed-treelist-control-to-a-report-at-runtime-e3239/VB/Reports/TreeReport.vb#L39

Detail.Controls.Add(wcc)
wcc.WinControl = treeList

Reporting_how-to-embed-a-gaugecontrol-into-the-end-user-designers-toolbox-e1177/VB/WindowsApplication1/MyGaugeControl.vb#L15

MyBase.New()
Me.WinControl = gauge
Me.DrawMethod = WinControlDrawMethod.UseWMPaintRecursive