WinForms › Scrollable Panel › ScrollerPanel

ScrollerPanel

class.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WinForms.Controls.Containers

A custom Panel control acts like a stock .NET Panel control, and additionally provides many features including being able to customize various user-interface aspects of the scrollbars in the control.

public class ScrollerPanel : Control, IScrollersDockHost, IScrollerPanel

Inherits from / implements: Control, IScrollersDockHost, IScrollerPanel

Members at a glance

`ScrollerPanel`	Initializes a new instance of the `ScrollerPanel` class.
`BorderColor`	Gets or sets the color of the border.
`BorderSize`	Gets or sets the size of the border.
`BorderStyle`	Gets or sets the border style.
`ContentHostingPanel`	Gets or sets the content hosting panel.
`DefaultSize`	Gets the size this control starts out at before anything sets it.
`DockHost`	Gets the dock host.
`DropShadowColor`	Gets or sets the colour of the drop shadow. The alpha component is ignored; `DropShadowOpacity` controls the strength.
`DropShadowDepth`	Gets or sets how far the drop shadow reaches, in logical (96 DPI) pixels.
`DropShadowOpacity`	Gets or sets how dark the drop shadow is at its strongest, from 0 to 255.
`HorizontalScrollBar`	Gets the horizontal scroll bar.
`ScrollBarsOpaqueCornerColor`	Gets or sets the color of the scroll bars opaque corner.
`ScrollControlsCompositeSizeMetadata`	Gets the scroll controls composite size metadata.
`ScrollSize`	Gets or sets the size of the scroll.
`ShouldDrawDropShadow`	Gets or sets whether the control draws a drop shadow along its bottom and right edges.
`ShouldNotPerformDockHostHorizontalSizePainting`	Gets a value indicating whether the control should not perform dock host horizontal size painting.
`ShouldNotPerformDockHostVerticalSizePainting`	Gets a value indicating whether the control should not perform dock host vertical size painting.
`ShouldProvideExtendedRenderingArtefacts`	Gets a value indicating whether the control should provide extended rendering artifacts.
`VerticalScrollBar`	Gets the vertical scroll bar.
`IsInputKey`	Reports whether this control wants a key that the framework would otherwise treat as navigation.
`OnHandleCreated`	Raises the HandleCreated event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.
`OnKeyDown`	Raises the KeyDown event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.
`OnKeyUp`	Raises the KeyUp event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.
`OnMouseWheel`	Raises the MouseWheel event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.
`OnPaint`	Raises the Paint event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.
`OnParentBackColorChanged`	Raises the ParentBackColorChanged event, and repaints the shadow band, which is filled with the colour behind the control.
`OnParentChanged`	Raises the ParentChanged event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.
`OnSizeChanged`	Raises the SizeChanged event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.
`OnTabStopChanged`	Raises the TabStopChanged event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.
`OnVisibleChanged`	Raises the VisibleChanged event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.
`WndProc`	Processes the Windows messages sent to this control's window.
`ScrollerPanelUpdated`	Occurs when scroller panel is updated.

Constructors

ScrollerPanel

public ScrollerPanel()

Initializes a new instance of the ScrollerPanel class.

Properties

BorderColor

public Color BorderColor

Gets or sets the color of the border.

Value. The color of the border.

BorderSize

public int BorderSize

Gets or sets the size of the border.

Value. The size of the border.

BorderStyle

public ButtonBorderStyle BorderStyle

Gets or sets the border style.

Value. The border style.

ContentHostingPanel

public Panel ContentHostingPanel

Gets or sets the content hosting panel.

DefaultSize

protected override Size DefaultSize

Gets the size this control starts out at before anything sets it.

DockHost

public Control DockHost

Gets the dock host.

DropShadowColor

public Color DropShadowColor

Gets or sets the colour of the drop shadow. The alpha component is ignored; DropShadowOpacity controls the strength.

DropShadowDepth

public int DropShadowDepth

Gets or sets how far the drop shadow reaches, in logical (96 DPI) pixels.

Scaled to the display when drawn. Clamped to 0 through MaximumDepth.

DropShadowOpacity

public int DropShadowOpacity

Gets or sets how dark the drop shadow is at its strongest, from 0 to 255.

HorizontalScrollBar

public HorizontalScrollBar HorizontalScrollBar

Gets the horizontal scroll bar.

ScrollBarsOpaqueCornerColor

public Color ScrollBarsOpaqueCornerColor

Gets or sets the color of the scroll bars opaque corner.

ScrollControlsCompositeSizeMetadata

public Size ScrollControlsCompositeSizeMetadata

Gets the scroll controls composite size metadata.

ScrollSize

public Size ScrollSize

Gets or sets the size of the scroll.

ShouldDrawDropShadow

public bool ShouldDrawDropShadow

Gets or sets whether the control draws a drop shadow along its bottom and right edges.

A child control cannot paint outside its own window, so the shadow is drawn inside the control's bounds, outside its border, and the area available to the content and the scroll bars shrinks by DropShadowDepth on those two edges.

ShouldNotPerformDockHostHorizontalSizePainting

public bool ShouldNotPerformDockHostHorizontalSizePainting

Gets a value indicating whether the control should not perform dock host horizontal size painting.

ShouldNotPerformDockHostVerticalSizePainting

public bool ShouldNotPerformDockHostVerticalSizePainting

Gets a value indicating whether the control should not perform dock host vertical size painting.

ShouldProvideExtendedRenderingArtefacts

public bool ShouldProvideExtendedRenderingArtefacts

Gets a value indicating whether the control should provide extended rendering artifacts.

VerticalScrollBar

public VerticalScrollBar VerticalScrollBar

Gets the vertical scroll bar.

Methods

IsInputKey

protected override bool IsInputKey(Keys keyData)

Reports whether this control wants a key that the framework would otherwise treat as navigation.

OnHandleCreated

protected override void OnHandleCreated(EventArgs e)

Raises the HandleCreated event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnKeyDown

protected override void OnKeyDown(KeyEventArgs e)

Raises the KeyDown event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnKeyUp

protected override void OnKeyUp(KeyEventArgs e)

Raises the KeyUp event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnMouseWheel

protected override void OnMouseWheel(MouseEventArgs e)

Raises the MouseWheel event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnPaint

protected override void OnPaint(PaintEventArgs e)

Raises the Paint event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnParentBackColorChanged

protected override void OnParentBackColorChanged(EventArgs e)

Raises the ParentBackColorChanged event, and repaints the shadow band, which is filled with the colour behind the control.

e: The data for the event.

OnParentChanged

protected override void OnParentChanged(EventArgs e)

Raises the ParentChanged event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnSizeChanged

protected override void OnSizeChanged(EventArgs e)

Raises the SizeChanged event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnTabStopChanged

protected override void OnTabStopChanged(EventArgs e)

Raises the TabStopChanged event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

OnVisibleChanged

protected override void OnVisibleChanged(EventArgs e)

Raises the VisibleChanged event. ScrollerPanel overrides it so the control's own handling runs alongside the base behavior.

e: The data for the event.

WndProc

protected override void WndProc(ref Message m)

Processes the Windows messages sent to this control's window.

Events

ScrollerPanelUpdated

public event EventHandler<ScrollerPanelEventArgs> ScrollerPanelUpdated

Occurs when scroller panel is updated.