1 of 96

Containers

Accordion

Wisej.Web.Accordion

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Control
- Accordion

Displays collapsible set of AccordionPanel panels for presenting information in a limited amount of space.

public class Accordion : Control, ISupportInitialize

Public Class Accordion
    Inherits Control
    Implements ISupportInitialize

Constructors

Accordion()

Initializes a new instance of the Accordion class.

Properties

BorderStyle

BorderStyle: Returns or sets the type of border that is drawn around the Accordion panel.

Collapsible

Boolean: Returns or sets a value indicating whether the Accordion control collapses when all the AccordionPanel children are collapsed.

When this property is set to false (default) one panel is always expanded.

Rectangle: Returns the rectangle that represents the virtual display area of the control.

Int32: Returns or sets the size of the header. When the header is horizontal, the size if the height; when it's vertical, the size if the width. Set it to -1 to reset to the size set in the current theme.

ImageList: Returns or sets the images to display on the panel's title bar.

Int32: Returns the number of panels in the container.

PanelCollection: Returns the collection of panels in the container.

Int32: Returns or sets the index of the currently selected panel.

Throws:

ArgumentOutOfRangeException The value is less than -1.

Boolean: Returns or sets a value indicating whether the selected panel is moved to the top of the Accordion container.

AccordionPanel: Returns or sets the currently selected panel.

Boolean: Returns or sets whether a panel's ToolTip is shown when the mouse passes over the panel's title.

Methods

Makes the AccordionPanel following the AccordionPanel with the specified index the current panel.

Throws:

ArgumentOutOfRangeException index is less than 0 or greater than the number of AccordionPanel controls in the Panels collection minus 1.

Makes the AccordionPanel following the specified AccordionPanel the current panel.

Throws:

ArgumentNullException panel is null.

Makes the AccordionPanel following the AccordionPanel the specified name the current panel.

Throws:

ArgumentNullException panelName is null; or panelName does not match the Name property of any AccordionPanel in the Panels collection.

Returns the AccordionPanel panel at the specified location.

Returns: Control. The AccordionPanel at the specified location.

Throws:

ArgumentOutOfRangeException index is less than 0 or greater than the number of AccordionPanel controls in the Panels collection minus 1.

Makes the AccordionPanel with the specified index the current AccordionPanel.

Throws:

ArgumentOutOfRangeException index is less than 0 or greater than the number of AccordionPanel controls in the Panels collection minus 1.

Makes the specified AccordionPanel the current AccordionPanel.

Throws:

ArgumentNullException panel is null.

Makes AccordionPanel with the specified name the current AccordionPanel.

Throws:

ArgumentNullException panelName is null; or panelName does not match the Name property of any AccordionPanel in the Panels collection.

Events

AccordionEventHandler Fired when a panel is deselected.

AccordionCancelEventHandler Occurs before a panel is deselected, enabling a handler to cancel the panel change.

AccordionEventHandler Fired when a panel is selected.

EventHandler Fired when the SelectedIndex property has changed.

AccordionCancelEventHandler Occurs before a panel is selected, enabling a handler to cancel the panel change.

Implements

AccordionAction

Wisej.Web.AccordionAction

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Defines values representing Accordion events.

public enum AccordionAction : Enum

Public Enum AccordionAction As [Enum]

Fields

Name

Description

Used By

Name

Description

AccordionCancelEventArgs

Wisej.Web.AccordionCancelEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the Selecting and Deselecting events of a Accordion control.

public class AccordionCancelEventArgs : CancelEventArgs

Public Class AccordionCancelEventArgs
    Inherits CancelEventArgs

Constructors

AccordionCancelEventArgs(panel, panelIndex, cancel, action)

Initializes a new instance of the AccordionCancelEventArgs class.

Name

Type

Description

Properties

Action

AccordionAction: Returns a value indicating which event is occurring.

Panel

AccordionPanel: Returns the AccordionPanel the event is occurring for.

Int32: Returns the zero-based index of the Panel in the Panels collection.

Used By

AccordionCancelEventHandler

Wisej.Web.AccordionCancelEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the Selecting or Deselecting event of a Accordion control.

public delegate void AccordionCancelEventHandler(Object sender, AccordionCancelEventArgs e)

