WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfScrollFrame

    Show / Hide Table of Contents

    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
    IThemeProvider
    IVisualStyle
    System.IDisposable
    System.Windows.Forms.IMessageFilter
    Inherited Members
    BaseComponent.GetActiveThemeName()
    BaseComponent.OnCanApplyThemeChanged(Boolean)
    BaseComponent.OnCanOverrideStyleChanged(Boolean)
    BaseComponent.ThemeName
    BaseComponent.CanOverrideStyle
    BaseComponent.IThemeProvider.BaseThemeName
    BaseComponent.CanApplyTheme
    BaseComponent.ControlName
    BaseComponent.IVisualStyle.VisualTheme
    BaseComponent.IsVisualStyleEnabled
    BaseComponent.ThemeNameChanged
    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 Description
    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 Description
    HorizontalScrollBar

    Style

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

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

    VerticalScrollBar

    Gets the vertical scrollbar of the attached scroller frame.

    Declaration
    public VerticalScrollBar VerticalScrollBar { get; }
    Property Value
    Type Description
    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
    BaseComponent.GetControlName(String)

    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
    BaseComponent.OnThemeNameChanged(String)

    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
    BaseComponent.RaiseThemeChanged(Object, ThemeChangedEventArgs)

    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 Description
    ThemeChangedEventHandler

    Implements

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