Introduction
Knowledge Base
API Reference / Server-side / Telerik.Web.UI / RadWizardStep
New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

RadWizardStep

Class

This Class defines the RadWizardStep in RadWizard.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:
C#
public class RadWizardStep : WebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor

Inheritance: objectControlWebControlRadWizardStep

Implements: IAttributeAccessorIComponentIControlBuilderAccessorIControlDesignerAccessorIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIUrlResolutionService...

Inherited Members WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.LoadViewState(object)WebControl.TrackViewState()WebControl.MergeStyle(Style)WebControl.Render(HtmlTextWriter)WebControl.RenderBeginTag(HtmlTextWriter)WebControl.RenderEndTag(HtmlTextWriter)WebControl.RenderContents(HtmlTextWriter)WebControl.SaveViewState()WebControl.AccessKeyWebControl.AttributesWebControl.BackColorWebControl.BorderColorWebControl.BorderWidthWebControl.BorderStyleWebControl.ControlStyleWebControl.ControlStyleCreatedWebControl.CssClassWebControl.DisabledCssClassWebControl.StyleWebControl.EnabledWebControl.EnableThemingWebControl.FontWebControl.ForeColorWebControl.HasAttributesWebControl.IsEnabledWebControl.SupportsDisabledAttributeWebControl.SkinIDWebControl.TabIndexWebControl.TagNameControl.ResolveAdapter()Control.HasEvents()Control.GetRouteUrl(object)Control.GetRouteUrl(string, object)Control.GetRouteUrl(RouteValueDictionary)Control.GetRouteUrl(string, RouteValueDictionary)Control.GetUniqueIDRelativeTo(Control)Control.ApplyStyleSheetSkin(Page)Control.OnDataBinding(EventArgs)Control.DataBind()Control.DataBind(bool)Control.DataBindChildren()Control.AddParsedSubObject(object)Control.EnsureID()Control.OnInit(EventArgs)Control.ClearChildState()Control.ClearChildControlState()Control.ClearChildViewState()Control.ClearEffectiveClientIDMode()Control.ClearCachedClientID()Control.Focus()Control.LoadControlState(object)Control.MapPathSecure(string)Control.OpenFile(string)Control.OnLoad(EventArgs)Control.OnPreRender(EventArgs)Control.BuildProfileTree(string, bool)Control.SaveControlState()Control.RenderChildren(HtmlTextWriter)Control.RenderControl(HtmlTextWriter)Control.RenderControl(HtmlTextWriter, ControlAdapter)Control.OnUnload(EventArgs)Control.Dispose()Control.RaiseBubbleEvent(object, EventArgs)Control.OnBubbleEvent(object, EventArgs)Control.AddedControl(Control, int)Control.CreateControlCollection()Control.CreateChildControls()Control.ResolveUrl(string)Control.ResolveClientUrl(string)Control.FindControl(string)Control.FindControl(string, int)Control.GetDesignModeState()Control.HasControls()Control.IsLiteralContent()Control.EnsureChildControls()Control.RemovedControl(Control)Control.SetDesignModeState(IDictionary)Control.SetRenderMethodDelegate(RenderMethod)Control.ClientIDModeControl.ClientIDControl.ClientIDSeparatorControl.ContextControl.AdapterControl.DesignModeControl.EventsControl.IDControl.IsChildControlStateClearedControl.EnableViewStateControl.ViewStateModeControl.IsViewStateEnabledControl.NamingContainerControl.IdSeparatorControl.LoadViewStateByIDControl.PageControl.RenderingCompatibilityControl.TemplateControlControl.ParentControl.TemplateSourceDirectoryControl.AppRelativeTemplateSourceDirectoryControl.SiteControl.VisibleControl.UniqueIDControl.HasChildViewStateControl.ControlsControl.ValidateRequestModeControl.ViewStateControl.ViewStateIgnoresCaseControl.ChildControlsCreatedControl.IsTrackingViewStateControl.DisposedControl.DataBindingControl.InitControl.LoadControl.PreRenderControl.Unloadobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

RadWizardStep()

C#
public RadWizardStep()

Properties

Active

Gets or sets a value indicating whether the current RadWizardStep is active.

C#
public bool Active { get; set; }
Property Value:

true if the current RadWizardStep is active; otherwise false. The default value is false.

Use the Active property to activate a RadWizardStep object. There can be only one selected RadWizardStep at a time within a RadWizard control.

ActiveImageUrl

Gets or sets the URL to an image which is displayed when the step is active.

C#
public string ActiveImageUrl { get; set; }
Property Value:

The URL to the image to display when the step is active. The default value is empty string which means the image specified via ImageUrl will be used.

Use the ActiveImageUrl property to specify a custom image that will be displayed when the current step is active. Setting the SelectedImageUrl property required the ImageUrl property to be set beforehand.

If the ActiveImageUrl property is not set the value of the ImageUrl will be used instead.

AllowReturn

Gets or sets the allow return.

C#
public virtual bool AllowReturn { get; set; }
Property Value:

The allow return.

CausesValidation

C#
public virtual bool CausesValidation { get; set; }

DisabledImageUrl

Gets or sets the URL to an image which is displayed when the step is disabled (its Enabled property is set to false).

