Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Wisej.Web.Accordion
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Displays collapsible set of AccordionPanel panels for presenting information in a limited amount of space.
Initializes a new instance of the Accordion class.
Initializes a new instance of the Accordion class with the specified settings.
Initializes a new instance of the Accordion class with the specified settings.
Initializes a new instance of the Accordion class with the specified settings.
BorderStyle: Returns or sets the type of border that is drawn around the Accordion panel. (Default: Solid
)
Boolean: Returns or sets a value indicating whether the Accordion control collapses when all the AccordionPanel children are collapsed. (Default: False
)
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. (Default: null
)
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. (Default: -1
)
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. (Default: False
)
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. (Default: True
)
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.
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.
Wisej.Web.AccordionCancelEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Provides data for the Selecting and Deselecting events of a Accordion control.
Initializes a new instance of the AccordionCancelEventArgs class.
AccordionAction: Returns a value indicating which event is occurring.
AccordionPanel: Returns the AccordionPanel the event is occurring for.
Int32: Returns the zero-based index of the Panel in the Panels collection.
Wisej.Web.AccordionAction
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Defines values representing Accordion events.
Wisej.Web.Accordion PanelCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Contains a collection of AccordionPanel objects.
Int32: Returns the number of panels in the collection.
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.
AccordionPanel: Returns the AccordionPanel with the specified key from the collection.
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.
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.
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.
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.
Initializes a new instance of the AccordionEventArgs class.
AccordionAction: Returns a value indicating which event is occurring.
AccordionPanel: Returns the AccordionPanel the event is occurring for.
Int32: Returns the zero-based index of the Panel in the Panels collection.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
panels
An array of AccordionPanel objects to be added to the panel.
onSelectedIndexChanged
An Action delegate to handle the SelectedIndexChanged event.
location
The location of the panel on its parent control.
size
The size of the panel.
onSelectedIndexChanged
An Action delegate to handle the SelectedIndexChanged event.
location
The location of the panel on its parent control.
size
The size of the panel.
panels
An array of AccordionPanel objects to be added to the panel.
onSelectedIndexChanged
An Action delegate to handle the SelectedIndexChanged event.
index
The index in the Panels collection of the AccordionPanel to deselect.
panel
The AccordionPanel to deselect.
panelName
The Name of the panel to deselect.
index
The index of the AccordionPanel to get.
index
The index in the Panels collection of the tab to select.
panel
The AccordionPanel to select.
panelName
The Name of the tab to select.
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
panel
The AccordionPanel the event is occurring for.
panelIndex
The zero-based index of panel in the Panels collection.
cancel
true to cancel the panel change by default; otherwise, false.
action
One of the AccordionAction values.
Represents the method that will handle the Selecting or Deselecting event of a Accordion control.
Deselected
Represents the Deselected event.
Deselecting
Represents the Deselecting event.
Selected
Represents the Selected event.
Selecting
Represents the Selecting event.
Returns a value indicating which event is occurring.
Returns a value indicating which event is occurring.
panel
The AccordionPanel to add.
text
The text to display on the panel.
key
The name of the AccordionPanel.
text
The text to display on the title of AccordionPanel.
key
The name of the AccordionPanel.
text
The text to display on the AccordionPanel.
imageIndex
The index of the image to display on the title of the AccordionPanel.
key
The name of the AccordionPanel.
text
The text to display on the AccordionPanel.
imageKey
The key of the image to display on the title of the AccordionPanel.
panels
An array of type AccordionPanel that contains the panels to add.
dispose
Indicates whether to dispose the AccordionPanel panels removed from the collection.
panel
The AccordionPanel to locate in the collection.
key
The name of the AccordionPanel to search for.
array
The one-dimensional array that is the destination of the AccordionPanel panels copied from the collection. The array must have zero-based indexing.
index
The zero-based index in the array at which copying begins.
panel
The AccordionPanel to locate in the collection.
key
The name of the AccordionPanel to find in the collection.
index
The zero-based index location where the AccordionPanel is inserted.
panel
The AccordionPanel to insert in the collection.
index
The zero-based index location where the AccordionPanel is inserted.
text
The text to display in the AccordionPanel.
index
The zero-based index location where the AccordionPanel is inserted.
key
The name of the AccordionPanel.
text
The text to display on the AccordionPanel.
index
The zero-based index location where the AccordionPanel is inserted
key
The name of the AccordionPanel.
text
The text to display on the AccordionPanel.
imageIndex
The zero-based index of the image to display on the AccordionPanel.
index
The zero-based index location where the AccordionPanel is inserted.
key
The name of the AccordionPanel.
text
The text to display on the AccordionPanel.
imageKey
The key of the image to display on the AccordionPanel.
panel
The AccordionPanel to remove.
index
The zero-based index of the AccordionPanel to remove.
key
The name of the AccordionPanel to remove.
sender
The source of the event.
e
A AccordionCancelEventArgs that contains the event data.
Occurs before a panel is selected, enabling a handler to cancel the panel change.
Occurs before a panel is deselected, enabling a handler to cancel the panel change.
panel
The AccordionPanel the event is occurring for.
panelIndex
The zero-based index of panel in the Panels collection.
action
One of the AccordionAction values.
Represents the method that will handle the Selected or Deselected event of a Accordion control.
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.
Wisej.Web.AcceleratorEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Provides data for the Accelerator event.
Initializes a new instance of the KeyEventArgs class.
IWisejComponent: Returns the Wisej component that generated the "keydown" event'.
Wisej.Web.AcceleratorEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the method that will handle the Accelerator event.
Wisej.Web.AccordionPanel
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a panel in a Accordion control.
Initializes a new instance of the AccordionPanel class.
Initializes a new instance of the AccordionPanel class and specifies the text to display as the title of the panel.
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.
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.
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.
Initializes a new instance of the ContainerControl class.
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. (Default: null
)
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. (Default: False
)
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 (Default: False
)
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.
AcceleratorEventHandler Fired when one of the Accelerators key is pressed.
EventHandler Fired when the value of the RightToLeftLayout property changes.
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Name | Description |
---|---|
Parameter | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Represents the method that handles the event.
Name | Type | Description |
---|
Name | Description |
---|
Provides data for the event.
Initializes a new instance of the class.
Name | Type | Description |
---|
: Gets the number of items being deleted.
: Returns the index of the item that is being deleted.
Name | Description |
---|
Represents the method that will handle the , , , and events.
Name | Type | Description |
---|
Name | Description |
---|
Provides data for the , , , and events.
Initializes a new instance of the class.
Name | Type | Description |
---|
: Return the number of items being added to or deleted from a control.
: Returns the index of the item being added or deleted.
Name | Description |
---|
Initializes a new instance of the class.
: Returns or sets whether users can add a new row to the at run time. (Default: True
)
: Returns or sets whether users can delete a row from the at run time. (Default: True
)
: Returns or sets the border style for the control. (Default: Solid
)
: Returns the current in the control.
: Returns or sets the index of the current in a control.
: Return or sets the name of the list or table in the data source for which the is displaying data. (Default: ""
)
: Returns or sets the data source for which the is displaying data. (Default: null
)
: Returns the list of items currently displayed on the client.
: Return the index of the first currently displayed in a control.
: Return whether the data for a in the control has been changed by a user.
: Returns or sets the border style for the items in a control.
: Returns or sets the number of items that are in the control.
: Return sets the size of the item header in a control.
: Returns or sets whether item headers are displayed in a control.
: Returns or sets the background color for the panel when it's the .
: Returns or sets the size of the child panels.
: Returns the template that represents the for the control.
: Return or sets whether the control will be displayed with a vertical or horizontal orientation. (Default: Vertical
)
: Returns or sets the number of items to prefetch outside of the visible area. The default is 0 (disabled). (Default: 0
)
: Enables or disables right-to-left layout when the value of is (Default: False
)
: 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
)
: Returns or sets a value that indicates whether you have provided your own data-management operations for the control. (Default: False
)
Adds a new to the control.
The property is set to False.
Allows users to cancel an edit to the current child control in the current .
Forces a full reload of the data displayed by this .
Forces a full reload of the data displayed by this .
Parameter | Type | Description |
---|
Removes a at the specified position from a control.
Parameter | Type | Description |
---|
The value specified for index is less than 0 or greater than - 1.
Resets the value of to the original value.
Resets the value of to the original value.
Resets the value of to the original value.
Scrolls the specified into view.
Parameter | Type | Description |
---|
The value specified for index is less than 0 or greater than - 1.
Scrolls a specified into view, optionally aligning it with the top of the control.
Parameter | Type | Description |
---|
The value specified for index is less than 0 or greater than - 1.
Fired when the property changes.
Fired when the property changes.
Fired when the property changes.
Fired when an external data-parsing or validation operation throws an exception, or when an attempt to commit data to a data source fails.
Fired when the property changes.
Fired when the property changes.
Fired after the and its controls are cloned from the .
Fired before the and its controls are cloned from the .
Fired when a new is added to the control.
Fired after the becomes the current item.
Fired when a is deleted from the control.
Fired when an instance of is updated.
Fired when the property is set to true and a new value for a child control of a is needed.
Fired when the property is set to true and the value of a child control in the changes.
Fired when the property changes.
Fired when the property is set to true and the user creates a new .
Fired when the user adds a new .
Fired after the user deletes a .
Fired when the user deletes a .
Fired when the property changes.
Name | Description |
---|
sender
The source of the event.
e
A AccordionEventArgs that contains the event data.
Fired when a panel is selected.
Fired when a panel is deselected.
keyData
component
The Wisej component that originated the keyboard event.
Represents the method that will handle the Accelerator event.
sender
The source of the event.
e
A AcceleratorEventArgs that contains the event data.
Fired when one of the Accelerators key is pressed.
text
The text for the title of the panel.
control
The Control to look for.
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
Provides access to common image properties across the controls that implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
checkAutoValidate
If true, the value of the AutoValidate property is used to determine if validation should be performed; if false, validation is unconditionally performed.
UI implementation for the FileDialog class.
UI implementation for the FolderDialog class.
Represents a window or dialog box that makes up an application's user interface.
Represents a web page that fills the browser and acts as the main container for the application. An application can have only one active main page at any given time.
Represents a control consisting of a movable bar that divides a container's display area into two resizable panels.
Provides an empty control that can be used to create other controls.
Displays data in a customizable list format.
Represents a desktop container that can host floating windows.
Provides an popup container that can be attached to other controls.
Bindable components implement this interface.
Provides the functionality for a control to act as a parent for other controls.
Controls that support drag & drop operations implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
sender | The source of the event. |
e | An object that contains the event data. |
index |
count | The number of items being deleted. |
sender | The source of the event. |
e | An object that contains the event data. |
index |
count | The number of items being added or deleted. |
refreshChildren | True to also refresh all the children of this control. |
index |
index |
index |
alignWithTop |
Bindable components implement this interface. |
Provides the functionality for a control to act as a parent for other controls. |
Controls that support drag & drop operations implement this interface. |
All wisej components implement this interface. |
Allows an object to serialize itself. |
Wisej.Web.DataRepeaterItem
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Used by the DataRepeater control to display data at run time.
Initializes a new instance of the DataRepeaterItem object.
Boolean: Return a value that determines whether a DataRepeaterItem is the currently selected item in a DataRepeater control.
Int32: Returns the index of a DataRepeaterItem in a DataRepeater control.
Boolean: Returns value that determines whether the data for a DataRepeaterItem in a DataRepeater control has been changed by the user.
Wisej.Web.DataRepeaterDataErrorEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the method that will handle the DataError event.
Wisej.Web.DataRepeaterItemCloneEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Provides data for the ItemCloning event.
Initializes a new instance of the DataRepeaterItemCloneEventArgs class.
Boolean: Gets or sets a value that specifies whether the cloning is handled by the developer.
DataRepeaterItem: Gets the DataRepeaterItem from which the new DataRepeaterItem will be cloned.
DataRepeaterItem: Gets or sets the new DataRepeaterItem that is the result of the cloning operation.
Wisej.Web.DataRepeaterDataErrorEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Provides data for the DataError event.
Initializes a new instance of the DataRepeaterDataErrorEventArgs class.
Throws:
ArgumentNullException ex is null.
Control: Gets the Control that raised the data error.
DataRepeaterItem: Gets the DataRepeaterItem that raised the data error.
Exception: Gets the Exception that represents the error.
String: Gets the name of the property of the control that raised the error.
Boolean: Gets or sets a value that indicates whether to throw an exception after code execution exits the DataError event handler.
Fired when the user deletes a .
The index of the that is being deleted.
Represents the method that handles the event.
Fired when a new is added to the control.
Fired when a is deleted from the control.
Fired when the user adds a new .
Fired after the user deletes a .
The index of the that is being added or deleted.
Represents the method that will handle the , , , and events.
The index of the .
The index of the .
The index of the .
true to align the top of the with the top of the control; otherwise, false.
All wisej controls derived from the class must implement this interface.
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Represents the method that will handle the event.
Name | Type | Description |
---|
Name | Description |
---|
Provides data for the event.
Initializes a new instance of the class.
Name | Type | Description |
---|
: Returns a instance that triggered the event.
Name | Description |
---|
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
Provides access to common image properties across the controls that implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
sender
The source of the event.
e
A DataRepeaterDataErrorEventArgs object that contains the event data.
Fired when an external data-parsing or validation operation throws an exception, or when an attempt to commit data to a data source fails.
source
The ItemTemplate from which the new item will be cloned.
Represents the method that will handle the ItemCloning event.
item
The DataRepeaterItem on which the error occurred.
control
The Control on the DataRepeaterItem on which the error occurred.
property
The property on which the error occurred. For most controls, this will be the Text property.
ex
The exception object.
Represents the method that will handle the DataError event.
sender | The source of the event. |
e |
item |
Wisej.Web.DataRepeaterItemEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the method that will handle the ItemCloned event.
A object that contains the event data.
Fired before the and its controls are cloned from the .
The cloned from the object.
Represents the method that will handle the event.
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Provides an enumeration for specifying the orientation of items in a control.
Name | Description |
---|
Name | Description |
---|
sender
The source of the event.
e
A DataRepeaterItemEventArgs object that contains the event data.
Fired after the DataRepeaterItem and its controls are cloned from the ItemTemplate.
Fired after the DataRepeaterItem becomes the current item.
Fired when an instance of DataRepeaterItem is updated.
Horizontal | Items are displayed in a horizontal format. A horizontal scroll bar will be displayed as necessary. |
Vertical | Items are displayed in a vertical format. A vertical scroll bar will be displayed as necessary. |
Wisej.Web.DataRepeaterItemValueEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Provides data for the ItemValueNeeded and ItemValuePushed events.
Initializes a new instance of the DataRepeaterItemValueEventArgs class.
Control: Gets the child control of a DataRepeaterItem that is raising the ItemValueNeeded or ItemValuePushed event.
Int32: Gets the index of the DataRepeaterItem that contains the control that is raising the ItemValueNeeded or ItemValuePushed event.
String: Gets the name of the data-bound property of the control that is raising a ItemValueNeeded or ItemValuePushed event.
Object: Gets the property value that has changed to raise a ItemValueNeeded or ItemValuePushed event.
Return or sets whether the control will be displayed with a vertical or horizontal orientation.
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
itemIndex
The index of the DataRepeaterItem that contains the control that is raising the event.
control
The child control that is raising the event.
propertyName
The property of the control that has changed or that needs data.
value
The property value that has changed.
Represents the method that will handle the ItemValueNeeded and ItemValuePushed events.
Wisej.Web.Desktop
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a desktop container that can host floating windows.
Initializes a new instance of the Desktop class.
Boolean: Returns true if this desktop instance is the currently active desktop. It is the same as comparing the instance with Desktop.
Boolean: Returns or sets whether the taskbar is hidden automatically when there are no opened windows or no windows with the property ShowInTaskbar set to true. (Default: False
)
Rectangle: Returns a rectangle that represents the inner dimensions of the Desktop control.
DockStyle: Returns or sets which control borders are docked to its parent control and determines how a control is resized with its parent. (Default: None
)
Int32: Returns or sets the height of the page.
Boolean: Returns whether the taskbar is currently visible.
DesktopTaskBarItemCollection: Returns the collection of DesktopTaskBarItem controls displayed in the taskbar of the desktop control.
Point: Returns or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
Size: Returns the height and width of the page.
HorizontalAlignment: Return or sets the alignment of the Items in the taskbar. (Default: Left
)
Position: Return or sets the position of the taskbar to one of the four sides indicated by the Position values. (Default: Bottom
)
Int32: Returns the height or width of the taskbar in the current theme, depending on the value of TaskbarPosition.
String: Returns or sets the title of the Desktop. If the desktop is the main desktop, setting the text also changes the title in the browser. (Default: ""
)
String: Returns or sets the wallpaper image. (Default: ""
)
Int32: Returns or sets the width of the page.
EventHandler Fired when the desktop becomes active, and it's the new Desktop.
EventHandler Fired when the desktop is deactivated and it's no longer the Desktop.
DesktopTaskBarItemClickEventHandler Fired when a DesktopTaskBarItem on the Desktop is clicked.
DesktopTaskBarItemClickEventHandler Fired when a DesktopTaskBarItem on the Desktop is double clicked.
EventHandler Fired before the desktop becomes visible for the first time.
EventHandler Occurs when the property TaskbarAlignment changes value.
EventHandler Occurs when the property TaskbarPosition changes value.
EventHandler Occurs when the property AutoHideTaskbar is set to true and the TaskBar is either hidden or shown.
Name | Description |
---|---|
Bindable components implement this interface.
Provides the functionality for a control to act as a parent for other controls.
Controls that support drag & drop operations implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
All wisej top-level windows implement this interface.
Allows an object to serialize itself.
Wisej.Web.DesktopTaskBarItemClickEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Provides data for the ItemClick event.
Initializes a new instance of the DesktopTaskBarItemClickEventArgs class.
DesktopTaskBarItem: Returns or sets the DesktopTaskBarItem that was clicked.
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Represents the method that will handle the event of a .
Name | Type | Description |
---|
Name | Description |
---|
item
The DesktopTaskBarItem that was clicked.
button
One of the MouseButtons values that indicate which mouse button was pressed.
clicks
The number of times a mouse button was pressed.
sender | The source of the event. |
e |
A that contains the event data.
Fired when a on the is clicked.
Fired when a on the is double clicked.
Wisej.Web.DesktopTaskBarItemControl
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a component in the Desktop control's taskbar that can host any Control.
Initializes a new instance of DesktopTaskBarItemControl.
Control: Returns or sets the Control to be hosted. (Default: null
)
Desktop: Returns the Desktop control that the taskbar item button is assigned to.
Name | Description |
---|---|
All wisej components implement this interface.
Allows an object to serialize itself.
Wisej.Web.DesktopTaskBarItem
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a component in the Desktop control's taskbar.
Initializes a new instance of the DesktopTaskBarItem class.
Initializes a new instance of the DesktopTaskBarItem class and displays the specified text on the item.
Boolean: Returns or sets a value indicating that the control can display html in the Text property. (Default: False
)
Boolean: Returns or sets whether the button is enabled. (Default: True
)
Image: Returns or sets the image that is displayed in a DesktopTaskBarItem.
ImagePosition: Returns or sets the position of the Image within this taskbar item. (Default: Left
)
String: Returns or sets the theme name or URL for the image to display in the DesktopTaskBarItem.
String: Returns or sets the name of the DesktopTaskBarItem.
Desktop: Returns the Desktop control that the taskbar item button is assigned to.
LeftRightAlignment: Returns or sets the position of this DesktopTaskBarItem within the taskbar in the parent Desktop. (Default: Left
)
Object: Returns or sets the object that contains user data. (Default: null
)
String: Returns or sets the text displayed on the taskbar item. (Default: ""
)
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 "<br/>".
String: Returns or sets the text that appears as a ToolTip for the taskbar item. (Default: ""
)
Boolean: Returns or sets whether the taskbar item is visible or hidden. (Default: True
)
Updates the component on the client. Overridden to repaint the taskbar in design mode.
Wisej.Web.DesktopTaskBarItemCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the collection of DesktopTaskBarItem controls in a Desktop control.
Initializes a new instance of the DesktopTaskBarItemCollection class.
Boolean: Returns a value indicating whether this collection is read-only.
DesktopTaskBarItem: Returns or sets the DesktopTaskBarItem at the specified index.
DesktopTaskBarItem: Returns the DesktopTaskBarItem identified by the name.
Adds a DesktopTaskBarItem with the specified text to the collection.
Returns: DesktopTaskBarItem. A DesktopTaskBarItem that represents the item that was added to the collection.
Adds a DesktopTaskBarItem to the collection.
Returns: Int32. The zero-based index of the item in the collection.
Throws:
ArgumentNullException The DesktopTaskBarItem being added to the collection is null.
ArgumentException The parent of the DesktopTaskBarItem specified in the item parameter is not null.
Adds an array of DesktopTaskBarItem to the collection.
Removes all DesktopTaskBarItem objects from the collection.
Removes and optionally disposes all DesktopTaskBarItem objects from the collection.
Determines whether the specified DesktopTaskBarItem is located within the collection.
Returns: Boolean. true if the DesktopTaskBarItem is located within the collection; otherwise, false.
Determines whether the collection contains a DesktopTaskBarItem with the specified key.
Returns: Boolean. true to indicate the collection contains a DesktopTaskBarItem with the specified key; otherwise, false.
Returns an enumerator to use to iterate through the DesktopTaskBarItem objects in the collection.
Returns: IEnumerator. An IEnumerator that represents the item collection.
Returns the index within the collection of the specified DesktopTaskBarItem.
Returns: Int32. The zero-based index where the DesktopTaskBarItem is located within the collection; otherwise, negative one (-1).
Returns the index of the first occurrence of a DesktopTaskBarItem with the specified key.
Returns: Int32. The zero-based index of the first occurrence of the DesktopTaskBarItem with the specified key, if found; otherwise, -1.
Inserts the specified DesktopTaskBarItem into the collection at the specified index.
Throws:
ArgumentNullException The button parameter is null.
ArgumentException The button parameter's parent is not null.
ArgumentOutOfRangeException The index parameter is less than zero or greater than the value of the Count property of the DesktopTaskBarItemCollection.
Removes the specified DesktopTaskBarItem from the collection.
Throws:
ArgumentNullException The DesktopTaskBarItem assigned to the item parameter is null.
Removes the DesktopTaskBarItem located at the specified index within the collection.
Throws:
ArgumentOutOfRangeException The index parameter is less than zero or greater than or equal to the value of the Count property of the DesktopTaskBarItemCollection.
Removes the DesktopTaskBarItem with the specified key from the collection.
Wisej.Web.DesktopTaskBarItemDateTime
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a DateTime component in the Desktop control's taskbar.
Initializes a new instance of DesktopTaskBarItemDateTime setting the initial Position value to Right.
LeftRightAlignment: Returns or sets the position of this DesktopTaskBarItem within the taskbar in the parent Desktop. (Default: Right
)
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Name | Description |
---|---|
Used by the property to determines the layout engine used to arrange the child controls in the panel.
Name | Description |
---|
Name | Description |
---|
text
The text to display on the new DesktopTaskBarItem.
Represents a DateTime component in the Desktop control's taskbar.
All wisej components implement this interface.
Allows an object to serialize itself.
owner
The Desktop control that owns this collection.
text
The text for the DesktopTaskBarItem that is being added.
item
A DesktopTaskBarItem that represents the panel to add to the collection.
items
Array of DesktopTaskBarItem objects to add to the collection.
dispose
Indicates whether the removed items should be disposed.
button
The DesktopTaskBarItem to locate in the collection.
key
The name of the item to find in the collection.
button
The DesktopTaskBarItem to locate in the collection.
key
The name of the DesktopTaskBarItem to find in the collection.
index
The zero-based index location where the panel is inserted.
button
A DesktopTaskBarItem representing the panel to insert.
item
The DesktopTaskBarItem representing the panel to remove from the collection.
index
The zero-based index of the item to remove.
key
The name of the DesktopTaskBarItem to remove from the collection.
All wisej components implement this interface.
Allows an object to serialize itself.
Default | Child controls are arranged according to the location, dock style and anchoring values. |
Horizontal | Child controls are arranged horizontally using their margin and alignment properties. |
Vertical | Child controls are arranged vertically using their margin and alignment properties. |
Determines the layout engine to use to arrange the panel's child controls. |
Wisej.Web.FlowLayoutPanel
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a panel that dynamically arranges its controls horizontally or vertically in automatic rows or columns.
Arranges child controls horizontally or vertically. Ignores the control location, dock style and anchoring. Uses the following properties of the child controls:
Margin Increases the space around the control.
FillWeight Stretches the width of control proportionally, according to the fill weights of all the controls, to use the remaining space in the row.
MinimumSize Enforces the minimum size of controls stretched using the FillWeight value.
MaximumSize Enforces the maximum size of controls stretched using the FillWeight value.
FlowBreak Determines whether to create a new row or a new column after the control.
Uses the following properties of the parent FlowLayoutPanel control:
FlowDirection Wraps child controls to a new column (TopDown, or BottomUp) or to a new row (LeftToRight, RightToLeft).
WrapContents When set to false, child controls do not wrap and are either clipped or scrolled.
Padding Increases the distance between the child controls and the borders of the parent panel.
Initializes a new instance of the FlowLayoutPanel class.
Initializes a new instance of the FlowLayoutPanel class with the specified initial settings.
Initializes a new instance of the FlowLayoutPanel class with the specified initial settings.
FlowDirection: Returns or sets a value indicating the flow direction of the FlowLayoutPanel control. (Default: LeftToRight
)
LayoutEngine: Returns the control's layout engine.
Boolean: Returns or sets whether the FlowLayoutPanel control should wrap its contents or let the contents be clipped. (Default: True
)
Determines whether to proportionally stretch the width or the control to fill the remaining space it the containing row.
Returns: Int32. The fill weight value associated with the control.
The FillWeight property defines the relative width of a control in a row managed by the FlowLayoutPanel. The default value is 0 and the maximum value is 100 (the control will fill all the remaining width of the row.)
Determines whether to create a new row or a new column, depending on the value of the FlowDirection property, after the control.
Returns: Boolean. true if the flow break is set; otherwise, false.
Determines whether to proportionally stretch the width or the control to fill the remaining space it the containing row.
The FillWeight property defines the relative width of a control in a row managed by the FlowLayoutPanel. The default value is 0 and the maximum value is 100 (the control will fill all the remaining width of the row.) Throws:
ArgumentOutOfRangeException The value is less than 0 or greater than 100.
Determines whether to create a new row or a new column, depending on the value of the FlowDirection property, after the control.
Wisej.Web.FlexLayoutPanel
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a panel that dynamically arranges its child controls.
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.
Padding Increases the distance between the child controls and the borders of the parent panel.
Initializes a new instance of the FlexLayoutPanel class.
Initializes a new instance of the FlexLayoutPanel class with the specified settings.
Initializes a new instance of the FlexLayoutPanel class with the specified settings.
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
)
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.
Wisej.Web.Form
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a window or dialog box that makes up an application's user interface.
Default constructor.
Initializes a new instance of the Form class with the specified initial settings.
Initializes a new instance of the Form class with the specified initial settings.
Initializes a new instance of the Form class with the specified initial settings.
Initializes a new instance of the Form class with the specified initial settings.
Initializes a new instance of the Form class with the specified initial settings.
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:
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
)
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|
Name | Description |
---|
Provides data for the event.
Initializes a new instance of the class.
Name | Type | Description |
---|
: Returns a value that indicates why the form was closed.
Name | Description |
---|
Represents the method that handles a event.
Name | Type | Description |
---|
Name | Description |
---|
controls
The array of child controls to add to the panel.
direction
The flow direction of the layout of the child controls.
location
The location of the panel on its parent control.
size
The size of the panel.
controls
The array of child controls to add to the panel.
direction
The flow direction of the layout of the child controls.
control
The child control.
control
The child control.
control
The child control.
value
The fill weight value to set.
control
The child control.
value
The flow-break value to set.
Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source.
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
Provides access to common image properties across the controls that implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
controls
An array of Control objects to be added to the panel.
layout
Initial LayoutStyle.
location
The location of the panel on its parent control.
size
The size of the panel.
controls
An array of Control objects to be added to the panel.
layout
Initial LayoutStyle.
control
control
control
The child control.
control
value
control
value
control
The child control.
value
The fill weight value to set.
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
Provides access to common image properties across the controls that implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
onClosed
Handler for the Closed event.
controls
An array of Control objects to be added to the form.
onClosed
Handler for the Closed event.
location
The location of the form on the screen.
size
The size of the form.
controls
An array of Control objects to be added to the form.
location
The location of the form on the screen.
size
The size of the form.
onClosed
Handler for the Closed event.
location
The location of the form on the screen.
size
The size of the form.
controls
An array of Control objects to be added to the form.
onClosed
Handler for the Closed event.
ownedForm
The Form that this form will own.
point
The screen coordinate Point to convert.
point
The client coordinate Point to convert.
refreshChildren
True to also refresh all the children of this control.
ownedForm
A Form representing the form to remove from the list of owned forms for this form.
UI implementation for the FileDialog class.
UI implementation for the FolderDialog class.
Bindable components implement this interface.
Provides the functionality for a control to act as a parent for other controls.
Controls that support drag & drop operations implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
All wisej top-level windows implement this interface.
Allows an object to serialize itself.
BottomUp
Elements flow from the bottom of the design surface to the top.
LeftToRight
Elements flow from the left edge of the design surface to the right.
RightToLeft
Elements flow from the right edge of the design surface to the left.
TopDown
Elements flow from the top of the design surface to the bottom.
Returns or sets a value indicating the flow direction of the FlowLayoutPanel control.
Fixed | A fixed, not resizable border. |
FixedToolWindow | A tool window border that is not resizable. |
None | No border. |
Sizable | A resizable border. |
SizableToolWindow | A resizable tool window border. |
Optional async handler for the close event; called when the form/dialog has been closed. It's the equivalent of handling the event.
owner
A Form that is related to this instance. This form is added to the OwnedForms collection of the owner form.
Optional async handler for the close event; called when the form/dialog has been closed. It's the equivalent of handling the event.
Optional async handler for the close event; called when the form/dialog has been closed. It's the equivalent of handling the event.
owner
A Form that is related to this instance. This form is added to the OwnedForms collection of the owner form.
Optional async handler for the close event; called when the form/dialog has been closed. It's the equivalent of handling the event. When the onclose event handler is specified, the modal dialog doesn't suspend the execution on the server but it's still shown as a modal dialog on the client.
An optional Form that is related to this instance. This form is added to the OwnedForms collection of the owner form.
Returns or sets the border style of the form. |
closeReason |
sender | The source of the event. |
e |
Occurs after the form is closed. |
onclose
onclose
onclose
onclose
owner
A value that represents the reason why the form was closed.
Represents the method that handles a event.
A that contains the event data.
Name | Description |
---|
Name | Description |
---|
Represents the method that handles a event.
Name | Type | Description |
---|
Name | Description |
---|
Provides data for the event.
Initializes a new instance of the class.
Name | Type | Description |
---|
: Returns a value that indicates why the form is being closed.
Name | Description |
---|
Name | Description |
---|
Name | Description |
---|
Maximized | A maximized window. |
Minimized | A minimized window. |
Normal | A default sized window. |
Returns or sets a value that indicates whether form is minimized, maximized, or normal. |
sender | The source of the event. |
e |
Occurs before the form is closed. |
closeReason |
cancel | true to cancel the event; otherwise, false. |
CenterParent | The form is centered within the bounds of its parent form. |
CenterScreen | The form is centered on the current display, and has the dimensions specified in the form's size. |
DefaultLocation | The form is positioned at the default location and has the dimensions specified in the form's size. |
Manual |
Returns or sets the starting position of the form at run time. |
Wisej.Web.ScrollableControl
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Defines a base class for controls that support auto-scrolling behavior.
Throws:
Computes the location of the specified screen point into client coordinates.
Computes the location of the specified client point into screen coordinates.
Scrolls the specified child control into view.
Scrolls the specified child control into view. using the specified alignX and alignY preferences.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
Returns or sets the initial of the common dialog.
A that contains the event data.
A value that represents the reason why the form is being closed.
Represents the method that handles a event.
The position of the form is determined by the property.
Initializes a new instance of the class.
Name | Type | Description |
---|
: Returns or sets the area of the control (for example, along the top) where the tabs are aligned. (Default: Top
)
: Returns or sets whether the user can change the position of a tab button by dragging it. (Default: False
)
: Returns or sets the background color for the control.
: Indicates the border style for the control. (Default: Solid
)
: Returns or sets a value indicating the horizontal or vertical orientation of the tab pages.
: Returns or sets whether the menu of the MdiChild form is shown on the tab button. (Default: False
)
: Returns or sets whether the thumbnail page is visible. (Default: True
)
: Returns or sets whether the tab buttons should fill the control's size, or placed in the center, or aligned to the left. (Default: Normal
)
Initializes a new instance of the class.
: Returns or sets whether the container enables the user to scroll to any controls placed outside of its visible boundaries. (Default: False
)
: Returns or sets the size of the auto-scroll margin. (Default: {Width=0, Height=0}
)
The or value assigned is less than 0.
: Returns or sets the minimum size of the auto-scroll. (Default: {Width=0, Height=0}
)
: Returns the rectangle that represents the virtual display area of the control.
: Returns the properties associated with the horizontal scroll bar.
: Returns or sets the type of scroll bars to display for the control. (Default: Both
)
: Returns the properties associated with the vertical scroll bar.
Parameter | Type | Description |
---|
Returns: . A that represents the converted , point , in client coordinates.
Parameter | Type | Description |
---|
Returns: . A that represents the converted , point , in screen coordinates.
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|
Fired when the user or code scrolls through the client area.
Name | Description |
---|
Name | Description |
---|
owner |
point |
point |
control | The child control to scroll into view. |
control | The child control to scroll into view. |
alignX |
alignY |
Represents a panel that dynamically lays out its contents in a grid composed of rows and columns. |
UI implementation for the FileDialog class. |
UI implementation for the FolderDialog class. |
Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source. |
Provides focus-management functionality for controls that can function as a container for other controls. |
Represents a panel that dynamically arranges its controls horizontally or vertically in automatic rows or columns. |
Represents a window or dialog box that makes up an application's user interface. |
Represents a web page that fills the browser and acts as the main container for the application. An application can have only one active main page at any given time. |
Represents a collapsible panel with an optional header that contains a group of controls. |
Represents a control consisting of a movable bar that divides a container's display area into two resizable panels. |
Provides an empty control that can be used to create other controls. |
Displays data in a customizable list format. |
Represents a desktop container that can host floating windows. |
Represents a panel that dynamically arranges its child controls. |
Provides an popup container that can be attached to other controls. |
Bindable components implement this interface. |
Controls that support drag & drop operations implement this interface. |
All wisej components implement this interface. |
Allows an object to serialize itself. |
Wisej.Web.MdiClient
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the container for multiple-document interface (MDI) child forms.
Initializes a new instance of MdiClient.
Form: Returns the currently active multiple-document interface (MDI) child window.
Form[]: Returns the child multiple-document interface (MDI) forms of the MdiClient control.
TabControl: Returns the internal TabControl.
Wisej.Web.ScrollEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Provides data for the Scroll event.
Initializes a new instance of the ScrollEventArgs class using the given values for the Type and NewValue properties.
Initializes a new instance of the ScrollEventArgs class using the given values for the Type and NewValue properties.
Initializes a new instance of the ScrollEventArgs class using the given values for the Type, NewValue, and ScrollOrientation properties.
Initializes a new instance of the ScrollEventArgs class using the given values for the Type, OldValue, and NewValue properties.
Initializes a new instance of the ScrollEventArgs class using the given values for the Type, OldValue, NewValue, and ScrollOrientation properties.
Int32: Returns or sets the new Value of the scroll bar.
Int32: Returns the old Value of the scroll bar.
ScrollOrientation: Returns the scroll bar orientation that raised the Scroll event.
ScrollEventType: Returns the type of scroll event that occurred.
Wisej.Web.GroupBox
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a Wisej control that displays a frame around a group of controls with an optional caption.
Initializes a new instance of the GroupBox class.
Initializes a new instance of the GroupBox class with the specified text.
Initializes a new instance of the GroupBox class with the specified controls, text, and collapsed state.
Boolean: Returns or sets a value indicating that the control can display html in the Text property. (Default: False
)
Boolean: Returns or sets a value that indicates whether the GroupBox resizes based on its contents. (Default: False
)
AutoSizeMode: Returns or sets the mode by which the Button automatically resizes itself. (Default: GrowOnly
)
Boolean: Gets or sets whether the checkbox next to the group box title is checked or unchecked. (Default: True
)
Boolean: Returns or sets a value that indicates whether the GroupBox is collapsed or expanded. (Default: False
)
Rectangle: Returns a rectangle that represents the inner dimensions of the GroupBox control.
Boolean: Enables or disables right-to-left layout when the value of RightToLeft is Yes (Default: False
)
Boolean: Gets or sets whether the group box shows a checkbox next to the text. (Default: False
)
Boolean: Returns or sets a value that indicates the GroupBox displays the open/close button next to the title. (Default: False
)
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
)
EventHandler Fired when the value of the Checked property changes.
EventHandler Fired when the groupbox is collapsed.
EventHandler Fired when the groupbox is expanded.
EventHandler Fired when the value of the RightToLeftLayout property changes.
Wisej.Web.Page
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a web page that fills the browser and acts as the main container for the application. An application can have only one active main page at any given time.
To show the page assign it to the MainPage property.
Initializes a new instance of the Page class.
Initializes a new instance of the Page class with the specified initial settings.
IButtonControl: Returns or sets the button that is clicked when the user presses the ENTER key. (Default: null
)
Boolean: Returns true if this page instance is the currently active page. It is the same as comparing the instance with MainPage.
Page: Returns the currently active page for this application. It's the same as MainPage, it is added to be consistent with ActiveForm.
Boolean: Returns or sets whether the container enables the user to scroll to any controls placed outside of its visible boundaries. (Default: False
)
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
)
Int32: Returns or sets the height of the page.
Size: Returns the height and width of the page.
String: Returns or sets the title of the Page. If the page is the main page, setting the text also changes the title in the browser. (Default: ""
)
Int32: Returns or sets the width of the page.
Validates all selectable child controls in the container, including descendants. This is equivalent to calling ValidateChildren(ValidationConstraints.Selectable). See Selectable for details of exactly which child controls will be validated.
Returns: Boolean. true if all of the children validated successfully; otherwise, false. If called from the Validating or Validated event handlers, this method will always return false.
Validates all the child controls in the container. Exactly which controls are validated and which controls are skipped is determined by flags .
Returns: Boolean. true if all of the children validated successfully; otherwise, false. If called from the Validating or Validated event handlers, this method will always return false.
EventHandler Fired when the page becomes active, and it's the new MainPage.
EventHandler Fired when the page is deactivated and it's no longer the MainPage.
EventHandler Fired before the control becomes visible for the first time.
Wisej.Web.ScrollEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the method that handles the Scroll event of a ScrollableControl, ScrollBar, TrackBar, or DataGridView.
The whose properties this object describes.
The screen coordinate to convert.
The client coordinate to convert.
Indicates the preference. The final location of the control depends on the scrollable range and the available space. Note that will not scroll the control to the center, but will instead scroll it into the closest visible location with the minimum movement.
Indicates the preference. The final location of the control depends on the scrollable range and the available space. Note that will not scroll the control to the middle, but will instead scroll it into the closest visible location with the minimum movement.
Creates a panel that is associated with a .
Represents a single tab page in a .
Used by the control to display data at run time.
Represents a panel in a control.
All wisej controls derived from the class must implement this interface.
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Initializes a new instance of the class.
Initializes a new instance of the class with the specified settings.
Name | Type | Description |
---|
Initializes a new instance of the class with the specified settings.
Name | Type | Description |
---|
: Returns or sets a value that indicates whether the collapsed panel is automatically expanded when the mouse hovers over the title bar. (Default: OnClick
)
: Returns or sets a value that indicates whether the control resizes based on its contents. (Default: False
)
: Indicates the automatic sizing behavior of the control. (Default: GrowOnly
)
: Indicates the border style for the control. (Default: None
)
: Returns or sets a value that indicates whether the is collapsed. (Default: False
)
: Returns or sets a value that indicates to which side should the panel collapse. (Default: Top
)
: Returns a rectangle that represents the dimensions of the .
: Returns or sets whether the control can gain the focus. (Default: False
)
: Returns or sets the alignment of the header text in the control. (Default: Left
)
: Returns or sets the background color of the header of the panel.
: Returns or sets the text color of the header of the panel.
: Returns or sets a value that indicates on which side to display the header when the header is visible. (Default: Top
)
: 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.
: Returns or sets the image that is displayed in the header of the panel.
: Returns or sets the image list index value of the image in the displayed in the button control. (Default: -1
)
The specified index is less than -1.
: Returns or sets the key accessor for the image in the displayed in the header of the panel. (Default: ""
)
: Returns or sets the that contains the displayed in the header of the panel control. (Default: null
)
: Returns or sets the theme name or URL for the image to display in the header of the panel.
: Enables or disables right-to-left layout when the value of is (Default: False
)
: Returns or sets a value that indicates the caption bar displays the close button to collapse or expand the panel. (Default: True
)
: Returns or sets a value that indicates whether the caption bar is visible. (Default: False
)
: Returns or sets whether the user can give the focus to this control using the TAB key and the property is set to true. (Default: False
)
: Returns or sets the title of the panel. (Default: ""
)
: Returns the instance of associated with this control.
: Returns or sets the ToolTip text for the header of the panel. (Default: ""
)
Fired when the panel is collapsed.
Fired when the panel is expanded.
Fired when the value of the property changes.
Fired when a is clicked.
Name | Description |
---|
Name | Description |
---|
owner
The MdiParent form using this container to host its children.
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
args
The arguments received from the client.
type
One of the ScrollEventType values.
newValue
The new value for the scroll bar.
type
One of the ScrollEventType values.
newValue
The new value for the scroll bar.
scroll
One of the ScrollOrientation values.
type
One of the ScrollEventType values.
oldValue
The old value for the scroll bar.
newValue
The new value for the scroll bar.
type
One of the ScrollEventType values.
oldValue
The old value for the scroll bar.
newValue
The new value for the scroll bar.
scroll
One of the ScrollOrientation values.
Represents the method that handles the Scroll event of a ScrollableControl, ScrollBar, TrackBar, or DataGridView.
text
The text to display on the GroupBox.
controls
An array of control objects to add to the GroupBox.
text
The text to display on the GroupBox.
location
Initial location.
size
Initial size.
controls
An array of control objects to add to the GroupBox.
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
controls
An array of Control objects to be added to the form.
flags
Places restrictions on which controls have their Validating event raised.
Bindable components implement this interface.
Provides the functionality for a control to act as a parent for other controls.
Controls that support drag & drop operations implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
All wisej top-level windows implement this interface.
Allows an object to serialize itself.
sender
The source of the event.
e
A ScrollEventArgs that contains the event data.
Fired when the user or code scrolls through the client area.
Fired when the scroll box has been moved by either a mouse or keyboard action.
Fired when the user or code scrolls the grid.
Fired when the SlideBar widget scrolls its content.
Fired when the user or code scrolls the ListView.
controls |
location | The location of the panel on its parent control. |
size | The size of the panel. |
controls |
Represents a panel that dynamically lays out its contents in a grid composed of rows and columns. |
Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source. |
Represents a panel that dynamically arranges its controls horizontally or vertically in automatic rows or columns. |
Represents a panel that dynamically arranges its child controls. |
Bindable components implement this interface. |
Controls that support drag & drop operations implement this interface. |
Provides access to common image properties across the controls that implement this interface. |
All wisej components implement this interface. |
Allows an object to serialize itself. |
Wisej.Web.SlideBar
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Displays child controls vertically or horizontally in a scrollable container.
Initializes a new instance of the SlideBar class.
Initializes a new instance of the SlideBar class with the specified settings.
Initializes a new instance of the SlideBar class with the specified settings.
BorderStyle: Returns or sets the type of border that is drawn around the SlideBar control. (Default: None
)
Color: Returns or sets the background Color of the scroll buttons.
The default background color is set in the theme color as "slidebarButtons".
HScrollProperties: Returns the properties associated with the horizontal scroll position.
LayoutEngine: Returns the control's layout engine.
Orientation: Returns or sets the Orientation of the SlideBar control. (Default: Horizontal
)
Int32: Returns or sets the number of pixels to scroll when the scroll buttons are pressed. (Default: 15
)
Throws:
ArgumentOutOfRangeException The value is less than 1 or greater than 32000.
Int32: Returns or sets the spacing between the child controls. (Default: 0
)
Throws:
ArgumentOutOfRangeException The value is less than 0 or greater than 32000.
VScrollProperties: Returns the properties associated with the vertical scroll position.
Scrolls the content by the specified offset in pixels.
Scrolls the specified child control into view.
Scrolls the specified child control into view. using the specified alignX preference.
Scrolls the specified child control into view. using the specified alignY preference.
Scrolls the content to the specified position in pixels.
EventHandler Fired when the value of Orientation changes.
ScrollEventHandler Fired when the SlideBar widget scrolls its content.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EventHandler Fired when the control has completed the scrolling animation.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
EventHandler Fired when the value of ScrollStep changes.
EventHandler Fired when the value of Spacing changes.
Wisej.Web.SplitContainer
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a control consisting of a movable bar that divides a container's display area into two resizable panels.
Throws:
Throws:
Throws:
Throws:
Resets the size of the splitter to the value set in the theme.
An array of objects to be added to the panel.
An array of objects to be added to the panel.
Creates a panel that is associated with a .
Represents a single tab page in a .
Used by the control to display data at run time.
Represents a panel in a control.
All wisej controls derived from the class must implement this interface.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Name | Description |
---|---|
Specifies that , , or neither panel is fixed.
Name | Description |
---|
Name | Description |
---|
Initializes a new instance of the class with the specified coordinates of the mouse pointer and the upper left corner of the .
Name | Type | Description |
---|
: Returns or sets the X coordinate of the upper left corner of the splitter in client coordinates.
: Returns or sets the Y coordinate of the upper left corner of the splitter in client coordinates.
Name | Description |
---|
Initializes a new instance of the class.
: Returns or sets the background image displayed in the control. (Default: null
)
: Returns or sets the background image displayed in the control. (Default: null
)
: Returns or sets the for the .
: Returns or sets the style of border for the . (Default: Solid
)
: Returns or sets which panel remains the same size when the container is resized. (Default: None
)
: Returns or sets whether the splitter is fixed or movable. (Default: False
)
: Returns or sets a value indicating the horizontal or vertical orientation of the panels. (Default: Vertical
)
: Returns the left or top panel of the , depending on .
: Returns or sets a value determining whether is collapsed or expanded. (Default: False
)
: Returns or sets the minimum distance in pixels of the splitter from the left or top edge of . (Default: 25
)
The specified value is incompatible with the orientation.
: Returns the right or bottom panel of the , depending on .
: Returns or sets a value determining whether is collapsed or expanded. (Default: False
)
: Returns or sets the minimum distance in pixels of the splitter from the right or bottom edge of . (Default: 25
)
The specified value is incompatible with the orientation.
: Returns or sets the location of the splitter, in pixels, from the left or top edge of the . (Default: 50
)
The value is less than zero.
The value is incompatible with the orientation.
: Returns the size and location of the splitter relative to the .
: Returns or sets the width of the splitter in pixels.
The value is less than one or is incompatible with the orientation.
Fired when the value of changes.
Fired when the splitter control is moved.
Fired when the splitter control is in the process of moving.
Name | Description |
---|
controls
An array of Control objects to be added to the panel.
orientation
Initial Orientation value.
location
The location of the panel on its parent control.
size
The size of the panel.
controls
An array of Control objects to be added to the panel.
orientation
Initial Orientation value.
offset
Number of pixels to scroll by.
duration
The time in milliseconds the scroll to should take.
control
The child control to scroll into view.
control
The child control to scroll into view.
alignX
Indicates the HorizontalAlignment preference. The final location of the control depends on the scrollable range and the available space. Note that Center will not scroll the control to the center, but will instead scroll it into the closest visible location with the minimum movement.
control
The child control to scroll into view.
alignY
Indicates the VerticalAlignment preference. The final location of the control depends on the scrollable range and the available space. Note that Middle will not scroll the control to the middle, but will instead scroll it into the closest visible location with the minimum movement.
position
The position in pixels to scroll to.
duration
The time in milliseconds the scroll to should take.
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
None |
Panel1 |
Panel2 |
splitX | The X coordinate of the upper left corner of the splitter in client coordinates. |
splitY | The Y coordinate of the upper left corner of the splitter in client coordinates. |
Bindable components implement this interface. |
Provides the functionality for a control to act as a parent for other controls. |
Controls that support drag & drop operations implement this interface. |
All wisej components implement this interface. |
Allows an object to serialize itself. |
Wisej.Web.SplitterCancelEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the method that will handle the SplitterMoving event of a SplitContainer.
Wisej.Web.StatusBar
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Displays information to the user in a about the object being viewed, the object's components, or the object's operation.
Initializes a new instance of the StatusBar class.
DockStyle: Returns or sets the docking behavior of the StatusBar control. (Default: Bottom
)
Int32: Returns the number of child panels without forcing the creation of the collection.
StatusBarPanelCollection: Returns the collection of StatusBar panels contained within the control.
Boolean: Returns or sets whether any panels that have been added to the control are displayed. (Default: True
)
The StatusBar control displays the value of its Text property without any panels by default. When ShowPanels is set to true, the StatusBarPanel children specified in the StatusBar control are displayed; otherwise they are hidden and the Text is displayed instead.
Boolean: Returns or sets whether a sizing grip is displayed in the lower-right corner of the control. (Default: True
)
String: Returns or sets the text displayed in the StatusBar control when if doesn't contain any StatusBarPanel or when ShowPanels is false. (Default: ""
)
The text assigned to the StatusBar is displayed only if it doesn't contain any StatusBarPanel or if the property ShowPanels is false.
HorizontalAlignment: Returns or sets how text is aligned in a StatusBar control. (Default: Left
)
StatusBarPanelClickEventHandler Fired when a StatusBarPanel object on a StatusBar control is clicked.
Specifies that neither , is fixed. A event affects both panels.
Specifies that is fixed. A event affects only .
Specifies that is fixed. A event affects only .
Returns or sets which panel remains the same size when the container is resized.
Represents the method that will handle the event of a .
All wisej controls derived from the class must implement this interface.
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Description |
---|---|
sender
The source of the event.
e
A SplitterCancelEventArgs that contains the event data.
Fired when the splitter control is in the process of moving.
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
Wisej.Web.StatusBarPanel
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a panel in a StatusBar control.
Initializes a new instance of the StatusBarPanel class.
HorizontalAlignment: Returns or sets the alignment of text and icons within the status bar panel. (Default: Left
)
Boolean: Returns or sets a value indicating that the control can display html in the Text property. (Default: False
)
StatusBarPanelAutoSize: Returns or sets whether the status bar panel is automatically resized. (Default: None
)
StatusBarPanelBorderStyle: Returns or sets the border style of the status bar panel. (Default: Solid
)
Image: Returns or sets the icon to display within the status bar panel.
Int32: Returns or sets the index value of the image assigned to the StatusBarPanel. (Default: -1
)
Throws:
ArgumentException The assigned value is less than -1.
String: Returns or sets the theme name or URL for the icon to display in the StatusBarPanel.
String: Returns or sets the name of the image assigned to the StatusBarPanel. (Default: ""
)
Int32: Returns or sets the minimum allowed width of the status bar panel within the StatusBar control. (Default: 10
)
Throws:
ArgumentException A value less than 0 is assigned to the property.
String: Returns or sets the name to apply to the StatusBarPanel.
Padding: Returns or sets padding within the statusbar panel.
StatusBar: Returns the StatusBar control that hosts the status bar panel.
Object: Returns or sets an object that contains data about the StatusBarPanel. (Default: null
)
String: Returns or sets the text of the status bar panel. (Default: ""
)
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 "<br/>".
String: Returns or sets ToolTip text associated with the status bar panel. (Default: ""
)
Int32: Returns or sets the width of the status bar panel within the StatusBar control. (Default: 100
)
Throws:
ArgumentException The width specified is less than the value of the MinWidth property.
Begins the initialization of a StatusBarPanel.
Ends the initialization of a StatusBarPanel.
Updates the component on the client. Overridden to repaint the parent control in design mode.
EventHandler Fired when the StatusBarPanel is clicked.
Name | Description |
---|---|
Name | Description |
---|---|
Represents a panel in a control that can host any .
Initializes a new instance of .
: Returns or sets the to be hosted. (Default: null
)
Name | Description |
---|
Bindable components implement this interface.
All wisej components implement this interface.
Allows an object to serialize itself.
Bindable components implement this interface. |
All wisej components implement this interface. |
Allows an object to serialize itself. |
Wisej.Web.StatusBar StatusBarPanelCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the collection of StatusBarPanel controls in a StatusBar control.
Boolean: Returns a value indicating whether this collection is read-only.
StatusBarPanel: Returns or sets the StatusBarPanel at the specified index.
StatusBarPanel: Returns the StatusBarPanel identified by the name.
Adds a StatusBarPanel with the specified text to the collection.
Returns: StatusBarPanel. A StatusBarPanel that represents the panel that was added to the collection.
Adds a StatusBarPanel to the collection.
Returns: Int32. The zero-based index of the item in the collection.
Throws:
ArgumentNullException The StatusBarPanel being added to the collection was null.
ArgumentException The parent of the StatusBarPanel specified in the panel parameter is not null.
Adds an array of StatusBarPanel to the collection.
Removes all panels from the collection.
Removes and optionally disposes all StatusBarPanel objects from the collection.
Determines whether the specified StatusBarPanel is located within the collection.
Returns: Boolean. true if the StatusBarPanel is located within the collection; otherwise, false.
Determines whether the collection contains a StatusBarPanel with the specified key.
Returns: Boolean. true to indicate the collection contains a StatusBarPanel with the specified key; otherwise, false.
Returns an enumerator to use to iterate through the StatusBarPanel objects in the collection.
Returns: IEnumerator. An IEnumerator that represents the item collection.
Returns the index within the collection of the specified StatusBarPanel.
Returns: Int32. The zero-based index where the StatusBarPanel is located within the collection; otherwise, negative one (-1).
Returns the index of the first occurrence of a StatusBarPanel with the specified key.
Returns: Int32. The zero-based index of the first occurrence of the StatusBarPanel with the specified key, if found; otherwise, -1.
Inserts the specified StatusBarPanel into the collection at the specified index.
Throws:
ArgumentNullException The panel parameter is null.
ArgumentException The panel parameter's parent is not null.
ArgumentOutOfRangeException The index parameter is less than zero or greater than the value of the Count property of the StatusBarPanelCollection class.
Removes the specified StatusBarPanel from the collection.
Throws:
ArgumentNullException The StatusBarPanel assigned to the panel parameter is null.
Removes the StatusBarPanel located at the specified index within the collection.
Throws:
ArgumentOutOfRangeException The index parameter is less than zero or greater than or equal to the value of the Count property of the StatusBarPanelCollection class.
Removes the StatusBarPanel with the specified key from the collection.
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Specifies how a on a control behaves when the control resizes.
Name | Description |
---|
Name | Description |
---|
Specifies the appearance of the border for a on a control.
Name | Description |
---|
Name | Description |
---|
Provides data for the event.
Initializes a new instance of the class.
Name | Type | Description |
---|
Initializes a new instance of the class.
Name | Type | Description |
---|
Initializes a new instance of the class.
Name | Type | Description |
---|
: Returns the to draw.
Name | Description |
---|
text
The text for the StatusBarPanel that is being added.
panel
A StatusBarPanel that represents the panel to add to the collection.
panels
Array of StatusBarPanel objects to add to the collection.
dispose
Indicates whether the removed StatusBarPanel objects should be disposed.
panel
The StatusBarPanel to locate in the collection.
key
The name of the item to find in the collection.
panel
The StatusBarPanel to locate in the collection.
key
The name of the StatusBarPanel to find in the collection.
index
The zero-based index location where the panel is inserted.
panel
A StatusBarPanel representing the panel to insert.
panel
The StatusBarPanel representing the panel to remove from the collection.
index
The zero-based index of the item to remove.
key
The name of the StatusBarPanel to remove from the collection.
Dashed | A dashed line border. |
Dotted | A dotted line border. |
Double | A double solid line border. |
None | No border. |
Solid | A solid line border. |
Contents |
None |
Spring |
Returns or sets whether the status bar panel is automatically resized. |
Returns or sets the border style of the status bar panel. |
statusBarPanel |
button |
clicks | The number of times that the mouse button was clicked. |
x | The x-coordinate of the mouse click. |
y | The y-coordinate of the mouse click. |
statusBarPanel |
button |
clicks | The number of times that the mouse button was clicked. |
x | The x-coordinate of the mouse click. |
y | The y-coordinate of the mouse click. |
role | The internal role assigned to the element that generated the pointer event. |
args | The event arguments received from the client. |
Wisej.Web.StatusBarPanelClickEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the method that will handle the PanelClick event of a StatusBar.
Wisej.Web.TabControl
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Manages a related set of TabPage pages.
Initializes a new instance of the TabControl class.
Initializes a new instance of the TabControl class with the specified initial settings.
Initializes a new instance of the TabControl class with the specified initial settings.
Initializes a new instance of the TabControl class with the specified initial settings.
Initializes a new instance of the TabControl class with the specified initial settings.
TabAlignment: Returns or sets the area of the control (for example, along the top) where the tabs are aligned.
Boolean: Returns or sets whether the user can change the position of a tab button by dragging it. (Default: False
)
Boolean: Returns or sets the option to automatically activate the first focusable control of the TabPage when the SelectedTab is changed. Since 3.5.4 (Default: False
)
BorderStyle: Indicates the border style for the control. (Default: Solid
)
Display: Returns or sets the Display mode of the control to determine whether to display the icon, the text or both. (Default: Both
)
Rectangle: Returns the display area of the control's tab pages.
ImageList: Returns or sets the images to display on the control's tabs. (Default: null
)
Size: Returns or sets the fixed size of the tab buttons. The default value is Empty to use the itemSize set in the current theme or auto sizing.
When set to Empty (default) it uses the itemSize set in the theme. You can also set only the width or the height and leave the other value set to 0 to use the value in the current theme or auto sizing. The width (or height when Alignment is Left or Right) is applied when the value SizeMode is Fixed or Center. The height (or width when Alignment is Top or Bottom) is applied always.
Orientation: Returns or sets a value indicating the horizontal or vertical orientation of the TabControl tabs.
Int32: Returns the number of rows that are currently being displayed in the control's tab strip.
Int32: Returns or sets the number of pixels to scroll when the scroll buttons are pressed. (Default: 15
)
Throws:
ArgumentOutOfRangeException The value is less than 1 or greater than 500.
Int32: Returns or sets the index of the currently selected tab page. (Default: -1
)
Throws:
ArgumentOutOfRangeException The value is less than -1.
TabPage: Returns or sets the currently selected tab page.
Boolean: Returns or sets whether a tab's ToolTip is shown when the mouse passes over the tab. (Default: False
)
Boolean: Returns or sets whether the tab visibility menu button is visible. (Default: False
)
TabSizeMode: Returns or sets whether the tab buttons should fill the control's size, or placed in the center, or use the size set in ItemSize.
Int32: Gets the number of tabs in the tab strip.
TabPageCollection: Returns the collection of tab pages in this tab control.
Makes the tab following the tab with the specified index the current tab.
Throws:
ArgumentOutOfRangeException index is less than 0 or greater than the number of TabPage controls in the TabPages collection minus 1.
Makes the tab following the specified TabPage the current tab.
Throws:
ArgumentNullException tabPage is null.
Makes the tab following the tab with the specified name the current tab.
Throws:
ArgumentNullException tabPageName is null; or tabPageName does not match the Name property of any TabPage in the TabPages collection.
Returns the TabPage control at the specified location.
Returns: Control. The TabPage at the specified location.
Throws:
ArgumentOutOfRangeException index is less than 0 or greater than the number of TabPage controls in the TabPages collection minus 1.
Returns the bounding rectangle for the tab button of the TabPage at the specified index in this TabControl control.
Returns: Rectangle. A Rectangle that represents the bounds of the specified tab.
Bounding rectangles for the tab buttons are received from the client and are updated asynchronously. If the application adds a tab page, or changes any property that causes the tab button to be resized (orientation, sizing, text, alignment, etc.) it cannot immediately after retrieve the new bounds. When the tab rectangles are updated, the TabControl will fire the StyleChanged event to inform the application that the bounding rectangles have been updated. In alternative, you can use the GetTabRect and GetTabRectAsync overloads to query the client and receive the new bounding rectangle for the request tab page. Bounding rectangles are always empty until the TabControl has been rendered on the client. Throws:
ArgumentOutOfRangeException The index is less than zero; or the index is greater than or equal to TabCount.
Retrieves the bounding rectangle for the tab button of the TabPage at the specified index in this TabControl control.
Bounding rectangles are always empty until the TabControl has been rendered on the client. Throws:
ArgumentOutOfRangeException The index is less than zero; or the index is greater than or equal to Count.
ArgumentNullException The callback method is null.
Retrieves the bounding rectangle for the tab button of the TabPage at the specified index in this TabControl control.
Returns: Task<Rectangle>.
Bounding rectangles are always empty until the TabControl has been rendered on the client. Throws:
ArgumentOutOfRangeException The index is less than zero; or the index is greater than or equal to Count.
Makes the tab with the specified index the current tab.
Throws:
ArgumentOutOfRangeException index is less than 0 or greater than the number of TabPage controls in the TabPages collection minus 1.
Makes the specified TabPage the current tab.
Throws:
ArgumentNullException tabPage is null.
Makes the tab with the specified name the current tab.
Throws:
ArgumentNullException tabPageName is null; or tabPageName does not match the Name property of any TabPage in the TabPages collection.
TabControlEventHandler Fired when a tab is deselected.
TabControlCancelEventHandler Occurs before a tab is deselected, enabling a handler to cancel the tab change.
EventHandler Fired when the value of ScrollStep changes.
TabControlEventHandler Fired when a tab is selected.
EventHandler Fired when the SelectedIndex property has changed.
TabControlCancelEventHandler Occurs before a tab is selected, enabling a handler to cancel the tab change.
TabControlEventHandler Occurs after a tab is closed by the user and has been removed from the tab control.
TabControlCancelEventHandler Occurs before a tab is closed by the user, enabling a handler to cancel the tab closing.
TabControlEventHandler Fired when the user drags a TabPage into a new position and the AllowUserToMoveTabs property is set to true.
TabControlEventHandler Occurs after a tab is shown or hidden by the user through the ShowVisibilityMenu or programmatically through the Hidden property.
The width of the is determined by its contents.
The does not change size when the control resizes.
The uses the available space on the (the space not taken up by other panels whose property is set to or ) and shares it with other panels that have their property set to .
The that represents the panel that was clicked.
One of the values that represents the mouse buttons that were clicked while over the .
The that represents the panel that was clicked.
One of the values that represents the mouse buttons that were clicked while over the .
Represents the method that will handle the event of a .
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Description |
---|
Name | Description |
---|
Provides data for the and events of a control.
Initializes a new instance of the class.
Name | Type | Description |
---|
Initializes a new instance of the class.
Name | Type | Description |
---|
: Returns a value indicating which event is occurring.
: Returns the zero-based index of the being selected when processing otherwise it returns -1.
: Returns the the event is occurring for.
: Returns the zero-based index of the being selected when processing and , or being deselected when processing and .
Name | Description |
---|
sender
The source of the event.
e
A StatusBarPanelClickEventArgs that contains the event data.
Fired when a StatusBarPanel object on a StatusBar control is clicked.
onSelectedIndexChanged
An Action delegate to handle the SelectedIndexChanged event.
tabPages
An array of TabPage objects to be added to the TabControl.
onSelectedIndexChanged
An Action delegate to handle the SelectedIndexChanged event.
location
The location of the TabControl on its parent control.
size
The size of the TabControl.
onSelectedIndexChanged
An Action delegate to handle the SelectedIndexChanged event.
location
The location of the TabControl on its parent control.
size
The size of the TabControl.
tabPages
An array of TabPage objects to be added to the TabControl.
onSelectedIndexChanged
An Action delegate to handle the SelectedIndexChanged event.
index
The index in the TabPages collection of the tab to deselect.
tabPage
The TabPage to deselect.
tabPageName
The Name of the tab to deselect.
index
The index of the TabPage to get.
index
The zero-based index of the tab page for which to retrieve the bounding rectangle of the tab button.
index
The zero-based index of the tab page for which to retrieve the bounding rectangle of the tab button.
callback
Callback method that will receive the bounding rectangle for the request tab button.
index
The zero-based index of the tab page for which to retrieve the bounding rectangle of the tab button.
index
The index in the TabPages collection of the tab to select.
tabPage
The TabPage to select.
tabPageName
The Name of the tab to select.
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
Bottom | The tab buttons are located across the bottom of the control. |
Left | The tab buttons are located along the left edge of the control. |
Right | The tab buttons are located along the right edge of the control. |
Top | The tab buttons are located across the top of the control. |
Returns or sets the area of the control (for example, along the top) where the tabs are aligned. |
Returns or sets the area of the control (for example, along the top) where the tabs are aligned. |
tabPage |
tabPageIndex |
cancel | true to cancel the tab change by default; otherwise, false. |
action |
tabPage |
tabPageIndex |
newTabPageIndex |
cancel | true to cancel the tab change by default; otherwise, false. |
action |
Wisej.Web.TabControlAction
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Defines values representing TabControl events.
Wisej.Web.TabControlCancelEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the method that will handle the Selecting or Deselecting event of a TabControl control.
Wisej.Web.TabControlEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Provides data for the Selected and Deselected events of a TabControl control.
Initializes a new instance of the TabControlEventArgs class.
TabControlAction: Returns a value indicating which event is occurring.
TabPage: Returns the TabPage the event is occurring for.
Int32: Returns the zero-based index of the TabPage in the TabPages collection.
Wisej.Web.TabControlEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the method that will handle the Selected or Deselected event of a TabControl control.
The the event is occurring for.
The zero-based index of tabPage in the collection.
One of the values.
The the event is occurring for.
The zero-based index of tabPage in the collection.
The zero-based index of tabPage in the collection.
One of the values.
Represents the method that will handle the or event of a control.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Specifies how tabs in a are sized.
Name | Description |
---|
Name | Description |
---|
Closed
Represents the TabClosed event.
Closing
Represents the TabClosing event.
Deselected
Represents the Deselected event.
Deselecting
Represents the Deselecting event.
Moved
Represents the TabMoved event.
Selected
Represents the Selected event.
Selecting
Represents the Selecting event.
VisibilityChanged
Represents the TabVisibilityChanged event.
Returns a value indicating which event is occurring.
Returns a value indicating which event is occurring.
sender
The source of the event.
e
A TabControlCancelEventArgs that contains the event data.
Occurs before a tab is selected, enabling a handler to cancel the tab change.
Occurs before a tab is closed by the user, enabling a handler to cancel the tab closing.
Occurs before a tab is deselected, enabling a handler to cancel the tab change.
tabPage
The TabPage the event is occurring for.
tabPageIndex
The zero-based index of tabPage in the TabPages collection.
action
One of the TabControlAction values.
Represents the method that will handle the Selected or Deselected event of a TabControl control.
sender
The source of the event.
e
A TabControlEventArgs that contains the event data.
Occurs after a tab is closed by the user and has been removed from the tab control.
Occurs after a tab is shown or hidden by the user through the ShowVisibilityMenu or programmatically through the Hidden property.
Fired when a tab is selected.
Fired when a tab is deselected.
Fired when the user drags a TabPage into a new position and the AllowUserToMoveTabs property is set to true.
Center |
Fill |
Fixed | All tab buttons use the same width (or height when vertically aligned). |
Normal | The width (or height when vertically aligned) of each tab button is sized to accommodate its content. |
Returns or sets whether the tab buttons should fill the control's size, or placed in the center, or aligned to the left. |
Wisej.Web.TabPage
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a single tab page in a TabControl.
Initializes a new instance of the TabPage class.
Initializes a new instance of the TabPage class and specifies the text to display as the title the tab.
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.
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.
EventHandler Fired when the value of the Text property changes.
Wisej.Web.TableLayoutPanel
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a panel that dynamically lays out its contents in a grid composed of rows and columns.
Returns the column position of the specified child control.
Throws:
Returns the number of columns spanned by the specified child control.
Returns the child control occupying the specified position.
Throws:
Returns the row position of the specified child control.
Throws:
Returns the number of rows spanned by the specified child control.
Sets the column position of the specified child control.
Sets the number of columns spanned by the child control.
Throws:
Sets the row position of the specified child control.
Sets the number of rows spanned by the child control.
Throws:
Tab buttons are centered within the width of the .
The width of each tab button is sized to fill the entire width of the .
Returns or sets whether the tab buttons should fill the control's size, or placed in the center, or use the size set in .
Name | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Name | Description |
---|---|
Initializes a new instance of the class.
Initializes a new instance of the class with the specified initial settings.
Name | Type | Description |
---|
: Returns or sets the number of columns in the table. (Default: 0
)
: Returns a collection of column styles for the .
: Returns the collection of controls contained within the .
: Returns or sets whether the control should expand to accommodate new cells when all existing cells are occupied. (Default: AddRows
)
: Returns the control's layout engine.
: Returns or sets the number of rows in the table. (Default: 0
)
: Returns a collection of row styles for the .
Returns the that represents the row and the column of the cell.
Parameter | Type | Description |
---|
Returns: . A that represents the cell position.
Parameter | Type | Description |
---|
Returns: . The column position of the specified child control, or -1 if the position of control is determined by .
control is null.
control is not a type that can be arranged by this .
Parameter | Type | Description |
---|
Returns: . The number of columns spanned by the child control. The default is 1.
Parameter | Type | Description |
---|
Returns: . 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 property set to false.
Either column or row (or both) is less than 0.
Returns the that represents the row and the column of the cell that contains the control.
Parameter | Type | Description |
---|
Returns: . A that represents the cell position.
Parameter | Type | Description |
---|
Returns: . The row position of control , or -1 if the position of control is determined by .
control is null.
control is not a type that can be arranged by this .
Returns an array representing the heights, in pixels, of the rows in the .
Returns: . An array of type that contains the heights, in pixels, of the rows in the .
Parameter | Type | Description |
---|
Returns: . The number of rows spanned by the child control. The default is 1.
Sets the that represents the row and the column of the cell.
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|
value is less than 1.
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|
value is less than 1.
Name | Description |
---|
text
The text for the tab.
control
The Control to look for.
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
Provides access to common image properties across the controls that implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
location | The location of the panel on its parent control. |
size | The size of the panel. |
controls | The array of child controls to add to the panel. |
control | A control contained within a cell. |
control |
control |
column | The column position of the control to retrieve. |
row | The row position of the control to retrieve. |
control | A control contained within a cell. |
control |
control |
control | A control contained within a cell. |
position |
control | The control to move to another column. |
column | The column to which control will be moved. |
control |
value | The number of columns to span. |
control | The control to move to another row. |
row | The row to which control will be moved. |
control |
value | The number of rows to span. |
Bindable components implement this interface. |
Controls that support drag & drop operations implement this interface. |
Provides access to common image properties across the controls that implement this interface. |
All wisej components implement this interface. |
Allows an object to serialize itself. |
Wisej.Web.ColumnStyle
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the look and feel of a column in a table layout.
Initializes an instance of the ColumnStyle class to its default state.
Initializes and instance of the ColumnStyle class to its default state.
Initializes an instance of the ColumnStyle class using the supplied SizeType value.
Initializes and instance of the ColumnStyle class using the supplied SizeType and width values.
Throws:
ArgumentOutOfRangeException width is less than 0.
Single: Returns or sets the width value for a column.
Throws:
ArgumentOutOfRangeException The value is less than 0 when setting this property.
Wisej.Web.RowStyle
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the look and feel of a row in a table layout.
Initializes an instance of the RowStyle class to its default state.
Initializes an instance of the RowStyle class.
Initializes an instance of the RowStyle class using the supplied SizeType value.
Initializes an instance of the RowStyle class using the supplied SizeType and height values.
Throws:
ArgumentOutOfRangeException height is less than 0.
Single: Returns or sets the height of a row.
Throws:
ArgumentOutOfRangeException The value is less than 0 when setting this property.
A child control of the .
A child control of the .
A child control of the .
A child control of the .
A that represents the row and the column of the cell.
A child control of the .
A child control of the .
All wisej controls derived from the class must implement this interface.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Represents a cell in a .
Initializes a new instance of the class.
Name | Type | Description |
---|
: Returns or sets the column number of the current .
: Returns or sets the row number of the current .
Name | Description |
---|
A collection that stores objects.
: Returns or sets the at the specified index.
Adds a new to the .
Parameter | Type | Description |
---|
Returns: . The position into which the new element was inserted.
Determines whether the contains a specific style.
Parameter | Type | Description |
---|
Returns: . true if the is found in the ; otherwise, false.
Determines the index of a specific item in the .
Parameter | Type | Description |
---|
Returns: . The index of colStyle if found in the ; otherwise, -1.
Inserts a into the at the specified position.
Parameter | Type | Description |
---|
Removes the first occurrence of a specific object from the .
Parameter | Type | Description |
---|
style
Underlying style instance.
sizeType
A SizeType indicating how the column should be should be sized relative to its containing table.
sizeType
A SizeType indicating how the column should be should be sized relative to its containing table.
width
The preferred width, in pixels or percentage, depending on the sizeType parameter.
style
Underlying style instance.
sizeType
A SizeType indicating how the row should be should be sized relative to its containing table.
sizeType
A SizeType indicating how the row should be should be sized relative to its containing table.
height
The preferred height in pixels or percentage of the TableLayoutPanel, depending on sizeType .
column | The column position of the cell. |
row | The row position of the cell. |
colStyle |
colStyle |
colStyle |
index |
colStyle |
colStyle |
Wisej.Web.TableLayoutControlCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a collection of child controls in a table layout container.
Initializes a new instance of the TableLayoutControlCollection class.
TableLayoutPanel: Returns the parent TableLayoutPanel that contains the controls in the collection.
Adds the specified control to the collection and positions it at the specified cell.
Throws:
ArgumentException Either * column* or row is less than -1.
Wisej.Web.TableLayoutPanelGrowStyle
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Specifies how a TableLayoutPanel will gain additional rows or columns after its existing cells are full.
Returns the that represents the row and the column of the cell.
Returns the that represents the row and the column of the cell.
The to add to the .
The to locate in the .
The to locate in the .
The zero-based index at which the should be inserted.
The to insert into the . The value can be null.
The to remove from the . The value can be null.
Name | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Description |
---|---|
container
The TableLayoutPanel control that contains the control collection.
control
The control to add.
column
The column in which control will be placed.
row
The row in which control will be placed.
AddColumns
The TableLayoutPanel gains additional columns after it is full.
AddRows
The TableLayoutPanel gains additional rows after it is full.
FixedSize
The TableLayoutPanel does not allow additional rows or columns after it is full.
Returns or sets whether the TableLayoutPanel control should expand to accommodate new cells when all existing cells are occupied.
Returns or sets a value indicating how the table layout should expand to accommodate new cells when all existing cells are occupied.
Wisej.Web.TableLayoutSettings
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Collects the characteristics associated with table layouts.
Throws:
Throws:
Throws:
Returns the column position of the specified child control.
Throws:
Returns the number of columns that the cell containing the child control spans.
Returns the row position of the specified child control.
Throws:
Returns the number of rows that the cell containing the child control spans.
Throws:
Sets the column position for the specified child control.
Throws:
Sets the number of columns that the cell containing the child control spans.
Throws:
Sets the row position of the specified child control.
Throws:
Sets the number of rows that the cell containing the child control spans.
Throws:
: Returns or sets the maximum number of columns allowed in the table layout. (Default: 0
)
The property value is less than 0.
: Returns the collection of styles used to determine the look and feel of the table layout columns.
: Returns or sets a value indicating how the table layout should expand to accommodate new cells when all existing cells are occupied. (Default: AddRows
)
: Returns the current table layout engine.
: Returns or sets the maximum number of rows allowed in the table layout. (Default: 0
)
The property value is less than 0.
: Returns the collection of styles used to determine the look and feel of the table layout rows.
Returns the that represents the row and the column of the cell.
Parameter | Type | Description |
---|
Returns: . A that represents the cell position.
control is null.
Parameter | Type | Description |
---|
Returns: . The column position of the specified child control.
control is null.
Parameter | Type | Description |
---|
Returns: . The number of columns that the cell containing the child control spans.
Parameter | Type | Description |
---|
Returns: . The row position of the specified child control.
control is null.
Parameter | Type | Description |
---|
Returns: . The number of rows that the cell containing the child control spans.
Sets the that represents the row and the column of the cell.
Parameter | Type | Description |
---|
control is null.
Parameter | Type | Description |
---|
control is null.
column is less than -1.
Parameter | Type | Description |
---|
control is null.
value is less than 1.
Parameter | Type | Description |
---|
control is null.
row is less than -1.
Parameter | Type | Description |
---|
control is null.
value is less than 1.
control | A control contained within a cell. |
control | A control contained within a cell. |
control | A control contained within a cell. |
control | A control contained within a cell. |
control | A control contained within a cell. |
control | A control contained within a cell. |
cell |
control | A control contained within a cell. |
column | The column position for the specified child control. |
control | A control contained within a cell. |
value | The number of columns that the cell containing the child control spans. |
control | A control contained within a cell. |
row | The row position of the specified child control. |
control | A control contained within a cell. |
value | The number of rows that the cell containing the child control spans. |
Wisej.Web.TableLayoutStyle
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Implements the basic functionality that represents the appearance and behavior of a table layout.
SizeType: Returns or sets a flag indicating how a row or column should be sized relative to its containing table. (Default: AutoSize
)
Wisej.Web.TableLayoutStyleCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Implements the basic functionality for a collection of table layout styles.
Int32: Gets the number of styles actually contained in the TableLayoutStyleCollection.
TableLayoutStyle: Returns or sets TableLayoutStyle at the specified index.
Throws:
ArgumentException The property value is already assigned to another owner. You must first remove it from its current location or clone it.
Adds a new TableLayoutStyle to the end of the current collection.
Returns: Int32. The position into which the new element was inserted.
Throws:
ArgumentException style is already assigned to another owner. You must first remove it from its current location or clone it.
Disassociates the collection from its associated TableLayoutPanel and empties the collection.
Removes the style at the specified index of the collection.
A that represents the cell position.
Name | Description |
---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Name | Description |
---|---|
Initializes a new instance of the class.
: Enables the overflow handling which automatically removes items that don't fit in the and adds them to a drop-down menu button. (Default: True
)
: Returns or sets whether the toolbar adjusts its size automatically, based on the size of the buttons and the dock style. (Default: True
)
: Returns or sets the border style of the toolbar control. (Default: None
)
: Returns the number of child buttons without forcing the creation of the collection.
: Returns the collection of controls assigned to the toolbar control.
: Returns or sets whether clicking ToolBar buttons causes validation to be performed on the active control. (Default: False
)
: (Default: Top
)
: Returns or sets the collection of images available to the toolbar button controls. (Default: null
)
: Returns or sets whether the toolbar displays a ToolTip for each button. (Default: True
)
: Returns or sets the alignment of text in relation to each image displayed on the toolbar button controls. (Default: Underneath
)
Fired when the value of the property has changed.
Fired when a on the is clicked.
Fired when a drop-down style or its down arrow is clicked.
Name | Description |
---|
Represents the look and feel of a column in a table layout.
Represents the look and feel of a row in a table layout.
style
The TableLayoutStyle to add to the TableLayoutStyleCollection.
index
The zero-based index of the TableLayoutStyle to be removed.
A collection that stores ColumnStyle objects.
A collection that stores RowStyle objects.
Bindable components implement this interface. |
Controls that support drag & drop operations implement this interface. |
All wisej components implement this interface. |
Allows an object to serialize itself. |
Wisej.Web.ToolBarButton
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents an item in the ToolBar.
Change the type of item to display using the Style property.
Initializes a new instance of the ToolBarButton class.
Initializes a new instance of the ToolBarButton class and displays the assigned text on the button.
Boolean: Returns or sets a value indicating that the control can display HTML in the Text property. (Default: False
)
String: Sets the appearance key for the theme engine. (Default: null
)
Boolean: Returns or sets whether the application blocks the browser with a modal mask when this button is clicked and until the server is done processing the execution request. (Default: False
)
AutoShowLoader blocks the entire browser as soon as the button is clicked since it's implemented on the client side, while ShowLoader blocks the specific widget when returning from the request.
ICommand: Returns or sets the ICommand implementation to invoke. (Default: null
)
ContextMenu: Returns or sets the menu to be displayed in the drop-down toolbar button. (Default: null
)
Boolean: Returns or sets whether the button is enabled. (Default: True
)
Color: Returns or sets the text color of the toolbar button.
Image: Returns or sets the image that is displayed in a ToolBarButton.
Int32: Returns or sets the index value of the image assigned to the ToolBarButton. (Default: -1
)
Throws:
ArgumentOutOfRangeException The specified index is less than -1.
String: Returns or sets the name of the image assigned to the button. (Default: ""
)
String: Returns or sets the theme name or URL for the image to display in the ToolBarButton.
Padding: Returns or sets the space between toolbar buttons.
String: Returns or sets the name of the ToolBarButton.
Padding: Returns or sets padding within the toolbar button.
ToolBar: Returns the toolbar control that the toolbar button is assigned to.
Boolean: Returns or sets whether a toggle-style toolbar button is currently in the pushed state. (Default: False
)
ToolBarButtonSizeMode: Returns or sets how the toolbar button is resized. (Default: Auto
)
ToolBarButtonStyle: Returns or sets the style of the toolbar button. (Default: PushButton
)
Object: Returns or sets the object that contains data about the toolbar button. (Default: null
)
String: Returns or sets the text displayed on the toolbar button. (Default: ""
)
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 "<br/>".
String: Returns or sets the text that appears as a ToolTip for the button. (Default: ""
)
Boolean: Returns or sets whether the toolbar button is visible or hidden. (Default: True
)
Generates the Click and ButtonClick events.
Updates the component on the client. Overridden to repaint the toolbar in design mode.
EventHandler Fired when the control is clicked.
EventHandler Fired when the Command property value changes.
EventHandler Fired when the Pushed property value changes.
Wisej.Web.ToolBarButtonClickEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Provides data for the ButtonClick event.
Initializes a new instance of the ToolBarButtonClickEventArgs class.
ToolBarButton: Returns or sets the ToolBarButton that was clicked.
Wisej.Web.ToolBarButtonSizeMode
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Specifies how a ToolBarButton in a ToolBar control behaves when the control resizes.
Wisej.Web.ToolBarButtonStyle
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Specifies the style of the button in a ToolBar control.
Wisej.Web.ToolBarButtonClickEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the method that will handle the ButtonClick event of a ToolBar.
Wisej.Web.ToolBar ToolBarButtonCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the collection of ToolBarButton controls in a ToolBar control.
Initializes a new instance of the ToolBarButtonCollection class.
Boolean: Returns a value indicating whether this collection is read-only.
ToolBarButton: Returns or sets the ToolBarButton at the specified index.
ToolBarButton: Returns the ToolBarButton identified by the name.
Adds a ToolBarButton with the specified text to the collection.
Returns: ToolBarButton. A ToolBarButton that represents the panel that was added to the collection.
Adds a ToolBarButton to the collection.
Returns: Int32. The zero-based index of the item in the collection.
Throws:
ArgumentNullException The ToolBarButton being added to the collection is null.
ArgumentException The parent of the ToolBarButton specified in the button parameter is not null.
Adds an array of ToolBarButton to the collection.
Removes all ToolBarButton objects from the collection.
Removes and optionally disposes all ToolBarButton objects from the collection.
Determines whether the specified ToolBarButton is located within the collection.
Returns: Boolean. true if the ToolBarButton is located within the collection; otherwise, false.
Determines whether the collection contains a ToolBarButton with the specified key.
Returns: Boolean. true to indicate the collection contains a ToolBarButton with the specified key; otherwise, false.
Returns an enumerator to use to iterate through the ToolBarButton objects in the collection.
Returns: IEnumerator. An IEnumerator that represents the item collection.
Returns the index within the collection of the specified ToolBarButton.
Returns: Int32. The zero-based index where the ToolBarButton is located within the collection; otherwise, negative one (-1).
Returns the index of the first occurrence of a ToolBarButton with the specified key.
Returns: Int32. The zero-based index of the first occurrence of the ToolBarButton with the specified key, if found; otherwise, -1.
Inserts the specified ToolBarButton into the collection at the specified index.
Throws:
ArgumentNullException The button parameter is null.
ArgumentException The button parameter's parent is not null.
ArgumentOutOfRangeException The index parameter is less than zero or greater than the value of the Count property of the ToolBarButtonCollection class.
Removes the specified ToolBarButton from the collection.
Throws:
ArgumentNullException The ToolBarButton assigned to the button parameter is null.
Removes the ToolBarButton located at the specified index within the collection.
Throws:
ArgumentOutOfRangeException The index parameter is less than zero or greater than or equal to the value of the Count property of the ToolBarButtonCollection class.
Removes the ToolBarButton with the specified key from the collection.
All wisej controls derived from the class must implement this interface.
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Represents the method that will handle the and events.
Name | Type | Description |
---|
Name | Description |
---|
text
The text to display on the new ToolBarButton.
Bindable components implement this interface.
Defines an object that can invoke a Command.
All wisej components implement this interface.
Allows an object to serialize itself.
button
The ToolBarButton that was clicked.
Represents the method that will handle the ButtonClick event of a ToolBar.
Auto
The width of the ToolBarButton is determined by its contents.
Fill
Returns or sets how the toolbar button is resized.
DropDownButton
A drop-down button that displays a menu when clicked.
PushButton
A standard button.
Separator
A line between ToolBar buttons.
ToggleButton
A toggle button. The Pushed property and state is toggle on each click.
Returns or sets the style of the toolbar button.
sender
The source of the event.
e
A ToolBarButtonClickEventArgs that contains the event data.
Fired when a ToolBarButton on the ToolBar is clicked.
Fired when a drop-down style ToolBarButton or its down arrow is clicked.
Fired when a ToolBarButton on the ToolBar is clicked.
Fired when a drop-down style ToolBarButton or its down arrow is clicked.
owner
The ToolBar control that owns this collection.
text
The text for the ToolBarButton that is being added.
button
A ToolBarButton that represents the panel to add to the collection.
buttons
Array of ToolBarButton objects to add to the collection.
dispose
Indicates whether the removed items should be disposed.
button
The ToolBarButton to locate in the collection.
key
The name of the item to find in the collection.
button
The ToolBarButton to locate in the collection.
key
The name of the ToolBarButton to find in the collection.
index
The zero-based index location where the panel is inserted.
button
A ToolBarButton representing the panel to insert.
button
The ToolBarButton representing the panel to remove from the collection.
index
The zero-based index of the item to remove.
key
The name of the ToolBarButton to remove from the collection.
sender | The source of the event. |
e |
Wisej.Web.ToolBarTextAlign
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Specifies the alignment of text on the ToolBarButton control.
A object that contains the event data.
Fired when the property is set to true and a new value for a child control of a is needed.
Fired when the property is set to true and the value of a child control in the changes.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Represents the method that will handle the event of a .
Name | Type | Description |
---|
Name | Description |
---|
Provides data for the event.
Initializes an instance of the class with the specified coordinates of the mouse pointer and the coordinates of the upper-left corner of the control.
Name | Type | Description |
---|
: Returns or sets the x-coordinate of the upper-left corner of the splitter (in client coordinates).
: Returns or sets the y-coordinate of the upper-left corner of the splitter (in client coordinates).
: Returns the x-coordinate of the mouse pointer (in client coordinates).
: Returns the y-coordinate of the mouse pointer (in client coordinates).
Name | Description |
---|
ApplicationExit
The application is terminating.
FormOwnerClosing
The owner control form is closing.
MdiFormClosing
The parent form of this multiple document interface (MDI) form is closing.
None
The cause of the closure was not defined or could not be determined.
UserClosing
The user is closing the form through the user interface (UI).
Returns the reason for the form closing.
Returns a value that indicates why the form was closed.
Returns a value that indicates why the form is being closed.
Closes the window.
Right
The text is aligned to the right of the ToolBarButton image.
Underneath
The text is aligned underneath the ToolBarButton image.
Returns or sets the alignment of text in relation to each image displayed on the toolbar button controls.
sender | The source of the event. |
e |
Fired when the splitter control is moved. |
x | The x-coordinate of the mouse pointer (in client coordinates). |
y | The y-coordinate of the mouse pointer (in client coordinates). |
splitX | The x-coordinate of the upper-left corner of the splitter (in client coordinates). |
splitY | The y-coordinate of the upper-left corner of the splitter (in client coordinates). |
A that contains the event data.
Represents the method that will handle the event of a .
Creates a panel that is associated with a .
Initializes a new instance of the class with its specified .
Name | Type | Description |
---|
: Returns or sets a value that indicates whether the is collapsed. (Default: False
)
: Returns or sets a value that indicates to which side should the panel collapse. (Default: Top
)
: The name of this .
: Returns or sets the that contains this .
: Returns or sets the height and width of the .
Name | Description |
---|
splitContainer |
Bindable components implement this interface. |
Controls that support drag & drop operations implement this interface. |
Provides access to common image properties across the controls that implement this interface. |
All wisej components implement this interface. |
Allows an object to serialize itself. |
Wisej.Web.TableLayoutRowStyleCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
A collection that stores RowStyle objects.
RowStyle: Returns or sets the RowStyle at the specified index.
Adds a new RowStyle to the TableLayoutRowStyleCollection.
Returns: Int32. The position into which the new element was inserted.
Determines whether the TableLayoutRowStyleCollection contains a specific style.
Returns: Boolean. true if the RowStyle is found in the TableLayoutRowStyleCollection; otherwise, false.
Determines the index of a specific item in the TableLayoutRowStyleCollection.
Returns: Int32. The index of rowStyle if found in the TableLayoutRowStyleCollection; otherwise, -1.
Inserts a RowStyle into the TableLayoutRowStyleCollection at the specified position.
Removes the first occurrence of a specific object from the TableLayoutRowStyleCollection.
The that contains the .
All wisej controls derived from the class must implement this interface.
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
rowStyle
The RowStyle to add to the TableLayoutRowStyleCollection.
rowStyle
The RowStyle to locate in the TableLayoutRowStyleCollection.
rowStyle
The RowStyle to locate in the TableLayoutRowStyleCollection.
index
The zero-based index at which the RowStyle should be inserted.
rowStyle
The RowStyle to insert into the TableLayoutRowStyleCollection. The value can be null.
rowStyle
The RowStyle to remove from the TableLayoutRowStyleCollection. The value can be null.
Wisej.Web.TabControl TabPageCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Contains a collection of TabPage objects.
Int32: Returns the number of tab pages in the collection.
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.
TabPage: Returns the TabPage with the specified key from the collection.
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.
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.
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
tabPage
The TabPage to add.
text
The text to display on the TabPage.
key
The name of the TabPage.
text
The text to display on the TabPage.
key
The name of the TabPage.
text
The text to display on the TabPage.
imageIndex
The index of the image to display on the TabPage.
key
The name of the TabPage.
text
The text to display on the TabPage.
imageKey
The key of the image to display on the TabPage.
pages
dispose
Indicates whether to dispose the TabPage pages removed from the collection.
tabPage
The TabPage to locate in the collection.
key
The name of the TabPage page to search for.
array
The one-dimensional array that is the destination of the tab pages copied from the collection. The array must have zero-based indexing.
index
The zero-based index in the array at which copying begins.
tabPage
The TabPage to locate in the collection.
key
The name of the TabPage to find in the collection.
index
The zero-based index location where the TabPage page is inserted.
tabPage
The TabPage to insert in the collection.
index
The zero-based index location where the TabPage page is inserted.
text
The text to display in the TabPage page.
index
The zero-based index location where the TabPage is inserted.
key
The name of the TabPage.
text
The text to display on the TabPage.
index
The zero-based index location where the TabPage is inserted
key
The name of the tab page.
text
The text to display on the TabPage.
imageIndex
The zero-based index of the image to display on the TabPage.
index
The zero-based index location where the TabPage is inserted.
key
The name of the tab page.
text
The text to display on the TabPage.
imageKey
The key of the image to display on the TabPage.
tabPage
The TabPage to remove.
index
The zero-based index of the TabPage to remove.
key
The name of the TabPage page to remove.