Skip to main content
All docs
V24.2

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

SelectDataMembersPage Class

Implements the Select Queries and Select Data Fields sections of the Report Wizard’s Define Report Layout page.

#Declaration

TypeScript
export class SelectDataMembersPage extends WizardPageBase

#Remarks

This class implements two page sections:

See the following topics for more information:

#constructor(_fieldListCallBack)

Initializes a new instance of the SelectDataMembersPage class with specified settings.

#Declaration

TypeScript
constructor(
    _fieldListCallBack: DevExpress.Reporting.Designer.Internal.IReportWizardFieldsCallback,
    _hideDataMemberSubItems?: boolean
)

#Parameters

Name Type
_fieldListCallBack IReportWizardFieldsCallback
_hideDataMemberSubItems boolean

#Methods

#canFinish Method

Specifies whether it is possible to finish the wizard.

#Declaration

TypeScript
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

TypeScript
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

TypeScript
commit(): JQuery.Promise<any, any, any>

#Returns

Type Description
Promise<any,any,any>

A JQuery Promise object that identifies whether the commit succeeded.

#initialize(state) Method

Initializes the section with the specified settings.

#Declaration

TypeScript
initialize(
    state: DevExpress.Reporting.Designer.Wizard.IReportWizardState
): JQueryPromise<any>

#Parameters

Name Type Description
state IReportWizardState

The section’s state.

#Returns

Type Description
JQueryPromise<any>

A JQuery Promise object that identifies whether section initialization succeeded.

#selectAllDataFields Method

Selects all data members and fields.

#Declaration

TypeScript
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

TypeScript
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

TypeScript
selectDataField(
    dataFieldPath: string
): void

#Parameters

Name Type Description
dataFieldPath 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

TypeScript
selectDataFields(
    dataMemberPath: string
): void

#Parameters

Name Type Description
dataMemberPath 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

TypeScript
selectDataMember(
    dataMemberPath: string
): void

#Parameters

Name Type Description
dataMemberPath 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>