Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Encapsulates a collection of objects for use by the DomainUpDown class.

public class DomainUpDownItemCollection : IList, ICollection, IEnumerable

Public Class DomainUpDownItemCollection
    Inherits IList
    Implements ICollection, IEnumerable

Properties

Count

Int32: Returns the number of items in the collection.

IsReadOnly

Boolean: Returns a value indicating whether this collection can be modified.

Item(index)

Object: Retrieves the item at the specified index within the collection.

Throws:

• ArgumentOutOfRangeException The index was less than zero; or the index was greater of equal to the count of items in the collection.

Methods

Adds an object to the end of the collection.

Returns: Int32. The index at which the item has been added.

Adds a collection of objects to the end of the collection.

Removes all items from the DomainUpDown control.

Determines if the specified item is located within the collection.

Returns: Boolean. true if the item is located within the collection; otherwise, false.

Returns an enumerator that can be used to iterate through the item collection.

Returns: IEnumerator. A IEnumerator that represents the item collection.

Retrieves the index within the collection of the specified item.

Returns: Int32. The zero-based index where the item is located within the collection; otherwise, -1.

Throws:

• ArgumentNullException The item parameter was null.

Inserts an element into the collection at the specified index.

Throws:

• ArgumentOutOfRangeException index is less than zero, or index is greater than number of items in the collection.

Removes the first occurrence of a specific object from the collection.

Removes the element at the specified index of the collection.

Throws:

• ArgumentOutOfRangeException index is less than zero; or index is equal to or greater than number of items in the collection.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents a set of tool widgets associated with a component. The component includes the tools panel according to its design. For example, the Form component includes the tools in its caption bar. Other components may include the tools elsewhere.

public class ComponentToolCollection : IList, ICollection, IEnumerable, IList<ComponentTool>, ICollection<ComponentTool>, IEnumerable<ComponentTool>

Public Class ComponentToolCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of ComponentTool), ICollection(Of ComponentTool), IEnumerable(Of ComponentTool)

Constructors

ComponentToolCollection()

Initializes a new instance of the ComponentToolCollection class not bound to any control.

ComponentToolCollection(owner)

Initializes a new instance of the ComponentToolCollection class.

Properties

IsReadOnly

Boolean: Returns a value indicating whether this collection is read-only.

Item(index)

ComponentTool: Returns or sets the ComponentTool at the specified index.

ComponentTool: Returns the ComponentTool identified by the name.

Methods

Adds a ComponentTool with the specified name and image source to the collection.

Returns: ComponentTool. A ComponentTool that represents the panel that was added to the collection.

Adds a ComponentTool to the collection.

Throws:

• ArgumentNullException The ComponentTool being added to the collection was null.

• ArgumentException The parent of the ComponentTool specified in the tool parameter is not null.

Adds an array of ComponentTool to the collection

Removes all tools from the collection.

Removes and optionally disposes all tools from the collection.

Determines whether the specified panel is located within the collection.

Returns: Boolean. true if the panel is located within the collection; otherwise, false.

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

Returns: Boolean. true to indicate the collection contains a ComponentTool with the specified key; otherwise, false.

Returns an enumerator to use to iterate through the item collection.

Returns: IEnumerator. An IEnumerator that represents the item collection.

Returns the index within the collection of the specified panel.

Returns: Int32. The zero-based index where the panel is located within the collection; otherwise, negative one (-1).

Returns the index of the first occurrence of a ComponentTool with the specified key.

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

Inserts the specified ComponentTool into the collection at the specified index.

Throws:

• ArgumentNullException The tool parameter is null.

• ArgumentException The tool 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 ComponentToolCollection class.

Removes the specified ComponentTool from the collection.

Returns: Boolean.

Throws:

• ArgumentNullException The ComponentTool assigned to the tool parameter is null.

Removes the ComponentTool 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 ComponentToolCollection class.

Removes the ComponentTool with the specified key from the collection.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

• Control

  • DateTimePicker

Represents a control that allows the user to select or type a date and a time.

public class DateTimePicker : Control, INotifyPropertyChanged, IModified, ILabel, IReadOnly, IValidation

Public Class DateTimePicker
    Inherits Control
    Implements INotifyPropertyChanged, IModified, ILabel, IReadOnly, IValidation

