DevExpress.XtraWizard.v25.1

Contains classes which implement the main functionality of the XtraWizard suite.

Serves as a base for classes that represent the Welcome Page and Completion Page.

This member supports the internal infrastructure and is not intended to be used directly from your code.

A Color value.

Gets or sets the text displayed at the page’s bottom.

A string value that specifies the text displayed within the page’s bottom.

Serves as a base for classes that represent wizard pages.

Initializes a new instance of the class.

Gets or sets whether the Back button is enabled.

true, to enable the button; otherwise, false.

Gets or sets whether the Cancel button is enabled.

true to enable the button; otherwise, false.

Gets or sets whether the Finish button is enabled.

true if the Finish button is enabled; otherwise, false.

Gets or sets whether the Next button is enabled.

true to enable the button; otherwise, false.

This property isn’t used.

This property isn’t used.

This property isn’t used.

This property isn’t used.

This property isn’t used.

This member supports the internal infrastructure and is not intended to be used directly from your code.

A Booelan value.

This property isn’t used.

This property isn’t used.

This property isn’t used.

This property isn’t used.

This property isn’t used.

Gets the XtraWizard control which owns the current wizard page.

A object which contains the current page within the WizardControl.Pages collection.

Enables you to persist the changes made within the current step.

Fires when the current is about to be displayed and allows you to initialize the content of this page.

Enables you to rollback the current step.

Enables you to specify whether page data is valid, and whether the page can be switched.

This property isn’t used.

This property isn’t used.

Gets or sets the header text.

A string value that specifies the header text.

Gets or sets whether the page is visible.

A Boolean value that specifies the visibility of the page.

Represents the Completion Page.

Initializes a new instance of the class.

Gets or sets the completion text.

A string value that specifies the completion text.

Gets or sets the text displayed at the bottom of the page.

A string value that specifies the text displayed at the bottom of the page.

Gets or sets the header text.

A string value that specifies the header text.

Represents the Welcome Page.

Initializes a new instance of the class.

Gets or sets the introduction text.

A string value that specifies the introduction text.

Gets or sets the header text.

A string value that specifies the header text.

Contains appearance settings for the .

Contains the appearance settings used to paint the wizard control’s title (in the WizardStyle.WizardAero style).

An that contains the corresponding appearance settings.

Contains appearance settings used to customize the inner regions of the Welcome Page and Completion Page, when the WizardStyle.Wizard97 style is applied.

An that contains the corresponding appearance settings.

Contains the appearance settings used to paint the titles of Welcome Page and Completion Page, when the WizardStyle.Wizard97 style is applied.

An that contains the corresponding appearance settings.

Gets whether the XtraWizard control is being initialized

true if if the XtraWizard control is being initialized; otherwise, false.

Contains the appearance settings used to paint 1) the background and descriptions of inner pages in the WizardStyle.Wizard97 style, and 2) the background of all pages in the WizardStyle.WizardAero style.

An that contains the corresponding settings.

Contains the appearance settings used to paint 1) the titles of inner pages in the WizardStyle.Wizard97 style, and 2) the titles of all pages in the WizardStyle.WizardAero style.

An that contains the corresponding appearance settings.

Provides data for the WizardControl.PrevClick and WizardControl.NextClick events.

Initializes a new instance of the class.

A descendant that represents the current wizard page. This value is assigned to the WizardPageEventArgs.Page property.

Gets or sets whether an event was handled.

true if the default precessing is not required; otherwise, false.

Represents a method that will handle the button click events.

The event source. A object that contains event data.

Allows you to generate multi-step wizard dialogs and Windows-inspired installer UIs.

Initializes a new instance of the class.

This member supports the .NET Framework infrastructure and cannot be used directly from your code.

Gets or sets whether the size of the WizardControl’s buttons is changed according to the DPI settings.

A value that specifies whether the size of the WizardControl’s buttons is changed according to the DPI settings.

Gets or sets whether HTML tags are used to format the text on wizard pages.

true if HTML tags are used to format the text on wizard pages; otherwise, false.

Gets or sets whether to display page paddings.

true to display page paddigns; otherwise, false.

Gets or sets whether the fading animation effect in the transition from one page to another page is enabled.

true to enable the fading animation effect; otherwise, false.

This property isn’t used.

Gets or sets the length of the fading animation effect.

An integer value that specifies the length of the fading animation effect, in system timer ticks.

Provides access to the settings that control the appearance of the ‘s elements.

A object containing the appearance settings.

This property isn’t used.

This property isn’t used.

This property isn’t used.

Starts the XtraWizard’s runtime initialization.

Locks the object by preventing visual updates until the EndUpdate method is called.

Returns information about the visual elements located at the specified point.

A structure that specifies the test point coordinates relative to the XtraWizard control’s top-left corner. A object that contains information about the visual elements located at the specified point.

Gets or sets whether a click on the Cancel button must fire validation events for the currently focused control.

true if a click on this button must fire validation events; otherwise, false.

Fires after the Cancel button has been clicked.

Gets or sets the Cancel button’s text.

