Form.Modal Property (System.Windows.Forms)

Modal Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

Form..::.Modal Property

Gets a value indicating whether this form is displayed modally.

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

Syntax

Visual Basic

<BrowsableAttribute(False)> _
Public ReadOnly Property Modal As Boolean

[BrowsableAttribute(false)]
public bool Modal { get; }

Visual C++

[BrowsableAttribute(false)]
public:
property bool Modal {
    bool get ();
}

[<BrowsableAttribute(false)>]
member Modal : bool

Property Value

Type: System..::.Boolean
true if the form is displayed modally; otherwise, false.

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.

Examples

The following code 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.

Visual Basic

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

        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;
            }
        }

Visual C++

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;
      }
   }

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.

Reference

Form Class

System.Windows.Forms Namespace

ShowDialog