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

Represents a container for sliding panes (RadSlidingPane) in a RadSplitter control.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

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

Inheritance: objectControlWebControlRadWebControlSplitterItemsContainerRadSlidingZone...

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIPostBackDataHandlerIScriptControlISkinnableControlIUrlResolutionService...

Inherited Members SplitterItemsContainer.GetParentPane()SplitterItemsContainer.GetItemById(string)SplitterItemsContainer.CreateControlCollection()SplitterItemsContainer.AddParsedSubObject(object)SplitterItemsContainer.Page_PreRenderComplete(object, EventArgs)SplitterItemsContainer.ItemsWebControl.AddAttributesToRender(HtmlTextWriter)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.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.EnsureID()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.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 RadSlidingZone()

Properties

Sets/gets whether the pane should be clicked in order to open

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

Sets/gets the id of the pane that is will be displayed docked

C#
[ClientControlProperty]
[ClientPropertyName("_initiallyDockedPaneId")]
public string DockedPaneId { get; set; }

Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.

C#
public override bool EnableEmbeddedBaseStylesheet { get; }

Overrides: RadWebControl.EnableEmbeddedBaseStylesheet

If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.

Gets or sets the value, indicating whether to render links to the embedded skins or not.

C#
public override bool EnableEmbeddedSkins { get; }

Overrides: RadWebControl.EnableEmbeddedSkins

If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.

Sets/gets the id of the pane that is will be expanded

C#
[ClientControlProperty]
[ClientPropertyName("_initiallyExpandedPaneId")]
public string ExpandedPaneId { get; set; }

Sets/gets the height of the sliding zone

C#
[ClientControlProperty]
[ClientPropertyName("_height")]
public override Unit Height { get; set; }

Overrides: RadWebControl.Height

Gets or sets a value indicating the client-side event handler that is called when the RadSlidingZone control is initialized.

C#
[ClientControlEvent]
[ClientPropertyName("load")]
public string OnClientLoad { 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 RadSlidingZone that fired the event
  • args

This event cannot be cancelled.

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

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientLoad(sender, eventArgs)<br />
         {<br />
         alert(sender.get_id());<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;radspl:RadSlidingZone ID="RadSlidingZone1"<br />
         runat= "server"<br />
        <strong>OnClientLoad="OnClientLoad"</strong>&gt;<br />
        ....<br />
        &lt;/radspl:RadSlidingZone&gt;
    </div>
</p>
C#
[Obsolete("This property is now obsolete. Please use the OnClientLoad property instead.", false)]
public string OnClientLoaded { get; set; }

Sets/gets the step in px in which the resize bar will be moved when dragged.

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

Sets/gets the direction in which the panes will slide

C#
[ClientControlProperty]
[ClientPropertyName("_slideDirection")]
public SplitterSlideDirection SlideDirection { get; set; }

Sets/gets the duration of the slide animation in milliseconds.

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

Animation is not performed when the RadSlidingPane's DockOnOpen property is set to true.

Reference to the parent Splitter object

C#
[Browsable(false)]
public RadSplitter Splitter { get; }

Sets/gets the width of the sliding zone

C#
[ClientControlProperty]
[ClientPropertyName("_width")]
public override Unit Width { get; set; }

Overrides: RadWebControl.Width

Methods

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: RadWebControl.DescribeClientEvents(IScriptDescriptor)

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

Overrides: RadWebControl.DescribeClientProperties(IScriptDescriptor)

Retrieves a RadSlidingPane by its ID from the items collection.

C#
public RadSlidingPane GetPaneById(string paneId)
Parameters:paneIdstring

The ID of the pane to retrieve.

Returns:

RadSlidingPane

The RadSlidingPane with the specified ID, or null if not found.

Gets a list of all RadSlidingPane items contained in this RadSlidingZone.

C#
public ArrayList GetPanes()
Returns:

ArrayList

An ArrayList of RadSlidingPane objects.

C#
protected bool IsHorizontalSlide()
Returns:

bool

Loads the client state data

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

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

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

Overrides: RadWebControl.OnInit(EventArgs)

C#
protected override void RegisterInitializeScriptWithScriptManager()

Overrides: SplitterItemsContainer.RegisterInitializeScriptWithScriptManager()