A string value that specifies the button’s text.

Allows you to customize predefined buttons (Previous, Next, Cancel, Finish, and Help) and display/customize custom buttons.

This property isn’t used.

Ends the XtraWizard’s runtime initialization.

Unlocks the object after a call to the BeginUpdate method and causes an immediate visual update.

Fires after the Finish button has been clicked.

Gets or sets the Finish button’s text.

A string value that specifies the button’s text.

This property isn’t used.

This property isn’t used.

Gets or sets the header image.

The header image.

Contains settings that allow you to assign and customize the Wizard Control’s header image. This property is supported in the WizardStyle.Wizard97 style.

An object that contains settings to specify an image and its display options.

Gets or sets whether a click on the Help button must fire validation events for the currently focused control.

true if a click on this button must fire validation events; otherwise, false.

Fires after the Help button has been clicked.

Gets or sets the Help button’s text.

A string value that specifies the button’s text.

Gets or sets whether the Help button is displayed.

true to display the Help button; otherwise, false.

Gets or sets a collection of images that you can embed into captions/messages/tooltips in the control using the image HTML-inspired tag.

An or that contains images.

Fires when a user clicks a hyperlink on a wizard page.

Gets or sets the image displayed within the Welcome Page and Completion Page.

An Image object.

Gets or sets a value that specifies the position of the image.

An enumeration value that specifies the position of the image.

Contains settings that allow you to assign and customize an image displayed within the Welcome Page and Completion Page. This image is supported in the WizardStyle.Wizard97 style.

An object that contains settings to specify an image and its display options.

Gets or sets the width of an image displayed within the Welcome Page and Completion Page.

An integer value that specifies the image width, in pixels.

Indicates whether the XtraWizard control contains the Completion Page.

true if the Completion Page is created; otherwise, false.

Indicates whether the XtraWizard control is being initialized.

true if the XtraWizard control is being initialized; otherwise, false.

Gets whether the XtraWizard control is immediately updated in response to changing its settings.

true if the XtraWizard control cannot be updated until unlocked; otherwise, false.

Indicates whether the XtraWizard control contains the Welcome Page.

true if the Welcome Page is created; otherwise, false.

Updates the XtraWizard control.

This property isn’t used.

Provides access to the settings that control the XtraWizard’s look and feel.

A object whose properties specify the control’s look and feel.

Gets or sets whether clicking the Previous button navigates to the preceding or to the last visited page.

A NavigationMode value that specifies which page is activated when clicking the Previous button.

Fires when the Next button is clicked. Allows you to cancel the operation or navigate to a custom page.

Gets or sets the Next button’s text.

A string value that specifies the button’s text.

Provides access to the XtraWizard’s page collection.

A object that represents a collection of wizard pages.

Fires after the Back button has been clicked and allows you to cancel the operation.

Gets or sets whether a click on the Previous button must fire validation events for the currently focused control.

true if a click on this button must fire validation events; otherwise, false.

Gets or sets the Back button’s text.

A string value that specifies the button’s text.

This member supports the internal infrastructure and is not intended to be used directly from your code.

Gets or sets the currently selected wizard page.

A descendant that represents the selected wizard page.

Fires after the current wizard page has been changed.

Enables you to control whether a wizard page can be selected.

Gets or sets the current wizard page.

An integer value that specifies the wizard page’s position within the WizardControl.Pages collection.

This member supports the internal infrastructure and is not intended to be used directly from your code.

Selects the next wizard page.

true if the next page has been selected; otherwise, false.

Selects the previous wizard page.

true if the previous page has been selected; otherwise, false.

Gets or sets whether the Back button is displayed. This property is in effect if WizardControl.WizardStyle is set to WizardStyle.WizardAero.

true if the Back button is displayed; otherwise, false.

Gets or sets whether the header image (see WizardControl.HeaderImageOptions) is displayed within the Welcome Page and Completion Page. This property is supported in the WizardStyle.Wizard97 style.

true to display the header image within the Welcome Page and Completion Page; otherwise, false.

This property isn’t used.

This property isn’t used.

This property isn’t used.

Gets or sets the wizard’s title.

A string value that specifies the title.

Gets or sets the XtraWizard’s title image.

An Image object.

Contains settings that allow you to assign and customize the XtraWizard’s title image. This property is supported in the WizardStyle.Wizard97 style.

An object that contains settings to specify an image and its display options.

Gets or sets whether the Next/Finish button is automatically clicked when the user presses the Enter key.

true to enable Enter key processing; otherwise, false.

Gets or sets whether the Cancel button is automatically clicked when the user presses the Esc key.

true to enable Esc key processing; otherwise, false.

Gets or sets the XtraWizard’s layout.

A enumeration value that specifies the XtraWizard’s layout.

Contains information about a specific point within the XtraWizard control.

Initializes a new instance of the class.

Sets the class’ properties to their default values.

Gets or sets the test point.

A structure that represents the test point. The point coordinates are set relative to the XtraWizard’s top-left corner.

Gets a value which identifies a wizard element located under the test point.

A enumeration value that identifies the wizard element located under the test point.

Indicates whether the hit information supplied by this object is valid.

true if the hit information is valid; otherwise, false.

Lists the values that identify wizard elements located under the test point.

The test point belongs to the Cancel button.

The test point belongs to the Help button.

The test point belongs to the navigation panel.

The test point belongs to the Next button.

The test point does not belong to any wizard element or is outside the XtraWizard control.

The test point belongs to a content area.

The test point belongs to the Back button.

Represents an Interior Page.

Initializes a new instance of the class with the default settings.

Gets or sets the description text displayed below the header text.

A string value that specifies the description.

Gets or sets the header text.

A string value that specifies the header text.

Provides data for the WizardControl.SelectedPageChanged event.

Initializes a new instance of the class.

A descendant that represents the previously active wizard page. This value is assigned to the WizardPageChangedEventArgs.PrevPage property. A descendant that represents the wizard page currently being selected. This value is assigned to the WizardPageEventArgs.Page property. A DevExpress.XtraWizard.Direction enumeration value that specifies in which direction a user navigates between pages. This value is assigned to the WizardPageChangedEventArgs.Direction property.

Gets a value that indicates in which direction a user navigates between pages.

A DevExpress.XtraWizard.Direction enumeration value that specifies in which direction a user navigates between pages.

Gets the previously active wizard page.

A descendant that represents the previously active wizard page.

Represents a method that will handle the WizardControl.SelectedPageChanged event.

The event sender. A object that contains event data.

Provides data for the WizardControl.SelectedPageChanging event.

Initializes a new instance of the class.

A descendant that represents the previously active wizard page. This value is assigned to the WizardPageChangedEventArgs.PrevPage property. A descendant that represents the current wizard page. This value is assigned to the WizardPageChangingEventArgs.Page property. A DevExpress.XtraWizard.Direction enumeration value that specifies the navigation direction. This value is assigned to the WizardPageChangedEventArgs.Direction property.

Gets or sets whether the operation must be canceled.

true to cancel the operation; otherwise, false.

Gets or sets the current wizard page.

A descendant that represents the current wizard page.

Represents a method that will handle the WizardControl.SelectedPageChanging event.

The event sender. A object that contains event data.

Represents a collection of wizard pages within the XtraWizard control.

Initializes a new instance of the class with the specified owner.

A object that owns this collection.

Adds a new page to the collection.

A descendant that represents the new page.

Adds the specified columns to the collection.

A object to add to the collection.

Adds a new page with the specified text to the collection.

A string value that specifies the text displayed within the page’s header. This value is assigned to the BaseWizardPage.Text property. A descendant that represents the new page.

Adds an array of wizard pages to the end of the collection.

An array of objects to add to the collection.

Fires when changes are made to the page collection.

Indicates whether the collection contains the specified wizard page.

A object to locate in the collection. true if the collection contains the specified wizard page; otherwise, false.

Returns the position of the wizard page within the collection.

A object to locate in the collection. A zero-based index of the specified wizard page in the collection. -1 if the collection doesn’t contain the specified page.

Adds the specified wizard page to the collection at the specified position.

A object at which position the specified wizard page is inserted. If this page isn’t contained within the collection, the method does nothing. A object to add to the collection. If this wizard page is already contained within the collection, the method does nothing. true if the specified wizard page has been added to the collection; otherwise, false.

Adds the specified wizard page to the collection at the specified position.

A zero-based index at which the specified page is inserted. If negative or exceeds the number of elements in the collection, an exception is thrown. A object to add to the collection. true if the specified wizard page has been added to the collection; otherwise, false.

Gets a wizard page at the specified index.

An integer value that specifies the zero-based index of the required wizard page. If negative or exceeds the maximum available index, an exception is raised. A object located at the specified position within the collection.

Removes the specified wizard page from the collection.

A object to remove from the collection.

Gets the XtraWizard control which owns this collection.

A object which owns this collection.

Serves as a base for classes that provide data for the page events.

Initializes a new instance of the class.

A descendant that represents the processed wizard page.

Gets the processed wizard page.

A descendant that represents the processed wizard page.

Provides data for the BaseWizardPage.PageValidating event.

Initializes a new instance of the class with the specified drection.

A DevExpress.XtraWizard.Direction value that specifies whether the next or previous page is about to be activated.

Gets whether the next or previous page is about to be activated.

A DevExpress.XtraWizard.Direction value that specifies whether the next or previous page is about to be activated.

Gets or sets the type of icon displayed within an error message.

A System.Windows.Forms.MessageBoxIcon enumeration value that specifies the type of icon displayed within an error message.

Gets or sets the error text displayed within the error message box.

A string value that specifies the error text.

Gets or sets whether the processed wizard page is valid.

true if a wizard page is valid; otherwise, false.

Represents a method that will handle the BaseWizardPage.PageValidating event.

The event sender. A object that contains event data.

Lists values that specify the XtraWizard’s layout.

The XtraWizard control is painted inWizard’97 style.

The XtraWizard control is painted in Aero style.