Class RadScrollablePanel

The RadScrollablePanel control can be used as a container for different UI elements. This control is powered by the Telerik Presentation Framework and supports gradient backgrounds, shapes and theming. This control supports also theming of the scrollbars.

Inheritance
System.Object
RadControl
RadScrollablePanel
CollapsiblePanelControlsContainer
RadDataEntry
RadPopupContainer
ValidationPanel
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[TelerikToolboxCategory("Containers")]
public class RadScrollablePanel : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadScrollablePanel()

Initializes a new instance of the RadScrollablePanel class.

Declaration
public RadScrollablePanel()

Properties

AllowAutomaticScrollToControl

Gets or sets a value indicating whether the focused control inside the RadScrollablePanel will be automatically scrolled into view when gaining focus.

Declaration
public bool AllowAutomaticScrollToControl { get; set; }
Property Value
System.Boolean

AutoScroll

Gets or sets a value indicating whether the container enables auto-scrolling. When enabled, scroll bars appear automatically when content exceeds the visible area.

Declaration
public override bool AutoScroll { get; set; }
Property Value
System.Boolean

true if auto-scrolling is enabled; otherwise, false.

AutoScrollMargin

Gets or sets the margin around the scrollable content. This property defines the extra space around the scrollable area.

Declaration
public Size AutoScrollMargin { get; set; }
Property Value
System.Drawing.Size

A Size structure representing the margin dimensions.

AutoScrollMinSize

Gets or sets the minimum size of the auto-scroll region. This property defines the minimum scrollable area dimensions.

Declaration
public Size AutoScrollMinSize { get; set; }
Property Value
System.Drawing.Size

A Size structure representing the minimum scrollable size.

AutoScrollOffset

Gets or sets the auto-scroll offset for the scrollable panel. This property determines the current scroll position offset.

Declaration
public override Point AutoScrollOffset { get; set; }
Property Value
System.Drawing.Point

A Point representing the scroll offset coordinates.

AutoScrollPosition

Gets or sets the location of the auto-scroll position. This property determines where the scrolled content is positioned relative to the container.

Declaration
public Point AutoScrollPosition { get; set; }
Property Value
System.Drawing.Point

A Point representing the auto-scroll position coordinates.

DefaultSize

Gets the default size of the control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

The default System.Drawing.Size of the control.
Remarks

The default Size of the control.

ForeColor

This property is not relevant for this class.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

HorizontalScrollbar

Gets the horizontal scrollbar of the control.

Declaration
public RadHScrollBar HorizontalScrollbar { get; }
Property Value
RadHScrollBar

HorizontalScrollBarState

Gets or sets the state of the horizontal scroll bar which indicates whether it will be always visible(AlwaysShow), always hidden(AlwaysHide) or determined by the content(AutoHide) - default

Declaration
public ScrollState HorizontalScrollBarState { get; set; }
Property Value
ScrollState

Padding

Gets or sets the padding within the scrollable panel. This property defines the spacing between the edge of the panel and its content.

Declaration
public Padding Padding { get; set; }
Property Value
System.Windows.Forms.Padding

A Padding structure representing the padding values.

PanelContainer

Gets the container panel that holds all the components added to the panel.

Declaration
public virtual Panel PanelContainer { get; }
Property Value
System.Windows.Forms.Panel

PanelElement

Gets an instance of the RadScrollablePanelElement class which represents the main element of the control.

Declaration
public RadScrollablePanelElement PanelElement { get; }
Property Value
RadScrollablePanelElement

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

VerticalScrollbar

Gets the vertical scrollbar of the control.

Declaration
public RadVScrollBar VerticalScrollbar { get; }
Property Value
RadVScrollBar

VerticalScrollBarState

Gets or sets the state of the vertical scroll bar which indicates whether it will be always visible(AlwaysShow), always hidden(AlwaysHide) or determined by the content(AutoHide) - default

