ReportDesignExtension.AssociateReportWithExtension(XtraReport, String) Method

Associates the report with the custom design extension, to employ parameters of custom types.

Namespace: DevExpress.XtraReports.Extensions

Assembly: DevExpress.XtraReports.v23.2.Extensions.dll

NuGet Package: DevExpress.Win.Reporting

Declaration

C#

public static void AssociateReportWithExtension(
    XtraReport report,
    string contextName
)

VB.NET

Public Shared Sub AssociateReportWithExtension(
    report As XtraReport,
    contextName As String
)

Parameters

Name	Type	Description
report	XtraReport	An XtraReport class descendant.
contextName	String	A String value, identifying the context.

Remarks

To provide parameters of custom types to your report, you should create a custom report design extension inherited from the ReportDesignExtension class.

Then, register the extension (using the ReportDesignExtension.RegisterExtension method) and associate the report with the custom extension (using the AssociateReportWithExtension method).

To learn more, see Creating Custom Report Parameters.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AssociateReportWithExtension(XtraReport, String) method.

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-winforms-custom-xml-serialization/CS/WindowsApplication54/Form1.cs#L36

void OnDesignPanelLoaded(object sender, DevExpress.XtraReports.UserDesigner.DesignerLoadedEventArgs e) {
    ReportDesignExtension.AssociateReportWithExtension((XtraReport)e.DesignerHost.RootComponent, ExtensionName);
}

reporting-winforms-parameter-custom-type-serialization/CS/Form1.cs#L29

ReportDesignExtension.AssociateReportWithExtension(report, TeamParameterName);

VB.NET

reporting-winforms-custom-xml-serialization/VB/WindowsApplication54/Form1.vb#L39

Private Sub OnDesignPanelLoaded(ByVal sender As Object, ByVal e As DevExpress.XtraReports.UserDesigner.DesignerLoadedEventArgs)
    ReportDesignExtension.AssociateReportWithExtension(CType(e.DesignerHost.RootComponent, XtraReport), ExtensionName)
End Sub

reporting-winforms-parameter-custom-type-serialization/VB/Form1.vb#L31

ReportDesignExtension.AssociateReportWithExtension(report, TeamParameterName)
report.Parameters.Add(New DevExpress.XtraReports.Parameters.Parameter() With {