Back to Devexpress

WizardControl Properties

windowsforms-devexpress-dot-xtrawizard-dot-wizardcontrol-dot-underscore-properties.md

latest39.4 KB
Original Source

WizardControl Properties

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

NameDescription
AccessibilityObjectGets the AccessibleObject assigned to the control. Inherited from Control.
AccessibleDefaultActionDescriptionGets or sets the default action description of the control for use by accessibility client applications. Inherited from Control.
AccessibleDescriptionGets or sets the description of the control used by accessibility client applications. Inherited from Control.
AccessibleNameGets or sets the name of the control used by accessibility client applications. Inherited from Control.
AccessibleRoleGets or sets the accessible role of the control. Inherited from Control.
AllowAutoScalingGets or sets whether the size of the WizardControl’s buttons is changed according to the DPI settings.
AllowDropGets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control.
AllowHtmlTextGets or sets whether HTML tags are used to format the text on wizard pages.
AllowPagePaddingGets or sets whether to display page paddings.
AllowTransitionAnimationGets or sets whether the fading animation effect in the transition from one page to another page is enabled.
AnchorThis property isn’t used.
AnimationIntervalGets or sets the length of the fading animation effect.
AppearanceProvides access to the settings that control the appearance of the WizardControl‘s elements.
AutoScrollOffsetGets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control.
AutoSizeThis property is not relevant for this class. Inherited from Control.
BackColorThis property isn’t used.
BackgroundImageThis property isn’t used.
BackgroundImageLayoutThis property isn’t used.
BindingContextGets or sets the BindingContext for the control. Inherited from Control.
BottomGets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control.
BoundsGets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. Inherited from Control.
CancelButtonCausesValidationGets or sets whether a click on the Cancel button must fire validation events for the currently focused control.
CancelTextGets or sets the Cancel button’s text.
CanEnableIme protectedGets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from Control.
CanFocusGets a value indicating whether the control can receive focus. Inherited from Control.
CanRaiseEvents protectedDetermines if events can be raised on the control. Inherited from Control.
CanSelectGets a value indicating whether the control can be selected. Inherited from Control.
CaptureGets or sets a value indicating whether the control has captured the mouse. Inherited from Control.
CausesValidationGets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. Inherited from Control.
CheckForIllegalCrossThreadCalls staticGets or sets a value indicating whether to catch calls on the wrong thread that access a control’s Handle property when an application is being debugged. Inherited from Control.
ClientRectangleGets the rectangle that represents the client area of the control. Inherited from Control.
ClientSizeGets or sets the height and width of the client area of the control. Inherited from Control.
CompanyNameGets the name of the company or creator of the application containing the control. Inherited from Control.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContainsFocusGets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control.
ContextMenuGets or sets the shortcut menu associated with the control. Inherited from Control.
ContextMenuStripGets or sets the ContextMenuStrip associated with this control. Inherited from Control.
ControlsGets the collection of controls contained within the control. Inherited from Control.
CreatedGets a value indicating whether the control has been created. Inherited from Control.
CreateParams protectedGets the required creation parameters when the control handle is created. Inherited from Control.
CursorGets or sets the cursor that is displayed when the mouse pointer is over the ControlBase control. Inherited from ControlBase.
DataBindingsGets the data bindings for the control. Inherited from Control.
DefaultBackColor staticGets the default background color of the control. Inherited from Control.
DefaultCursor protectedGets or sets the default cursor for the control. Inherited from Control.
DefaultFont staticGets the default font of the control. Inherited from Control.
DefaultForeColor staticGets the default foreground color of the control. Inherited from Control.
DefaultImeMode protectedGets the default Input Method Editor (IME) mode supported by the control. Inherited from Control.
DefaultMargin protectedGets the space, in pixels, that is specified by default between controls. Inherited from Control.
DefaultMaximumSize protectedGets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control.
DefaultPadding protectedGets the internal spacing, in pixels, of the contents of a control. Inherited from Control.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayRectangleGets the rectangle that represents the display area of the control. Inherited from Control.
DisposingGets a value indicating whether the base Control class is in the process of disposing. Inherited from Control.
DockThis property isn’t used.
DoubleBuffered protectedGets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control.
EnabledGets or sets a value indicating whether the control can respond to user interaction. Inherited from Control.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FinishTextGets or sets the Finish button’s text.
FocusedGets a value indicating whether the control has input focus. Inherited from Control.
FontThis property isn’t used.
FontHeight protectedGets or sets the height of the font of the control. Inherited from Control.
ForeColorThis property isn’t used.
HandleGets the window handle that the control is bound to. Inherited from Control.
HasChildrenGets a value indicating whether the control contains one or more child controls. Inherited from Control.
HeaderImageGets or sets the header image.
HeaderImageOptionsContains settings that allow you to assign and customize the Wizard Control’s header image. This property is supported in the WizardStyle.Wizard97 style.
HeightGets or sets the height of the control. Inherited from Control.
HelpButtonCausesValidationGets or sets whether a click on the Help button must fire validation events for the currently focused control.
HelpTextGets or sets the Help button’s text.
HelpVisibleGets or sets whether the Help button is displayed.
HtmlImagesGets or sets a collection of images that you can embed into captions/messages/tooltips in the control using the image HTML-inspired tag.
ImageGets or sets the image displayed within the Welcome Page and Completion Page.
ImageLayoutGets or sets a value that specifies the position of the image.
ImageOptionsContains 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.
ImageWidthGets or sets the width of an image displayed within the Welcome Page and Completion Page.
ImeModeGets or sets the Input Method Editor (IME) mode of the control. Inherited from Control.
ImeModeBase protectedGets or sets the IME mode of a control. Inherited from Control.
InvokeRequiredGets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. Inherited from Control.
IsAccessibleGets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control.
IsCompletionPageCreatedIndicates whether the XtraWizard control contains the Completion Page.
IsDisposedGets a value indicating whether the control has been disposed of. Inherited from Control.
IsHandleCreatedGets a value indicating whether the control has a handle associated with it. Inherited from Control.
IsLoadingIndicates whether the XtraWizard control is being initialized.
IsLockUpdateGets whether the XtraWizard control is immediately updated in response to changing its settings.
IsMirroredGets a value indicating whether the control is mirrored. Inherited from Control.
IsRightToLeftGets whether the ControlBase‘s visual elements are actually aligned to support locales using right-to-left fonts. Inherited from ControlBase.
IsWelcomePageCreatedIndicates whether the XtraWizard control contains the Welcome Page.
LayoutEngineGets a cached instance of the control’s layout engine. Inherited from Control.
LeftGets or sets the distance, in pixels, between the left edge of the control and the left edge of its container’s client area. Inherited from Control.
LocationThis property isn’t used.
LookAndFeelProvides access to the settings that control the XtraWizard’s look and feel.
MarginGets or sets the space between controls. Inherited from Control.
MaximumSizeGets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control.
MinimumSizeGets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control.
ModifierKeys staticGets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control.
MouseButtons staticGets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control.
MousePosition staticGets the position of the mouse cursor in screen coordinates. Inherited from Control.
NameGets or sets the name of the control. Inherited from Control.
NavigationModeGets or sets whether clicking the Previous button navigates to the preceding or to the last visited page.
NextTextGets or sets the Next button’s text.
PaddingGets or sets padding within the control. Inherited from Control.
PagesProvides access to the XtraWizard’s page collection.
ParentGets or sets the parent container of the control. Inherited from Control.
PreferredSizeGets the size of a rectangular area into which the control can fit. Inherited from Control.
PreviousButtonCausesValidationGets or sets whether a click on the Previous button must fire validation events for the currently focused control.
PreviousTextGets or sets the Back button’s text.
ProductNameGets the product name of the assembly containing the control. Inherited from Control.
ProductVersionGets the version of the assembly containing the control. Inherited from Control.
PropagatingImeMode protected staticGets an object that represents a propagating IME mode. Inherited from Control.
RecreatingHandleGets a value indicating whether the control is currently re-creating its handle. Inherited from Control.
RegionGets or sets the window region associated with the control. Inherited from Control.
RenderRightToLeft protectedThis property is now obsolete. Inherited from Control.
ResizeRedraw protectedGets or sets a value indicating whether the control redraws itself when resized. Inherited from Control.
RightGets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control.
RightToLeftGets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control.
ScaleChildren protectedGets a value that determines the scaling of child controls. Inherited from Control.
SelectedPageGets or sets the currently selected wizard page.
SelectedPageIndexGets or sets the current wizard page.
ShowBackButtonGets or sets whether the Back button is displayed. This property is in effect if WizardControl.WizardStyle is set to WizardStyle.WizardAero.
ShowFocusCues protectedGets a value indicating whether the control should display focus rectangles. Inherited from Control.
ShowHeaderImageGets 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.
ShowKeyboardCues protectedGets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control.
SiteGets or sets the site of the control. Inherited from Control.
SizeThis property isn’t used.
TabIndexThis property isn’t used.
TabStopThis property isn’t used.
TagGets or sets the object that contains data about the control. Inherited from Control.
TextGets or sets the wizard’s title.
TitleImageGets or sets the XtraWizard’s title image.
TitleImageOptionsContains settings that allow you to assign and customize the XtraWizard’s title image. This property is supported in the WizardStyle.Wizard97 style.
TopGets or sets the distance, in pixels, between the top edge of the control and the top edge of its container’s client area. Inherited from Control.
TopLevelControlGets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. Inherited from Control.
UseAcceptButtonGets or sets whether the Next/Finish button is automatically clicked when the user presses the Enter key.
UseCancelButtonGets or sets whether the Cancel button is automatically clicked when the user presses the Esc key.
UseWaitCursorGets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control.
VisibleGets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control.
WidthGets or sets the width of the control. Inherited from Control.
WindowTargetThis property is not relevant for this class. Inherited from Control.
WizardStyleGets or sets the XtraWizard’s layout.

See Also

WizardControl Class

WizardControl Members

DevExpress.XtraWizard Namespace