There are 4 tooltip labels that can be localized for this control. They are already localized in the default languages provided by Wisej. An application can localize the tooltip labels by adding the string resources to the localized Resources.resx or /Properties/Resources.resx.

• $Next year The tooltip text displayed on the popup calendar for the next-year button.

• $Last year The tooltip text displayed on the popup calendar for the last-year button.

• $Next month The tooltip text displayed on the popup calendar for the next-month button.

• $Last month The tooltip text displayed on the popup calendar for the last-month button.

Constructors

DateTimePicker()

Initializes a new instance of the DateTimePicker class.

Properties

Boolean: Returns or sets whether the height of the control is set automatically. (Default: True)

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

Boolean: Returns or sets whether the checkbox in the DateTimePicker is checked and the user can change the control's value. It works in conjunction with the ShowCheckBox property. (Default: True)

String: Returns or sets the custom date/time format string. (Default: "")

See Custom Date and Time Format Strings for the supported format definitions.

Boolean: Returns or sets whether the user can edit the text in the control. (Default: True)

Boolean: Enables or disables the browser's context menu. (Default: True)

Day: Returns or sets the first day of the week as displayed in the month calendar. (Default: Default)

DateTimePickerFormat: Returns or sets the format of the date/time value displayed in the control. (Default: Long)

Boolean: Returns or sets whether the prompt characters in the input mask are hidden when the masked datetime picker loses focus. (Default: False)

Boolean: Returns or sets a value that indicates that the control is invalid.

String: Returns or sets the invalid message that is shown in the invalid tooltip. (Default: "")

LabelWrapper: Provides a label related to the control.

String: Returns or sets the localizable label associated with this control. (Default: "")

String: Returns or sets the input mask. (Default: "")

When setting an edit mask on the DateTimePicker control you must also select a Format that matches the mask. Otherwise the formatted date selected using the drop down calendar or by code will be formatted into a string that is not compatible with the edit mask. For example, if the mask is "##/##/####" the Format should be Short or CustomFormat should be "dd/MM/yyyy". See also the TextMaskFormat property to determine how the mask is stripped when reading the Text property.

DateTime: Returns or sets the maximum date and time that can be selected in the control.

Throws:

• ArgumentException The value assigned is not less than the MaximumDate value (12/31/9998).

• SystemException The value assigned is less than the MinimumDateTime value (01/01/1753).

DateTime: Returns or sets the minimum date and time that can be selected in the control.

Throws:

• ArgumentException The value assigned is not less than the MaximumDate value (12/31/9998).

• SystemException The value assigned is less than the MinimumDateTime value (01/01/1753).

Boolean: Returns or sets a value that indicates that the date time picker control has been modified by the user since the control was created or its contents were last set.

Nullable<DateTime>: Returns or sets the date/time Value assigned to the control with the difference that if the value is DateTime.MinValue it returns null.

This property should be used when the DateTimePicker may hold a null date and it's bound to a database nullable column. Throws:

• ArgumentOutOfRangeException The set value is less than MinDate or more than MaxDate.

Char: Returns or sets the character used to represent the absence of user input in the DateTimePicker control. (Default: _)

Throws:

• ArgumentException The character specified when setting this property is not a valid prompt character.

Boolean: Returns or sets whether the control is read-only. (Default: False)

Boolean: Selects the text when gaining the focus. (Default: False)

Boolean: Returns or sets a value indicating if a calendar button (drop down control) is displayed and can be used to pick the date/time value. (Default: True)

Boolean: Returns or sets whether a check box is displayed to the left of the selected date. (Default: False)

Boolean: Returns or sets whether the current date is displayed at the bottom of the control. (Default: False)

Boolean: Returns or sets whether the popup calendar shows ToolTips. (Default: True)

Boolean: Returns or sets a value indicating if the spin buttons (up and down controls) are displayed and can be used to adjust the date/time value. (Default: False)

Boolean: Returns or sets whether the calendar control displays week numbers (1-52) to the left of each row of days. (Default: True)

String: Returns or sets the text associated with this control. (Default: "")

MaskFormat: Since 3.2.8 Returns or sets a value that determines whether literals and prompt characters are included in the Text value when the DateTimePicker also specifies a Mask. (Default: IncludeLiterals)