Public Delegate Sub AccordionCancelEventHandler(ByVal sender As [Object], ByVal e As AccordionCancelEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

AccordionEventArgs

Wisej.Web.AccordionEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the Selected and Deselected events of a Accordion control.

public class AccordionEventArgs : EventArgs

Public Class AccordionEventArgs
    Inherits EventArgs

Constructors

AccordionEventArgs(panel, panelIndex, action)

Initializes a new instance of the AccordionEventArgs class.

Name

Type

Description

Properties

Action

AccordionAction: Returns a value indicating which event is occurring.

Panel

AccordionPanel: Returns the AccordionPanel the event is occurring for.

Int32: Returns the zero-based index of the Panel in the Panels collection.

Used By

AccordionEventHandler

Wisej.Web.AccordionEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the Selected or Deselected event of a Accordion control.

public delegate void AccordionEventHandler(Object sender, AccordionEventArgs e)

Public Delegate Sub AccordionEventHandler(ByVal sender As [Object], ByVal e As AccordionEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

AccordionPanel

Wisej.Web.AccordionPanel

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Control
- ScrollableControl
  - Panel
    AccordionPanel

Represents a panel in a Accordion control.

public class AccordionPanel : Panel

Public Class AccordionPanel
    Inherits Panel

Constructors

AccordionPanel()

Initializes a new instance of the AccordionPanel class.

AccordionPanel(text)

Initializes a new instance of the AccordionPanel class and specifies the text to display as the title of the panel.

Name

Type

Description

Properties

Accordion: Returns the parent Accordion control.

Boolean: Returns whether the AccordionPanel is collapsed.

Boolean: Returns or sets a value indicating that the panel can show the expand button on the title bar.

String: Returns or sets the text to display as the title of the AccordionPanel.

ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this control.

Methods

Retrieves the panel that contains the specified Control.

Returns: AccordionPanel. The AccordionPanel that contains the specified Control, or null if it cannot be found.

Overridden to update the parent Accordion when in design mode.

Implements

ContainerControl

Wisej.Web.ContainerControl

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Control
- ScrollableControl
  - ContainerControl

Provides focus-management functionality for controls that can function as a container for other controls.

public class ContainerControl : ScrollableControl, IContainerControl, IContainerControl

Public Class ContainerControl
    Inherits ScrollableControl
    Implements IContainerControl, IContainerControl

Constructors

ContainerControl()

Initializes a new instance of the ContainerControl class.

Properties

Accelerators

Keys[]: Returns or sets a collection of keys that fire the Accelerator event when the user presses the accelerator key while the focus is on any child control.

ActiveControl

Control: Returns or sets the active control on the container control.

Throws:

ArgumentException The Control assigned could not be activated.

BindingContext: Returns or sets the BindingContext for the control.

Boolean: Returns or sets whether the container will receive key events before the event is passed to the control that has focus.

Form: Returns the Form that the container control is assigned to.

Page: Returns the Page that the container control is assigned to.

Boolean: Enables or disables right-to-left layout when the value of RightToLeft is Yes

Methods

Validates the last unvalidated control and its ancestors up through, but not including the current control.

Returns: Boolean.

Validates the last unvalidated control and its ancestors up through, but not including the current control.

Returns: Boolean.

Events

AcceleratorEventHandler Fired when one of the Accelerators key is pressed.

EventHandler Fired when the value of the RightToLeftLayout property changes.

Inherited By

Implements

AcceleratorEventArgs

Wisej.Web.AcceleratorEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

KeyEventArgs
- AcceleratorEventArgs

Provides data for the Accelerator event.

public class AcceleratorEventArgs : KeyEventArgs

Public Class AcceleratorEventArgs
    Inherits KeyEventArgs

Constructors

AcceleratorEventArgs(keyData, component)

Initializes a new instance of the KeyEventArgs class.

Name

Type

Description

Properties

Component

IWisejComponent: Returns the Wisej component that generated the "keydown" event'.

Used By

AcceleratorEventHandler

Wisej.Web.AcceleratorEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the Accelerator event.

public delegate void AcceleratorEventHandler(Object sender, AcceleratorEventArgs e)

Public Delegate Sub AcceleratorEventHandler(ByVal sender As [Object], ByVal e As AcceleratorEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

DataRepeater

Wisej.Web.DataRepeater

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Displays data in a customizable list format.

Constructors

DataRepeater()

Initializes a new instance of the class.

Properties

AllowUserToAddItems

: Returns or sets whether users can add a new row to the at run time.

Methods

Throws:

Events

Implements

DataRepeaterAddRemoveItemsCancelEventArgs

Wisej.Web.DataRepeaterAddRemoveItemsCancelEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the UserDeletingItems event.

public class DataRepeaterAddRemoveItemsCancelEventArgs : CancelEventArgs

Public Class DataRepeaterAddRemoveItemsCancelEventArgs
    Inherits CancelEventArgs

Constructors

DataRepeaterAddRemoveItemsCancelEventArgs(index, count)

Initializes a new instance of the DataRepeaterAddRemoveItemsCancelEventArgs class.

Name

Type

Description

Properties

ItemCount

Int32: Gets the number of items being deleted.

ItemIndex

Int32: Returns the index of the item that is being deleted.

Used By

DataRepeaterAddRemoveItemsCancelEventHandler

Wisej.Web.DataRepeaterAddRemoveItemsCancelEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that handles the UserDeletingItems event.

public delegate void DataRepeaterAddRemoveItemsCancelEventHandler(Object sender, DataRepeaterAddRemoveItemsCancelEventArgs e)

Public Delegate Sub DataRepeaterAddRemoveItemsCancelEventHandler(ByVal sender As [Object], ByVal e As DataRepeaterAddRemoveItemsCancelEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

DataRepeaterAddRemoveItemsEventArgs

Wisej.Web.DataRepeaterAddRemoveItemsEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the ItemsAdded, ItemsRemoved, UserAddedItems, and UserDeletedItems events.

public class DataRepeaterAddRemoveItemsEventArgs : EventArgs

Public Class DataRepeaterAddRemoveItemsEventArgs
    Inherits EventArgs

Constructors

DataRepeaterAddRemoveItemsEventArgs(index, count)

Initializes a new instance of the DataRepeaterAddRemoveItemsEventArgs class.

Name

Type

Description

Properties

ItemCount

Int32: Return the number of items being added to or deleted from a DataRepeater control.

ItemIndex

Int32: Returns the index of the item being added or deleted.

Used By

DataRepeaterAddRemoveItemsEventHandler

Wisej.Web.DataRepeaterAddRemoveItemsEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the ItemsAdded, ItemsRemoved, UserAddedItems, and UserDeletedItems events.

public delegate void DataRepeaterAddRemoveItemsEventHandler(Object sender, DataRepeaterAddRemoveItemsEventArgs e)

Public Delegate Sub DataRepeaterAddRemoveItemsEventHandler(ByVal sender As [Object], ByVal e As DataRepeaterAddRemoveItemsEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

DataRepeaterDataErrorEventArgs

Wisej.Web.DataRepeaterDataErrorEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the event.

Constructors

DataRepeaterDataErrorEventArgs(item, control, property, ex)

Initializes a new instance of the class.

Name

Type

Description

Throws:

ex is null.

Properties

Control

Used By

DataRepeaterDataErrorEventHandler

Wisej.Web.DataRepeaterDataErrorEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the DataError event.

public delegate void DataRepeaterDataErrorEventHandler(Object sender, DataRepeaterDataErrorEventArgs e)

Public Delegate Sub DataRepeaterDataErrorEventHandler(ByVal sender As [Object], ByVal e As DataRepeaterDataErrorEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

DataRepeaterItem

Wisej.Web.DataRepeaterItem

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Used by the control to display data at run time.

Constructors

DataRepeaterItem()

Initializes a new instance of the object.

Properties

IsCurrent

: Return a value that determines whether a is the currently selected item in a control.

Implements

DataRepeaterItemCloneEventHandler

Wisej.Web.DataRepeaterItemCloneEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the ItemCloning event.

public delegate void DataRepeaterItemCloneEventHandler(Object sender, DataRepeaterItemCloneEventArgs e)

Public Delegate Sub DataRepeaterItemCloneEventHandler(ByVal sender As [Object], ByVal e As DataRepeaterItemCloneEventArgs)

Parameters

Name

Type

Description

Fired By

Name

Description

DataRepeaterItemEventArgs

Wisej.Web.DataRepeaterItemEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the event.

Constructors

DataRepeaterItemEventArgs(item)

Initializes a new instance of the class.

Name

Type

Description

Properties

DataRepeaterItem

: Returns a instance that triggered the event.

Used By

Name

Description

DataRepeaterItemEventHandler

Wisej.Web.DataRepeaterItemEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the event.

Parameters

Name

Type

Description

Fired By

Name

Description

DataRepeaterItemValueEventArgs

Wisej.Web.DataRepeaterItemValueEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the and events.

Constructors

DataRepeaterItemValueEventArgs(itemIndex, control, propertyName, value)

Initializes a new instance of the class.

Name

Type

Description

Properties

Control

: Gets the child control of a that is raising the or event.

ItemIndex

Used By

DataRepeaterItemValueEventHandler

Wisej.Web.DataRepeaterItemValueEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the and events.

Parameters

Name

Type

Description

Fired By

Name

Description

DataRepeaterLayoutStyles

Wisej.Web.DataRepeaterLayoutStyles

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides an enumeration for specifying the orientation of items in a control.

Fields

Name

Description

Used By

Name

Description

DesktopTaskBarItem

Wisej.Web.DesktopTaskBarItem

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents a component in the control's taskbar.

Constructors

DesktopTaskBarItem()

Initializes a new instance of the class.

DesktopTaskBarItem(text)

Initializes a new instance of the class and displays the specified text on the item.

Name

Type

Description

Properties

When AllowHtml is set to true, the text can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with " ".

Methods

Updates the component on the client. Overridden to repaint the taskbar in design mode.

Inherited By

Implements

DesktopTaskBarItemClickEventArgs

Wisej.Web.DesktopTaskBarItemClickEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Provides data for the event.

Constructors

DesktopTaskBarItemClickEventArgs(item, button, clicks)

Initializes a new instance of the class.

Name

Type

Description

Properties

Item

: Returns or sets the that was clicked.

Used By

DesktopTaskBarItemClickEventHandler

Wisej.Web.DesktopTaskBarItemClickEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Represents the method that will handle the event of a .

Parameters

Name

Type

Description

Fired By

Name

Description

FlexLayoutPanel

Wisej.Web.FlexLayoutPanel

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Control
- ScrollableControl
  - Panel
    FlexLayoutPanel

Represents a panel that dynamically arranges its child controls.

public class FlexLayoutPanel : Panel, IExtenderProvider

Public Class FlexLayoutPanel
    Inherits Panel
    Implements IExtenderProvider

The FlexLayoutPanel can arrange its child controls using the layout engine specified in LayoutStyle. When the value is set to Default, the child controls are arranged using the default layout engine, using their location, dock style and anchor properties. When the value of LayoutStyle is set to Horizontal, child controls are arranged horizontally in a single row. When the value of LayoutStyle is set to Vertical, child controls are arranged vertically in a single column. Uses the following properties of the child controls:

Margin Increases the space around the control.
AlignY Aligns the control vertically within its parent using one of the VerticalAlignment values. It's used only when LayoutStyle is set to Horizontal.
AlignX Aligns the control horizontally within its parent using one of the HorizontalAlign values. It's used only when LayoutStyle is set to Vertical.
FillWeight Stretches the control's width or height to use the remaining space in the parent FlexLayoutPanel proportionally, according to the fill weights of all the children.
MinimumSize Enforces the minimum size of controls stretched using the FillWeight value.
MaximumSize Enforces the maximum size of controls stretched using the FillWeight value.

Uses the following properties of the parent FlexLayoutPanel control:

HorizontalAlign Aligns all the child controls horizontally using one of the HorizontalAlignment values. If any of the child control indicates a FillWeight value greater than 0, the remaining space is used to stretch the control and no alignment can take place since there is no remaining space. When LayoutStyle is set to Vertical, the value of HorizontalAlign is the default for the AlignX property of child controls.
VerticalAlign Aligns all the child controls vertically using one of the VerticalAlignment values. If any of the child control indicates a FillWeight value greater than 0, the remaining space is used to stretch the control and no alignment can take place since there is no remaining space. When LayoutStyle is set to Horizontal, the value of VerticalAlign is the default for the AlignY property of child controls.
Spacing Increases the horizontal or vertical space between the child controls. The value in pixels of Spacing is added to the control's Margin.
Padding Increases the distance between the child controls and the borders of the parent panel.

Constructors

Properties

HorizontalAlignment: Determines the horizontal alignment of the child controls when LayoutStyle is set to Vertical.

LayoutEngine: Returns the control's layout engine.

FlexLayoutStyle: Determines the layout engine to use to arrange the panel's child controls.

Default Controls are arranged using the default layout engine and according to their location, dock style, and anchoring.
Horizontal Controls are arranged horizontally in a single row according to their width, alignment, fill weight, and margin. The control's location, dock style, and anchoring are ignored.
Vertical Controls are arranged vertically in a single column according to their height, alignment, fill weight, and margin. The control's location, dock style, and anchoring are ignored.

Int32: Returns or sets the additional space, in pixels, between child controls when LayoutStyle is set to Horizontal or Vertical. The default value is 10.

VerticalAlignment: Determines the vertical alignment of the child controls when LayoutStyle is set to Horizontal.

Methods

Determines the horizontal alignment of the child control within the panel when LayoutStyle is set to Vertical.

Returns: HorizontalAlignment.

Determines the vertical alignment of the child control within the panel when LayoutStyle is set to Horizontal.

Returns: VerticalAlignment.

Determines whether to proportionally stretch the child within the panel to use the remaining space.

Returns: Int32. The fill weight value associated with the control.

The FillWeight property defines the relative width or height of a control managed by the Panel. The default value is 0 and the maximum value is 100.

Determines the horizontal alignment of the child control within the panel when LayoutStyle is set to Vertical.

Determines the vertical alignment of the child control within the panel when LayoutStyle is set to Horizontal.

Determines whether to proportionally stretch the child within the panel to use the remaining space.

The FillWeight property defines the relative width or height of a control managed by the Panel. The default value is 0 and the maximum value is 100. Throws:

ArgumentOutOfRangeException The value is less than 0 or greater than 100.

Implements

Form

Wisej.Web.Form

Namespace: Wisej.Web

Assembly: Wisej.Framework (2.5.0.0)

Control
- ScrollableControl
  - ContainerControl
    Form

Represents a window or dialog box that makes up an application's user interface.

public class Form : ContainerControl, IWisejWindow

Public Class Form
    Inherits ContainerControl
    Implements IWisejWindow

Constructors

Form()

Default constructor.

Properties

AcceptButton

IButtonControl: Returns or sets the button on the form that is clicked when the user presses the ENTER key.

Assigning the AcceptButton doesn't automatically close the window when the button is pressed. It only assigns the value of the DialogResult property of the form to the value of the DialogResult property of the button. To close the form when the AcceptButton is clicked, you have to call the Close method when the button is pushed.

Boolean: Returns whether the form is the currently active top level window or the active mdi child window.

Form: Returns the currently active form for this application.

Form: Returns the currently active multiple-document interface (MDI) child window.

Boolean: Returns or sets whether the opacity of the form can be adjusted.

String: Sets the appearance key for the theme engine.

Boolean: Automatically closes the form or dialog when the user clicks anywhere on the browser outside of the form.

Boolean: Returns or sets a value that indicates whether the control resizes based on its contents.

AutoSizeMode: Indicates the automatic sizing behavior of the control.

AutoValidate: Returns or sets how the control performs validation when the user changes focus to another control.

IButtonControl: Returns or sets the button control that is clicked when the user presses the ESC key.

Assigning the CancelButton doesn't automatically close the window when the button is pressed. It only assigns the value of the DialogResult property of the form to the value of the DialogResult property of the button. To close the form when the CancelButton is clicked, you have to call the Close method when the button is pushed.

Size: Returns or sets the size of the client area of the form.

Boolean: Returns or sets whether the Close button is displayed in the caption bar of the form.

CloseReason: Returns the reason for the form closing.

Boolean: Returns or sets whether a control box is displayed in the caption bar of the form.

DialogResult: Returns or sets the dialog result for the form.

Boolean: Enables or disables merging the MdiParent's menu with the active MdiChild form's menu.

FormBorderStyle: Returns or sets the border style of the form.

Boolean: Returns whether this form is an IsMdiContainer and has any Mdi child form.

Boolean: Returns whether this form has any owned form.

Color: Returns or sets the background color of the title bar and frame of the window.

Color: Returns or sets the text color of the title bar of the window.

Image: Returns or sets the icon (32x32) for the Form.

Image: Returns or sets the large icon (128x128) for the Form.

String: Returns or sets the theme name or URL for the large icon to display for the Form.

String: Returns or sets the theme name or URL for the icon to display for the Form.

Boolean: Returns whether the Form has been closed.

Modal dialogs are reusable and are not disposed automatically when closed. Use this property to check whether a modal dialog has been closed, and use IsDisposed to check if it has been disposed.

Boolean: Returns whether the Form was created as a modal or modeless dialog using ShowDialog.

Boolean: Returns a value indicating whether the form is a multiple-document interface (MDI) child form.

Boolean: Returns or sets whether the form is a container for multiple-document interface (MDI) child forms.

Boolean: Keeps the form always centered in the browser.

Boolean: Keeps the entire form within the browser view preventing the user from dragging the form, even partially, outside of the view.

Boolean: Returns or sets whether the form is resized while the border is being dragged.

Boolean: Returns or sets whether the Maximize button is displayed in the caption bar of the form.

Size: Returns the maximum size the form can be resized to.

Throws:

ArgumentOutOfRangeException The values of the height or width within the Size object are less than zero.

Form[]: Returns an array of forms that represent the multiple-document interface (MDI) child forms that are parented to this form.

MdiClient: Returns the internal MdiClient component.

Form: Returns or sets the current multiple-document interface (MDI) parent form of this form.

Throws:

Exception The Form assigned to this property is not marked as an MDI container.

MdiTabProperties: Provides properties for the TabControl object used to display the tabbed MDI interface.

MainMenu: Returns or sets the MainMenu that is displayed in the form.

MainMenu: Returns the merged menu for the form.

Boolean: Returns or sets whether the Minimize button is displayed in the caption bar of the form.

Size: Returns or sets the minimum size the form can be resized to.

Throws:

ArgumentOutOfRangeException The values of the height or width within the Size object are less than zero.

Boolean: Returns whether this form is displayed modally.

Boolean: Returns or sets whether the form can be moved by dragging.

Double: Returns or sets the opacity level of the form.

Form[]: Returns an array of Form objects that represent all forms that are owned by this form.

Form: Returns or sets the form that owns this form.

Throws:

Exception A top-level window cannot have an owner.

Boolean: Returns or sets whether the form is displayed in the Desktop taskbar.

Boolean: Returns or sets a value that shows the modal mask on the client when this form is displayed.

Modal forms - forms opened using ShowDialog - always show the modal mask by default.

Size: Returns or sets the size of the form.

FormStartPosition: Returns or sets the starting position of the form at run time.

String: Returns or sets the title of the Form window.

ComponentToolCollection: Returns the instance of ComponentToolCollection associated with this control.

Boolean: Returns or sets whether to display the form as a top-level window.

Throws:

Exception A Multiple-document interface (MDI) parent form must be a top-level window.

Boolean: Returns or sets whether the form should be displayed as a topmost form.

FormWindowState: Returns or sets a value that indicates whether form is minimized, maximized, or normal.

Methods

Activates the form and gives it focus.

Adds an owned form to this form.

Closes the form.

Computes the location of the specified screen point into client coordinates.

Returns: Point. A Point that represents the converted Point, point , in client coordinates.

Computes the location of the specified client point into screen coordinates.

Returns: Point. A Point that represents the converted Point, point , in screen coordinates.

Removes an owned form from this form.

Shows the form to the user.

Forms are disposed immediately when they are closed and cannot be shown again. The optional onclose parameter is an asynchronous callback handler invoked when the form is closed. It is similar to handling the FormClosed event.

form.Show((sender, result) => {
  
  // this code is executed when the form is closed.
  // sender is a reference to the form being closed.
  // result contains the value of form.DialogResult.
});

Throws:

InvalidOperationException The form being shown is already visible; or the form being shown is not a top-level window; or the form being shown as a dialog box is already a modal form.

Shows the form with the specified owner to the user.

form.Show((sender, result) => {
  
  // this code is executed when the form is closed.
  // sender is a reference to the form being closed.
  // result contains the value of form.DialogResult.
});

Throws:

InvalidOperationException The form being shown is already visible; or The form specified in the owner parameter is the same as the form being shown; or the form being shown is disabled; or the form being shown is not a top-level window; or the form being shown as a dialog box is already a modal form.

Shows the form as a modal dialog box. When the onclose is specified, the dialog is modal only in the browser.

Returns: DialogResult. One of the DialogResult values.

When using ShowDialog, the dialog instance is not automatically disposed when the dialog is closed because dialogs are reusable. To make sure that memory is released properly, you must dispose the instance in your code or use the typical using pattern. Dialogs that are closed, but not disposed and not referenced by the application will be disposed by the Garbage Collector when it kicks in.

using (var dialog and new MyDialog())
{
  dialog.ShowDialog();
}

Modal dialogs suspend the code execution on the server side effectively replicating the full modal workflow employed by desktop applications. However, when the optional onclose parameter is specified, the dialog is modal only in the browser and doesn't suspend the server thread. Which is similar to the typical asynchronous modal pattern used in javascript.

dialog.ShowDialog((sender, result) => {
  
  // this code is executed when the dialog is closed.
  // sender is a reference to the dialog being closed.
  // result contains the value of dialog.DialogResult.
  
  // you may dispose it here:
  sender.Dispose();
});

// this code is executed immediately, unlike the real modal workflow.

Throws:

InvalidOperationException The form being shown is already visible; or the form being shown is disabled; or the form being shown is not a top-level window; or the form being shown as a dialog box is already a modal form.

Shows the form as a modal dialog box with the specified owner. When the onclose is specified, the dialog is modal only in the browser.

Returns: DialogResult. One of the DialogResult values.

using (var dialog and new MyDialog())
{
  dialog.ShowDialog();
}

dialog.ShowDialog((sender, result) => {
  
  // this code is executed when the dialog is closed.
  // sender is a reference to the dialog being closed.
  // result contains the value of dialog.DialogResult.
  
  // you may dispose it here:
  sender.Dispose();
});

// this code is executed immediately, unlike the real modal workflow.

Throws:

ArgumentException The form specified in the owner parameter is the same as the form being shown.
InvalidOperationException The form being shown is already visible; or The form specified in the owner parameter is the same as the form being shown; or the form being shown is disabled; or the form being shown is not a top-level window; or the form being shown as a dialog box is already a modal form.

Asynchronously shows the form as an awaitable modal dialog box.

Returns: Task<DialogResult>. An awaitable Task that contains the DialogResult value returned asynchronous when the user closes the modal dialog.

using (var dialog and new MyDialog())
{
    var result = await dialog.ShowDialog();
}

Asynchronous Modal dialogs don't suspend the code execution on the server side but can be "awaited" in "async" methods effectively replicating the full modal workflow employed by desktop applications in an asynchronous environment.

private async void button_Click(object sender, EventArgs e)
{
    var result = await dialog.ShowDialog();

    // this code is executed when the dialog is closed.
    // result contains the value of dialog.DialogResult.

    // you may dispose the dialog here:
    dialog.Dispose();
}

Throws:

InvalidOperationException The form being shown is already visible; or the form being shown is disabled; or the form being shown is not a top-level window; or the form being shown as a dialog box is already a modal form.

Events

EventHandler Fired when the form is activated in code or by the user.

EventHandler Fired when the form loses focus and is no longer the active form.

FormClosedEventHandler Occurs after the form is closed.

FormClosingEventHandler Occurs before the form is closed.

EventHandler Fired when the Help button is clicked.

EventHandler Fired before a form is displayed for the first time.

EventHandler Fired when the value of the MaximumSize property has changed.

EventHandler Fired when a multiple-document interface (MDI) child form is activated.

ControlEventHandler Fired when a multiple-document interface (MDI) child form is added to the mdi parent.

ControlEventHandler Fired when a multiple-document interface (MDI) child form is removed from the mdi parent.

EventHandler Fired when the value of the MinimumSize property has changed.

EventHandler Fired whenever the form is first displayed.

ToolClickEventHandler Fired when a ComponentTool is clicked.

EventHandler Fired when the value of the WindowStateChanged property has changed.