Namespace: Wisej.Web

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

MaskedTextBox

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

• Control

  • TextBoxBase

    • MaskedTextBox

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

public class MaskedTextBox : TextBoxBase

Public Class MaskedTextBox
    Inherits TextBoxBase

The MaskedTextBox class is an enhanced TextBox control that supports a declarative syntax for accepting or rejecting user input. Using the Mask 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 MaskedTextBox 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 PromptChar property to specify a custom prompt character. The HidePromptOnLeave property determines if the user sees the prompt characters when the control loses input focus

Constructors

Initializes a new instance of the MaskedTextBox class using defaults.

Initializes a new instance of the MaskedTextBox class using the specified input mask.

Throws:

• ArgumentNullException mask is null.

Properties

CharacterCasing: Returns or sets whether the MaskedTextBox control modifies the case of characters as they are typed.

CultureInfo: Returns or sets the culture information associated with the masked text box.

Boolean: Returns or sets whether the prompt characters in the input mask are hidden when the masked text box loses focus.

InputType: Specifies the type, min, max and step properties to associate to the element.

String: Returns or sets the input mask.

The Mask is a string that defines the masking characters and the literals to display and process during user input and when reading the Text property. Server side masking is processed by an instance of the MaskedTextProvider class exposed by the MaskedTextProvider property. On the client side, the mask processing is performed by the "wisej.utils.MaskProvider.js" class while the user edits the input field.

Masking Character Description 0 Digit, required. This element will accept any single digit between 0 and 9. 9 Digit or space, optional.

Digit or space, optional. If this position is blank in the mask, it will be rendered as a space in the Text property. Plus (+) and minus (-) signs are allowed. L Letter, required. Restricts input to the ASCII letters a-z and A-Z. This mask element is equivalent to [a-zA-Z] in regular expressions. ? Letter, optional. Restricts input to the ASCII letters a-z and A-Z. This mask element is equivalent to [a-zA-Z]? in regular expressions. & Character, required. This element behaves like the "L" element. C Character, optional. Any non-control character. This element behaves like the "?" element. A Alphanumeric, required. The only characters it will accept are the ASCII letters a-z and A-Z. This mask element behaves like the "a" element. a Alphanumeric, optional. The only characters it will accept are the ASCII letters a-z and A-Z. This mask element behaves like the "A" element. . Decimal placeholder. The actual display character used will be the decimal symbol appropriate to the format provider, as determined by the control's FormatProvider property. , Thousands placeholder. The actual display character used will be the thousands placeholder appropriate to the format provider, as determined by the control's FormatProvider property. : Time separator. The actual display character used will be the time symbol appropriate to the format provider, as determined by the control's FormatProvider property. / Date separator. The actual display character used will be the date symbol appropriate to the format provider, as determined by the control's FormatProvider property. $ Currency symbol. The actual character displayed will be the currency symbol appropriate to the format provider, as determined by the control's FormatProvider property. < Shift down. Converts all characters that follow to lowercase.

Shift up. Converts all characters that follow to uppercase. | Disable a previous shift up or shift down. Escape. Escapes a mask character, turning it into a literal. "\" is the escape sequence for a backslash. Others Literals. All non-mask elements will appear as themselves within MaskedTextBox. Literals always occupy a static position in the mask at run time, and cannot be moved or deleted by the user. If you change the Mask when the control already contains a value, it will apply the new mask to the existing text. The decimal (.), thousand (,), time (:), date (/), and currency ($) symbols default to displaying those symbols as defined by the application's culture. You can force a specific MaskedTextBox to display symbols for another culture by using the Culture property. Otherwise you can set the application-wide culture by setting the CurrentCulture property.

MaskedTextProvider: Returns the mask provider associated with this instance of the masked text box control.

Char: Returns or sets the character used to mask characters of a password in a single-line MaskedTextBox control.

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

Char: Returns or sets the character used to represent the absence of user input in the MaskedTextBox control.

Throws:

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

Boolean: Returns or sets whether the parsing of input text should stop after the first invalid character is reached.

Boolean: Returns or sets whether the text in the MaskedTextBox is spell checked by the browser.

String: Returns or sets the current text in the text box.

HorizontalAlignment: Returns or sets how text is aligned in a TextBox control.

Int32: Returns the length of text in the control.

MaskFormat: Returns or sets a value that determines whether literals and prompt characters are included in the formatted string.

Type: Returns or sets the data type used to verify the data input by the user.

Methods

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

Returns: Object. If successful, an Object of the type specified by the ValidatingType property; otherwise, null to indicate conversion failure.

Throws:

• Exception A critical exception occurred during the parsing of the input string.

Events

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

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

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

TypeValidationEventHandler Occurs when MaskedTextBox has finished parsing the current value using the ValidatingType property.

Inherited By

Implements

Namespace: Wisej.Web

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

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.

String: Returns or sets the text associated with this control.

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 " ".

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.0.0.0)

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

Properties

Max

: Specifies the maximum value allowed. See https://www.w3schools.com/tags/att_input_type.asp.

Min

: Specifies the minimum value allowed. See https://www.w3schools.com/tags/att_input_type.asp.

Mode

: 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.

Step

: Specifies the legal number intervals. See https://www.w3schools.com/tags/att_input_type.asp.

Type

Namespace: Wisej.Web

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

Properties

AllowHtml

: Returns or sets whether the label can contain HTML code.

AutoEllipsis

: Returns or sets whether to append the ... symbol when the text doesn't fit the label.

