ReportDesignExtension.RegisterExtension(ReportDesignExtension, String) Method

Registers the custom report design extension to serialize custom parameter types.

Namespace: DevExpress.XtraReports.Extensions

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

Declaration

C#

public static void RegisterExtension(
    ReportDesignExtension extension,
    string contextName
)

VB.NET

Public Shared Sub RegisterExtension(
    extension As ReportDesignExtension,
    contextName As String
)

Parameters

Name	Type	Description
extension	ReportDesignExtension	A ReportDesignExtension object.
contextName	String	A String value, identifying the context.

Remarks

You can use the RegisterExtension property to serialize custom report parameters along with a report’s definition.

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 RegisterExtension method) and associate the report with the custom extension (using the ReportDesignExtension.AssociateReportWithExtension method).

See the following tutorials to learn how to register custom parameter types in reporting applications created for different platforms:

• Register Custom Report Parameter Types (in WinForms Applications)
• Register Custom Report Parameter Types (in WPF Applications)
• Register Custom Report Parameter Types (in Web Applications)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the RegisterExtension(ReportDesignExtension, 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_how-to-implement-custom-xml-serialization-of-a-report-that-is-bound-to-a-dataset-e3157/CS/WindowsApplication54/Form1.cs#L21

    ReportExtension.RegisterExtensionGlobal(new ReportExtension());
    ReportDesignExtension.RegisterExtension(new DesignExtension(), ExtensionName);
}

Reporting_how-to-serialize-an-xpo-data-source-e3169/CS/WindowsApplication54/Form1.cs#L21

ReportExtension.RegisterExtensionGlobal(new ReportExtension());
ReportDesignExtension.RegisterExtension(new DesignExtension(), ExtensionName);

Reporting_how-to-create-a-parameter-of-systemenum-type-e2613/CS/Form1.cs#L12

static Form1() {
    ReportDesignExtension.RegisterExtension(new CustomReportExtension(), TeamParameterName);
}

Reporting_how-to-create-parameter-editors-that-are-dependent-on-each-others-values-e3291/CS/DependentEditors/XtraReportBase.cs#L166

    "DependentEditorsReport");
ReportDesignExtension.RegisterExtension(new TimePeriodDesignExtention(),
    "DependentEditorsReport");

Reporting_how-to-serialize-parameters-of-custom-types-e3186/CS/Form1.cs#L13

static Form1() {
    ReportDesignExtension.RegisterExtension(new CustomReportExtension(), TeamParameterName);
    CustomReportStorageExtension.RegisterExtensionGlobal(new CustomReportStorageExtension());

VB.NET

Reporting_how-to-implement-custom-xml-serialization-of-a-report-that-is-bound-to-a-dataset-e3157/VB/WindowsApplication54/Form1.vb#L23

    ReportExtension.RegisterExtensionGlobal(New ReportExtension())
    ReportDesignExtension.RegisterExtension(New DesignExtension(), ExtensionName)
End Sub

Reporting_how-to-serialize-an-xpo-data-source-e3169/VB/WindowsApplication54/Form1.vb#L23

ReportExtension.RegisterExtensionGlobal(New ReportExtension())
ReportDesignExtension.RegisterExtension(New DesignExtension(), ExtensionName)

Reporting_how-to-create-a-parameter-of-systemenum-type-e2613/VB/Form1.vb#L14

Shared Sub New()
    ReportDesignExtension.RegisterExtension(New CustomReportExtension(), TeamParameterName)
End Sub

Reporting_how-to-create-parameter-editors-that-are-dependent-on-each-others-values-e3291/VB/DependentEditors/XtraReportBase.vb#L186

    ParametersRequestExtension.RegisterExtension(New TimePeriodParametersExtention(), "DependentEditorsReport")
    ReportDesignExtension.RegisterExtension(New TimePeriodDesignExtention(), "DependentEditorsReport")
End Sub

Reporting_how-to-serialize-parameters-of-custom-types-e3186/VB/Form1.vb#L15

Shared Sub New()
    ReportDesignExtension.RegisterExtension(New CustomReportExtension(), TeamParameterName)
    CustomReportStorageExtension.RegisterExtensionGlobal(New CustomReportStorageExtension())