C#
public string DisabledImageUrl { get; set; }
Property Value:

The URL to the image to display when the step is disabled. The default value is empty string which means the image specified via ImageUrl will be used.

Use the DisabledImageUrl property to specify a custom image that will be displayed when the current step is disabled. Setting the DisabledImageUrl property required the ImageUrl property to be set beforehand.

If the DisabledImageUrl property is not set the value of the ImageUrl will be used instead.

DisplayCancelButton

Gets or sets the display cancel button.

C#
public virtual bool DisplayCancelButton { get; set; }
Property Value:

The display cancel button.

Height

Gets or sets the height of the Web server control.

C#
public override Unit Height { get; }
Property Value:

A Unit that represents the height of the control. The default is Empty.

Exceptions: ArgumentException

The height was set to a negative value.

Overrides: WebControl.Height

HoveredImageUrl

Gets or sets the URL to an image which is displayed when the user hovers the current step with the mouse.

C#
public string HoveredImageUrl { get; set; }
Property Value:

The URL to the image to display for the step when the user hovers it with the mouse. The default value is empty string which means the image specified via ImageUrl will be used.

Use the HoveredImageUrl property to specify a custom image that will be displayed when the user hovers the step with the mouse. Setting the HoveredImageUrl property required the ImageUrl property to be set beforehand.

If the HoveredImageUrl property is not set the value of the ImageUrl will be used instead.

ImageUrl

Gets or sets the URL to an image which is displayed next to the text of a step.

C#
public string ImageUrl { get; set; }
Property Value:

The URL to the image to display for the step. The default value is empty string which means by default no image is displayed.

Use the ImageUrl property to specify a custom image that will be displayed before the text of the current step.

Example:
C#
<p>
       The following example demonstrates how to specify the image to display for
       the step using the <b>ImageUrl</b> property.
   </p>
<p>
        &lt;telerik:RadWizard id="RadWizard1" runat="server"&gt;<br />
         &lt;WizardSteps&gt;<br />
         &lt;telerik:RadWizardStep<strong>ImageUrl="~/Img/inbox.gif"</strong>
        Text="Index"&gt;&lt;/telerik:RadWizardStep&gt;<br />
         &lt;telerik:RadWizardStep<strong>ImageUrl="~/Img/outbox.gif"</strong>
        Text="Outbox"&gt;&lt;/telerik:RadWizardStep&gt;<br />
         &lt;telerik:RadWizardStep<strong>ImageUrl="~/Img/trash.gif"</strong>
        Text="Trash"&gt;&lt;/telerik:RadWizardStep&gt;<br />
         &lt;telerik:RadWizardStep<strong>ImageUrl="~/Img/meetings.gif"</strong>
        Text="Meetings"&gt;&lt;/telerik:RadWizardStep&gt;<br />
         &lt;/WizardSteps&gt;<br />
        &lt;/telerik:RadWizard&gt;
</p>

Index

Gets the zero-based index of the current RadWizardStep object.

C#
[Browsable(false)]
public int Index { get; }
Property Value:

The zero-based index of the current RadWizardStep; -1 will be returned if the current RadWizardStep object is not added in a RadWizard control.

ResolvedDisplayCancelButton

C#
protected bool ResolvedDisplayCancelButton { get; }

SpriteCssClass

Gets or sets the Cascading Style Sheet (CSS) class that contains the sprite image for this item and the positioning for it.

C#
public string SpriteCssClass { get; set; }
Property Value:

The CSS that is used in sprite image scenarios. String.Empty.

By default, the image in an item is defined by the ImageUrl property. You can use SpriteCssClass to specify a class that will position a sprite instead of using image.

StepType

Gets or sets the type of the step.

C#
public virtual RadWizardStepType StepType { get; set; }
Property Value:

The type of the step.

TagKey

C#
protected override HtmlTextWriterTag TagKey { get; }

Overrides: WebControl.TagKey

Title

Gets or sets the title.

C#
public virtual string Title { get; set; }
Property Value:

The title.

ToolTip

Gets or sets the tooltip of the wizard step.

C#
public override string ToolTip { get; set; }

Overrides: WebControl.ToolTip

ValidationGroup

Gets or sets the validation group.

C#
public virtual string ValidationGroup { get; set; }
Property Value:

The validation group.

Width

Gets or sets the width of the Web server control.

C#
public override Unit Width { get; }
Property Value:

A Unit that represents the width of the control. The default is Empty.

Exceptions: ArgumentException

The width of the Web server control was set to a negative value.

Overrides: WebControl.Width

Wizard

Gets the wizard.

C#
public RadWizard Wizard { get; }
Property Value:

The wizard.

Methods

AddAttributesToRender(HtmlTextWriter)

C#
protected override void AddAttributesToRender(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: WebControl.AddAttributesToRender(HtmlTextWriter)

In this article
DefinitionConstructorsRadWizardStep()PropertiesActiveActiveImageUrlAllowReturnCausesValidationDisabledImageUrlDisplayCancelButtonHeightHoveredImageUrlImageUrlIndexResolvedDisplayCancelButtonSpriteCssClassStepTypeTagKeyTitleToolTipValidationGroupWidthWizardMethodsAddAttributesToRender(HtmlTextWriter)
Not finding the help you need?
Contact Support