New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

A control which contains RadPageView controls. Only one page view can be visible at a time.

RadMultiPage is usually used with RadTabStrip to create paged data entry forms. Use the MultiPageID property to associate a RadMultiPage control with RadTabStrip.

You can find information on the Server-side API of RadMultiPage at .

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

C#
[EmbeddedSkin("MultiPage", typeof(RadMultiPage))]
[RequiredScript(typeof(jQueryPlugins))]
[ClientScriptResource("Telerik.Web.UI.RadMultiPage", "Telerik.Web.UI.TabStrip.MultiPage.RadMultiPageScripts.js")]
[ToolboxBitmap(typeof(RadMultiPage), "Toolbox.Icons.MultiPage.png")]
[TelerikToolboxCategory("Navigation")]
public class RadMultiPage : RadWebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl

Inheritance: objectControlWebControlRadWebControlRadMultiPage

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIPostBackDataHandlerIScriptControlISkinnableControlIUrlResolutionService...

Inherited Members WebControl.AddAttributesToRender(HtmlTextWriter)WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.TrackViewState()WebControl.MergeStyle(Style)WebControl.Render(HtmlTextWriter)WebControl.RenderBeginTag(HtmlTextWriter)WebControl.RenderEndTag(HtmlTextWriter)WebControl.RenderContents(HtmlTextWriter)WebControl.AccessKeyWebControl.AttributesWebControl.BackColorWebControl.BorderColorWebControl.BorderWidthWebControl.BorderStyleWebControl.ControlStyleWebControl.ControlStyleCreatedWebControl.CssClassWebControl.DisabledCssClassWebControl.StyleWebControl.EnabledWebControl.EnableThemingWebControl.FontWebControl.ForeColorWebControl.HasAttributesWebControl.HeightWebControl.IsEnabledWebControl.SupportsDisabledAttributeWebControl.SkinIDWebControl.TabIndexWebControl.TagNameWebControl.ToolTipWebControl.WidthControl.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.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.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

C#
public RadMultiPage()

Properties

The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()

C#
protected override string CssClassFormatString { get; }

Overrides: RadWebControl.CssClassFormatString

Example:
C#
protected override string CssClassFormatString
{
       get
       {
           return "RadDock RadDock_{0} rdWTitle rdWFooter";
       }
}

When set to true enables support for WAI-ARIA

C#
public bool EnableAriaSupport { get; set; }

Gets a RadPageViewCollection that represents the RadMultiPage controls int the current RadMultiPage instance.

C#
[Browsable(false)]
public RadPageViewCollection PageViews { get; }

Gets or sets a value indicating whether to render only the currently selected RadMultiPage.

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

True if only the current RadMultiPage should be rendered; otherwise false. The default value is false which means all pageviews will be rendered.

Use the RenderSelectedPageOnly to make the RadMultiPage control render only the selected RadMultiPage. This can save output size because by default all pageviews are rendered. If RenderSelectedPageOnly is set to true RadMultiPage will make a request to the server in order to change the selected pageview.

Gets or sets the visibility and position of scroll bars in the RadMultiPage control.

C#
public MultiPageScrollBars ScrollBars { get; set; }
Property Value:

One of the MultiPageScrollBars values. The default value is None.

Use this property to customize the visibility and position of scroll bars. By default any overflowing content is visible.

Gets or sets the index of the selected RadMultiPage.

C#
public int SelectedIndex { get; set; }
Property Value:

The index of the currently selected RadMultiPage. The default value is -1, which means that no RadMultiPage is selected.

Gets the selected pageview.

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

Returns the pageview which is currently selected. If no pageview is selected (the SelectedIndex property is -1) the SelectedPageView property will return null (Nothing in VB.NET).

C#
protected override HtmlTextWriterTag TagKey { get; }

Overrides: WebControl.TagKey

Methods

C#
protected override void AddedControl(Control control, int index)
Parameters:controlControlindexint

Overrides: Control.AddedControl(Control, int)

C#
protected override void AddParsedSubObject(object obj)
Parameters:objobject

Overrides: Control.AddParsedSubObject(object)

C#
protected override ControlCollection CreateControlCollection()
Returns:

ControlCollection

Overrides: Control.CreateControlCollection()

C#
protected virtual RadPageView CreatePageView()
Returns:

RadPageView

Finds a RadPageView with the specified ID.

C#
public RadPageView FindPageViewByID(string id)
Parameters:idstring

The ID of the RadPageView

Returns:

RadPageView

A RadPageView with the specified ID. Null (Nothing) is returned if there is no RadPageView with the specified ID.

Executed when post data is loaded from the request

C#
protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)
Parameters:postDataKeystringpostCollectionNameValueCollectionReturns:

bool

Overrides: RadWebControl.LoadPostData(string, NameValueCollection)

C#
protected override void LoadViewState(object savedState)
Parameters:savedStateobject

Overrides: WebControl.LoadViewState(object)

C#
protected virtual void OnPageViewCreated(RadMultiPageEventArgs eventArgs)
Parameters:eventArgsRadMultiPageEventArgs
C#
protected override object SaveViewState()
Returns:

object

Overrides: WebControl.SaveViewState()

Events

Occurs when page views are added programmatically to the RadMultiPage control. It also occurs after postback when the RadMultiPage control recreates its page views from ViewState.

C#
public event RadMultiPageEventHandler PageViewCreated

Use this event when you need to create page views from code behind. Controls added dynamically should be created in the PageViewCreated event handler.

Example:
cs-api-definition
protected void Page_Load(object sender, System.EventArgs e)
{
if (!Page.IsPostBack)
{
PageView view = new RadPageView();
view.ID = "dynamicPageView";
RadMultiPage1.PageViews.Add(view);
}
}

protected void RadMultiPage1_PageViewCreated(object sender, Telerik.Web.UI.RadMultiPageEventArgs e)
{
Label l = new Label();
l.ID = "dynamicLabel";
l.Text = "Programatically created label";
e.PageView.Controls.Add(l);
}