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

RadDrawer

Class

Represents the RadDrawer control that provides a collapsible panel for navigation or content display.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:
C#
[RequiredScript(typeof(jQueryPlugins))]
[RequiredScript(typeof(Html5Drawer))]
[ClientScriptResource("Telerik.Web.UI.RadDrawer", "Telerik.Web.UI.Drawer.Scripts.RadDrawer.js")]
[EmbeddedSkin("Drawer", typeof(RadDrawer))]
[EmbeddedSkin("Drawer", "Default", typeof(RadDrawer))]
[RequiredCss("Telerik.Web.UI.Skins.Common.common.css", RenderMode.Classic, typeof(RadDrawer))]
[RequiredCss("Telerik.Web.UI.Skins.Common.common.css", RenderMode.Lightweight, typeof(RadDrawer))]
[RequiredCss("Telerik.Web.UI.Skins.Common.common.css", RenderMode.Mobile, typeof(RadDrawer))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Classic, typeof(RadDrawer))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadDrawer))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Mobile, typeof(RadDrawer))]
[ToolboxBitmap(typeof(RadCard), "Toolbox.Icons.Drawer.png")]
public class RadDrawer : RadWebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, INamingContainer

Inheritance: objectControlWebControlRadWebControlRadDrawer

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorINamingContainerIParserAccessorIPostBackDataHandlerIScriptControlISkinnableControlIUrlResolutionService...

Inherited Members WebControl.AddAttributesToRender(HtmlTextWriter)WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()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.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.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

RadDrawer()

C#
public RadDrawer()

Properties

ClientEvents

Defines the client events handlers.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public DrawerClientEvents ClientEvents { get; }

ContentContainer

Gets the control, where the ContentTemplate will be instantiated in. You can add controls programmatically here.

C#
[Browsable(false)]
public SingleTemplateContainer ContentContainer { get; }

You can use this property to programmatically add controls to the content area. If you add controls to the ContentContainer the NavigateUrl property will be ignored.

Example:
C#
RadWindow1.ContentContainer.Controls.Add(new LiteralControl("this will appear in the RadWindow"));

ContentTemplate

Gets or sets the System.Web.UI.ITemplate that contains the controls which will be placed in the control content area.

C#
[TemplateContainer(typeof(SingleTemplateContainer))]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TemplateInstance(TemplateInstance.Single)]
[Browsable(false)]
[Bindable(false)]
public ITemplate ContentTemplate { get; set; }

You cannot set this property twice, or when you added controls to the ContentContainer. If you set ContentTemplate the NavigateUrl property will be ignored.

CssClassFormatString

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";
       }
}

DrawerWidth

Defines a specific width for the Kendo UI Drawer when expanded.

C#
public double DrawerWidth { get; set; }

ItemsTemplate

Specifies the drawer's content.

C#
[Browsable(true)]
[Bindable(true)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public string ItemsTemplate { get; set; }

MinHeight

Specifies the minimum height for the drawer in push mode. The overlay mode takes 100% of the page height.

C#
public double MinHeight { get; set; }

Mini

Enables or configures the mini mode for the Kendo UI Drawer. This is a compact view that is displayed when the Kendo UI Drawer is collapsed. Usually it used to show only the icons when the drawer content contains icon and text for an item. When set to true it uses the main template.

C#
public bool Mini { get; set; }

MiniSettings

Enables or configures the mini mode for the Kendo UI Drawer. This is a compact view that is displayed when the Kendo UI Drawer is collapsed. Usually it used to show only the icons when the drawer content contains icon and text for an item. When set to true it uses the main template.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public Mini MiniSettings { get; }

Mode

Determines how the Kendo UI Drawer will interact with the associated content. The default one (overlay) will simply overlap the associated content with overlay effect. On the other hand "push" mode will show the drawer next to associated cotent. The associated content will shrink its content.

C#
public DrawerModeType Mode { get; set; }

Navigatable

Navigate the widget using the keyboard. By default keyboard navigation is disabled.

C#
public bool Navigatable { get; set; }

Position

The position of the drawer. Can be left (default) or right.

C#
public DrawerPositionType Position { get; set; }

ShowBorders

Gets or sets a value indicating whether the outer borders will be displayed.

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

True if all the borders will be visible; otherwise False. The default value is False.

SwipeToOpen

If set to false, swiping the associated content will not activate the drawer. In this case, the drawer will only be open by calling the show method. should be disabled for browsers, which use side swiping gestures for back/forward navigation, such as iOS Safari. Otherwise, users should swipe from an inner part of the view, and not from the view edge.

C#
public bool SwipeToOpen { get; set; }

TagKey

C#
protected override HtmlTextWriterTag TagKey { get; }

Overrides: WebControl.TagKey

Methods

DescribeClientEvents(IScriptDescriptor)

C#
protected override void DescribeClientEvents(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeClientEvents(IScriptDescriptor)

DescribeComponent(IScriptDescriptor)

C#
protected override void DescribeComponent(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeComponent(IScriptDescriptor)

LoadViewState(object)

C#
protected override void LoadViewState(object state)
Parameters:stateobject

Overrides: WebControl.LoadViewState(object)

OnPreRender(EventArgs)

C#
protected override void OnPreRender(EventArgs e)
Parameters:eEventArgs

Overrides: RadWebControl.OnPreRender(EventArgs)

SaveViewState()

C#
protected override object SaveViewState()
Returns:

object

Overrides: WebControl.SaveViewState()

TrackViewState()

C#
protected override void TrackViewState()

Overrides: WebControl.TrackViewState()

In this article
DefinitionConstructorsRadDrawer()PropertiesClientEventsContentContainerContentTemplateCssClassFormatStringDrawerWidthItemsTemplateMinHeightMiniMiniSettingsModeNavigatablePositionShowBordersSwipeToOpenTagKeyMethodsDescribeClientEvents(IScriptDescriptor)DescribeComponent(IScriptDescriptor)LoadViewState(object)OnPreRender(EventArgs)SaveViewState()TrackViewState()
Not finding the help you need?
Contact Support