WinControlContainer.WinControl Property

Gets or sets a Control object that is placed into the WinControlContainer object.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.1.dll

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

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
Control	*null*	A Control class descendant.

Remarks

To learn more on embedding Windows Forms controls into reports, refer to the Using Third-Party Controls document.

The following method creates a WinControlContainer object and sets some of its properties. A GroupBox object is then wrapped in it.

C#

using System.Drawing;
using System.Windows.Forms;
using DevExpress.XtraReports.UI;
// ...

public WinControlContainer CreateWinControl() {
   // Create a GroupBox object.
   GroupBox groupBox = new GroupBox();

   // Set its text.
   groupBox.Text = "Windows.Forms Group Box";

   // Create a WinControlContainer object.
   WinControlContainer winContainer = new WinControlContainer();

   // Set its location and size.
   winContainer.LocationF = new PointF(250F, 40F);
   winContainer.SizeF = new SizeF(200F, 100F);

   // Set the groupBox as a wrapped object.
   winContainer.WinControl = groupBox;

   return winContainer;
}

VB.NET

Imports System.Drawing
Imports System.Windows.Forms
Imports DevExpress.XtraReports.UI
' ...

Public Function CreateWinControl()
   ' Create a GroupBox object.
   Dim groupBox As New GroupBox()

   ' Set its text.
   groupBox.Text = "Windows.Forms Group Box"

   ' Create a WinControlContainer object.
   Dim winContainer As New WinControlContainer()

   ' Set its location and size.
   winContainer.LocationF = New PointF(250F, 40F)
   winContainer.SizeF = New SizeF(200F, 100F)

   ' Set the groupBox as a wrapped object.
   winContainer.WinControl = groupBox

   Return winContainer
End Function

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