Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Wisej.Base.Component
Namespace: Wisej.Base
Assembly: Wisej.Framework (3.1.0.0)
The base class for Wisej components that are not controls. Wisej components are still managed on the client and the server but are not present on the designer surface. Examples of wisej components are: menu items, image lists, tree nodes, list items.
Default constructor
Default constructor
| Name | Type | Description |
|---|---|---|
Boolean: Checks if the UserData dynamic object was created and has any value.
Boolean: Indicates that the component has been disposed.
Object: Returns a dynamic object that can be used to store custom data in relation to this component.
Runs the JavaScript function within the component's context in the browser.
Runs the JavaScript function within the component's context in the browser and returns the value to the callback method.
Asynchronously runs the JavaScript function within the component's context in the browser and returns an awaitable Task containing the value returned by the remote call.
Returns: Task<Object>. An awaitable Task that represents the asynchronous operation.
Releases all resources used by the Component.
Runs the javaScript code within the component's context in the browser.
Runs the javaScript code within the component's context in the browser and returns the value to the callback method.
Asynchronously runs the javaScript code within the component's context in the browser and returns an awaitable Task that contains the value returned by the remote call.
Returns: Task<Object>. An awaitable Task that represents the asynchronous operation.
Updates the component on the client.
EventHandler Fired when the component is disposed.
Wisej.Base.Cookie
Wisej.Base.PostbackPropertyAttribute
Namespace: Wisej.Base
Assembly: Wisej.Framework (3.1.0.0)
Allows the property to return its value to postback requests.
Initializes the attribute.
Initializes the attribute.
| Name | Type | Description |
|---|
: Returns or sets whether the property is allows to return its value to postback requests.
Returns true if the property allows postback requests.
Wisej.Base.CookieCollection
Namespace: Wisej.Base
Assembly: Wisej.Framework (3.1.0.0)
Manages the collection of cookies for the current application.
: Returns the number of items in the collection.
: Returns the with a specific name from a .
Throws:
name is null.
: Returns the with a specific name from a .
Throws:
Adds a cookie to the collection.
Adds a new cookie to the collection.
Adds a new cookie to the collection.
Adds a new cookie to the collection.
Adds a new cookie to the collection.
Delete all cookies from the collection. NOTE: Cookies are only removed from the collection, not from the client. You need to set the expiration date to remove it from the client.
Determines whether the cookie is present in the collection.
Copies the cookie collection to a compatible one-dimensional array, starting at the specified index of the target array.
Returns the cookie with the specified name.
Searches for the specified cookie and returns the zero-based index of the first occurrence.
Searches for the specified cookie by name and returns the zero-based index of the first occurrence.
Removes the specified cookie from the collection. NOTE: Cookies are only removed from the collection, not from the client. You need to set the expiration date to remove it from the client.
Removes the specified cookie from the collection. NOTE: Cookies are only removed from the collection, not from the client. You need to set the expiration date to remove it from the client.
Removes the cookie at the specified index. NOTE: Cookies are only removed from the collection, not from the client. You need to set the expiration date to remove it from the client.
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Name | Description |
|---|---|
| Name | Description |
|---|---|
Creates a new instance of .
| Name | Type | Description |
|---|
Creates a new instance of .
| Name | Type | Description |
|---|
: Returns or sets the domain to associate the cookie with.
: Returns or sets the expiration date and time for the cookie.
: Returns or sets the name for the .
: Returns or sets the path of the .
: Returns or sets the value for the SameSite attribute of the cookie. The default value is .
: Returns or sets whether to transmit the cookie using Secure Sockets Layer (SSL)--that is, over HTTPS only.
: Returns or sets an individual cookie value.
| Parameter | Type | Description |
|---|
Returns: . True if the property allows postback requests.
index is out of range.
| Parameter | Type | Description |
|---|
| Parameter | Type | Description |
|---|
Returns: .
| Parameter | Type | Description |
|---|
Returns: .
| Parameter | Type | Description |
|---|
Returns: .
| Parameter | Type | Description |
|---|
Returns: .
| Parameter | Type | Description |
|---|
Returns: .
| Parameter | Type | Description |
|---|
| Parameter | Type | Description |
|---|
Returns: .
Returns: .
| Parameter | Type | Description |
|---|
Returns: .
| Parameter | Type | Description |
|---|
Returns: .
| Parameter | Type | Description |
|---|
Returns: . true if item is successfully removed; otherwise, false.
| Parameter | Type | Description |
|---|
Returns: . true if item is successfully removed; otherwise, false.
| Parameter | Type | Description |
|---|
function
The name of the JavaScript function to execute.
args
The arguments to pass to the function.
function
The name of the JavaScript function to execute.
callback
Asynchronous callback method that receives the return value.
args
The arguments to pass to the function.
function
The name of the JavaScript function to execute.
args
The arguments to pass to the function.
javaScript
The JavaScript code to run on the client.
javaScript
The JavaScript code to evaluate on the client.
callback
Asynchronous callback method that receives the return value.
javaScript
The JavaScript code to evaluate on the client.
Extends Component and enabled the components to appear on the designer surface.
Displays a message box that can contain text, buttons, and symbols that inform and instruct the user.
Implements a timer that raises an event at user-defined intervals.
Represents a component in the Desktop control's taskbar.
Represents a DateTime component in the Desktop control's taskbar.
Provides support for animating controls or windows using predefined animations definitions or custom animations in response to certain events.
Provides a user interface for indicating that a control on a form has an error associated with it.
Represents a small rectangular pop-up window that displays a brief help text next to a control when it gets activated (focused).
Allows controls to execute javascript code.
Add rotation capabilities along the X,Y,Z axis to Control controls.
Adds CSS styling to controls.
Represents a small rectangular pop-up window that displays a brief description of a control's purpose when the user rests the pointer on the control.
Displays an alert box that can contain an icon and text that inform and instruct the user. Alert boxes are not modal and can disappear automatically.
Displays a toast that can contain an icon and text.
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.
Provides methods to manage a collection of Image objects. This class cannot be inherited.
Displays a standard column header in a ListView control.
Displays an image column header in a ListView control.
Represents an individual menu item that is displayed within a MainMenu or ContextMenu and always shows a checkbox next to the label.
Represents a context menu associated to a Control.
Represents an individual menu item that is displayed within a MainMenu or ContextMenu rendered using the <a> link element to let the browser process the specified HRef URL.
Represents the main menu in a Form.
Represents the base functionality for all menus.
Represents an individual item that is displayed within a MainMenu or ContextMenu.
Represents a panel in a StatusBar control.
Represents an item in the ToolBar.
Represents a node of a TreeView.
All wisej components implement this interface.
Allows an object to serialize itself.
name | The name of the cookie. |
value | The value of the cookie. |
expires | The expiration date/time of the cookie. |
name | The name of the cookie. |
value | The value of the cookie. |
domain | The domain, or partial domain, associated with the cookie. |
expires | The expiration date/time of the cookie. |
property | Property to check. |
cookie | The cookie to add. |
name | The case-sensitive name of the cookie. |
value | The value of the new cookie to add. |
name | The case-sensitive name of the cookie. |
value | The value of the new cookie to add. |
domain | The domain, or partial domain, associated with the cookie. |
name | The case-sensitive name of the cookie. |
value | The value of the new cookie. |
expires | The expiration date/time of the new cookie. |
name | The case-sensitive name of the cookie. |
value | The value of the new cookie. |
domain | The value of the new cookie. |
expires | The expiration date/time of the new cookie. |
cookie | The cookie to locate. |
array | The one-dimensional System.Array that is the destination of the elements copied. |
index | The zero-based index in array at which copying begins. |
name | The case-sensitive name of the cookie to locate. |
cookie | The cookie to locate. |
name | The case-sensitive name cookie to locate. |
cookie | The cookie to remove from the collection. |
name | The case-sensitive name of the cookie to remove from the collection. |
index | The zero-based index of the element to remove. |
embedded
Indicates whether the component is embedded in a parent component. Embedded components don't update themselves, instead their parent is in charge of updating the corresponding client widget.
name | The name of the cookie. |
value | The value of the cookie. |
name | The name of the cookie. |
value | The value of the cookie. |
domain | The domain, or partial domain, associated with the cookie. |
allow | Indicates whether the property is allowed or disallowed to return its value to postback requests. |
Lax | Indicates the client should send the cookie with "same-site" requests, and with "cross-site" top-level navigations. |
None | Indicates the client should disable same-site restrictions. When using this value, the cookie must also have the property set to true. |
Strict | Indicates the client should only send the cookie with "same-site" requests. |
Unspecified | No SameSite field will be set, the client should follow its default cookie policy. |
Returns or sets the value for the SameSite attribute of the cookie. The default value is . |
Wisej.Base.TextUtils
Namespace: Wisej.Base
Assembly: Wisej.Framework (3.1.0.0)
Provides utility methods to measure, encode, and extract mnemonics from text.
| Name | Type | Description |
|---|---|---|
Escapes special characters in the specified string.
| Parameter | Type | Description |
|---|---|---|
Returns: String. The escaped string. Null if the specified string was null, or empty if it was empty.
Removes the ampersand from the text and encodes HTML characters if necessary.
Returns: String. The escaped string. Null if the specified string was null, or empty if it was empty.
Returns the first character that is preceded by an ampersand (&).
Returns: String.
Returns the size of the specified text when rendered with the specified font.
Returns: Size. The computed Size of the specified text.
Returns the size of the specified text when rendered with the specified font.
Returns: Size. The computed Size of the specified text.
Returns the size of the specified text when rendered with the specified font.
Returns: Size.
Returns the size of the specified text when rendered with the specified font.
Returns: Size.
Returns the size of the specified text when rendered with the specified font.
Returns the size of the specified text when rendered with the specified font.
Asynchronously returns the size of the specified text when rendered with the specified font. The measurement is performed on the browser. Returns an awaitable Task that contains the measured size.
Returns: Task<Size>. An awaitable Task that represents the asynchronous operation.
| 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 |
|---|---|---|
text
The text to convert.
allowHtml
Whether to encode HTML characters.
useMnemonic
Whether to convert the first mnemonic to an underlined character.
translateNewLines
Whether to convert newlines (CRLF) to <BR/>. The conversion is performed only when allowHtml is false, or, if allowHtml is true and the text doesn't contain any HTML.
text
The string from which to extract the mnemonic character.
text
The text to measure.
font
The Font to apply to the measured text.
text
The text to measure.
font
The Font to apply to the measured text.
format
Formatting information.
text
The text to measure.
font
The Font to apply to the measured text.
layoutArea
The Size to use as bounding rectangle for the text.
text
The text to measure.
font
The Font to apply to the measured text.
layoutArea
The Size to use as bounding rectangle for the text.
format
Formatting information.
text
The text to measure.
allowHtml
The text to measure may contain HTML tags.
font
The Font to apply to the measured text.
callback
Result callback method, invoked when the client has finished measuring the text.
text
The text to measure.
allowHtml
The text to measure may contain HTML tags.
font
The Font to apply to the measured text.
width
The width to use as bounding rectangle for the text.
callback
Result callback method, invoked when the client has finished measuring the text.
text
The text to measure.
allowHtml
The text to measure may contain HTML tags.
font
The Font to apply to the measured text.
width
The optional width to use as bounding rectangle for the text.
ConvertToString
Pluggable method used to convert user input to a string. [Since 3.0.10]
MeasureString
Pluggable method used to measure strings.
text
The text to escape.
allowHtml
Indicates that HTML tags should not be escaped. The default is false.
