1 of 100

Containers

Accordion

Wisej.Web.Accordion

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

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

Constructors

Accordion()

Initializes a new instance of the class.

Accordion(panels, onSelectedIndexChanged)

Initializes a new instance of the class with the specified settings.

Name

Type

Description

Accordion(location, size, onSelectedIndexChanged)

Initializes a new instance of the class with the specified settings.

Properties

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

Throws:

Methods

Throws:

Events

Implements

Accordion.PanelCollection

Wisej.Web.Accordion PanelCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Contains a collection of AccordionPanel objects.

public class PanelCollection : IList, ICollection, IEnumerable, IList<AccordionPanel>, ICollection<AccordionPanel>, IEnumerable<AccordionPanel>

Public Class PanelCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of AccordionPanel), ICollection(Of AccordionPanel), IEnumerable(Of AccordionPanel)

Properties

Count

Int32: Returns the number of panels in the collection.

Item(index)

AccordionPanel: Returns or sets a AccordionPanel in the collection at the specified index.

Throws:

ArgumentOutOfRangeException index is less than zero or greater than the highest available index.
ArgumentNullException value is null.

Item(name)

AccordionPanel: Returns the AccordionPanel with the specified key from the collection.

Methods

Adds a AccordionPanel to the collection.

Throws:

ArgumentNullException The specified panel is null.

Creates a AccordionPanel with the specified text, and adds it to the collection.

Creates a AccordionPanel with the specified key and text and adds it to the collection.

Creates a AccordionPanel with the specified key, text, and image, and adds it to the collection.

Adds a set of AccordionPanel panels to the collection.

Throws:

ArgumentNullException The value of panels is null.

Removes all the AccordionPanel panels from the collection.

Removes and disposes all AccordionPanel panels from the collection.

Determines whether a specified AccordionPanel is in the collection.

Returns: Boolean. true if the specified AccordionPanel is in the collection; otherwise, false.

Throws:

ArgumentNullException The value of panel is null.

Determines whether the collection contains a AccordionPanel with the specified key.

Returns: Boolean. true to indicate a AccordionPanel with the specified key was found in the collection; otherwise, false.

Copies the AccordionPanel panels in the collection to the specified array, starting at the specified index.

Throws:

ArgumentNullException array is null.
ArgumentOutOfRangeException array is less than zero.
ArgumentException array is multidimensional or the number of elements in the Panels is greater than the available space from index to the end of array .

Returns the index of the AccordionPanel in the collection.

Returns: Int32. The zero-based index of the panel; -1 if it cannot be found.

Throws:

ArgumentNullException The value of panel is null.

Returns the index of the first occurrence of the AccordionPanel with the specified key.

Returns: Int32. The zero-based index of the first occurrence of a AccordionPanel with the specified key, if found; otherwise, -1.

Inserts an existing AccordionPanel into the collection at the specified index.

Creates a new AccordionPanel with the specified text and inserts it into the collection at the specified index.

Creates a new AccordionPanel with the specified key and text, and inserts it into the collection at the specified index.

Creates a new AccordionPanel with the specified key, text, and image, and inserts it into the collection at the specified index.

Creates a AccordionPanel with the specified key, text, and image, and inserts it into the collection at the specified index.

Removes the AccordionPanel from the collection.

Throws:

ArgumentNullException The panel parameter is null.

Removes the AccordionPanel at the specified index from the collection.

Removes the AccordionPanel with the specified key from the collection.

AccordionAction

Wisej.Web.AccordionAction

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.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 (3.5.0.0)

Provides data for the and events of a control.

Constructors

AccordionCancelEventArgs(panel, panelIndex, cancel, action)

Initializes a new instance of the class.

Name

Type

Description

Properties

Action

: Returns a value indicating which event is occurring.

Panel

Used By

AccordionCancelEventHandler

