SqlWizardFramework Class

Definition

Provides the ability to customize the WizardFramework class.

public ref class SqlWizardFramework : Microsoft::SqlServer::Management::SqlWizardFramework::WizardFramework
public class SqlWizardFramework : Microsoft.SqlServer.Management.SqlWizardFramework.WizardFramework
type SqlWizardFramework = class
    inherit WizardFramework
Public Class SqlWizardFramework
Inherits WizardFramework
Inheritance
SqlWizardFramework

Constructors

SqlWizardFramework()

Initializes a new instance of the SqlWizardFramework class.

Properties

ButtonsPanel

Gets the WizardButtonsPanel object that represents the button panel.

(Inherited from WizardFramework)
CancelCaption

Gets or sets the title for the cancel message.

(Inherited from WizardFramework)
CancelMessage

The message that appears when the wizard is canceled.

(Inherited from WizardFramework)
CaptionPrefix

Gets or sets the text that is used to prefix the window title of the wizard.

ConfirmOnCancel

Gets or sets a value that indicates whether to confirm when the Cancel button is clicked.

(Inherited from WizardFramework)
CurrentPage

Gets the current page.

(Inherited from WizardFramework)
CurrentPageId

Gets the ID of the current page.

(Inherited from WizardFramework)
FrameworkName

Gets or sets the name of the wizard.

(Inherited from WizardFramework)
HeaderImage

Gets or sets the image that is displayed on the header panel.

(Inherited from WizardFramework)
HeaderPanel

Gets a WizardHeaderPanel object that represents the header panel.

(Inherited from WizardFramework)
HeaderTitle

Gets or sets the title of the header panel.

(Inherited from WizardFramework)
HelpKey

Gets or sets the help key for the WizardFramework object. This help key is used if a page does not have a help key associated with it.

(Inherited from WizardFramework)
HelpPanel

Gets a WizardHeaderPanel object that represents the help panel.

(Inherited from WizardFramework)
LastPage

Gets the last page.

(Inherited from WizardFramework)
NavigationPanel

Gets a WizardNavigationPanel object that represents the navigation panel.

(Inherited from WizardFramework)
PagePanel

Gets a WizardPagePanel object that represents the page panel.

(Inherited from WizardFramework)
Pages

Gets the list of pages in to the WizardFramework object.

(Inherited from WizardFramework)
ResizeState

Gets or sets the resize state.

(Inherited from WizardFramework)
SqlWizardTelemetryProperty (Inherited from WizardFramework)
StartPage

Gets or sets the start page.

(Inherited from WizardFramework)

Methods

AddPage(Page)

Adds the specified page to the wizard.

(Inherited from WizardFramework)
AddPage(Page, Page)

Adds a subpage to the wizard.

(Inherited from WizardFramework)
AddPage(String)

Adds all the pages that are defined in the specified assembly to the wizard.

(Inherited from WizardFramework)
AddPage(String, Type)

Searches the specified assembly for pages whose type matches the specified type, and adds them to the wizard.

(Inherited from WizardFramework)
AddPageRange(Page[])

Adds the pages in the specified array to the wizard.

(Inherited from WizardFramework)
Dispose(Boolean)

Cleans up any resources that are being used.

(Inherited from WizardFramework)
EnableButton(FrameworkButton, Boolean)

Enables or disables the specified button.

(Inherited from WizardFramework)
GetService(Type)

Gets the specified service. This method can be called by a child window to get console services.

(Inherited from WizardFramework)
IsCurrentPage(Page)

Checks whether the specified page is the current page.

(Inherited from WizardFramework)
IsLastPage(Page)

Checks whether the specified page is the last page.

(Inherited from WizardFramework)
IsStartPage(Page)

Checks whether the specified page is the first page.

(Inherited from WizardFramework)
OnClosing(CancelEventArgs)

Called when the wizard is closing.

(Inherited from WizardFramework)
OnHelpRequested(HelpEventArgs)

Called when help is requested.

(Inherited from WizardFramework)
OnLoad(EventArgs)

Called when the wizard is initialized.

(Inherited from WizardFramework)
OnValidityChanged(Int32)

Confirms that the page that has the specified ID has changed, and then refreshes the navigation panel and notifies the other pages.

(Inherited from WizardFramework)
OnValidityChanged(Page)

Confirms that the specified page has changed, and then refreshes the navigation panel and notifies the other pages.

(Inherited from WizardFramework)
RefreshNavigationPanel()

Refreshes the navigation panel.

(Inherited from WizardFramework)
RemoveAllPages()

Removes all the pages from the wizard.

(Inherited from WizardFramework)
RemoveHelpKey(Control)

Removes the help key for the specified control. Help will no longer be available for the specified control.

(Inherited from WizardFramework)
RemovePage(Int32)

Removes the page that has the specified ID from the wizard.

(Inherited from WizardFramework)
RemovePage(Page)

Removes the specified page from the wizard.

(Inherited from WizardFramework)
RemovePageRange(Page[])

Removes the specified pages from the wizard.

(Inherited from WizardFramework)
SetButtonText(FrameworkButton, String)

Sets the text for the specified button.

(Inherited from WizardFramework)
SetHelpKey(Control, String)

Sets the help key for the specified control.

(Inherited from WizardFramework)
ShowBooksOnlineHelp()

Shows the SQL Server Books Online help.

(Inherited from WizardFramework)
ShowBooksOnlineHelp(String)

Shows the SQL Server Books Online help.

(Inherited from WizardFramework)
ShowButton(FrameworkButton, Boolean)

Shows or hides the specified button.

(Inherited from WizardFramework)

Events

PageFrameworkAction

Occurs when the wizard is completed.

(Inherited from WizardFramework)

Applies to