NavigateEventArgs Class (System.Windows.Forms)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
NavigateEventArgs Class

Provides data for the Navigate event.

Inheritance Hierarchy
System.Object
  System.EventArgs
    System.Windows.Forms.NavigateEventArgs

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
Syntax
Visual Basic
<ComVisibleAttribute(True)> _
Public Class NavigateEventArgs _
	Inherits EventArgs
C#
[ComVisibleAttribute(true)]
public class NavigateEventArgs : EventArgs
Visual C++
[ComVisibleAttribute(true)]
public ref class NavigateEventArgs : public EventArgs
F#
[<ComVisibleAttribute(true)>]
type NavigateEventArgs =  
    class
        inherit EventArgs
    end

The NavigateEventArgs type exposes the following members.

Constructors
  Name Description
Public method NavigateEventArgs Initializes a new instance of the NavigateEventArgs class.
Top
Properties
  Name Description
Public property Forward Gets a value indicating whether to navigate in a forward direction.
Top
Methods
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Remarks

For more information about handling events, see Consuming Events.

Examples

The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the Navigate event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing Show with Console.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a project that contains an instance of type DataGrid named DataGrid1. Then ensure that the event handler is associated with the Navigate event.

Visual Basic

Private Sub DataGrid1_Navigate(sender as Object, e as NavigateEventArgs) _ 
     Handles DataGrid1.Navigate

    Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "Forward", e.Forward)
    messageBoxVB.AppendLine()
    MessageBox.Show(messageBoxVB.ToString(),"Navigate Event")

End Sub
C#

private void DataGrid1_Navigate(Object sender, NavigateEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "Forward", e.Forward );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "Navigate Event" );
}
Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

System.Windows.Forms Namespace
NavigateEventHandler
DataGrid