DataGrid.AllowNavigation Property

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a value indicating whether navigation is allowed.

public:
 property bool AllowNavigation { bool get(); void set(bool value); };

public bool AllowNavigation { get; set; }

member this.AllowNavigation : bool with get, set

Public Property AllowNavigation As Boolean

Property Value

Boolean

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

Examples

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

private:
   // Create an instance of the 'AllowNavigationChanged' EventHandler.
   void CallAllowNavigationChanged()
   {
      myDataGrid->AllowNavigationChanged += gcnew EventHandler( this, &MyDataGrid::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;
      else
            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 = String::Concat( myString, myBool ? (String^)" is " : " is not ", "allowed" );

      // Show information about navigation.
      MessageBox::Show( myString, "Navigation information" );
   }

// 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;
   else
      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");
}

' Create an instance of the 'AllowNavigationChanged' EventHandler.
Private Sub CallAllowNavigationChanged()
   AddHandler myDataGrid.AllowNavigationChanged, AddressOf Grid_AllowNavChange
End Sub


' Set the 'AllowNavigation' property on click of a button.
 Private Sub myButton_Click(ByVal sender As Object, ByVal e As EventArgs)
     If myDataGrid.AllowNavigation = True Then
         myDataGrid.AllowNavigation = False
     Else
         myDataGrid.AllowNavigation = True
     End If
 End Sub
 
' Raise the event when 'AllowNavigation' property is changed.
 Private Sub Grid_AllowNavChange(ByVal sender As Object, ByVal e As EventArgs)
     Dim myString As String = "AllowNavigationChanged event raised, Navigation "
     Dim myBool As Boolean = myDataGrid.AllowNavigation
     ' Create appropriate alert message.
     myString = myString + IIF(mybool, "is", "is not") + "allowed"
     ' Show information about navigation.
     MessageBox.Show(myString, "Navigation information")
 End Sub

Remarks

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

Applies to

Share via