Infragistics logo
메뉴
.NET and JavaScript UI Controls
Version

BeforeRowRegionScroll Event

Occurs before a row scrolling region is scrolled.
Syntax
'Declaration
 
Public Event BeforeRowRegionScroll As BeforeRowRegionScrollEventHandler
public event BeforeRowRegionScrollEventHandler BeforeRowRegionScroll
Event Data

The event handler receives an argument of type BeforeRowRegionScrollEventArgs containing data related to this event. The following BeforeRowRegionScrollEventArgs properties provide information specific to this event.

PropertyDescription
Cancel (Inherited from System.ComponentModel.CancelEventArgs) 
NewState The new state row scroll region (read-only)
OldState The old state row scroll region (read-only)
Remarks

The newstate argument returns a reference to a RowScrollRegion object that can be used to set properties of, and invoke methods on, the rowscrollregion as it exists after the scroll. You can use this reference to access any of the returned rowscrollregion's properties or methods.

The oldstate argument returns a reference to a RowScrollRegion object that can be used to set properties of, and invoke methods on, the rowscrollregion as it will exist after the scroll. You can use this reference to access any of the returned rowscrollregion's properties or methods.

The cancel argument enables you to programmatically prevent the rowscrollregion from scrolling. This argument can be used to prevent the user from scrolling unless a certain condition is met.

This event is generated before a rowscrollregion is scrolled, either programmatically, or by user interaction. A rowscrollregion can be scrolled programmatically by invoking its Scroll method.

The ScrollBar property of a scrolling region determines whether a scroll bar is displayed for that scrolling region.

The AfterRowRegionScroll event, which occurs after a rowscrollregion was scrolled, is generated after this event, provided cancel is not set to True.

The BeforeColRegionScroll event is generated before a colscrollregion is scrolled.

Example
Following code prevents rows from scrolling by canceling BeforeRowRegionScroll event.

For an overview of how to handle events in Visual Basic or Visual C#, see Event Handlers in Visual Basic and Visual C#. For specific information and code examples illustrating how to consume events in your application, see Consuming Events in the .NET Framework Developer's Guide.

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid
Imports System.Diagnostics

   Private Sub UltraGrid1_BeforeRowRegionScroll(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinGrid.BeforeRowRegionScrollEventArgs) Handles ultraGrid1.BeforeRowRegionScroll

       ' There may be circumstances where you may want to conditionally prevent the user
       ' from scrolling. To accomplish that, you can hook into the BeforeRowRegionScroll 
       ' event and cancel it when it gets fired.

       If Me.chkLockScrolling.Checked Then e.Cancel = True

       ' Write old and the new positions of the scroll bar.
       Debug.WriteLine("Old top row index = " & e.OldState.FirstRow.Index)
       Debug.WriteLine("New top row index = " & e.NewState.FirstRow.Index)

   End Sub
using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;

private void ultraGrid1_BeforeRowRegionScroll(object sender, Infragistics.Win.UltraWinGrid.BeforeRowRegionScrollEventArgs e)
{

	// There may be circumstances where you may want to conditionally prevent the user
	// from scrolling. To accomplish that, you can hook into the BeforeRowRegionScroll 
	// event and cancel it when it gets fired.

	if ( this.chkLockScrolling.Checked )
		e.Cancel = true;

	// Write old and the new positions of the scroll bar.
	Debug.WriteLine( "Old top row index = " + e.OldState.FirstRow.Index );
	Debug.WriteLine( "New top row index = " + e.NewState.FirstRow.Index );

}
Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also