Class SfScrollFrame

Represents the component that manages the scrollbars of the control and assigns the theme-able scrollbars to that control.

Inheritance
System.Object
BaseComponent
SfScrollFrame
Implements
System.IDisposable
System.Windows.Forms.IMessageFilter
Inherited Members
Namespace: Syncfusion.WinForms.Controls
Assembly: Syncfusion.Core.WinForms.dll
Syntax
public class SfScrollFrame : BaseComponent, IThemeProvider, IVisualStyle, IDisposable, IMessageFilter

Constructors

SfScrollFrame()

Initializes a new instance of the SfScrollFrame class.

Declaration
public SfScrollFrame()

Properties

Control

Gets or sets the control to attach the scroll frame.

Declaration
public Control Control { get; set; }
Property Value
Type
System.Windows.Forms.Control
Remarks

The SfScrollFrame can be attached to a control which is derived from the System.Windows.Forms.ScrollableControl or if the WS_HSCROLL and WS_VSCROLL window styles are enabled for that control.

HorizontalScrollBar

Gets the horizontal scrollbar of the attached scroller frame.

Declaration
public HorizontalScrollBar HorizontalScrollBar { get; }
Property Value
Type
HorizontalScrollBar

Style

Gets or sets the with settings that control the appearance of the SfScrollFrame.

Declaration
public ScrollerVisualStyle Style { get; set; }
Property Value
Type
ScrollerVisualStyle

VerticalScrollBar

Gets the vertical scrollbar of the attached scroller frame.

Declaration
public VerticalScrollBar VerticalScrollBar { get; }
Property Value
Type
VerticalScrollBar

Methods

Dispose(Boolean)

Disposes the unused resources.

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

Specifies whether to dispose both managed and unmanaged resources or only the unmanaged resources.

GetControlName(String)

Helps to apply the ControlName settings in control

Declaration
public override string GetControlName(string controlName)
Parameters
Type Name Description
System.String controlName

The ControlName.
Returns
Type Description
System.String

Returns the control name.
Overrides

OnThemeNameChanged(String)

Helps to apply the ThemeName settings in control

Declaration
public override void OnThemeNameChanged(string themeName)
Parameters
Type Name Description
System.String themeName

The ThemeName.
Overrides

PreFilterMessage(ref Message)

Updates the SfScrollerFrame based on the WndProc message of the parent control.

Declaration
protected bool PreFilterMessage(ref Message m)
Parameters
Type Name Description
System.Windows.Forms.Message m

The System.Windows.Forms.Message that passed to the parent control.
Returns
Type Description
System.Boolean

Return true when the message is need to be forward to the parent, otherwise return false.

RaiseThemeChanged(Object, ThemeChangedEventArgs)

Raises the and ThemeChanged event when theme name changed.

Declaration
protected override void RaiseThemeChanged(object sender, ThemeChangedEventArgs args)
Parameters
Type Name Description
System.Object sender

The sender value.
ThemeChangedEventArgs args

A ThemeChangedEventArgs contains the event data.
Overrides

Refresh()

Forces the scroller frame to update the attached scrollbars and immediately redraw its scrollbars.

Declaration
public void Refresh()

Events

ThemeChanged

Occurs when theme name of the SfScrollFrame has changed.

Declaration
public event ThemeChangedEventHandler ThemeChanged
Event Type
Type
ThemeChangedEventHandler

Implements

System.IDisposable
System.Windows.Forms.IMessageFilter