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

SplitterPaneBase

Class

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

[ClientScriptResource("Telerik.Web.UI.SplitterPaneBase", "Telerik.Web.UI.Splitter.RadSplitterScripts.js")]
public abstract class SplitterPaneBase : SplitterItem, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl

Inheritance: objectControlWebControlRadWebControlSplitterItemSplitterPaneBase...

Derived Classes: RadPaneRadSlidingPane

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIPostBackDataHandlerIScriptControlISkinnableControlIUrlResolutionService...

Inherited Members SplitterItem.EnableEmbeddedSkinsSplitterItem.EnableEmbeddedBaseStylesheetSplitterItem.IndexWebControl.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.HeightWebControl.IsEnabledWebControl.SupportsDisabledAttributeWebControl.SkinIDWebControl.TabIndexWebControl.TagKeyWebControl.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.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

SplitterPaneBase()

protected SplitterPaneBase()

Properties

MaxHeight

int

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

[ClientControlProperty]
public int MaxHeight { get; set; }

MaxWidth

int

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

[ClientControlProperty]
public int MaxWidth { get; set; }

MinHeight

int

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

[ClientControlProperty]
public virtual int MinHeight { get; set; }

MinWidth

int

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

[ClientControlProperty]
public virtual int MinWidth { get; set; }

OnClientBeforeCollapse

string

[Obsolete("This property is now obsolete. Please use the OnClientCollapsing property instead.", false)]
public string OnClientBeforeCollapse { get; set; }

OnClientBeforeExpand

string

[Obsolete("This property is now obsolete. Please use the OnClientExpanding property instead.", false)]
public string OnClientBeforeExpand { get; set; }

OnClientBeforeResize

string

[Obsolete("This property is now obsolete. Please use the OnClientResizing property instead.", false)]
public string OnClientBeforeResize { get; set; }

OnClientCollapsed

string

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

[ClientControlEvent]
[ClientPropertyName("collapsed")]
public string OnClientCollapsed { 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 pane object that raised the event
args

This event cannot be cancelled.

Example:

The following example demonstrates how to use the <strong>OnClientCollapsed</strong> property.

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

OnClientCollapsing

string

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

[ClientControlEvent]
[ClientPropertyName("collapsing")]
public string OnClientCollapsing { 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 pane object that raised the event
args

This event can be cancelled.

Example:

The following example demonstrates how to use the <strong>OnClientCollapsing</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientCollapsing(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:RadPane ID="RadPane1"<br />
         runat= "server"<br />
        <strong>OnClientCollapsing="OnClientCollapsing"</strong>&gt;<br />
        ....<br />
        &lt;/radspl:RadPane&gt;
    </div>
</p>

OnClientExpanded

string

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

[ClientControlEvent]
[ClientPropertyName("expanded")]
public string OnClientExpanded { 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 pane object that raised the event
args

This event cannot be cancelled.

Example:

The following example demonstrates how to use the <strong>OnClientExpanded</strong> property.

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

OnClientExpanding

string

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

[ClientControlEvent]
[ClientPropertyName("expanding")]
public string OnClientExpanding { 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 pane object that raised the event
args

This event can be cancelled.

Example:

The following example demonstrates how to use the <strong>OnClientExpanding</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function OnClientExpanding(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:RadPane ID="RadPane1"<br />
         runat= "server"<br />
        <strong>OnClientExpanding="OnClientExpanding"</strong>&gt;<br />
        ....<br />
        &lt;/radspl:RadPane&gt;
    </div>
</p>

OnClientResized

string

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

[ClientControlEvent]
[ClientPropertyName("resized")]
public string OnClientResized { 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 pane object that raised the event
args with the following methods:
get_oldWidth - the width of the pane before the resize
get_oldHeight - the height of the pane before the resize

This event cannot be cancelled.

Example:

The following example demonstrates how to use the
<strong>OnClientResized</strong> property.

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

OnClientResizing

string

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

[ClientControlEvent]
[ClientPropertyName("resizing")]
public string OnClientResizing { 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 event object
args with the following methods:
get_delta - the delta with which the pane will be resized
get_resizeDirection - the direction in which the pane will be resized. You can use the Telerik.Web.UI.SplitterDirection hash to check the direction. The 2 possible values are : Forward and Backward

This event can be cancelled.

Example:

The following example demonstrates how to use the <strong>OnClientResizing</strong> property.

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

PersistScrollPosition

bool

Sets/gets whether the scrolls position will be persisted acrosss postbacks

[ClientControlProperty]
public bool PersistScrollPosition { get; set; }

Scrolling

SplitterPaneScrolling

Sets/gets whether the content of the pane will get a scrollbars when it exceeds the pane area size

[ClientControlProperty]
public SplitterPaneScrolling Scrolling { get; set; }

Methods

DescribeClientEvents(IScriptDescriptor)

protected override void DescribeClientEvents(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeClientEvents(IScriptDescriptor)

DescribeClientProperties(IScriptDescriptor)

protected override void DescribeClientProperties(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeClientProperties(IScriptDescriptor)

DescribeComponent(IScriptDescriptor)

protected override void DescribeComponent(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: SplitterItem.DescribeComponent(IScriptDescriptor)

LoadClientState(Dictionary<string, object>)

Loads the client state data

protected override void LoadClientState(Dictionary<string, object> clientState)

Parameters:clientStateDictionary<string, object>

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