CommonDialog::ShowDialog Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Runs a common dialog box with a default owner.

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

public:
DialogResult ShowDialog()

Return Value

Type: System.Windows.Forms::DialogResult

DialogResult::OK if the user clicks OK in the dialog box; otherwise, DialogResult::Cancel.

This method implements RunDialog.

The following code example uses the ColorDialog implementation of CommonDialog and illustrates creating and showing a dialog box. This example requires that the method is called from within an existing form, which has a TextBox and Button placed on it.

private:
   void button1_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      ColorDialog^ MyDialog = gcnew ColorDialog;
      // Keeps the user from selecting a custom color.
      MyDialog->AllowFullOpen = false;
      // Allows the user to get help. (The default is false.)
      MyDialog->ShowHelp = true;
      // Sets the initial color select to the current text color.
      MyDialog->Color = textBox1->ForeColor;

      // Update the text box color if the user clicks OK 
      if ( MyDialog->ShowDialog() == ::System::Windows::Forms::DialogResult::OK )
      {
         textBox1->ForeColor = MyDialog->Color;
      }
   }

PrintingPermission

to print from a PrintDialog. Associated enumeration: PrintingPermissionLevel::SafePrinting

UIPermission

for safe subwindows to call this method. Associated enumeration: UIPermissionWindow::SafeSubWindows

.NET Framework
Available since 1.1
Return to top
Show: