WizardGroup.RegisterPage(WizardPageType, String, String, String, Image) Method

Registers the predefined Wizard’s page if it has been unregistered before.

Namespace: DevExpress.XtraCharts.Wizard

Assembly: DevExpress.XtraCharts.v23.2.Wizard.dll

NuGet Package: DevExpress.Win.Charts

Declaration

C#

public WizardPage RegisterPage(
    WizardPageType pageType,
    string label,
    string header,
    string description,
    Image image
)

VB.NET

Public Function RegisterPage(
    pageType As WizardPageType,
    label As String,
    header As String,
    description As String,
    image As Image
) As WizardPage

Parameters

Name	Type	Description
pageType	WizardPageType	A WizardPageType enumeration member, specifying the type of a page to register.
label	String	A String, representing a text to display in the Wizard’s sidebar.
header	String	A String, representing a text to display in the page’s header.
description	String	A String, representing a text of a page’s description, displayed at the top section of a page.
image	Image	An Image object, representing a picture displayed in the Wizard’s sidebar.

Returns

Type	Description
WizardPage	A WizardPage class (or its descendant) instance, representing a newly registered page.

Remarks

An attempt to register a page of the type that has been already registered results in an exception

Example

The following example demonstrates how to add a new group with a new page to the Chart Wizard at runtime.

First, create a control that becomes a page’s content. Create a new control that inherits from the WizardControlBase and drop the ChartControl onto it. This follows because the page is intended to customize the chart. The page should contain a chart control to display the changes as the settings are modified.

Then, use the following code to create a group and a page. You can handle the WizardPage.InitializePage event to get access to the contained chart control.

C#

using DevExpress.XtraCharts.Wizard;
//...

private void ShowNewWizard() {
    // Create a Wizard instance.
    ChartWizard wiz = new ChartWizard(this.chartControl1);

    // Create a new group.
    WizardGroup MyWizardGroup = wiz.RegisterGroup("NewGroup");

    // Create a new page with a "MyPage" name, "MyHeader" as a caption, "MyDesription" 
    // as a description, without image. It contains the UserControl1.
    WizardPage MyWizardPage =  MyWizardGroup.RegisterPage(typeof(UserControl1), 
        "MyPage", "MyHeader", "MyDesription", null);

    // Subscribe to the InitializePage event.
    MyWizardPage.InitializePage += new InitializePageEventHandler (MyWizardPage_InitializePage);

    // Invoke the Wizard.
    wiz.ShowDialog();
}

void MyWizardPage_InitializePage(object sender, InitializePageEventArgs e) {
    e.Chart = ((UserControl1)e.Control).chartControl1;
}

VB.NET

Imports DevExpress.XtraCharts.Wizard
' ...

Private Sub ShowNewWizard()
    ' Create a Wizard instance.
    Dim wiz As New ChartWizard(Me.chartControl1)

    ' Create a new group.
    Dim MyWizardGroup As WizardGroup = wiz.RegisterGroup("NewGroup")

    ' Create a new page with a "MyPage" name, "MyHeader" as a caption, 
    ' "MyDesription" as a description, without image. It contains the UserControl1.
    Dim MyWizardPage As WizardPage = MyWizardGroup.RegisterPage(GetType(UserControl1), _
        "MyPage", "MyHeader", "MyDesription", Nothing)

    ' Subscribe to the InitializePage event.
    AddHandler MyWizardPage.InitializePage, AddressOf MyWizardPage_InitializePage

    ' Invoke the Wizard.
    wiz.ShowDialog()
End Sub

Private Sub MyWizardPage_InitializePage(ByVal sender As Object, ByVal e As InitializePageEventArgs)
     e.Chart = DirectCast(e.Control, UserControl1).chartControl1
End Sub