RadWizard
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[EmbeddedSkin("Wizard", typeof(RadWizard))]
[EmbeddedSkin("Wizard", "Default", typeof(RadWizard))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadWizard))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Mobile, typeof(RadWizard))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Lightweight, typeof(RadButton))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Mobile, typeof(RadButton))]
[RequiredScript(typeof(jQueryPlugins), 1)]
[RequiredScript(typeof(MaterialRipple))]
[ClientScriptResource("Telerik.Web.UI.RadWizard", "Telerik.Web.UI.Wizard.RadWizardScripts.js")]
[TelerikToolboxCategory("Container")]
[ToolboxBitmap(typeof(RadWizard), "Toolbox.Icons.Wizard.png")]
public class RadWizard : RadWebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IPostBackEventHandlerInheritance: objectControlWebControlRadWebControlRadWizard
Implements:
Inherited Members
Constructors
public RadWizard()Properties
Gets the active step.
public RadWizardStep ActiveStep { get; }The active step.
Gets or sets the index of the selected RadWizardStep.
public int ActiveStepIndex { get; set; }The index of the currently selected RadWizardStep. The default value is -1, which means that no RadWizardStep is selected.
Gets or sets the click active step.
[ClientControlProperty]
[ClientPropertyName("_clickActiveStep")]
public bool ClickActiveStep { get; set; }The click active step.
The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()
protected override string CssClassFormatString { get; }Overrides:
Gets or sets the selected culture. Localization strings will be loaded based on this value.
public CultureInfo Culture { get; set; }The culture.
Gets or sets the display cancel button.
public virtual bool DisplayCancelButton { get; set; }The display cancel button.
Gets or sets the display navigationBar.
[ClientControlProperty]
[ClientPropertyName("_displayNavigationBar")]
public bool DisplayNavigationBar { get; set; }The display navigationBar.
Gets or sets the display navigation buttons.
public bool DisplayNavigationButtons { get; set; }The display navigation buttons.
Gets or sets the display progress bar.
[ClientControlProperty]
[ClientPropertyName("_displayProgressBar")]
public bool DisplayProgressBar { get; set; }The display progress bar.
Gets or sets a value indicating the position of the image within the step.
public RadWizardImagePostion ImagePosition { get; set; }One of the Telerik.Web.UI.RadWizardImagePostion?text=RadWizardImagePostion ++++++++++++++++Enumeration values. The default value is Left.
Gets the localization.
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
public WizardButtons Localization { get; }The localization.
Gets or sets a value indicating where RadWizard will look for its .resx localization files.
public string LocalizationPath { get; set; }The localization path.
Gets or sets the position of the NavigationBar.
public RadWizardNavigationBarPosition NavigationBarPosition { get; set; }The position of the NavigationBar. The default value is Top.
Gets or sets the position of the navigation buttons.
public RadWizardNavigationButtonsPosition NavigationButtonsPosition { get; set; }The position of the navigation buttons. The default value is Bottom.
The client-side event that is fired when some button is clicked.
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("buttonClicked")]
public string OnClientButtonClicked { get; set; }The on client button clicked.
The client-side cancelable event that is fired when some button is clicked.
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("buttonClicking")]
public string OnClientButtonClicking { get; set; }The on client button clicking.
Gets or sets a value indicating the client-side event handler that is called after the RadWizard client-side object is initialized.
[ClientControlEvent]
[ClientPropertyName("load")]
public string OnClientLoad { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
If specified, the OnClienLoad client-side event handler is called after the wizard is fully initialized on the client.
A single parameter - the wizard client object - is passed to the handler.
This event cannot be cancelled.
Gets or sets the position of the ProgressBar.
public RadWizardProgressBarPosition ProgressBarPosition { get; set; }The position of the ProgressBar. The default value is Top.
Gets or sets the position of the ProgressPercent.
public int ProgressPercent { get; set; }The position of the ProgressPercent. The default value is 0.
Gets or sets a value indicating whether tabs should postback when clicked.
[ClientControlProperty]
[ClientPropertyName("_renderedSteps")]
public RadWizardRenderedSteps RenderedSteps { get; set; }True if tabs should postback; otherwise false. The default value is false.
RadWizard will postback provided one of the following conditions is met:
- The RenderedSteps property is set to
true.
protected override bool SupportsRenderingMode { get; }Overrides:
protected override HtmlTextWriterTag TagKey { get; }Overrides:
Gets the wizard steps.
[Browsable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public RadWizardStepCollection WizardSteps { get; }The wizard steps.
Methods
protected override ControlCollection CreateControlCollection()Overrides:
Creates and returns a new wizard step.
Gets a list with the active steps that in the order they have been activated.
Gets the index of the previous step.
protected override void LoadControlState(object savedState)Overrides:
Executed when post data is loaded from the request
protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)Overrides:
Raises the CancelButtonClick event.
protected void OnCancelButtonClick(WizardEventArgs e)The WizardEventArgs instance containing the event data.
Raises the FinishButtonClick event.
protected void OnFinishButtonClick(WizardEventArgs e)The WizardEventArgs instance containing the event data.
Raises the NavigationBarButtonClick event.
protected void OnNavigationBarButtonClick(WizardEventArgs e)The WizardEventArgs instance containing the event data.
Raises the NextButtonClick event.
protected void OnNextButtonClick(WizardEventArgs e)The WizardEventArgs instance containing the event data.
Raises the PreviousButtonClick event.
protected void OnPreviousButtonClick(WizardEventArgs e)The WizardEventArgs instance containing the event data.
protected virtual void OnWizardStepCreated(WizardStepCreatedEventArgs eventArgs)Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.
public override void RenderBeginTag(HtmlTextWriter writer)A HtmlTextWriter that represents the output stream to render HTML content on the client.
Overrides:
Events
Occurs when the active step has changed.
public event EventHandler ActiveStepChangedOccurs when an Cancel button has been clicked.
public event WizardEventHandler CancelButtonClickOccurs when an Finish button has been clicked.
public event WizardEventHandler FinishButtonClickOccurs when an NavigationBar button has been clicked.
public event WizardEventHandler NavigationBarButtonClickOccurs when an Next button has been clicked.
public event WizardEventHandler NextButtonClickOccurs when an Previous button has been clicked.
public event WizardEventHandler PreviousButtonClickOccurs when wizard steps are added programmatically to the RadWizard control. It also occurs after postback when the RadWizard control recreates its page views from ViewState.
public event WizardStepCreatedEventHandler WizardStepCreatedUse this event when you need to create page views from code behind. Controls added dynamically should be created in the WizardStepCreated event handler.