This documentation is archived and is not being maintained.

DataGrid.AllowNavigation Property

Gets or sets a value indicating whether navigation is allowed.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in

public bool AllowNavigation { get; set; }
/** @property */
public boolean get_AllowNavigation ()

/** @property */
public void set_AllowNavigation (boolean value)

public function get AllowNavigation () : boolean

public function set AllowNavigation (value : boolean)

Not applicable.

Property Value

true if navigation is allowed; otherwise, false. The default is true.

If this property is set to false, links to child tables are not shown.

The following code example toggles the AllowNavigation property between the true and false.

// Create an instance of the 'AllowNavigationChanged' EventHandler.
private void CallAllowNavigationChanged()
   myDataGrid.AllowNavigationChanged += 
                                   new EventHandler(Grid_AllowNavChange);

// Set the 'AllowNavigation' property on click of a button.
private void myButton_Click(object sender, EventArgs e)
   if (myDataGrid.AllowNavigation == true)
      myDataGrid.AllowNavigation = false;
      myDataGrid.AllowNavigation = true;

// Raise the event when 'AllowNavigation' property is changed.
private void Grid_AllowNavChange(object sender, EventArgs e)
   string myString = "AllowNavigationChanged event raised, Navigation ";
   bool myBool = myDataGrid.AllowNavigation;
   // Create appropriate alert message.
   myString = myString + (myBool ? " is " : " is not ") + "allowed";
   // Show information about navigation.
   MessageBox.Show(myString, "Navigation information");

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0