menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ScrollersFrame - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ScrollersFrame

    Custom scrollbars with various VisualStyles and provision to add buttons to it.

    Inheritance
    System.Object
    BaseComponent
    ScrollersFrame
    Implements
    IThemeProvider
    System.IDisposable
    System.Windows.Forms.IMessageFilter
    IVisualStyle
    Inherited Members
    BaseComponent.CanApplyTheme
    BaseComponent.CanOverrideStyle
    BaseComponent.ControlName
    BaseComponent.GetActiveThemeName()
    BaseComponent.IsVisualStyleEnabled
    BaseComponent.IThemeProvider.BaseThemeName
    BaseComponent.OnCanApplyThemeChanged(Boolean)
    BaseComponent.OnCanOverrideStyleChanged(Boolean)
    BaseComponent.RaiseThemeChanged(Object, ThemeChangedEventArgs)
    BaseComponent.ThemeName
    BaseComponent.ThemeNameChanged
    Namespace: Syncfusion.Windows.Forms
    Assembly: Syncfusion.Shared.Base.dll
    Syntax
    public class ScrollersFrame : BaseComponent, IThemeProvider, IDisposable, IMessageFilter, IVisualStyle

    Constructors

    ScrollersFrame()

    Default constructor.

    Declaration
    public ScrollersFrame()

    ScrollersFrame(IContainer)

    Component oriented constructor. Mostly used by Windows Forms designer.

    Declaration
    public ScrollersFrame(IContainer container)
    Parameters
    Type Name Description
    System.ComponentModel.IContainer container

    reference on container that will control class life time.

    Fields

    hScroller

    Horizontal scroller instance.

    Declaration
    protected HScrollBarCustomDraw hScroller
    Field Value
    Type
    HScrollBarCustomDraw

    m_customrenderer

    Declaration
    public IRenderer m_customrenderer
    Field Value
    Type
    IRenderer

    m_sizeGripper

    Size gripper control instance.

    Declaration
    protected ScrollersFrame.SizeGripperAdv m_sizeGripper
    Field Value
    Type
    ScrollersFrame.SizeGripperAdv

    vScroller

    Vertical scroller instance.

    Declaration
    protected VScrollBarCustomDraw vScroller
    Field Value
    Type
    VScrollBarCustomDraw

    Properties

    AttachedTo

    Reference on control to which we assign our custom scrollers.

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

    CustomRender

    Gets or Sets custom renderer to customize the scroll bars

    Declaration
    public IRenderer CustomRender { get; set; }
    Property Value
    Type
    IRenderer

    EnableDelayedScrollBarUpdate

    Gets or sets whether delayed scrollbar updates must be updated.

    Declaration
    public virtual bool EnableDelayedScrollBarUpdate { get; set; }
    Property Value
    Type
    System.Boolean

    HorizontalScroller

    Reference on configurable Horizontal Scroller control.

    Declaration
    public HScrollBarCustomDraw HorizontalScroller { get; }
    Property Value
    Type
    HScrollBarCustomDraw

    HorizontalSmallChange

    Gets or sets the value to be added to or subtracted from the Value property when the horizontal scroll box is moved a small distance.

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

    IsHorizontalScrollVisible

    True - horizontal scroller is visible to user, otherwise False.

    Declaration
    protected bool IsHorizontalScrollVisible { get; }
    Property Value
    Type
    System.Boolean

    IsVerticalScrollVisible

    True - vertical scroller is visible to user, otherwise False.

    Declaration
    protected bool IsVerticalScrollVisible { get; }
    Property Value
    Type
    System.Boolean

    MetroColorScheme

    Gets or sets whether the Metro color scheme should be User defined colors.

    Declaration
    public MetroColorScheme MetroColorScheme { get; set; }
    Property Value
    Type
    MetroColorScheme

    MetroThumbSize

    Gets/Sets the size of Metro Scroller Thumb

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

    Office2010ColorScheme

    Gets or sets whether the Office color scheme should be Silver or Blue or Black.

    Declaration
    public Office2010ColorScheme Office2010ColorScheme { get; set; }
    Property Value
    Type
    Office2010ColorScheme

    Office2016ColorScheme

    Gets or sets Office2016 color scheme for horizontal and vertical scrollbars.

    Declaration
    public ScrollBarOffice2016ColorScheme Office2016ColorScheme { get; set; }
    Property Value
    Type
    ScrollBarOffice2016ColorScheme

    OfficeColorScheme

    Gets or sets whether the Office color scheme should be Silver or Blue or Black.

    Declaration
    public Office2007ColorScheme OfficeColorScheme { get; set; }
    Property Value
    Type
    Office2007ColorScheme

    RefreshOnValueChange

    Gets or sets value indicating whether scrollbar should be refreshed on each value change. If set to false, scrollbar is invalidated only and therefore is visually refreshed after processing all scrolling messages.

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

    ScrollMetroColorTable

    Gets or sets custom color to MetroScroller.

    Declaration
    public MetroColorTable ScrollMetroColorTable { get; set; }
    Property Value
    Type
    MetroColorTable

    ScrollOffice2016BlackColorTable

    Gets or sets the custom color for Office2016 black scrollbar.

    Declaration
    public MetroColorTable ScrollOffice2016BlackColorTable { get; set; }
    Property Value
    Type
    MetroColorTable

    ScrollOffice2016ColorfulColorTable

    Gets or sets the custom color for Office2016 colorful scrollbar.

    Declaration
    public MetroColorTable ScrollOffice2016ColorfulColorTable { get; set; }
    Property Value
    Type
    MetroColorTable

    ScrollOffice2016DarkGrayColorTable

    Gets or sets the custom color for Office2016 dark gray scrollbar.

    Declaration
    public MetroColorTable ScrollOffice2016DarkGrayColorTable { get; set; }
    Property Value
    Type
    MetroColorTable

    ScrollOffice2016WhiteColorTable

    Gets or sets the custom color for Office2016 white scrollbar.

    Declaration
    public MetroColorTable ScrollOffice2016WhiteColorTable { get; set; }
    Property Value
    Type
    MetroColorTable

    ShowMetroArrowButton

    Gets/Sets whether to display Metro scroller buttons

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

    SizeGripperVisibility

    Gets or sets visibility of size gripper.

    Declaration
    public SizeGripperVisibility SizeGripperVisibility { get; set; }
    Property Value
    Type
    SizeGripperVisibility

    ThemeStyle

    Gets or sets a style of the ScrollFrame components.

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

    UseTouchScrollBehavior

    Gets or Sets whether to set the win 8 style scroll behavior

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

    VerticallSmallChange

    Gets or sets the value to be added to or subtracted from the Value property when the vertical scroll box is moved a small distance.

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

    VerticalScroller

    Reference on configurable Vertical Scroller control.

    Declaration
    public VScrollBarCustomDraw VerticalScroller { get; }
    Property Value
    Type
    VScrollBarCustomDraw

    VisualStyle

    Specifies the style of appearance.

    Declaration
    public ScrollBarCustomDrawStyles VisualStyle { get; set; }
    Property Value
    Type
    ScrollBarCustomDrawStyles

    Methods

    AttachFrame(Control)

    Method attach scroller frame to the specified control. Previously attaches to the controls will be released.

    Declaration
    public void AttachFrame(Control control)
    Parameters
    Type Name Description
    System.Windows.Forms.Control control

    Reference on windows forms control. Can not be NULL.

    CreateControlContainer()

    Method create special container windows that will host attached control.

    Declaration
    protected virtual void CreateControlContainer()
    Remarks

    NOT implemented. Reserved for future enhancements. But can be overrided and implemented by user.

    DetachFrame()

    Detach scrollers frame from previously attached control.

    Declaration
    public void DetachFrame()

    Dispose(Boolean)

    Clean up any resources being used.

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

    GetControlName(String)

    Overridden to gets the control name of the scroll frame.

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

    The control name.

    Returns
    Type Description
    System.String

    Returns the name of the control.

    Overrides
    BaseComponent.GetControlName(String)

    GetGripperVisibility()

    Gets visibility of the size gripper.

    Declaration
    protected bool GetGripperVisibility()
    Returns
    Type Description
    System.Boolean

    true if gripper should be shown; otherwise false.

    OnScrollerScroll(Object, ScrollEventArgs)

    Declaration
    protected virtual void OnScrollerScroll(object sender, ScrollEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Forms.ScrollEventArgs e

    OnThemeNameChanged(String)

    Occurs when the theme name is changed.

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

    The theme name.

    Overrides
    BaseComponent.OnThemeNameChanged(String)

    PreFilterMessage(ref Message)

    Method filter parent control messages and according to them set scroller frame settings.

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

    Windows message.

    Returns
    Type Description
    System.Boolean

    True - allow forward of message, otherwise False.

    ReflectRightToLeft()

    Reflect Right to Left settings from parent control with respect to internal logic.

    Declaration
    protected virtual void ReflectRightToLeft()
    Remarks

    change RTL before SetParent calls. RTL force re-creation of the scroller handle!!!

    ResetOffice2010ColorScheme()

    Resets the office2010 color scheme.

    Declaration
    protected virtual void ResetOffice2010ColorScheme()

    ResetOfficeColorScheme()

    Resets the office color scheme.

    Declaration
    protected virtual void ResetOfficeColorScheme()

    ResetVisualStyle()

    Resets the office color scheme.

    Declaration
    protected virtual void ResetVisualStyle()

    ShouldSerializeOffice2010ColorScheme()

    Indicates whether the current value of the Office2010ColorScheme property is to be serialized.

    Declaration
    protected virtual bool ShouldSerializeOffice2010ColorScheme()
    Returns
    Type Description
    System.Boolean

    a boolean value.

    ShouldSerializeOfficeColorScheme()

    Indicates whether the current value of the OfficeColorScheme property is to be serialized.

    Declaration
    protected virtual bool ShouldSerializeOfficeColorScheme()
    Returns
    Type
    System.Boolean

    ShouldSerializeVisualStyle()

    Indicates whether the current value of the OfficeColorScheme property is to be serialized.

    Declaration
    protected virtual bool ShouldSerializeVisualStyle()
    Returns
    Type
    System.Boolean

    Update()

    Refresh scroller frames internal settings and repaint.

    Declaration
    public void Update()

    UpdateGripperVisibility()

    Updates visibility of gripper.

    Declaration
    protected virtual void UpdateGripperVisibility()

    UpdateParentInDragging()

    If parent is being dragged, scrollers get invisible.

    Declaration
    protected virtual void UpdateParentInDragging()

    WM_MouseMove(ref Message)

    Method process a WM_MOUSEMOVE message.

    Declaration
    protected virtual bool WM_MouseMove(ref Message m)
    Parameters
    Type Name Description
    System.Windows.Forms.Message m
    Returns
    Type
    System.Boolean

    WM_Move(ref Message)

    Method process a WM_MOVE message.

    Declaration
    protected virtual bool WM_Move(ref Message m)
    Parameters
    Type Name Description
    System.Windows.Forms.Message m
    Returns
    Type
    System.Boolean

    WmNcCalcSize(ref Message)

    Method process WM_NSCALCSIZE message.

    Declaration
    protected virtual bool WmNcCalcSize(ref Message m)
    Parameters
    Type Name Description
    System.Windows.Forms.Message m
    Returns
    Type
    System.Boolean

    WmStyleChanged(ref Message)

    Method process WM_STYLECHANGED message.

    Declaration
    protected virtual bool WmStyleChanged(ref Message m)
    Parameters
    Type Name Description
    System.Windows.Forms.Message m
    Returns
    Type
    System.Boolean

    WmWindowPosChanged(ref Message)

    Method process WM_WINDOWPOSCHANGED message.

    Declaration
    protected virtual bool WmWindowPosChanged(ref Message m)
    Parameters
    Type Name Description
    System.Windows.Forms.Message m
    Returns
    Type
    System.Boolean

    Explicit Interface Implementations

    IVisualStyle.VisualTheme

    Declaration
    string IVisualStyle.VisualTheme { get; set; }
    Returns
    Type
    System.String

    Implements

    IThemeProvider
    System.IDisposable
    System.Windows.Forms.IMessageFilter
    IVisualStyle
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved