SelectDataMembersPage Class
Implements the Select Queries and Select Data Fields sections of the Report Wizard’s Define Report Layout page.
#Declaration
export class SelectDataMembersPage extends WizardPageBase
#Remarks
This class implements two page sections:
- Select Queries - use the FullscreenReportWizardSectionId.SelectDataMembersPage_Members value to identify this section in code;
- Select Data Fields - use the FullscreenReportWizardSectionId.SelectDataMembersPage_Fields value to identify this section in code.
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)
#Inheritance
#constructor(_fieldListCallBack)
Initializes a new instance of the SelectDataMembersPage
class with specified settings.
#Declaration
constructor(
_fieldListCallBack: DevExpress.Reporting.Designer.Internal.IReportWizardFieldsCallback,
_hideDataMemberSubItems?: boolean
)
#Parameters
Name | Type |
---|---|
_field |
IReport |
_hide |
boolean |
#Methods
#canFinish Method
Specifies whether it is possible to finish the wizard.
#Declaration
canFinish(): boolean
#Returns
Type | Description |
---|---|
boolean | true, if it is possible to finish the wizard; otherwise, false. |
#canNext Method
Specifies whether the next section is available.
#Declaration
canNext(): boolean
#Returns
Type | Description |
---|---|
boolean | true, if the next section is available; otherwise, false. |
#commit Method
Commits settings to the local page state.
#Declaration
commit(): JQuery.Promise<any, any, any>
#Returns
Type | Description |
---|---|
Promise |
A JQuery Promise object that identifies whether the commit succeeded. |
#initialize(state) Method
Initializes the section with the specified settings.
#Declaration
initialize(
state: DevExpress.Reporting.Designer.Wizard.IReportWizardState
): JQueryPromise<any>
#Parameters
Name | Type | Description |
---|---|---|
state | IReport |
The section’s state. |
#Returns
Type | Description |
---|---|
JQuery |
A JQuery Promise object that identifies whether section initialization succeeded. |
#selectAllDataFields Method
Selects all data members and fields.
#Declaration
selectAllDataFields(): void
#Remarks
The following example demonstrates how to handle the afterSectionInitialize event and use the selectAllDataFields method.
<script type="text/javascript">
function afterSectionInit(args) {
if (args.sectionId === DevExpress.Reporting.Designer.Wizard.FullscreenReportWizardSectionId.SelectDataMembersPage_Members) {
args.section.selectAllDataFields();
}
}
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="ASPxReportDesigner1" runat="server">
<ClientSideEvents CustomizeWizard="CustomizeWizard" />
</dx:ASPxReportDesigner>
#selectAllDataMembers Method
Selects all data members.
#Declaration
selectAllDataMembers(): void
#Remarks
The following example demonstrates how to handle the afterSectionInitialize event and use the selectAllDataMembers method.
<script type="text/javascript">
function afterSectionInit(args) {
if (args.sectionId === DevExpress.Reporting.Designer.Wizard.FullscreenReportWizardSectionId.SelectDataMembersPage_Members) {
args.section.selectAllDataMembers();
}
}
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="ASPxReportDesigner1" runat="server">
<ClientSideEvents CustomizeWizard="CustomizeWizard" />
</dx:ASPxReportDesigner>
#selectDataField(dataFieldPath) Method
Selects the specified data field.
#Declaration
selectDataField(
dataFieldPath: string
): void
#Parameters
Name | Type | Description |
---|---|---|
data |
string | The path to the data field. |
#Remarks
The following example demonstrates how to handle the afterSectionInitialize event and use the selectDataField method.
<script type="text/javascript">
function afterSectionInit(args) {
if (args.sectionId === DevExpress.Reporting.Designer.Wizard.FullscreenReportWizardSectionId.SelectDataMembersPage_Members) {
args.section.selectDataField("Categories.CategoryID")
args.section.selectDataField("Categories.CategoryName")
}
}
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="ASPxReportDesigner1" runat="server">
<ClientSideEvents CustomizeWizard="CustomizeWizard" />
</dx:ASPxReportDesigner>
#selectDataFields(dataMemberPath) Method
Select all data fields of the specified data member.
#Declaration
selectDataFields(
dataMemberPath: string
): void
#Parameters
Name | Type | Description |
---|---|---|
data |
string | The data member’s name. |
#Remarks
The following example demonstrates how to handle the afterSectionInitialize event and use the selectDataFields method.
<script type="text/javascript">
function afterSectionInit(args) {
if (args.sectionId === DevExpress.Reporting.Designer.Wizard.FullscreenReportWizardSectionId.SelectDataMembersPage_Members) {
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="ASPxReportDesigner1" runat="server">
<ClientSideEvents CustomizeWizard="CustomizeWizard" />
</dx:ASPxReportDesigner>
#selectDataMember(dataMemberPath) Method
Selects the specified data member.
#Declaration
selectDataMember(
dataMemberPath: string
): void
#Parameters
Name | Type | Description |
---|---|---|
data |
string | The data member name. |
#Remarks
The following example demonstrates how to handle the afterSectionInitialize event and use the selectDataMember method.
<script type="text/javascript">
function afterSectionInit(args) {
if (args.sectionId === DevExpress.Reporting.Designer.Wizard.FullscreenReportWizardSectionId.SelectDataMembersPage_Members) {
args.section.selectDataMember("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="ASPxReportDesigner1" runat="server">
<ClientSideEvents CustomizeWizard="CustomizeWizard" />
</dx:ASPxReportDesigner>