Class RadScrollLayoutPanel

RadScrollLayoutPanel is the layout panel that arranges viewport, horizontal and vertical scrollbars and a spot that appears when both scrollbars are shown.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
LayoutPanel
RadScrollLayoutPanel
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadScrollLayoutPanel : LayoutPanel, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode
Remarks

For more information about scrolling see the help for RadScrollViewer and for IRadScrollViewport.

Constructors

RadScrollLayoutPanel()

Declaration
public RadScrollLayoutPanel()

RadScrollLayoutPanel(RadElement)

Declaration
public RadScrollLayoutPanel(RadElement viewport)
Parameters
RadElement viewport

RadScrollLayoutPanel(RadElement, Int32)

Declaration
public RadScrollLayoutPanel(RadElement viewport, int initialScrollThickness)
Parameters
RadElement viewport

System.Int32 initialScrollThickness

Fields

ForceViewportHeightProperty

Declaration
public static readonly RadProperty ForceViewportHeightProperty
Field Value
RadProperty

ForceViewportWidthProperty

Declaration
public static readonly RadProperty ForceViewportWidthProperty
Field Value
RadProperty

ScrollThicknessProperty

Declaration
public static readonly RadProperty ScrollThicknessProperty
Field Value
RadProperty

Properties

BlankSpot

Gets the rectangle that is between the two scrollbars when they both are shown.

Declaration
public FillPrimitive BlankSpot { get; }
Property Value
FillPrimitive

CanHorizontalScroll

Gets a value indicating whether can be performed horizontal scrolling operation

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

CanVerticalScroll

Gets a value indicating whether can be performed vertical scrolling operation

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

ForceViewportHeight

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

ForceViewportWidth

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

HorizontalScrollBar

Gets the horizontal scrollbar

Declaration
public RadScrollBarElement HorizontalScrollBar { get; }
Property Value
RadScrollBarElement

HorizontalScrollState

Gets or sets the scroll state of the horizontal scroll bar.

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

State of type ScrollState. Default value is AutoHide.

MaxValue

Gets the maximum possible scrolling position.

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

Point which contains maximum values for scrolling in horizontal and vertical direction.

MeasureWithAvaibleSize

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

MinValue

Gets the minimum possible scrolling position.

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

Point which contains minimum values for scrolling in horizontal and vertical direction.

PixelsPerLineScroll

Gets or sets the number of pixels to use when performing Line Up/Down/Left/Right scrolling operation.

Still the scrolling position can be set with one pixel accuracy if the scroll bar thumb is dragged.

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

ScrollThickness

Gets or sets the thickness of the scrollbar.

Declaration
public int ScrollThickness { get; set; }
Property Value
System.Int32

UsePhysicalScrolling

Gets or sets a value indicating whether physical or logical scrolling will be used.

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

Boolean value: when it is false logical scrolling will be used.
Remarks

This property cannot be set to false if Viewport does not implement IRadScrollViewport.

Default value is true for ordinary viewports and false for viewports that implement IRadScrollViewport.

Value

Gets or sets the scrolling position. The value is between MinValue and MaxValue.

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

Point which contains the current scrolling position in horizontal and vertical direction.

VerticalScrollBar

Gets the vertical scrollbar

Declaration
public RadScrollBarElement VerticalScrollBar { get; }
Property Value
RadScrollBarElement

VerticalScrollState

Gets or sets the scroll state of the vertical scroll bar.

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

State of type ScrollState. Default value is AutoHide.

Viewport

Gets or sets the element which content will be scrolled if the scroll viewer has not enough space for it. Very often the viewport is a layout panel that implements IRadScrollViewport.

Declaration
public RadElement Viewport { get; set; }
Property Value
RadElement

Object of type RadElement which represents the content that could be scrolled if necessary. Default value is null.

Methods

ArrangeOverride(SizeF)

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

Returns
System.Drawing.SizeF

Overrides

ArrangeViewPort(RectangleF, SizeF, RadScrollLayoutPanel.ScrollFlags)

Declaration
protected virtual void ArrangeViewPort(RectangleF viewportRect, SizeF finalSize, RadScrollLayoutPanel.ScrollFlags flags)
Parameters
System.Drawing.RectangleF viewportRect

System.Drawing.SizeF finalSize

RadScrollLayoutPanel.ScrollFlags flags

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

GetScrollBarsSize(RadScrollLayoutPanel.ScrollFlags)

Declaration
protected Size GetScrollBarsSize(RadScrollLayoutPanel.ScrollFlags flags)
Parameters
RadScrollLayoutPanel.ScrollFlags flags

Returns
System.Drawing.Size

GetScrollingNeeds(Size, Size)

Declaration
protected RadScrollLayoutPanel.ScrollFlags GetScrollingNeeds(Size extentSize, Size clientSize)
Parameters
System.Drawing.Size extentSize

System.Drawing.Size clientSize

Returns
RadScrollLayoutPanel.ScrollFlags

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

Returns
System.Drawing.SizeF

Overrides

OnNewViewportSet(RadElement, RadElement)

Declaration
protected virtual void OnNewViewportSet(RadElement oldViewport, RadElement newViewport)
Parameters
RadElement oldViewport

RadElement newViewport

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnScroll(Point, Point)

Declaration
protected virtual void OnScroll(Point oldValue, Point newValue)
Parameters
System.Drawing.Point oldValue

System.Drawing.Point newValue

OnScrollNeedsChanged(ScrollNeedsEventArgs)

Declaration
protected virtual void OnScrollNeedsChanged(ScrollNeedsEventArgs args)
Parameters
ScrollNeedsEventArgs args

OnScrollParametersChanged(RadScrollBarElement)

Declaration
protected virtual void OnScrollParametersChanged(RadScrollBarElement scrollBar)
Parameters
RadScrollBarElement scrollBar

ResetLayout()

Declaration
public void ResetLayout()

ScrollElementIntoView(RadElement)

Declaration
public void ScrollElementIntoView(RadElement childElement)
Parameters
RadElement childElement

ScrollTo(Int32, Int32)

Declaration
public void ScrollTo(int xpos, int ypos)
Parameters
System.Int32 xpos

System.Int32 ypos

ScrollWith(Int32, Int32)

Declaration
public void ScrollWith(int xoffs, int yoffs)
Parameters
System.Int32 xoffs

System.Int32 yoffs

Events

Scroll

Occurs when horizontal or vertical scrolling is performed

Declaration
public event RadScrollPanelHandler Scroll
Event Type
RadScrollPanelHandler

ScrollNeedsChanged

Occurs when the need for horizontal or vertical scrollbar has changed.

Declaration
public event ScrollNeedsHandler ScrollNeedsChanged
Event Type
ScrollNeedsHandler

ScrollParametersChanged

Occurs when property that affects the scrolling functionality is changed.

Declaration
public event RadPanelScrollParametersHandler ScrollParametersChanged
Event Type
RadPanelScrollParametersHandler

ScrollViewportSet

Occurs when the Viewport is changed

Declaration
public event ScrollViewportSetHandler ScrollViewportSet
Event Type
ScrollViewportSetHandler

Extension Methods