Class ChartScrollBar

Abstract class that implements the basic functionality of IChartScrollBar interface.

Inheritance

System.Object

ChartScrollBar

ChartHScrollBar

ChartVScrollBar

Implements

IChartScrollBar

Namespace: Syncfusion.Windows.Forms.Chart.Scrolling

Assembly: Syncfusion.Chart.Base.dll

Syntax

public abstract class ChartScrollBar : UserControl, IChartScrollBar

Constructors

ChartScrollBar()

Initializes a new instance of the ChartScrollBar class.

Declaration

public ChartScrollBar()

Fields

m_otherVisible

Indicates whether complementary scrollbar is visible.

Declaration

protected bool m_otherVisible

Field Value

Type
System.Boolean

m_scrollBar

The ScrollBar instance.

Declaration

protected ScrollBar m_scrollBar

Field Value

Type
System.Windows.Forms.ScrollBar

m_visibleInst

Indicates the visibility of control.

Declaration

protected bool m_visibleInst

Field Value

Type
System.Boolean

m_zoomButton

The ChartZoomButton instance.

Declaration

protected ChartZoomButton m_zoomButton

Field Value

Type
ChartZoomButton

Properties

ChartArea

Used for storing chart area reference.

Declaration

public IChartArea ChartArea { get; set; }

Property Value

Type
IChartArea

ChartAxis

Used for storing chart area reference.

Declaration

public ChartAxis ChartAxis { get; set; }

Property Value

Type
ChartAxis

Dimension

Returns the dimensions of the scroll bar. That is the width for vertical scroll bars and the height for horizontal ones.

Declaration

public int Dimension { get; }

Property Value

Type
System.Int32

LargeChange

Gets or sets the scroll bar's large change value.

Declaration

public int LargeChange { get; set; }

Property Value

Type
System.Int32

Maximum

Gets or sets the scroll bar's maximum value.

Declaration

public int Maximum { get; set; }

Property Value

Type
System.Int32

Minimum

Gets or sets the scroll bar's minimum value.

Declaration

public int Minimum { get; set; }

Property Value

Type
System.Int32

ScrollBar

Returns the Windows scrollbar instance.

Declaration

public ScrollBar ScrollBar { get; }

Property Value

Type
System.Windows.Forms.ScrollBar

ShouldPosition

Indicates whether the chart should attempt to position this scrollbar.

Declaration

public bool ShouldPosition { get; }

Property Value

Type
System.Boolean

SmallChange

Gets or sets the scroll bar's small change value.

Declaration

public int SmallChange { get; set; }

Property Value

Type
System.Int32

Value

Gets or sets the scroll bar's current value.

Declaration

public int Value { get; set; }

Property Value

Type
System.Int32

Visible

Gets or sets value indicates visibility of scroll bar.

Declaration

public virtual bool Visible { get; set; }

Property Value

Type
System.Boolean

ZoomButton

Gets the zoom button.

Declaration

public ChartZoomButton ZoomButton { get; }

Property Value

Type	Description
ChartZoomButton	The zoom button.

Methods

CreateScrollBar()

Creates the scroll bar.

Declaration

protected abstract ScrollBar CreateScrollBar()

Returns

Type
System.Windows.Forms.ScrollBar

OnLayout()

Arranges controls.

Declaration

protected abstract void OnLayout()

OnSizeChanged(EventArgs)

Raises the System.Windows.Forms.Control.SizeChanged event.

Declaration

protected override void OnSizeChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	An System.EventArgs that contains the event data.

ResetScrollBar()

Resets the scrollbar.

Declaration

[Obsolete("This method isn't used anymore and might be deleted.")]
public abstract void ResetScrollBar()

SetOtherVisible(Boolean)

Informs this scroll bar that it's complementary scroll bar's visibilty has changed.

Declaration

[Obsolete("This method isn't used anymore and might be deleted.")]
public void SetOtherVisible(bool b)

Parameters

Type	Name	Description
System.Boolean	b	Visibility flag.

SetPosition(Rectangle)

Sets the position of this scroll bar if the scroll bar is contained within the chart.

Declaration

public virtual void SetPosition(Rectangle rect)

Parameters

Type	Name	Description
System.Drawing.Rectangle	rect	Bounding rectangle.

Events

ValueChanged

Occurs when scroll value is changed.

Declaration

public event ChartScrollBarValueChangedEventHandler ValueChanged

Event Type

Type
Syncfusion.Windows.Forms.Chart.Scrolling.ChartScrollBarValueChangedEventHandler

ZoomButtonClicked

Occurs when zoom button is clicked.

Declaration

public event ChartScrollBarZoomButtonClickedEventHandler ZoomButtonClicked

Event Type

Type
Syncfusion.Windows.Forms.Chart.Scrolling.ChartScrollBarZoomButtonClickedEventHandler

Implements

IChartScrollBar