RadSlidingPane
Represents a sliding pane that can be expanded or collapsed within a RadSlidingZone.
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[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:
Inherited Members
Constructors
public RadSlidingPane()
Properties
Gets or sets the text for collapse image
public string CollapseText { get; set; }
Sets/gets whether the sliding pane will automatically dock on open
[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.
Sets/gets whether the pane can be docked
[ClientControlProperty]
public bool EnableDock { get; set; }
Sets/gets whether the resize bar will be active
[ClientControlProperty]
public bool EnableResize { get; set; }
Sets/gets the height of the sliding pane
[ClientControlProperty]
public override Unit Height { get; set; }
Overrides:
Gets or sets the path to an image to display for the item.
public string IconUrl { get; set; }
Sets/gets the min height to which the pane can be resized
[ClientControlProperty]
public override int MinHeight { get; set; }
Overrides:
Sets/gets the min width to which the pane can be resized
[ClientControlProperty]
public override int MinWidth { get; set; }
Overrides:
[Obsolete("This property is now obsolete. Please use the OnClientDocking property instead.", false)]
public string OnClientBeforeDock { get; set; }
[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.
[ClientControlEvent]
[ClientPropertyName("docked")]
public string OnClientDocked { get; set; }
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.
Gets or sets a value indicating the client-side event handler that is called before the RadSlidingPane is docked.
[ClientControlEvent]
[ClientPropertyName("docking")]
public string OnClientDocking { get; set; }
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.
Gets or sets a value indicating the client-side event handler that is called when the RadSlidingPane is undocked.
[ClientControlEvent]
[ClientPropertyName("undocked")]
public string OnClientUndocked { get; set; }
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.
Gets or sets a value indicating the client-side event handler that is called before the RadSlidingPane is undocked.
[ClientControlEvent]
[ClientPropertyName("undocking")]
public string OnClientUndocking { get; set; }
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.
Gets or sets a value indicating whether the sliding pane will create an overlay element.
[ClientControlProperty]
[Browsable(true)]
[Bindable(true)]
public bool Overlay { get; set; }
The default value is false.
Gets or sets the text for resize bar
public string ResizeText { get; set; }
Reference to the parent SlidingZone object
[Browsable(false)]
public RadSlidingZone SlidingZone { get; }
Sets/gets way the tab of the pane is rendered
public SplitterSlidePaneTabView TabView { get; set; }
The title that will be displayed when the pane is docked/docked
[ClientControlProperty]
public string Title { get; set; }
Gets or sets the text for undock image
public string UndockText { get; set; }
Methods
protected override void AddAttributesToRender(HtmlTextWriter writer)
Overrides:
Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason
protected override void ControlPreRender()
Overrides:
protected override void DescribeClientEvents(IScriptDescriptor descriptor)
Overrides:
protected override void DescribeClientProperties(IScriptDescriptor descriptor)
Overrides:
protected override void DescribeComponent(IScriptDescriptor descriptor)
Overrides:
Loads the client state data
protected override void LoadClientState(Dictionary<string, object> clientState)
Overrides: