InitializePageEventArgs Class

Provides data for a wizard page’s WizardPage.InitializePage event.

Namespace: DevExpress.XtraCharts.Wizard

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

Declaration

C#

public class InitializePageEventArgs :
    EventArgs

VB.NET

Public Class InitializePageEventArgs
    Inherits EventArgs

Related API Members

InitializePageEventArgs is the data class for the following events:

• WizardPage.InitializePage

Remarks

The WizardPage.InitializePage event occurs when the custom wizard page is loaded. The InitializePageEventArgs class introduces the InitializePageEventArgs.Control property which represents a user control embedded into the custom wizard page, and the InitializePageEventArgs.Chart property, which provides access to the chart object currently being edited in the wizard. Note that you must set the InitializePageEventArgs.Chart property value in the WizardPage.InitializePage event handler.

InitializePageEventArgs objects are automatically created, initialized and passed to WizardPage.InitializePage event handlers.

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

Inheritance

Object

EventArgs

InitializePageEventArgs