ClassRadScrollablePanel
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.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
[TelerikToolboxCategory("Containers")]
[Docking(DockingBehavior.Ask)]
public class RadScrollablePanel : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadScrollablePanel
Derived Classes:
Implements:
Inherited Members
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
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
true if auto-scrolling is enabled; otherwise, false.
Overrides
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
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
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
A Point representing the scroll offset coordinates.
Overrides
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
A Point representing the auto-scroll position coordinates.
DefaultSize
Gets the default size of the control.
Declaration
protected override Size DefaultSize { get; }
Property Value
The default System.Drawing.Size of the control.
Overrides
Remarks
The default Size of the control.
HorizontalScrollBarState
Gets or sets the state of the horizontal scroll bar which indicates whether it will be always visible(), always hidden() or determined by the content() - default
Declaration
public ScrollState HorizontalScrollBarState { get; set; }
Property Value
HorizontalScrollbar
Gets the horizontal scrollbar of the control.
Declaration
[Browsable(false)]
public RadHScrollBar HorizontalScrollbar { get; }
Property Value
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
A Padding structure representing the padding values.
PanelContainer
Gets the container panel that holds all the components added to the panel.
PanelElement
Gets an instance of the RadScrollablePanelElement class which represents the main element of the control.
Declaration
[Browsable(false)]
public RadScrollablePanelElement PanelElement { get; }
Property Value
VerticalScrollBarState
Gets or sets the state of the vertical scroll bar which indicates whether it will be always visible(), always hidden() or determined by the content() - default
Declaration
public ScrollState VerticalScrollBarState { get; set; }
Property Value
VerticalScrollbar
Gets the vertical scrollbar of the control.
Declaration
[Browsable(false)]
public RadVScrollBar VerticalScrollbar { get; }
Property Value
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
parent
The parent RadElement to which child elements will be added.
Overrides
CreateControlsInstance()
Creates a new instance of the control's Control.ControlCollection.
Declaration
protected override Control.ControlCollection CreateControlsInstance()
Returns
A new RadScrollablePanelControlCollection for this control.
Overrides
CreatePanelElement()
Creates the panel element for this RadScrollablePanel.
Declaration
protected virtual RadScrollablePanelElement CreatePanelElement()
Returns
A new instance of RadScrollablePanelElement.
CreateRootElement()
Declaration
protected override RootRadElement CreateRootElement()
Returns
Overrides
CreateScrollablePanelContainer()
Declaration
protected virtual RadScrollablePanelContainer CreateScrollablePanelContainer()
Returns
Dispose(bool)
Declaration
protected override void Dispose(bool disposing)
Parameters
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.
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.
OnNotifyPropertyChanged(string)
Raises the PropertyChanged event
Declaration
protected override void OnNotifyPropertyChanged(string propertyName)
Parameters
propertyName
The name of the property
Overrides
OnResize(EventArgs)
Handles the control's resize event and updates the scrollbars position.
OnRightToLeftChanged(EventArgs)
Handles changes to the control's right-to-left layout and adjusts the vertical scrollbar position accordingly.
OnThemeChanged()
Handles changes to the control's theme and updates the scrollbars accordingly.
Declaration
protected override void OnThemeChanged()
Overrides
ProcessAutoSizeChanged(bool)
Declaration
protected override void ProcessAutoSizeChanged(bool value)
Parameters
value
Overrides
ResetBackColorThemeOverrides()
Declaration
protected override void ResetBackColorThemeOverrides()
Overrides
SetBackColorThemeOverrides()
Declaration
protected override void SetBackColorThemeOverrides()
Overrides
SynchronizeHScrollbar(int)
Declaration
protected virtual void SynchronizeHScrollbar(int value)
Parameters
value
SynchronizeScrollbars(Point)
Declaration
protected virtual void SynchronizeScrollbars(Point scrollPoint)
Parameters
scrollPoint
SynchronizeScrollbarsVisiblity()
Declaration
protected virtual void SynchronizeScrollbarsVisiblity()
SynchronizeVScrollbar(int)
Declaration
protected virtual void SynchronizeVScrollbar(int value)
Parameters
value