Wisej.Web.AccordionCancelEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.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 (3.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 (3.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 (3.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. (Default: False)

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

String: Returns or sets the text to display as the title of the AccordionPanel. (Default: "")

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 (3.5.0.0)

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

Constructors

ContainerControl()

Initializes a new instance of the class.

Properties

Accelerators

: 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. (Default: null)

ActiveControl

Throws:

Methods

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

Events

Inherited By

Implements

AcceleratorEventArgs

Wisej.Web.AcceleratorEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Provides data for the event.

Constructors

AcceleratorEventArgs(keyData, component)

Initializes a new instance of the class.

Name

Type

Description

Properties

Component

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

Used By

Accordion.PanelCollection

Wisej.Web.Accordion PanelCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Contains a collection of AccordionPanel objects.

public class PanelCollection : IList, ICollection, IEnumerable, IList<AccordionPanel>, ICollection<AccordionPanel>, IEnumerable<AccordionPanel>

Public Class PanelCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of AccordionPanel), ICollection(Of AccordionPanel), IEnumerable(Of AccordionPanel)

Properties

Count

Int32: Returns the number of panels in the collection.

Item(index)

AccordionPanel: Returns or sets a AccordionPanel in the collection at the specified index.

Throws:

ArgumentOutOfRangeException index is less than zero or greater than the highest available index.
ArgumentNullException value is null.

Item(name)

AccordionPanel: Returns the AccordionPanel with the specified key from the collection.

Methods

Add(panel)

Adds a AccordionPanel to the collection.

Parameter

Type

Description

Throws:

ArgumentNullException The specified panel is null.

Add(text)

Creates a AccordionPanel with the specified text, and adds it to the collection.

Parameter

Type

Description

Add(key, text)

Creates a AccordionPanel with the specified key and text and adds it to the collection.

Parameter

Type

Description

Add(key, text, imageIndex)

Creates a AccordionPanel with the specified key, text, and image, and adds it to the collection.

Parameter

Type

Description

Add(key, text, imageKey)

Creates a AccordionPanel with the specified key, text, and image, and adds it to the collection.

Parameter

Type

Description

AddRange(panels)

Adds a set of AccordionPanel panels to the collection.

Parameter

Type

Description

Throws:

ArgumentNullException The value of panels is null.

Clear()

Removes all the AccordionPanel panels from the collection.

Clear(dispose)

Removes and disposes all AccordionPanel panels from the collection.

Parameter

Type

Description

Contains(panel)

Determines whether a specified AccordionPanel is in the collection.

Parameter

Type

Description

Returns: Boolean. true if the specified AccordionPanel is in the collection; otherwise, false.

Throws:

ArgumentNullException The value of panel is null.

ContainsKey(key)

Determines whether the collection contains a AccordionPanel with the specified key.

Parameter

Type

Description

Returns: Boolean. true to indicate a AccordionPanel with the specified key was found in the collection; otherwise, false.

CopyTo(array, index)

Copies the AccordionPanel panels in the collection to the specified array, starting at the specified index.

Parameter

Type

Description

Throws:

ArgumentNullException array is null.
ArgumentOutOfRangeException array is less than zero.
ArgumentException array is multidimensional or the number of elements in the Panels is greater than the available space from index to the end of array .

IndexOf(panel)

Returns the index of the AccordionPanel in the collection.

Parameter

Type

Description

Returns: Int32. The zero-based index of the panel; -1 if it cannot be found.

Throws:

ArgumentNullException The value of panel is null.

IndexOfKey(key)

Returns the index of the first occurrence of the AccordionPanel with the specified key.

Parameter

Type

Description

Returns: Int32. The zero-based index of the first occurrence of a AccordionPanel with the specified key, if found; otherwise, -1.

Insert(index, panel)

Inserts an existing AccordionPanel into the collection at the specified index.

Parameter

Type

Description

Insert(index, text)

Creates a new AccordionPanel with the specified text and inserts it into the collection at the specified index.

Parameter

Type

Description

Insert(index, key, text)

Creates a new AccordionPanel with the specified key and text, and inserts it into the collection at the specified index.

Parameter

Type

Description

Insert(index, key, text, imageIndex)

Creates a new AccordionPanel with the specified key, text, and image, and inserts it into the collection at the specified index.

Parameter

Type

Description

Insert(index, key, text, imageKey)

Creates a AccordionPanel with the specified key, text, and image, and inserts it into the collection at the specified index.

Parameter

Type

Description

Remove(panel)

Removes the AccordionPanel from the collection.

Parameter

Type

Description

Throws:

ArgumentNullException The panel parameter is null.

RemoveAt(index)

Removes the AccordionPanel at the specified index from the collection.

Parameter

Type

Description

RemoveByKey(key)

Removes the AccordionPanel with the specified key from the collection.

Parameter

Type

Description

Accordion

Wisej.Web.Accordion

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

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

Constructors

Accordion()

Initializes a new instance of the class.

Accordion(panels, onSelectedIndexChanged)

Initializes a new instance of the class with the specified settings.

Name

Type

Description

Accordion(location, size, onSelectedIndexChanged)

Initializes a new instance of the class with the specified settings.

Name

Type

Description

Accordion(location, size, panels, onSelectedIndexChanged)

Initializes a new instance of the class with the specified settings.

Name

Type

Description

Properties

BorderStyle

: Returns or sets the type of border that is drawn around the panel. (Default: Solid)

Collapsible

: Returns or sets a value indicating whether the Accordion control collapses when all the children are collapsed. (Default: False)

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

DisplayRectangle

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

HeaderSize

: 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. (Default: null)

PanelCount

: Returns the number of panels in the container.

Panels

: Returns the collection of panels in the container.

SelectedIndex

: Returns or sets the index of the currently selected panel. (Default: -1)

Throws:

The value is less than -1.

SelectedOnTop

: Returns or sets a value indicating whether the selected panel is moved to the top of the container. (Default: False)

SelectedPanel

: Returns or sets the currently selected panel.

ShowToolTips

: Returns or sets whether a panel's ToolTip is shown when the mouse passes over the panel's title. (Default: True)

Methods

DeselectPanel(index)

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

Parameter

Type

Description

Throws:

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

DeselectPanel(panel)

Makes the following the specified the current panel.

Parameter

Type

Description

Throws:

panel is null.

DeselectPanel(panelName)

Makes the following the the specified name the current panel.

Parameter

Type

Description

Throws:

panelName is null; or panelName does not match the property of any in the collection.

GetControl(index)

Returns the panel at the specified location.

Parameter

Type

Description

Returns: . The at the specified location.

Throws:

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

SelectPanel(index)

Makes the with the specified index the current .

Parameter

Type

Description

Throws:

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

SelectPanel(panel)

Makes the specified the current .

Parameter

Type

Description

Throws:

panel is null.

SelectPanel(panelName)

Makes with the specified name the current .

Parameter

Type

Description

Throws:

panelName is null; or panelName does not match the property of any in the collection.

Events

Deselected

Fired when a panel is deselected.

Deselecting

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

Selected

Fired when a panel is selected.

SelectedIndexChanged

Fired when the property has changed.

Selecting

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

Implements

Name

Description

DataRepeater

Wisej.Web.DataRepeater

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Control
- ScrollableControl
  - ContainerControl
    DataRepeater

Displays data in a customizable list format.

public class DataRepeater : ContainerControl, ISupportInitialize

Public Class DataRepeater
    Inherits ContainerControl
    Implements ISupportInitialize

Constructors

DataRepeater()

Initializes a new instance of the DataRepeater class.

Properties

AllowUserToAddItems

Boolean: Returns or sets whether users can add a new row to the DataRepeater at run time. (Default: True)

Boolean: Returns or sets whether users can delete a row from the DataRepeater at run time. (Default: True)

BorderStyle: Returns or sets the border style for the DataRepeater control. (Default: Solid)

DataRepeaterItem: Returns the current DataRepeaterItem in the DataRepeater control.

Int32: Returns or sets the index of the current DataRepeaterItem in a DataRepeater control.

String: Return or sets the name of the list or table in the data source for which the DataRepeater is displaying data. (Default: "")

Object: Returns or sets the data source for which the DataRepeater is displaying data. (Default: null)

DataRepeaterItem[]: Returns the list of DataRepeaterItem items currently displayed on the client.

Int32: Return the index of the first currently displayed DataRepeaterItem in a DataRepeater control.

Boolean: Return whether the data for a DataRepeaterItem in the DataRepeater control has been changed by a user.

BorderStyle: Returns or sets the border style for the items in a DataRepeater control.

Int32: Returns or sets the number of DataRepeaterItem items that are in the DataRepeater control.

Int32: Return sets the size of the item header in a DataRepeater control.

Boolean: Returns or sets whether item headers are displayed in a DataRepeater control.

Color: Returns or sets the background color for the DataRepeaterItem panel when it's the CurrentItem.

Size: Returns or sets the size of the DataRepeaterItem child panels.

DataRepeaterItem: Returns the template that represents the DataRepeaterItem for the DataRepeater control.

DataRepeaterLayoutStyles: Return or sets whether the DataRepeater control will be displayed with a vertical or horizontal orientation. (Default: Vertical)

Int32: Returns or sets the number of items to prefetch outside of the visible area. The default is 0 (disabled). (Default: 0)

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

Boolean: Returns or sets whether the scrollbar is visible. When the scrollbar is hidden, the user can still scroll using touch events, the keyboard, or the wheel. (Default: True)

Boolean: Returns or sets a value that indicates whether you have provided your own data-management operations for the DataRepeater control. (Default: False)

Methods

Adds a new DataRepeaterItem to the DataRepeater control.

Throws:

ReadOnlyException The AllowUserToAddItems property is set to False.

Allows users to cancel an edit to the current child control in the current DataRepeaterItem.

Forces a full reload of the data displayed by this DataRepeater.

Removes a DataRepeaterItem at the specified position from a DataRepeater control.

Throws:

ArgumentOutOfRangeException The value specified for index is less than 0 or greater than ItemCount - 1.

Resets the value of ItemBorderStyle to the original value.

Resets the value of ItemHeaderSize to the original value.

Resets the value of ItemHeaderVisible to the original value.

Scrolls the specified DataRepeaterItem into view.

Throws:

ArgumentOutOfRangeException The value specified for index is less than 0 or greater than ItemCount - 1.

Scrolls a specified DataRepeaterItem into view, optionally aligning it with the top of the control.

Throws:

ArgumentOutOfRangeException The value specified for index is less than 0 or greater than ItemCount - 1.

Events

EventHandler Fired when the AllowUserToAddItems property changes.

EventHandler Fired when the AllowUserToDeleteItems property changes.

EventHandler Fired when the property CurrentItemIndex changes.

DataRepeaterDataErrorEventHandler Fired when an external data-parsing or validation operation throws an exception, or when an attempt to commit data to a data source fails.

EventHandler Fired when the DataMember property changes.

EventHandler Fired when the DataSource property changes.

DataRepeaterItemEventHandler Fired after the DataRepeaterItem and its controls are cloned from the ItemTemplate.

DataRepeaterItemCloneEventHandler Fired before the DataRepeaterItem and its controls are cloned from the ItemTemplate.

DataRepeaterAddRemoveItemsEventHandler Fired when a new DataRepeaterItem is added to the DataRepeater control.

DataRepeaterItemEventHandler Fired after the DataRepeaterItem becomes the current item.

DataRepeaterAddRemoveItemsEventHandler Fired when a DataRepeaterItem is deleted from the DataRepeater control.

DataRepeaterItemEventHandler Fired when an instance of DataRepeaterItem is updated.

DataRepeaterItemValueEventHandler Fired when the VirtualMode property is set to true and a new value for a child control of a DataRepeaterItem is needed.

DataRepeaterItemValueEventHandler Fired when the VirtualMode property is set to true and the value of a child control in the DataRepeaterItem changes.

EventHandler Fired when the LayoutStyle property changes.

EventHandler Fired when the VirtualMode property is set to true and the user creates a new DataRepeaterItem.

DataRepeaterAddRemoveItemsEventHandler Fired when the user adds a new DataRepeaterItem.

DataRepeaterAddRemoveItemsEventHandler Fired after the user deletes a DataRepeaterItem.

DataRepeaterAddRemoveItemsCancelEventHandler Fired when the user deletes a DataRepeaterItem.

EventHandler Fired when the VirtualMode property changes.

Implements

Form

Wisej.Web.Form

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.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.

Form(onClosed)

Initializes a new instance of the Form class with the specified initial settings.

Name

Type

Description

Form(controls, onClosed)

Initializes a new instance of the Form class with the specified initial settings.

Properties

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

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. (Default: null)

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

Boolean: EXPERIMENTAL: Automatically closes the Modal dialog when DialogResult is assigned to a value different than None by code or by a user action, i.e.: AcceptButton click. Since 3.5.6 (Default: False)

You can change the default value across the application using the AutoCloseModalDialogDefault property or related AppContext switch. The default WinForms behavior is to automatically close the modal dialog.

Boolean: EXPERIMENTAL: Default value for the AutoCloseModalDialog property. Since 3.5.6 (Default: False)

The default is false. You can set the value by code or using AppContext switches: AppContext.SetSwitch("FormAutoCloseModalDialog", true);

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

AutoSizeMode: Indicates the automatic sizing behavior of the control. (Default: GrowOnly)

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. (Default: null)

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. (Default: True)

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. (Default: True)

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. (Default: False)

FormBorderStyle: Returns or sets the border style of the form. (Default: Sizable)

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. (Default: False)

Boolean: Keeps the form always centered in the browser. (Default: False)

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

Boolean: Returns or sets whether the form is resized while the border is being dragged. (Default: False)

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

Size: Returns the maximum size the form can be resized to. (Default: {Width=0, Height=0})

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. (Default: null)

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. (Default: True)

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. (Default: 1)

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. (Default: True)

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

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. (Default: DefaultLocation)

String: Returns or sets the title of the Form window. (Default: "")

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. (Default: False)

FormWindowState: Returns or sets a value that indicates whether form is minimized, maximized, or normal. (Default: 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.

Forces the control to update the corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control and optionally of its children, including the non-client areas such as the caption of forms or panels.

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.

Inherited By

Implements

SplitContainer

Wisej.Web.SplitContainer

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Control
- ScrollableControl
  - ContainerControl
    SplitContainer

Represents a control consisting of a movable bar that divides a container's display area into two resizable panels.

public class SplitContainer : ContainerControl, ISupportInitialize

Public Class SplitContainer
    Inherits ContainerControl
    Implements ISupportInitialize

Constructors

SplitContainer()

Initializes a new instance of the SplitContainer class.

Properties

BackgroundImage

Image: Returns or sets the background image displayed in the control. (Default: null)

String: Returns or sets the background image displayed in the control. (Default: null)

BindingContext: Returns or sets the BindingContext for the SplitContainer.

BorderStyle: Returns or sets the style of border for the SplitContainer. (Default: Solid)

FixedPanel: Returns or sets which SplitContainer panel remains the same size when the container is resized. (Default: None)

Boolean: Returns or sets whether the splitter is fixed or movable. (Default: False)

Orientation: Returns or sets a value indicating the horizontal or vertical orientation of the SplitContainer panels. (Default: Vertical)

SplitterPanel: Returns the left or top panel of the SplitContainer, depending on Orientation.

Boolean: Returns or sets a value determining whether Panel1 is collapsed or expanded. (Default: False)

Int32: Returns or sets the minimum distance in pixels of the splitter from the left or top edge of Panel1. (Default: 25)

Throws:

ArgumentOutOfRangeException The specified value is incompatible with the orientation.

SplitterPanel: Returns the right or bottom panel of the SplitContainer, depending on Orientation.

Boolean: Returns or sets a value determining whether Panel2 is collapsed or expanded. (Default: False)

Int32: Returns or sets the minimum distance in pixels of the splitter from the right or bottom edge of Panel2. (Default: 25)

Throws:

ArgumentOutOfRangeException The specified value is incompatible with the orientation.

Int32: Returns or sets the location of the splitter, in pixels, from the left or top edge of the SplitContainer. (Default: 50)

Throws:

ArgumentOutOfRangeException The value is less than zero.
InvalidOperationException The value is incompatible with the orientation.

Rectangle: Returns the size and location of the splitter relative to the SplitContainer.

Int32: Returns or sets the width of the splitter in pixels.

Throws:

ArgumentOutOfRangeException The value is less than one or is incompatible with the orientation.

Methods

Resets the size of the splitter to the value set in the theme.

Events

EventHandler Fired when the value of Orientation changes.

SplitterEventHandler Fired when the splitter control is moved.

SplitterCancelEventHandler Fired when the splitter control is in the process of moving.

Implements

TabPage

Wisej.Web.TabPage

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Control
- ScrollableControl
  - Panel
    TabPage

Represents a single tab page in a TabControl.

public class TabPage : Panel

Public Class TabPage
    Inherits Panel

Constructors

TabPage()

Initializes a new instance of the TabPage class.

TabPage(text)

Initializes a new instance of the TabPage class and specifies the text to display as the title the tab.

Name

Type

Description

Properties

Boolean: Returns or sets a value indicating that the control can display html in the Text property. (Default: False)

Newlines (CRLF) are converted to <BR/> when allowHtml is false, or when allowHtml is true and the text doesn't contain any html.

CharacterCasing: Returns or sets the case of the text to display to the user. (Default: Normal)

Boolean: Returns or sets whether the TabPage is visible in the parent TabControl. (Default: False)

Int32: Returns or sets the index for the image in the ImageList of the associated TabControl. (Default: -1)

Throws:

ArgumentOutOfRangeException The specified index is less than -1.

String: Returns or sets the key accessor for the image in the ImageList of the associated TabControl. (Default: "")

Boolean: Returns or sets a value indicating that the tab can show the close button next to the name. (Default: False)

Boolean: Returns or sets whether the tab page should be included in the visibility menu. (Default: True)

Color: Returns or sets the background color of the TabPage tab button. (Default: Color [Empty])

TabControl: Returns the parent TabControl.

Color: Returns or sets the text color of the TabPage tab button. (Default: Color [Empty])

String: Returns or sets the text to display on the tab. (Default: "")

String: Returns or sets the ToolTip text for this tab. (Default: "")

Boolean: Returns or sets whether the first character that is preceded by an ampersand (&) is used as the mnemonic key of the control. (Default: True)

Boolean: Returns or sets whether the control and all its child controls are displayed.

Methods

Retrieves the tab page that contains the specified Control.

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

Returns the bounding rectangle for a specified tab in this tab control.

Returns: Rectangle. A Rectangle that represents the bounds of the specified tab.

Overridden to update the parent TabControl when in design mode.

Events

EventHandler Fired when the value of the Text property changes.

Implements

TabControl.TabPageCollection

Wisej.Web.TabControl TabPageCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Contains a collection of TabPage objects.

public class TabPageCollection : IList, ICollection, IEnumerable, IList<TabPage>, ICollection<TabPage>, IEnumerable<TabPage>

Public Class TabPageCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of TabPage), ICollection(Of TabPage), IEnumerable(Of TabPage)

Properties

Count

Int32: Returns the number of tab pages in the collection.

Item(index)

TabPage: Returns or sets a TabPage in the collection at the specified index.

Throws:

ArgumentOutOfRangeException index is less than zero or greater than the highest available index.
ArgumentNullException value is null.

Item(name)

TabPage: Returns the TabPage with the specified key from the collection.

Methods

Adds a TabPage to the collection.

Throws:

ArgumentNullException The specified tabPage is null.

Creates a TabPage with the specified text, and adds it to the collection.

Creates a TabPage with the specified key and text and adds it to the collection.

Creates a TabPage with the specified key, text, and image, and adds it to the collection.

Adds a set of TabPage pages to the collection.

Throws:

ArgumentNullException The value of pages is null.

Removes all the TabPage pages from the collection.

Removes and disposes all TabPage pages from the collection.

Determines whether a specified TabPage is in the collection.

Returns: Boolean. true if the specified TabPage is in the collection; otherwise, false.

Throws:

ArgumentNullException The value of tabPage is null.

Determines whether the collection contains a TabPage with the specified key.

Returns: Boolean. true to indicate a TabPage page with the specified key was found in the collection; otherwise, false.

Copies the TabPage pages in the collection to the specified array, starting at the specified index.

Throws:

ArgumentNullException array is null.
ArgumentOutOfRangeException array is less than zero.
ArgumentException array is multidimensional or the number of elements in the TabPageCollection is greater than the available space from index to the end of array .

Returns the index of the TabPage in the collection.

Returns: Int32. The zero-based index of the tab page; -1 if it cannot be found.

Throws:

ArgumentNullException The value of tabPage is null.

Returns the index of the first occurrence of the TabPage with the specified key.

Returns: Int32. The zero-based index of the first occurrence of a TabPage with the specified key, if found; otherwise, -1.

Inserts an existing TabPage into the collection at the specified index.

Creates a new TabPage with the specified text and inserts it into the collection at the specified index.

Creates a new TabPage with the specified key and text, and inserts it into the collection at the specified index.

Creates a new TabPage with the specified key, text, and image, and inserts it into the collection at the specified index.

Creates a TabPage with the specified key, text, and image, and inserts it into the collection at the specified index.

Removes the TabPage from the collection.

Throws:

ArgumentNullException The tabPage parameter is null.

Removes the TabPage at the specified index from the collection.

Removes the TabPage with the specified key from the collection.

TableLayoutPanel

Wisej.Web.TableLayoutPanel

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Control
- ScrollableControl
  - Panel
    TableLayoutPanel

Represents a panel that dynamically lays out its contents in a grid composed of rows and columns.

public class TableLayoutPanel : Panel, IExtenderProvider

Public Class TableLayoutPanel
    Inherits Panel
    Implements IExtenderProvider

Constructors

TableLayoutPanel()

Initializes a new instance of the TableLayoutPanel class.

TableLayoutPanel(location, size, controls)

Initializes a new instance of the TableLayoutPanel class with the specified initial settings.

Name

Type

Description

Properties

Int32: Returns or sets the number of columns in the table. (Default: 0)

TableLayoutColumnStyleCollection: Returns a collection of column styles for the TableLayoutPanel.

TableLayoutControlCollection: Returns the collection of controls contained within the TableLayoutPanel.

TableLayoutPanelGrowStyle: Returns or sets whether the TableLayoutPanel control should expand to accommodate new cells when all existing cells are occupied. (Default: AddRows)

LayoutEngine: Returns the control's layout engine.

Int32: Returns or sets the number of rows in the table. (Default: 0)

TableLayoutRowStyleCollection: Returns a collection of row styles for the TableLayoutPanel.

Methods

Returns the TableLayoutPanelCellPosition that represents the row and the column of the cell.

Returns: TableLayoutPanelCellPosition. A TableLayoutPanelCellPosition that represents the cell position.

Returns the column position of the specified child control.

Returns: Int32. The column position of the specified child control, or -1 if the position of control is determined by LayoutEngine.

Throws:

ArgumentNullException control is null.
NotSupportedException control is not a type that can be arranged by this LayoutEngine.

Returns the number of columns spanned by the specified child control.

Returns: Int32. The number of columns spanned by the child control. The default is 1.

Returns the child control occupying the specified position.

Returns: Control. The child control occupying the specified cell; otherwise, null if no control exists at the specified column and row, or if the control has its Visible property set to false.

Throws:

ArgumentException Either column or row (or both) is less than 0.

Returns the TableLayoutPanelCellPosition that represents the row and the column of the cell that contains the control.

Returns: TableLayoutPanelCellPosition. A TableLayoutPanelCellPosition that represents the cell position.

Returns the row position of the specified child control.

Returns: Int32. The row position of control , or -1 if the position of control is determined by LayoutEngine.

Throws:

ArgumentNullException control is null.
NotSupportedException control is not a type that can be arranged by this LayoutEngine.

Returns an array representing the heights, in pixels, of the rows in the TableLayoutPanel.

Returns: Int32[]. An array of type Int32 that contains the heights, in pixels, of the rows in the TableLayoutPanel.

Returns the number of rows spanned by the specified child control.

Returns: Int32. The number of rows spanned by the child control. The default is 1.

Sets the TableLayoutPanelCellPosition that represents the row and the column of the cell.

Sets the column position of the specified child control.

Sets the number of columns spanned by the child control.

Throws:

ArgumentOutOfRangeException value is less than 1.

Sets the row position of the specified child control.

Sets the number of rows spanned by the child control.

Throws:

ArgumentOutOfRangeException value is less than 1.

Implements

FlexLayoutPanel

Wisej.Web.FlexLayoutPanel

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.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

Initializes a new instance of the FlexLayoutPanel class.

Initializes a new instance of the FlexLayoutPanel class with the specified settings.

Properties

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

LayoutEngine: Returns the control's layout engine.

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

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. (Default: 10)

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

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

Panel

Wisej.Web.Panel

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Control
- ScrollableControl
  - Panel

Represents a collapsible panel with an optional header that contains a group of controls.

public class Panel : ScrollableControl, IImage

Public Class Panel
    Inherits ScrollableControl
    Implements IImage

Constructors

Panel()

Initializes a new instance of the Panel class.

Panel(controls)

Initializes a new instance of the Panel class with the specified settings.

Name

Type

Description

Panel(location, size, controls)

Initializes a new instance of the Panel class with the specified settings.

Properties

PanelAutoShowMode: Returns or sets a value that indicates whether the collapsed panel is automatically expanded when the mouse hovers over the title bar. (Default: OnClick)

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

AutoSizeMode: Indicates the automatic sizing behavior of the control. (Default: GrowOnly)

BorderStyle: Indicates the border style for the control. (Default: None)

Boolean: Returns or sets a value that indicates whether the Panel is collapsed. (Default: False)

HeaderPosition: Returns or sets a value that indicates to which side should the panel collapse. (Default: Top)

Rectangle: Returns a rectangle that represents the dimensions of the GroupBox.

Boolean: Returns or sets whether the control can gain the focus. (Default: False)

HorizontalAlignment: Returns or sets the alignment of the header text in the Panel control. (Default: Left)

Color: Returns or sets the background color of the header of the panel.

Color: Returns or sets the text color of the header of the panel.

HeaderPosition: Returns or sets a value that indicates on which side to display the header when the header is visible. (Default: Top)

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.

Image: Returns or sets the image that is displayed in the header of the panel.

Int32: Returns or sets the image list index value of the image in the ImageList displayed in the button control. (Default: -1)

Throws:

ArgumentOutOfRangeException The specified index is less than -1.

String: Returns or sets the key accessor for the image in the ImageList displayed in the header of the panel. (Default: "")

ImageList: Returns or sets the ImageList that contains the Image displayed in the header of the panel control. (Default: null)

String: Returns or sets the theme name or URL for the image to display in the header of the panel.

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

Boolean: Returns or sets a value that indicates the caption bar displays the close button to collapse or expand the panel. (Default: True)

Boolean: Returns or sets a value that indicates whether the caption bar is visible. (Default: False)

Boolean: Returns or sets whether the user can give the focus to this control using the TAB key and the Focusable property is set to true. (Default: False)

String: Returns or sets the title of the Panel panel. (Default: "")

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

String: Returns or sets the ToolTip text for the header of the panel. (Default: "")

Events

EventHandler Fired when the panel is collapsed.

EventHandler Fired when the panel is expanded.

EventHandler Fired when the value of the RightToLeftLayout property changes.

ToolClickEventHandler Fired when a ComponentTool is clicked.

Containers

Accordion

Constructors

Accordion()

Accordion(panels, onSelectedIndexChanged)

Accordion(location, size, onSelectedIndexChanged)

Properties

Methods

Events

Implements

Accordion.PanelCollection

Properties

Count

Item(index)

Item(name)

Methods

AccordionAction

Fields

Used By

AccordionCancelEventArgs

Constructors

AccordionCancelEventArgs(panel, panelIndex, cancel, action)

Properties

Action

Panel

Used By

AccordionCancelEventHandler

Parameters

Fired By

AccordionEventArgs

Constructors

AccordionEventArgs(panel, panelIndex, action)

Properties

Action

Panel

Used By

AccordionEventHandler

Parameters

Fired By

AccordionPanel

Constructors

AccordionPanel()

AccordionPanel(text)

Properties

Methods

Implements

ContainerControl

Constructors

ContainerControl()

Properties

Accelerators

ActiveControl

Methods

Events

Inherited By

Implements

AcceleratorEventArgs

Constructors

AcceleratorEventArgs(keyData, component)

Properties

Component

Used By

AccordionAction

Fields

Used By

AccordionEventHandler

Parameters

Fired By

AccordionEventArgs

Constructors

AccordionEventArgs(panel, panelIndex, action)

Properties

Action

Panel

PanelIndex

Used By

AccordionCancelEventHandler

Parameters

Fired By

AccordionPanel