menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class FlatScrollBar - API Reference

    Show / Hide Table of Contents

    Class FlatScrollBar

    Implements the basic functionality of a scroll bar control.

    Inheritance
    System.Object
    FlatScrollBar
    FlatHScrollBar
    FlatVScrollBar
    Implements
    IScrollBar
    Namespace: Syncfusion.Windows.Forms
    Assembly: Syncfusion.Shared.Base.dll
    Syntax
    public abstract class FlatScrollBar : ScrollBar, IScrollBar
    Remarks

    To adjust the value range of the scroll bar control, set the System.Windows.Forms.ScrollBar.Minimum and System.Windows.Forms.ScrollBar.Maximum properties. To adjust the distance the scroll box moves, set the System.Windows.Forms.ScrollBar.SmallChange and System.Windows.Forms.ScrollBar.LargeChange properties. To adjust the starting point of the scroll box, set the System.Windows.Forms.ScrollBar.Value property when the control is initially displayed.

    note

    The scroll box is sometimes referred to as the "thumb".

    Constructors

    FlatScrollBar()

    Declaration
    public FlatScrollBar()

    Properties

    Appearance

    Gets / sets the scroll bar style. Default is Flat style.

    Declaration
    public FlatScrollBarStyle Appearance { get; set; }
    Property Value
    Type Description
    FlatScrollBarStyle

    BackColor

    Gets / sets the background color of this scrollbar.

    Declaration
    public override Color BackColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    CreateParams

    Declaration
    protected override CreateParams CreateParams { get; }
    Property Value
    Type Description
    System.Windows.Forms.CreateParams

    IsThumbTracking

    Indicates whether the scroll bar is currently in thumb drag mode.

    Declaration
    public bool IsThumbTracking { get; }
    Property Value
    Type Description
    System.Boolean

    LargeChange

    Gets / sets the effect of clicking within the scroll bar but outside the scroll box.

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

    Maximum

    Gets / sets the maximum range of the scroll bar. Default is 100.

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

    Minimum

    Gets / sets the minimum range of the scroll bar. Default is zero.

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

    ShowScrollTips

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

    SmallChange

    Gets / sets the effect of clicking the scroll arrows at each end of the control.

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

    SupportsScrollTips

    Indicates whether the parent control should show ScrollTips while the user is dragging a scrollbar thumb.

    Declaration
    public bool SupportsScrollTips { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    ScrollControl checks this property to determine if ScrollTips should be displayed.

    SupportsThumbTrack

    Indicates whether the associated control should scroll while the user is dragging a scrollbar thumb.

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

    Value

    Gets / sets the starting value of the scroll bar.

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

    Methods

    OnBackColorChanged(EventArgs)

    Declaration
    protected override void OnBackColorChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    OnHandleCreated(EventArgs)

    Creates the handler. Overridden to help set up scrollbar information.

    Declaration
    protected override void OnHandleCreated(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    OnHandleDestroyed(EventArgs)

    Declaration
    protected override void OnHandleDestroyed(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    Refresh()

    Declaration
    public override void Refresh()

    ResetBackColor()

    Resets the backcolor of the scroll bar.

    Declaration
    public override void ResetBackColor()

    WndProc(ref Message)

    Declaration
    protected override void WndProc(ref Message m)
    Parameters
    Type Name Description
    System.Windows.Forms.Message m

    Explicit Interface Implementations

    IScrollBar.get_Enabled()

    Declaration
    bool IScrollBar.get_Enabled()
    Returns
    Type Description
    System.Boolean

    IScrollBar.set_Enabled(Boolean)

    Declaration
    void IScrollBar.set_Enabled(bool value)
    Parameters
    Type Name Description
    System.Boolean value

    IScrollBar.UpdateScrollInfo()

    Declaration
    void IScrollBar.UpdateScrollInfo()

    Implements

    IScrollBar

    See Also

    FlatVScrollBar
    FlatHScrollBar
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved