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

Represents a sliding pane that can be expanded or collapsed within a RadSlidingZone.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

C#
[TelerikToolboxCategory("Container")]
[ToolboxBitmap(typeof(RadSlidingPane), "Toolbox.Icons.Splitter.png")]
[ClientScriptResource("Telerik.Web.UI.RadSlidingPane", "Telerik.Web.UI.Splitter.RadSlidingZoneScripts.js")]
[RequiredScript(typeof(jQueryPlugins))]
[RequiredScript(typeof(jSlide))]
[RequiredScript(typeof(PopupBehavior))]
[RequiredScript(typeof(ResizeExtender))]
public class RadSlidingPane : SplitterPaneBase, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, ISkinnableControl, IControl, IPostBackDataHandler

Inheritance: objectControlWebControlRadWebControlSplitterItemSplitterPaneBaseRadSlidingPane...

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIPostBackDataHandlerIScriptControlISkinnableControlIUrlResolutionService...

Inherited Members SplitterPaneBase.MaxWidthSplitterPaneBase.MaxHeightSplitterPaneBase.ScrollingSplitterPaneBase.OnClientCollapsedSplitterPaneBase.OnClientBeforeCollapseSplitterPaneBase.OnClientCollapsingSplitterPaneBase.OnClientExpandedSplitterPaneBase.OnClientBeforeExpandSplitterPaneBase.OnClientExpandingSplitterPaneBase.OnClientResizedSplitterPaneBase.OnClientBeforeResizeSplitterPaneBase.OnClientResizingSplitterPaneBase.PersistScrollPositionSplitterItem.EnableEmbeddedSkinsSplitterItem.EnableEmbeddedBaseStylesheetSplitterItem.IndexWebControl.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.TagKeyWebControl.TagNameWebControl.ToolTipControl.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

C#
public RadSlidingPane()

Properties

Gets or sets the text for collapse image

C#
public string CollapseText { get; set; }

Sets/gets whether the sliding pane will automatically dock on open

C#
[ClientControlProperty]
public bool DockOnOpen { get; set; }

When set to true the animation is disabled, so the duration set via the SlideDuration property of the RadSlidingZone is ignored. False by default.

Gets or sets the text for dock image

C#
public string DockText { get; set; }

Sets/gets whether the pane can be docked

C#
[ClientControlProperty]
public bool EnableDock { get; set; }

Sets/gets whether the resize bar will be active

C#
[ClientControlProperty]
public bool EnableResize { get; set; }

Sets/gets the height of the sliding pane

C#
[ClientControlProperty]
public override Unit Height { get; set; }

Overrides: RadWebControl.Height

Gets or sets the path to an image to display for the item.

C#
public string IconUrl { get; set; }

Sets/gets the min height to which the pane can be resized

C#
[ClientControlProperty]
public override int MinHeight { get; set; }

Overrides: SplitterPaneBase.MinHeight

Sets/gets the min width to which the pane can be resized

C#
[ClientControlProperty]
public override int MinWidth { get; set; }

Overrides: SplitterPaneBase.MinWidth

C#
[Obsolete("This property is now obsolete. Please use the OnClientDocking property instead.", false)]
public string OnClientBeforeDock { get; set; }
C#
[Obsolete("This property is now obsolete. Please use the OnClientUndocking property instead.", false)]
public string OnClientBeforeUndock { get; set; }

Gets or sets a value indicating the client-side event handler that is called when the RadSlidingPane is docked.

C#
[ClientControlEvent]
[ClientPropertyName("docked")]
public string OnClientDocked { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Two parameters are passed to the handler:

  • sender, the RadSlidingPane client object that fired the event
  • args

This event cannot be cancelled.

Example:
C#
The following example demonstrates how to use the <strong>OnClientDocked</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientDocked(sender, args)<br />
         {<br />
         alert(sender.get_id());<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;radspl:RadSlidingPane ID="RadSlidingPane1"<br />
         runat= "server"<br />
        <strong>OnClientDocked="OnClientDocked"</strong>&gt;<br />
        ....<br />
        &lt;/radspl:RadSlidingPane&gt;
    </div>
</p>

Gets or sets a value indicating the client-side event handler that is called before the RadSlidingPane is docked.

C#
[ClientControlEvent]
[ClientPropertyName("docking")]
public string OnClientDocking { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Two parameters are passed to the handler:

  • sender, the RadSlidingPane client object that fired the event
  • args

This event can be cancelled.

Example:
C#
The following example demonstrates how to use the <strong>OnClientDocking</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientDocking(sender, args)<br />
         {<br />
         alert(sender.get_id());<br />
            args.set_cancel(true);//cancel the event<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;radspl:RadSlidingPane ID="RadSlidingPane1"<br />
         runat= "server"<br />
        <strong>OnClientDocking="OnClientDocking"</strong>&gt;<br />
        ....<br />
        &lt;/radspl:RadSlidingPane&gt;
    </div>
</p>

Gets or sets a value indicating the client-side event handler that is called when the RadSlidingPane is undocked.

C#
[ClientControlEvent]
[ClientPropertyName("undocked")]
public string OnClientUndocked { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Two parameters are passed to the handler:

  • sender, the RadSlidingPane client object that fired the event
  • args

This event cannot be cancelled.

Example:
C#
The following example demonstrates how to use the <strong>OnClientUndocked</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientUndocked(sender, args)<br />
         {<br />
         alert(sender.get_id());<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;radspl:RadSlidingPane ID="RadSlidingPane1"<br />
         runat= "server"<br />
        <strong>OnClientUndocked="OnClientUndocked"</strong>&gt;<br />
        ....<br />
        &lt;/radspl:RadSlidingPane&gt;
    </div>
</p>

Gets or sets a value indicating the client-side event handler that is called before the RadSlidingPane is undocked.

C#
[ClientControlEvent]
[ClientPropertyName("undocking")]
public string OnClientUndocking { get; set; }
Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Two parameters are passed to the handler:

  • sender, the RadSlidingPane client object that fired the event
  • args

This event can be cancelled.

Example:
C#
The following example demonstrates how to use the <strong>OnClientUndocking</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientUndocking(sender, args)<br />
         {<br />
         alert(sender.get_id());<br />
            args.set_cancel(true);//cancel the event<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;radspl:RadSlidingPane ID="RadSlidingPane1"<br />
         runat= "server"<br />
        <strong>OnClientUndocking="OnClientUndocking"</strong>&gt;<br />
        ....<br />
        &lt;/radspl:RadSlidingPane&gt;
    </div>
</p>

Gets or sets a value indicating whether the sliding pane will create an overlay element.

C#
[ClientControlProperty]
[Browsable(true)]
[Bindable(true)]
public bool Overlay { get; set; }
Property Value:

The default value is false.

Gets or sets the text for resize bar

C#
public string ResizeText { get; set; }

Reference to the parent SlidingZone object

C#
[Browsable(false)]
public RadSlidingZone SlidingZone { get; }

Sets/gets way the tab of the pane is rendered

C#
public SplitterSlidePaneTabView TabView { get; set; }

The title that will be displayed when the pane is docked/docked

C#
[ClientControlProperty]
public string Title { get; set; }

Gets or sets the text for undock image

C#
public string UndockText { get; set; }

Sets/gets the width of the sliding pane

C#
[ClientControlProperty]
public override Unit Width { get; set; }

Overrides: RadWebControl.Width

Methods

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

Overrides: RadWebControl.AddAttributesToRender(HtmlTextWriter)

Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason

C#
protected override void ControlPreRender()

Overrides: RadWebControl.ControlPreRender()

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

Overrides: SplitterPaneBase.DescribeClientEvents(IScriptDescriptor)

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

Overrides: SplitterPaneBase.DescribeClientProperties(IScriptDescriptor)

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

Overrides: SplitterPaneBase.DescribeComponent(IScriptDescriptor)

C#
protected virtual string GetTabHtml()
Returns:

string

Loads the client state data

C#
protected override void LoadClientState(Dictionary<string, object> clientState)
Parameters:clientStateDictionary<string, object>

Overrides: SplitterPaneBase.LoadClientState(Dictionary<string, object>)