CharacterCasing

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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 control shows tool widgets inside the caption bar. When a tool widget is pressed, it fires the toolClicked event on the container.

Constructors

ComponentTool()

Initializes a new instance of the class.

Properties

AutoHide

: Returns or sets whether the automatically hides itself when the host control loses the focus.

Control

Methods

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

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Encapsulates a collection of objects for use by the class.

Properties

Count

: Returns the number of items in the collection.

IsReadOnly

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

Item(index)

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

Throws:

• 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.

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

Determines if the specified item is located within the collection.

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

Retrieves the index within the collection of the specified item.

Throws:

Inserts an element into the collection at the specified index.

Throws:

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

Removes the element at the specified index of the collection.

Throws:

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

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

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 class.

Properties

Throws:

Throws:

Throws:

Throws:

Events

Inherited By

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.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.0.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.0.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).

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.

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.

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).

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

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.

String: Returns or sets a string to display before the value.

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

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

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

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

• Control

  • MonthCalendar

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

public class MonthCalendar : Control, IReadOnly

Public Class MonthCalendar
    Inherits Control
    Implements IReadOnly

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

DateTime[]: Returns or sets the array of DateTime objects that determines which annual days are displayed in bold.

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

DateTime[]: Returns or sets the array of DateTime objects that determines which nonrecurring dates are displayed in bold.

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

Size: Returns or sets the number of columns and rows of months displayed.

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

DateTime: Returns or sets the maximum allowable date.

Throws:

• ArgumentException The value is less than the MinDate.

Int32: Returns or sets the maximum number of days that can be selected in a month calendar control.

Throws:

• ArgumentException The value is less than 1; or the MaxSelectionCount cannot be set.

DateTime: Returns or sets the minimum allowable date.

Throws:

• ArgumentException The date set is greater than the MaxDate; or the date set is earlier than 01/01/1753.

DateTime[]: Returns or sets the array of DateTime objects that determine which monthly days to bold.

Boolean: Returns or sets whether the control is read-only.

DateTime: Returns or sets the end date of the selected range of dates.

Throws:

• ArgumentOutOfRangeException The date value is less than the MinDate value; or the date value is greater than the MaxDate value.

SelectionRange: Returns or sets the selected range of dates for a month calendar control.

Throws:

• ArgumentOutOfRangeException The Start value of the assigned SelectionRange is less than the minimum date allowable for a month calendar control; or the Start value of the assigned SelectionRange is greater than the maximum allowable date for a month calendar control; or the End value of the assigned SelectionRange is less than the minimum date allowable for a month calendar control; or the End value of the assigned SelectionRange is greater than the maximum allowable date for a month calendar control.

DateTime: Returns or sets the start date of the selected range of dates.

Throws:

• ArgumentOutOfRangeException The date value is less than MinDate; or the date value is greater than MaxDate.

Boolean: Returns or sets whether the month calendar control displays days from the previous and the next month.

Boolean: Returns or sets whether the date represented by the TodayDate property is displayed at the bottom of the control.

Boolean: Returns or sets whether the month calendar shows ToolTips.

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

DateTime: Returns or sets the value that is used by MonthCalendar 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.

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

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

HeaderPosition: Returns or sets the position of the ComponentTool items associated with this control.

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.

Returns: SelectionRange. The begin and end dates of the displayed calendar.

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:

• ArgumentOutOfRangeException x or y is less than 1.

Sets a date as the currently selected date.

Throws:

• ArgumentOutOfRangeException The value is less than the minimum allowable date; or the value is greater than the maximum allowable date. This exception will only be thrown if MinDate or MaxDate have been set explicitly.

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

Throws:

• ArgumentOutOfRangeException start is less than the minimum date allowable for a month calendar control; or start is greater than the maximum allowable date for a month calendar control; or end is less than the minimum date allowable for a month calendar control; or end is greater than the maximum allowable date for a month calendar control. This exception will only be thrown if MinDate or MaxDate have been set explicitly.

Events

DateRangeEventHandler Fired when the date shown in the MonthCalendar changes.

DateRangeEventHandler Fired when the user changes the selected date or range.

DateRangeEventHandler Fired when the displayed range changes.

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

ToolClickEventHandler Fired when a ComponentTool is clicked.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the DateChanged or DateSelected events of the MonthCalendar control.

public class DateRangeEventArgs : EventArgs

Public Class DateRangeEventArgs
    Inherits EventArgs

Constructors

DateRangeEventArgs(start, end)

Initializes a new instance of the DateRangeEventArgs class.

DateRangeEventArgs(range)

Initializes a new instance of the DateRangeEventArgs class.

Properties

End

DateTime: Returns the last date/time value in the range that the user has selected.

DateTime: Returns the first date/time value in the range that the user has selected.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the or or or events of a control.

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the event of a control.

Constructors

TagTextBoxRenderEventArgs(text, index)

Initializes a new instance of the class.

Properties

BackColor

: Allows the application to change the background color of the tag displayed on the client.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents a data field that displays a list of selectable and removable tags. The control recognizes tags as the user types and adds in front of the editable field.

Constructors

TagTextBox()

Initializes an instance of a control.

Properties

AllowDuplicateTags

: Returns or sets whether duplicate tags are allowed. [Since 3.0.10]

When a duplicate tag is rejected, the control fires the event.

Methods

Events

Use this event to change the visual aspect of each tag on the client.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the or events of a control.

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Provides data for the or events of a control

Constructors

TagTextBoxMousEventArgs(text, index, button, clicks)

Initializes a new instance of the class.

Properties

Index

Used By