CommonDialog
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.1.0.0)
Specifies the base class used for displaying dialog boxes on the screen.
- C#
- VB.NET
public class CommonDialog : Component
Public Class CommonDialog
Inherits Component
Constructors
CommonDialog()
Initializes a new instance of CommonDialog.
CommonDialog(container)
Initializes a new instance of the CommonDialog extender with a specified container.
| Name | Type | Description |
|---|---|---|
| container | IContainer | An IContainer that represents the container of the CommonDialog component. |
Properties
DialogTemplate
Type: Returns or sets the type of the common dialog UI control to show when calling the ShowDialog method. (Default: null)
Tag
Object: Returns or sets an object that contains data about the control. (Default: null)
Title
String: Returns or sets the dialog box title. (Default: "")
WindowState
FormWindowState: Returns or sets the initial WindowState of the common dialog. (Default: Normal)
Methods
CreateUI()
Creates the UI for the CommonDialog.
Returns: Form. An instance of Form.
Dispose(disposing)
| Parameter | Type | Description |
|---|---|---|
| disposing | Boolean |
OnHelpRequested(e)
Fires the HelpRequested event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | An HelpEventArgs that provides the event data. |
Reset()
When overridden in a derived class, resets the properties of a common dialog box to their default values.
ShowDialog()
Runs a common dialog box with a default owner.
Returns: DialogResult. OK if the user clicks OK in the dialog box; otherwise, Cancel.
ShowDialog(onclose)
Runs a common dialog box with a default owner.
| Parameter | Type | Description |
|---|---|---|
onclose  | Action<DialogResult> | Optional async handler for the close event; called when the form/dialog has been closed. It's the equivalent of handling the event. When the onclose event handler is specified, the modal dialog doesn't suspend the execution on the server but it's still shown as a modal dialog on the client. |
Returns: DialogResult. OK if the user clicks OK in the dialog box; otherwise, Cancel.
ShowDialog(owner)
Runs a common dialog box with the specified owner.
| Parameter | Type | Description |
|---|---|---|
| owner | Form | A Form that represents the top-level window that owns the modal dialog box. It can be null. |
Returns: DialogResult. OK if the user clicks OK in the dialog box; otherwise, Cancel.
ShowDialog(owner, onclose)
Runs a common dialog box with the specified owner.
| Parameter | Type | Description |
|---|---|---|
| owner | Form | A Form that represents the top-level window that owns the modal dialog box. It can be null. |
| onclose | Action<DialogResult> | Optional async handler for the close event; called when the form/dialog has been closed. It's the equivalent of handling the event. When the onclose event handler is specified, the modal dialog doesn't suspend the execution on the server but it's still shown as a modal dialog on the client. |
Returns: DialogResult. OK if the user clicks OK in the dialog box; otherwise, Cancel.
ShowDialogAsync(owner)
Runs a common dialog box with the specified owner asynchronously.
| Parameter | Type | Description |
|---|---|---|
| owner | Form | A Form that represents the top-level window that owns the modal dialog box. It can be null. |
Returns: Task<DialogResult>. OK if the user clicks OK in the dialog box; otherwise, Cancel.
Events
HelpRequested
EventHandler Fired when the user clicks the Help button on a common dialog box.
Inherited By
| Name | Description |
|---|---|
| ColorDialog | Represents a common dialog box that displays available colors along with controls that enable the user to define custom colors. |
| FileDialog | Displays a dialog box from which the user can select a file. |
| FolderBrowserDialog | Allows the user to select a folder from one of the Roots. |
| OpenFileDialog | Prompts the user to open a file from the server. |
| SaveFileDialog | Prompts the user to select a location for saving a file on the server. |