Skip to content

Commit 72a0cf8

Browse files
author
DevExpressExampleBot
committed
README auto update [skip ci]
1 parent 6ce0663 commit 72a0cf8

File tree

1 file changed

+75
-75
lines changed

1 file changed

+75
-75
lines changed

‎Readme.md

+75-75
Original file line numberDiff line numberDiff line change
@@ -3,78 +3,78 @@
33
[![](https://img.shields.io/badge/Open_in_DevExpress_Support_Center-FF7200?style=flat-square&logo=DevExpress&logoColor=white)](https://supportcenter.devexpress.com/ticket/details/T906638)
44
[![](https://img.shields.io/badge/📖_How_to_use_DevExpress_Examples-e9f6fc?style=flat-square)](https://docs.devexpress.com/GeneralInformation/403183)
55
<!-- default badges end -->
6-
# How to Create a Custom DevExpress Report Control
7-
8-
## Report Control Development Steps
9-
10-
To create a new report control, do the following:
11-
12-
1. Choose a base class. If you cannot find a suitable control to derive from, inherit a component from the [XRControl](https://docs.devexpress.com/XtraReports/DevExpress.XtraReports.UI.XRControl) class.
13-
14-
2. Create the component's object model. Specify a set of properties and related attributes that determine how properties are serialized and displayed in the Property grid.
15-
16-
3. Create component designers for Visual Studio and the End User Designer. Designers determine the component's appearance and behavior at design time. Add attributes as necessary.
17-
18-
4. Choose the base class for the component's “brick” - such as the brick that the base class creates. However, if the component inherits from the [XRControl](https://docs.devexpress.com/XtraReports/DevExpress.XtraReports.UI.XRControl) class, there are two options - select [VisualBrick](https://docs.devexpress.com/CoreLibraries/DevExpress.XtraPrinting.VisualBrick) as the brick's base class if you require a simple brick or [PanelBrick](https://docs.devexpress.com/CoreLibraries/DevExpress.XtraPrinting.PanelBrick) if you need a container.
19-
20-
5. Specify how the component creates its "brick" and map the component's properties to the brick's characteristics.
21-
22-
6. Implement the **BrickExporter** class to render the "brick". Override the methods used for drawing and export.
23-
24-
## XRSwissQRBill
25-
26-
Refer to the following document for information on **XRSwissQRBill** implementation: [How to Create a Custom DevExpress Report Control - Swiss QR Bill Implementation](./DevExpress.XtraReports.CustomControls.SwissQRBill/Readme.md).
27-
28-
## XRRoundLabel and XRRoundPanel
29-
30-
Refer to the following document for information on **XRRoundLabel and XRRoundPanel** implementation: [How to Create Controls with Rounded Corners](./DevExpress.XtraReports.CustomControls.RoundedControls/Readme.md).
31-
32-
## Examples
33-
34-
### WinForms
35-
36-
Run the sample project to invoke the WinForms End-User Report Designer with a toolbox that contains the [XRSwissQRBill](./DevExpress.XtraReports.CustomControls.SwissQRBill/SwissQRBill/XRSwissQRBill.cs), [XRRoundLabel](./DevExpress.XtraReports.CustomControls.RoundedControls/Label/XRRoundLabel.cs) and [XRRoundPanel](./DevExpress.XtraReports.CustomControls.RoundedControls/Panel/XRRoundPanel.cs) controls.
37-
38-
The project is in the [Examples/CustomControlExample.Win](./Examples/CustomControlExample.Win/) folder. File to review: [Program.cs](./Examples/CustomControlExample.Win/Program.cs).
39-
40-
### ASP.NET Core
41-
42-
Run the sample project to invoke the ASP.NET Core End-User Report Designer with a toolbox that contains the [XRRoundLabel](./DevExpress.XtraReports.CustomControls.RoundedControls/Label/XRRoundLabel.cs), and [XRRoundPanel](./DevExpress.XtraReports.CustomControls.RoundedControls/Panel/XRRoundPanel.cs) controls.
43-
44-
The project is in the [Examples/CustomControlExample.AspNetCore](./Examples/CustomControlExample.AspNetCore/) folder. Files to review: [Startup.cs](./Examples/CustomControlExample.AspNetCore/Startup.cs) and [Designer.cshtml](./Examples/CustomControlExample.AspNetCore/Views/Home/Designer.cshtml).
45-
46-
## Files to Review
47-
48-
### XRSwissQRBill
49-
50-
- [XRSwissQRBill.cs](/DevExpress.XtraReports.CustomControls.SwissQRBill/SwissQRBill/XRSwissQRBill.cs)
51-
- [SwissQRBillCustomControl.cs](/DevExpress.XtraReports.CustomControls.SwissQRBill/SwissQRBillCustomControl.cs)
52-
- [SwissQRBillBrick.cs](/DevExpress.XtraReports.CustomControls.SwissQRBill/SwissQRBill/SwissQRBillBrick.cs)
53-
- [CustomControlToolBoxRegistrator.cs](/DevExpress.XtraReports.CustomControls.Design/CustomControlToolBoxRegistrator.cs)
54-
- [XRSwissQRBillDesignerActionList.cs](/DevExpress.XtraReports.CustomControls.Design/XRSwissQRBillDesignerActionList.cs)
55-
- [TypeConverters.cs](/DevExpress.XtraReports.CustomControls.SwissQRBill/SwissQRBill/TypeConverters.cs)
56-
57-
### XRRoundLabel and XRRoundPanel
58-
59-
- [XRRoundLabel.cs](/DevExpress.XtraReports.CustomControls.RoundedControls/Label/XRRoundLabel.cs)
60-
- [RoundLabelBrick.cs](/DevExpress.XtraReports.CustomControls.RoundedControls/Label/RoundLabelBrick.cs)
61-
- [RoundLabelBrickExporter.cs](/DevExpress.XtraReports.CustomControls.RoundedControls/Label/RoundLabelBrickExporter.cs)
62-
- [XRRoundPanel.cs](/DevExpress.XtraReports.CustomControls.RoundedControls/Panel/XRRoundPanel.cs)
63-
- [RoundPanelBrick.cs](/DevExpress.XtraReports.CustomControls.RoundedControls/Panel/RoundPanelBrick.cs)
64-
- [RoundLabelBrickExporter.cs](/DevExpress.XtraReports.CustomControls.RoundedControls/Panel/RoundPanelBrickExporter.cs)
65-
- [RoundedBorderPaintHelper.cs](./DevExpress.XtraReports.CustomControls.RoundedControls/RoundedBorderPaintHelper.cs)
66-
- [RoundedCustomControl.cs](./DevExpress.XtraReports.CustomControls.RoundedControls/RoundedCustomControl.cs)
67-
- [CustomControlToolBoxRegistrator.cs](./DevExpress.XtraReports.CustomControls.Design/CustomControlToolBoxRegistrator.cs)
68-
69-
## Documentation
70-
71-
- [Use Custom Controls](https://docs.devexpress.com/XtraReports/2607/detailed-guide-to-devexpress-reporting/use-report-controls/use-custom-controls)
72-
73-
## More Examples
74-
75-
- [Create a Custom Numeric Label](https://github.com/DevExpress-Examples/Reporting-Create-Custom-Numeric-Label)
76-
- [Create a Custom Progress Bar Control](https://github.com/DevExpress-Examples/Reporting_how-to-create-custom-report-controls-e57)
77-
- [Add a Custom Control to the End-User Report Designer Toolbox (WPF)](https://github.com/DevExpress-Examples/Reporting_wpf-end-user-report-designer-how-to-register-a-custom-control-in-the-designers-t416384)
78-
- [Custom Report Control in the Web End User Designer Toolbox (ASP.NET Web Forms)](https://github.com/DevExpress-Examples/Reporting_aspxreportdesigner-how-to-register-a-custom-control-in-the-designers-toolbox-t209289)
79-
- [Custom Report Control in the Web End User Designer Toolbox (ASP.NET MVC)](https://github.com/DevExpress-Examples/Reporting-AspNetMvc-Create-Custom-Control)
80-
- [Custom Report Control in the Web End User Designer Toolbox in ASP.NET Core Application](https://github.com/DevExpress-Examples/Reporting-AspNetCore-Create-Custom-Control)
6+
# How to Create a Custom DevExpress Report Control
7+
8+
## Report Control Development Steps
9+
10+
To create a new report control, do the following:
11+
12+
1. Choose a base class. If you cannot find a suitable control to derive from, inherit a component from the [XRControl](https://docs.devexpress.com/XtraReports/DevExpress.XtraReports.UI.XRControl) class.
13+
14+
2. Create the component's object model. Specify a set of properties and related attributes that determine how properties are serialized and displayed in the Property grid.
15+
16+
3. Create component designers for Visual Studio and the End User Designer. Designers determine the component's appearance and behavior at design time. Add attributes as necessary.
17+
18+
4. Choose the base class for the component's “brick” - such as the brick that the base class creates. However, if the component inherits from the [XRControl](https://docs.devexpress.com/XtraReports/DevExpress.XtraReports.UI.XRControl) class, there are two options - select [VisualBrick](https://docs.devexpress.com/CoreLibraries/DevExpress.XtraPrinting.VisualBrick) as the brick's base class if you require a simple brick or [PanelBrick](https://docs.devexpress.com/CoreLibraries/DevExpress.XtraPrinting.PanelBrick) if you need a container.
19+
20+
5. Specify how the component creates its "brick" and map the component's properties to the brick's characteristics.
21+
22+
6. Implement the **BrickExporter** class to render the "brick". Override the methods used for drawing and export.
23+
24+
## XRSwissQRBill
25+
26+
Refer to the following document for information on **XRSwissQRBill** implementation: [How to Create a Custom DevExpress Report Control - Swiss QR Bill Implementation](./DevExpress.XtraReports.CustomControls.SwissQRBill/Readme.md).
27+
28+
## XRRoundLabel and XRRoundPanel
29+
30+
Refer to the following document for information on **XRRoundLabel and XRRoundPanel** implementation: [How to Create Controls with Rounded Corners](./DevExpress.XtraReports.CustomControls.RoundedControls/Readme.md).
31+
32+
## Examples
33+
34+
### WinForms
35+
36+
Run the sample project to invoke the WinForms End-User Report Designer with a toolbox that contains the [XRSwissQRBill](./DevExpress.XtraReports.CustomControls.SwissQRBill/SwissQRBill/XRSwissQRBill.cs), [XRRoundLabel](./DevExpress.XtraReports.CustomControls.RoundedControls/Label/XRRoundLabel.cs) and [XRRoundPanel](./DevExpress.XtraReports.CustomControls.RoundedControls/Panel/XRRoundPanel.cs) controls.
37+
38+
The project is in the [Examples/CustomControlExample.Win](./Examples/CustomControlExample.Win/) folder. File to review: [Program.cs](./Examples/CustomControlExample.Win/Program.cs).
39+
40+
### ASP.NET Core
41+
42+
Run the sample project to invoke the ASP.NET Core End-User Report Designer with a toolbox that contains the [XRRoundLabel](./DevExpress.XtraReports.CustomControls.RoundedControls/Label/XRRoundLabel.cs), and [XRRoundPanel](./DevExpress.XtraReports.CustomControls.RoundedControls/Panel/XRRoundPanel.cs) controls.
43+
44+
The project is in the [Examples/CustomControlExample.AspNetCore](./Examples/CustomControlExample.AspNetCore/) folder. Files to review: [Startup.cs](./Examples/CustomControlExample.AspNetCore/Startup.cs) and [Designer.cshtml](./Examples/CustomControlExample.AspNetCore/Views/Home/Designer.cshtml).
45+
46+
## Files to Review
47+
48+
### XRSwissQRBill
49+
50+
- [XRSwissQRBill.cs](/DevExpress.XtraReports.CustomControls.SwissQRBill/SwissQRBill/XRSwissQRBill.cs)
51+
- [SwissQRBillCustomControl.cs](/DevExpress.XtraReports.CustomControls.SwissQRBill/SwissQRBillCustomControl.cs)
52+
- [SwissQRBillBrick.cs](/DevExpress.XtraReports.CustomControls.SwissQRBill/SwissQRBill/SwissQRBillBrick.cs)
53+
- [CustomControlToolBoxRegistrator.cs](/DevExpress.XtraReports.CustomControls.Design/CustomControlToolBoxRegistrator.cs)
54+
- [XRSwissQRBillDesignerActionList.cs](/DevExpress.XtraReports.CustomControls.Design/XRSwissQRBillDesignerActionList.cs)
55+
- [TypeConverters.cs](/DevExpress.XtraReports.CustomControls.SwissQRBill/SwissQRBill/TypeConverters.cs)
56+
57+
### XRRoundLabel and XRRoundPanel
58+
59+
- [XRRoundLabel.cs](/DevExpress.XtraReports.CustomControls.RoundedControls/Label/XRRoundLabel.cs)
60+
- [RoundLabelBrick.cs](/DevExpress.XtraReports.CustomControls.RoundedControls/Label/RoundLabelBrick.cs)
61+
- [RoundLabelBrickExporter.cs](/DevExpress.XtraReports.CustomControls.RoundedControls/Label/RoundLabelBrickExporter.cs)
62+
- [XRRoundPanel.cs](/DevExpress.XtraReports.CustomControls.RoundedControls/Panel/XRRoundPanel.cs)
63+
- [RoundPanelBrick.cs](/DevExpress.XtraReports.CustomControls.RoundedControls/Panel/RoundPanelBrick.cs)
64+
- [RoundLabelBrickExporter.cs](/DevExpress.XtraReports.CustomControls.RoundedControls/Panel/RoundPanelBrickExporter.cs)
65+
- [RoundedBorderPaintHelper.cs](./DevExpress.XtraReports.CustomControls.RoundedControls/RoundedBorderPaintHelper.cs)
66+
- [RoundedCustomControl.cs](./DevExpress.XtraReports.CustomControls.RoundedControls/RoundedCustomControl.cs)
67+
- [CustomControlToolBoxRegistrator.cs](./DevExpress.XtraReports.CustomControls.Design/CustomControlToolBoxRegistrator.cs)
68+
69+
## Documentation
70+
71+
- [Use Custom Controls](https://docs.devexpress.com/XtraReports/2607/detailed-guide-to-devexpress-reporting/use-report-controls/use-custom-controls)
72+
73+
## More Examples
74+
75+
- [Create a Custom Numeric Label](https://github.com/DevExpress-Examples/Reporting-Create-Custom-Numeric-Label)
76+
- [Create a Custom Progress Bar Control](https://github.com/DevExpress-Examples/Reporting_how-to-create-custom-report-controls-e57)
77+
- [Add a Custom Control to the End-User Report Designer Toolbox (WPF)](https://github.com/DevExpress-Examples/Reporting_wpf-end-user-report-designer-how-to-register-a-custom-control-in-the-designers-t416384)
78+
- [Custom Report Control in the Web End User Designer Toolbox (ASP.NET Web Forms)](https://github.com/DevExpress-Examples/Reporting_aspxreportdesigner-how-to-register-a-custom-control-in-the-designers-toolbox-t209289)
79+
- [Custom Report Control in the Web End User Designer Toolbox (ASP.NET MVC)](https://github.com/DevExpress-Examples/Reporting-AspNetMvc-Create-Custom-Control)
80+
- [Custom Report Control in the Web End User Designer Toolbox in ASP.NET Core Application](https://github.com/DevExpress-Examples/Reporting-AspNetCore-Create-Custom-Control)

0 commit comments

Comments
 (0)