RadSplitter
A flexible UI component for ASP.NET applications that allows users to manage content size and layout by splitting areas into resizable panes.
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[EmbeddedSkin("Splitter")]
[EmbeddedSkin("Splitter", "Default")]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadEditor))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Lightweight, typeof(RadButton))]
[TelerikToolboxCategory("Container")]
[ToolboxBitmap(typeof(RadSplitter), "Toolbox.Icons.Splitter.png")]
[RequiredScript(typeof(jQueryPlugins))]
[RequiredScript(typeof(MaterialRipple))]
[ClientScriptResource("Telerik.Web.UI.RadSplitter", "Telerik.Web.UI.Splitter.RadSplitterScripts.js")]
public class RadSplitter : SplitterItemsContainer, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl
Inheritance: objectControlWebControlRadWebControlSplitterItemsContainerRadSplitter...
Implements:
Inherited Members
Constructors
public RadSplitter()
Properties
Set/Get size of the splitter border
[ClientControlProperty]
[ClientPropertyName("_borderSize")]
public int BorderSize { get; set; }
The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()
protected override string CssClassFormatString { get; }
Overrides:
Resize the splitter in 100% of the page
[Browsable(false)]
[Obsolete("The FullScreenMode property is deprecated in RadSplitter for ASP.NET Ajax. Use Width and Height instead.", false)]
public bool FullScreenMode { get; set; }
Sets/gets the height of the splitter
[ClientControlProperty]
[ClientPropertyName("_height")]
public override Unit Height { get; set; }
Overrides:
Sets/gets the pixels that should be substracted from the splitter height when its height is defined in percent
[ClientControlProperty]
public int HeightOffset { get; set; }
Sets/gets whether the rendering of the splitter panes is previewed during the resize
[ClientControlProperty]
public bool LiveResize { get; set; }
[Obsolete("This property is now obsolete. Please use the OnClientResizing property instead.", false)]
public string OnClientBeforeResize { get; set; }
Gets or sets a value indicating the client-side event handler that is called when the RadSplitter control is initialized.
[ClientControlProperty]
[ClientPropertyName("_load")]
public string OnClientLoad { 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 RadSplitter that fired the event
- args
This event cannot be cancelled.
[Obsolete("This property is now obsolete. Please use the OnClientLoad property instead.", false)]
public string OnClientLoaded { get; set; }
Gets or sets a value indicating the client-side event handler that is called when the RadSplitter is resized.
[ClientControlEvent]
[ClientPropertyName("resized")]
public string OnClientResized { get; set; }
A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
If specified, the OnClientResized client-side event handler is called when the RadSplitter is resized. Two parameters are passed to the handler:
- sender, the event object
- eventArgs with the following methods:
- get_oldWidth - the width of the splitter before the resize
- get_oldHeight - the height of the splitter before the resize
This event cannot be cancelled.
Gets or sets a value indicating the client-side event handler that is called before the RadSplitter is resized.
[ClientControlEvent]
[ClientPropertyName("resizing")]
public string OnClientResizing { 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 RadSplitter that fired the event
- args with the following methods:
- get_newWidth - the new width that will be applied to the RadSplitter object
- get_newHeight - the new height that will be applied to the RadSplitter object
This event can be cancelled.
Specify the orientation of the panes inside the splitter
[ClientControlProperty]
[ClientPropertyName("_orientation")]
public Orientation Orientation { get; set; }
Set/Get size of the splitter panes border
[ClientControlProperty]
[ClientPropertyName("_panesBorderSize")]
public int PanesBorderSize { get; set; }
Set/Get the way the panes are resized
[ClientControlProperty]
[ClientPropertyName("_resizeMode")]
public SplitterResizeMode ResizeMode { get; set; }
Sets/gets whether the splitter will be resized when the browser window is resized. The Width or Height properties should be defined in percent.
[ClientControlProperty]
[ClientPropertyName("_resizeWithBrowserWindow")]
public bool ResizeWithBrowserWindow { get; set; }
Sets/gets whether the splitter will resize when the parent pane is resized
public bool ResizeWithParentPane { get; set; }
Set/Get size of the split bars - in pixels
public Unit SplitBarsSize { get; set; }
Whether the Splitter should be visible during its initialization or not
[ClientControlProperty]
[ClientPropertyName("_visibleDuringInit")]
public bool VisibleDuringInit { get; set; }
Methods
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:
Gets a list of all RadPane items contained in this RadSplitter.
Retrieves a RadSplitBar by its ID from the items collection.
public RadSplitBar GetSplitBarById(string splitBarId)
The ID of the split bar to retrieve.
Returns:The RadSplitBar with the specified ID, or null if not found.
Gets a list of all RadSplitBar items contained in this RadSplitter.
Determines whether the splitter orientation is horizontal.
public bool IsHorizontal()
True if the orientation is horizontal; otherwise, false.
protected override void RegisterInitializeScriptWithScriptManager()
Overrides: