Form.Modal Property

Definition

Gets a value indicating whether this form is displayed modally.

public:
 property bool Modal { bool get(); };
[System.ComponentModel.Browsable(false)]
public bool Modal { get; }
[<System.ComponentModel.Browsable(false)>]
member this.Modal : bool
Public ReadOnly Property Modal As Boolean

Property Value

true if the form is displayed modally; otherwise, false.

Attributes

Examples

The following example uses the Modal property to determine if a form is displayed as a modal form. If it is not the FormBorderStyle and TopLevel properties are changed to make the form a non-top-level form with a tool window border.

private:
   void ShowMyNonModalForm()
   {
      Form^ myForm = gcnew Form;
      myForm->Text = "My Form";
      myForm->SetBounds( 10, 10, 200, 200 );
      myForm->Show();

      // Determine if the form is modal.
      if ( myForm->Modal == false )
      {
         // Change borderstyle and make it not a top level window.
         myForm->FormBorderStyle = ::FormBorderStyle::FixedToolWindow;
         myForm->TopLevel = false;
      }
   }
private void ShowMyNonModalForm()
{
    Form myForm = new Form();
    myForm.Text = "My Form";
    myForm.SetBounds(10,10,200,200);

    myForm.Show();
    // Determine if the form is modal.
    if(myForm.Modal == false)
    {
        // Change borderstyle and make it not a top level window.
        myForm.FormBorderStyle = FormBorderStyle.FixedToolWindow;
        myForm.TopLevel = false;
    }
}
Private Sub ShowMyNonModalForm()
    Dim myForm As New Form()
    myForm.Text = "My Form"
    myForm.SetBounds(10, 10, 200, 200)

    myForm.Show()
    ' Determine if the form is modal.
    If myForm.Modal = False Then
        ' Change borderstyle and make it not a top level window.
        myForm.FormBorderStyle = FormBorderStyle.FixedToolWindow
        myForm.TopLevel = False
    End If
End Sub

Remarks

When a form is displayed modally, no input (keyboard or mouse click) can occur except to objects on the modal form. The program must hide or close a modal form (usually in response to some user action) before input to another form can occur. Forms that are displayed modally are typically used as dialog boxes in an application.

You can use this property to determine whether a form that you have obtained from a method or property has been displayed modally.

To display a form modally use the ShowDialog method.

Applies to

See also