This property lets you control the value returned by the Text property when there is an edit Mask. The default is to remove the prompt and keep the literal in order to return a text value that can be parsed to a valid date: i.e. "1_/10/__23" is retuned as "1/10/23". Since 3.2.8 Note that when the value is null or empty, and regardless of the mask, the Text property returns an empty string.

DateTime: Returns or sets the value that is used by DateTimePicker as today's date.

Throws:

• ArgumentOutOfRangeException The value is less than the minimum allowable date; or the value is greater than the maximum allowable date.

String: Returns or sets the format string used to display today's date. (Default: "d")

See Custom Date and Time Format Strings for the supported format definitions.

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

DateTime: Returns or sets the DateTime value assigned to the control.

Throws:

• ArgumentOutOfRangeException The set value is less than MinDate or more than MaxDate.

String: Returns or sets the text to show when the field is empty. (Default: null)

Events

EventHandler Fired when the value of the Checked property changes.

EventHandler Fired when the drop-down calendar is dismissed and disappears.

EventHandler Fired when the drop-down calendar is shown.

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

EventHandler Fired when the Format property value has changed.

EventHandler Occurs after the input mask is changed.

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

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

ToolClickEventHandler Fired when a ComponentTool is clicked.

EventHandler Fired when the Value property changes.

Inherited By

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

• Component

  • ComponentTool

Represent a tool widget that can be displayed inside another control. A tool widget is different from other child controls: it's displayed inside the parent's layout. For example, the Form control shows tool widgets inside the caption bar. When a tool widget is pressed, it fires the toolClicked event on the container.

public class ComponentTool : Component

Public Class ComponentTool
    Inherits Component

Constructors

ComponentTool()

Initializes a new instance of the ComponentTool class.

Properties

AutoHide

Boolean: Returns or sets whether the ComponentTool automatically hides itself when the host control loses the focus. (Default: False)

Control

Control: Returns the Control that contains this ComponentTool object.

Boolean: Returns or sets whether the ComponentTool is enabled.

The tool can be forced enabled or disabled by assigning the Enabled property. Use ResetEnabled to reset this property to inherit from the container. If this property is not assigned, the tool will inherit the enabled state from the container Control. By assigning this property, you can force the tool to be enabled when the container is disabled and vice versa.

Image: Returns or sets the image that is displayed in a ComponentTool button.

String: Returns or sets the theme name or URL for the image to display in the ComponentTool button.

String: Returns or sets the name to apply to the ComponentTool. (Default: "")

LeftRightAlignment: Returns or sets the horizontal alignment of this ComponentTool within the parent's container. (Default: Right)

Boolean: Returns or sets whether a toggle-style ComponentTool is currently in the pushed state. (Default: False)

String: Returns or sets ToolTip text associated with the ComponentTool button. (Default: "")

Boolean: Returns or sets whether the ComponentTool is visible. (Default: True)

Methods

Resets the Enabled property to inherit the enabled state from the container Control.

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

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Specifies the case of the text that a control should enforce.

public enum CharacterCasing : Enum

Public Enum CharacterCasing As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Specifies the type, min, max, step, and mode properties to associate to the <input> element in a TextBox control. See https://www.w3schools.com/tags/att_input_type.asp.

public class InputType : ICloneable

Public Class InputType
    Inherits ICloneable

Properties

Max

String: Specifies the maximum value allowed. See https://www.w3schools.com/tags/att_input_type.asp. (Default: null)

Min

String: Specifies the minimum value allowed. See https://www.w3schools.com/tags/att_input_type.asp. (Default: null)

Mode

TextBoxMode: Specifies the type of data that might be entered by the user while editing the element or its contents. See https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode. (Default: Text)

Step

Nullable<Double>: Specifies the legal number intervals. See https://www.w3schools.com/tags/att_input_type.asp. (Default: null)

Type

TextBoxType: Specifies the type of <input> element to display. See https://www.w3schools.com/tags/att_input_type.asp. (Default: Text)

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

• Control

  • UpDownBase

    • DomainUpDown

Represents a spinner control that displays string values.

public class DomainUpDown : UpDownBase

Public Class DomainUpDown
    Inherits UpDownBase

Constructors

DomainUpDown()

Initializes a new instance of the NumericUpDown class.

Properties

Items

DomainUpDownItemCollection: A collection of objects assigned to the spinner control.

SelectedIndex

Int32: Returns or sets the index value of the selected item. (Default: -1)

Throws:

• ArgumentOutOfRangeException The assigned value is less than the default, -1; or the assigned value is greater than the Items count.

Object: Returns or sets the selected item based on the index value of the selected item in the collection.

Boolean: Returns or sets whether the item collection is sorted. (Default: False)

String: Returns or sets the text associated with this control. (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/>".

Events

EventHandler Fired when the SelectedItem property has been changed.

EventHandler Fired when the Sorted property has changed.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents the method that will handle the event of the control.

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Adds a label to the control it is attached to.

Controls that expose a "Label" property, can display a label in the position defined by . The label can automatically grow to fill the control's width or height (depending on the value of ) using either an absolute , a percentage, or the size that best fits the label. Size modes (values of :

• The size of the label is calculated automatically based in the font and the text. The and are applied when greater than 0.

• The size of the label is set by the value of the property in pixels. The and are applied when greater than 0.

• The size of the label is proportional to the size of the control according to the percentage set in the property. The and are applied when greater than 0.

This class implements the interface. To listen to property changes, simply attach to the event. Pointer events (, , etc.) occurring on the label associated with a control can be detected by checking if property contains the value "label". There are several additional properties and styles defined in the theme that can affect how the label behaves in the different positions and states set under the appearance key "label-wrapper".

Constructors

LabelWrapper()

Initializes a new instance of the class not bound to any control. It's used by the designer serializer to detect when the Label property is fully inherited.

Properties

AllowHtml

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Provides data for the or events of the control.

Constructors

DateRangeEventArgs(start, end)

Initializes a new instance of the class.

DateRangeEventArgs(range)

Initializes a new instance of the class.

Properties

End

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Provides data for the event.

Constructors

TypeValidationEventArgs(validatingType, isValidInput, returnValue, message)

Initializes a new instance of the class.

Properties

IsValidInput

: Returns whether the formatted input string was successfully converted to the validating type.

Message

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Uses a mask to distinguish between proper and improper user input.

The MaskedTextBox class is an enhanced control that supports a declarative syntax for accepting or rejecting user input. Using the property, you can enforce the following input types without writing any custom validation logic in your application:

• Required input characters.

• Optional input characters.

• The type of input expected at a given position in the mask; for example, a digit, or an alphabetic or alphanumeric character.

• Mask literals, or characters that should appear directly in the MaskedTextBox; for example, the hyphens(-) in a phone number, or the currency symbol in a price.

• Special processing for input characters; for example, to convert alphabetic characters to uppercase.

• Special processing for input characters; for example, to convert alphabetic characters to uppercase.

When a control is displayed at run time, it represents the mask as a series of prompt characters and optional literal characters. Each editable mask position, representing a required or optional input, is shown with a single prompt character. For example, the number sign (#) is often used as a placeholder for a numeric character input. You can use the property to specify a custom prompt character. The property determines if the user sees the prompt characters when the control loses input focus

Constructors

Throws:

Properties

This property only enables/disables the password mode for the textbox. It doesn't change the password masking character used by the browser.

Throws:

Methods

Converts the user input string to an instance of the validating type.

Throws:

Events

Inherited By

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents a control that enables the user to select a date using a visual monthly calendar display.

There are 4 tooltip labels that can be localized for this control. They are already localized in the default languages provided by Wisej. An application can localize the tooltip labels by adding the string resources to the localized Resources.resx or /Properties/Resources.resx.

• $Next year The tooltip text displayed on the popup calendar for the next-year button.

• $Last year The tooltip text displayed on the popup calendar for the last-year button.

• $Next month The tooltip text displayed on the popup calendar for the next-month button.

• $Last month The tooltip text displayed on the popup calendar for the last-month button.

Constructors

MonthCalendar()

Initializes an instance of the MonthCalendar control.

Properties

Throws:

Throws:

Throws:

Throws:

Throws:

Throws:

Throws:

Methods

Adds a day that is displayed in bold on an annual basis in the month calendar.

Adds a day to be displayed in bold in the month calendar.

Adds a day that is displayed in bold on a monthly basis in the month calendar.

Returns the low and high limits of the displayed dates of the control.

Removes all the annually bold dates.

Removes all the nonrecurring bold dates.

Removes all the monthly bold dates.

Removes the specified date from the list of annually bold dates.

Removes the specified date from the list of nonrecurring bold dates.

Removes the specified date from the list of monthly bolded dates.

Sets the number of columns and rows of months to display.

Throws:

Sets a date as the currently selected date.

Throws:

Sets the selected dates in a month calendar control to the specified date range.

Throws:

Events

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents the method that will handle the DateChanged or DateSelected event of a MonthCalendar.

public delegate void DateRangeEventHandler(Object sender, DateRangeEventArgs e)

Public Delegate Sub DateRangeEventHandler(ByVal sender As [Object], ByVal e As DateRangeEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents a date selection range in the MonthCalendar control.

public class SelectionRange

Public Class SelectionRange

Constructors

SelectionRange()

Initializes a new instance of the SelectionRange class.

SelectionRange(lower, upper)

Initializes a new instance of the SelectionRange class with the specified beginning and ending dates.

SelectionRange(range)

Initializes a new instance of the SelectionRange class with the specified selection range.

Properties

DateTime: Returns or sets the ending date and time of the selection range.

DateTime: Returns or sets the starting date and time of the selection range.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Provides data for the TagAdded or TagRejected or TagRejected or TagSelected events of a TagTextBox control

public class TagTextBoxEventArgs : EventArgs

Public Class TagTextBoxEventArgs
    Inherits EventArgs

Constructors

TagTextBoxEventArgs(text, index)

Initializes a new instance of the TagTextBoxEventArgs class.

Properties

Index

Int32: Returns the index of the tag being added, removed, rejected, or selected.

Text

String: Text of the tag that is being added, removed, rejected, or selected.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents the method that will handle the TagAdded or TagRejected or TagRejected or TagSelected events of a TagTextBox control.

public delegate void TagTextBoxEventHandler(Object sender, TagTextBoxEventArgs e)

Public Delegate Sub TagTextBoxEventHandler(ByVal sender As [Object], ByVal e As TagTextBoxEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

• Control

  • UpDownBase

    • NumericUpDown

Represents a spinner control that displays numeric values.

public class NumericUpDown : UpDownBase, ISupportInitialize, INotifyPropertyChanged

Public Class NumericUpDown
    Inherits UpDownBase
    Implements ISupportInitialize, INotifyPropertyChanged

Constructors

NumericUpDown()

Initializes a new instance of the NumericUpDown class.

Properties

DecimalPlaces

Int32: Returns or sets the number of decimal places to display in the spin box (also known as an up-down control). (Default: 0)

Throws:

• ArgumentOutOfRangeException The value assigned is less than 0; or the value assigned is greater than 99.

Boolean: Returns or sets whether the spin box (also known as an up-down control) should display the value it contains in hexadecimal format. (Default: False)

Decimal: Returns or sets the value to increment or decrement the spin box (also known as an up-down control) when the up or down buttons are clicked. (Default: 1)

Throws:

• ArgumentOutOfRangeException The assigned value is not greater than or equal to zero.

Decimal: Returns or sets the maximum value for the spin box (also known as an up-down control). (Default: 100)

Decimal: Returns or sets the minimum allowed value for the spin box (also known as an up-down control). (Default: 0)

Nullable<Decimal>: Returns or sets the Value assigned to the spin box (also known as an up-down control) with the difference that when the text is empty it returns null.

This property should be used when the NumericUpDown may hold a null value and it's bound to a database nullable column. Throws:

• ArgumentOutOfRangeException The assigned value is less than the Minimum property value; or the assigned value is greater than the Maximum property value.

String: Returns or sets a string to display after the value. (Default: "")

String: Returns or sets a string to display before the value. (Default: "")

Boolean: Returns or sets whether a thousands separator is displayed in the spin box (also known as an up-down control) when appropriate. (Default: False)

Decimal: Returns or sets the value assigned to the spin box (also known as an up-down control). (Default: 0)

Throws:

• ArgumentOutOfRangeException The assigned value is less than the Minimum property value; or the assigned value is greater than the Maximum property value.

Events

EventHandler Fired when the Value property has been changed in some way.

Inherited By

Implements