Declaration
public ScrollState VerticalScrollBarState { get; set; }
Property Value
ScrollState

Methods

AdjustSizingGrip()

Declaration
protected virtual void AdjustSizingGrip()

CreateChildItems(RadElement)

Creates the child elements of the RadScrollablePanel control.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent RadElement to which child elements will be added.
Overrides

CreateControlsInstance()

Creates a new instance of the control's System.Windows.Forms.Control.ControlCollection.

Declaration
protected override Control.ControlCollection CreateControlsInstance()
Returns
System.Windows.Forms.Control.ControlCollection

A new RadScrollablePanelControlCollection for this control.

CreatePanelElement()

Creates the panel element for this RadScrollablePanel.

Declaration
protected virtual RadScrollablePanelElement CreatePanelElement()
Returns
RadScrollablePanelElement

A new instance of RadScrollablePanelElement.

CreateRootElement()

Declaration
protected override RootRadElement CreateRootElement()
Returns
RootRadElement

Overrides

CreateScrollablePanelContainer()

Declaration
protected virtual RadScrollablePanelContainer CreateScrollablePanelContainer()
Returns
RadScrollablePanelContainer

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

Overrides

FitToChildControls()

Resizes the panel to fit its contents.

Declaration
public virtual void FitToChildControls()

GetContentMargin()

Calculates the non-client margin of the control based on the radius of the round rect shape.

Declaration
protected virtual Padding GetContentMargin()
Returns
System.Windows.Forms.Padding

An instance of the System.Windows.Forms.Padding struct which represents the left, top, right and bottom margin.

GetSizingGripColor()

Declaration
protected virtual Color GetSizingGripColor()
Returns
System.Drawing.Color

InitializeInternalControls()

This method initializes the scrollbars and the container control.

Declaration
protected virtual void InitializeInternalControls()

InsertInternalControls()

This method inserts the scrollbars and the container in the Controls collection of this control.

Declaration
protected virtual void InsertInternalControls()

OnAutoScrollChanged()

Handles changes to the auto-scroll property by updating the panel's padding, scrollbars, and layout.

Declaration
protected virtual void OnAutoScrollChanged()

OnHandleCreated(EventArgs)

Handles the creation of the control's handle and initializes auto-scroll settings.

Declaration
protected override void OnHandleCreated(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnNotifyPropertyChanged(String)

Declaration
protected override void OnNotifyPropertyChanged(string propertyName)
Parameters
System.String propertyName

Overrides

OnResize(EventArgs)

Handles the control's resize event and updates the scrollbars position.

Declaration
protected override void OnResize(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.

OnRightToLeftChanged(EventArgs)

Handles changes to the control's right-to-left layout and adjusts the vertical scrollbar position accordingly.

Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

OnThemeChanged()

Handles changes to the control's theme and updates the scrollbars accordingly.

Declaration
protected override void OnThemeChanged()
Overrides

ProcessAutoSizeChanged(Boolean)

Declaration
protected override void ProcessAutoSizeChanged(bool value)
Parameters
System.Boolean value

Overrides

ResetBackColorThemeOverrides()

Declaration
protected override void ResetBackColorThemeOverrides()
Overrides

SetBackColorThemeOverrides()

Declaration
protected override void SetBackColorThemeOverrides()
Overrides

SynchronizeHScrollbar(Int32)

Declaration
protected virtual void SynchronizeHScrollbar(int value)
Parameters
System.Int32 value

SynchronizeScrollbars(Point)

Declaration
protected virtual void SynchronizeScrollbars(Point scrollPoint)
Parameters
System.Drawing.Point scrollPoint

SynchronizeScrollbarsVisiblity()

Declaration
protected virtual void SynchronizeScrollbarsVisiblity()

SynchronizeVScrollbar(Int32)

Declaration
protected virtual void SynchronizeVScrollbar(int value)
Parameters
System.Int32 value

Extension Methods