IWizardFullscreenPageEvents<Sender> Interface
The fullscreen page’s event collection.
Declaration
export interface IWizardFullscreenPageEvents<Sender>
Type Parameters
Name | Description |
---|---|
Sender | A sender object. |
Remarks
The following table lists page events and describes how you can use them to customize the page.
Page Event | Description |
---|---|
Occurs before the section’s initialize method is called. Handle this event to customize the section’s content and state. For instance, you can remove a specific element or customize the section’s options. | |
Occurs after the page’s initialize method is called. Handle this event to customize the section’s settings to display in the UI. For instance, you can check a specific option (a data member, field or data connection). |
Use the ASPxClientReportDesigner.CustomizeWizard event to handle the page’s events as shown below.
<script type="text/javascript">
function beforeSectionInit(args) {
// ...
}
function beforePageInit(args) {
args.page.events.addHandler("beforeSectionInitialize", beforeSectionInit);
}
function CustomizeWizard(s, e) {
if(e.Type === "ReportWizard") {
e.Wizard.events.addHandler("beforePageInitialize", beforePageInit)
}
}
</script>
<dx:ASPxReportDesigner ID="ASPxReportDesigner1" runat="server">
<ClientSideEvents CustomizeWizard="CustomizeWizard" />
</dx:ASPxReportDesigner>
See the following topics for more information:
- Customize the Report/Data Source Wizard (ASP.NET Web Forms)
- Customize the Report/Data Source Wizard (ASP.NET MVC)
- Customize the Report/Data Source Wizard (ASP.NET Core)
Properties
afterSectionInitialize Property
Occurs after the page’s initialize method is called.
Declaration
"afterSectionInitialize": IWizardSectionEventArgs<Sender>
Property Value
Type | Description |
---|---|
IWizardSectionEventArgs<Sender> | The event’s arguments. |
Remarks
Handle this event to customize the section’s settings to display in the UI. For instance, you can check a specific option (a data member, field or data connection).
The following example demonstrates how to select all data members and fields on the Define Report Layout page:
<script type="text/javascript">
function afterSectionInit(args) {
if (args.sectionId === DevExpress.Reporting.Designer.Wizard.FullscreenReportWizardSectionId.SelectDataMembersPage_Members) {
args.section.selectAllDataFields();
// Uncomment these lines to select specific data fields.
//args.section.selectDataField("Categories.CategoryID")
//args.section.selectDataField("Categories.CategoryName")
// Uncomment this line to select the 'Products' table's fields.
//args.section.selectDataFields("Products")
}
}
function afterPageInit(args) {
if(args.pageId === DevExpress.Reporting.Designer.Wizard.FullscreenReportWizardPageId.DefineReportLayoutPage) {
args.page.events.addHandler("afterSectionInitialize", afterSectionInit);
}
}
function CustomizeWizard(s, e) {
if(e.Type === "ReportWizard") {
e.Wizard.events.addHandler("afterPageInitialize", afterPageInit)
}
}
</script>
<dx:ASPxReportDesigner ID="ASPxReportDesigner8" runat="server">
<ClientSideEvents CustomizeWizard="CustomizeWizard" />
</dx:ASPxReportDesigner>
The Define Report Layout page’s initial state:
See the following topics for more information:
- Customize the Report/Data Source Wizard (ASP.NET Web Forms)
- Customize the Report/Data Source Wizard (ASP.NET MVC)
- Customize the Report/Data Source Wizard (ASP.NET Core)
beforeSectionInitialize Property
Occurs before the section’s initialize method is called.
Declaration
"beforeSectionInitialize": IBeforeWizardSectionInitializeEventArgs<Sender>
Property Value
Type | Description |
---|---|
IBeforeWizardSectionInitializeEventArgs<Sender> | The event’s arguments. |
Remarks
Handle this event to customize the section’s content and state. For instance, you can remove a specific element or customize the section’s options.
The following example demonstrates how to remove the No Data item from the Select Data Source page.
<script type="text/javascript">
function beforePageInit(args) {
// Remove the 'Empty Report' and 'Label Report' types.
if(args.pageId === DevExpress.Reporting.Designer.Wizard.FullscreenReportWizardPageId.SelectReportTypePage) {
args.page.typeItems.splice(0, 1);
args.page.typeItems.pop();
}
}
function CustomizeWizard(s, e) {
if(e.Type === "ReportWizard") {
e.Wizard.events.addHandler("beforePageInitialize", beforePageInit)
}
}
</script>
<dx:ASPxReportDesigner ID="ASPxReportDesigner4" runat="server">
<ClientSideEvents CustomizeWizard="CustomizeWizard" />
</dx:ASPxReportDesigner>
The resulting Select Data Source page:
See the following topics for more information: