Class ScrollInfo
Provides all properties to configure a scrollbar.
Inheritance
Namespace: Syncfusion.GridCommon.ScrollAxis
Assembly: Syncfusion.GridCommon.Portable.dll
Syntax
public class ScrollInfo : Object, IScrollBar, INotifyPropertyChangedConstructors
ScrollInfo()
Initializes a new instance of the ScrollInfo class.
Declaration
public ScrollInfo()Properties
Enabled
Gets or sets a value indicating whether the scroll bar is enabled or not.
Declaration
public bool Enabled { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | A boolean value that indicates whether the scroll bar is enabled. |
LargeChange
Gets or sets a value to be added to or subtracted from the value of the property when the scroll box is moved a large distance.
Declaration
public double LargeChange { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | A value to be added to or subtracted from the value of the property when the scroll box is moved a large distance. |
Maximum
Gets or sets the upper limit of values of the scrollable range.
Declaration
public double Maximum { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The upper limit of values of the scrollable range. |
Minimum
Gets or sets the lower limit of values of the scrollable range.
Declaration
public double Minimum { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The lower limit of values of the scrollable range. |
SmallChange
Gets or sets the value to be added to or subtracted from the value of the property when the scroll box is moved a small distance.
Declaration
public double SmallChange { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The value to be added to or subtracted from the value of the property when the scroll box is moved a small distance. |
Value
Gets or sets a numeric value that represents the current position of the scroll box on the scroll bar control.
Declaration
public double Value { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | A numeric value that represents the current position of the scroll box on the scroll bar control. |
Methods
add_ValueChanging(ValueChangingEventHandler)
Declaration
public void add_ValueChanging(ValueChangingEventHandler value)Parameters
| Type | Name | Description |
|---|---|---|
| ValueChangingEventHandler | value |
Clone()
Clones this instance.
Declaration
public ScrollInfo Clone()Returns
| Type | Description |
|---|---|
| ScrollInfo | The cloned instance. |
CopyTo(ScrollInfo)
Copies current settings to another object.
Declaration
public void CopyTo(ScrollInfo scrollBar)Parameters
| Type | Name | Description |
|---|---|---|
| ScrollInfo | scrollBar | The object to which the settings is to be copied. |
Equals(Object)
Determines whether the specified ScrollInfo is equal to the current ScrollInfo.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | The ScrollInfo to compare with the current ScrollInfo. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the specified ScrollInfo is equal to the current ScrollInfo, otherwise false. |
GetHashCode()
Serves as a hash function for a particular type.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 | A hash code for the current ScrollInfo. |
OnPropertyChanged(String)
Called when a property is changed and raises the PropertyChanged event.
Declaration
protected virtual void OnPropertyChanged(string propertyName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | propertyName | Name of the property. |
remove_ValueChanging(ValueChangingEventHandler)
Declaration
public void remove_ValueChanging(ValueChangingEventHandler value)Parameters
| Type | Name | Description |
|---|---|---|
| ValueChangingEventHandler | value |
ToString()
Returns a System.String that represents the current System.Object.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String | A System.String that represents the current System.Object. |
Events
PropertyChanged
Occurs when a property value changes.
Declaration
public event PropertyChangedEventHandler PropertyChangedEvent Type
| Type |
|---|
| System.ComponentModel.PropertyChangedEventHandler |
ValueChanged
Occurs when the current position of the scroll box on the scroll bar has changed.
Declaration
public event EventHandler ValueChangedEvent Type
| Type |
|---|
| System.EventHandler |
ValueChanging
Occurs when the current position of the scroll box on the scroll bar is being changed.
Declaration
public event ValueChangingEventHandler ValueChangingEvent Type
| Type |
|---|
| ValueChangingEventHandler |