LogoLogo
HomeNewsSupportVideos
v4.0
v4.0
  • Wisej.NET API
  • What's New
  • Releases
  • Concepts
  • Themes
  • Extensions
  • Wisej.Web
    • General
      • Application
        • Client
        • ClientBrowser
        • ClientCollection
        • ClientPlatform
        • ClientProfile
        • ClientTheme
        • Configuration
        • LoadConfigurationEventArgs
        • LoadConfigurationEventHandler
        • PlatformProvider
        • Application.FormCollection
        • Application.PageCollection
        • Application.RequestType
        • HashChangedEventArgs
        • HashChangedEventHandler
        • LicenseErrorEventArgs
        • LicenseErrorEventHandler
        • RequestEventArgs
        • RequestEventHandler
        • ResponsiveProfileChangedEventArgs
        • ResponsiveProfileChangedEventHandler
      • BackgroundWorker
      • BindableComponent
      • Clipboard
      • Component
      • Control
        • Control.ControlCollection
        • ControlEventArgs
        • ControlEventHandler
        • DragEventArgs
        • DragEventHandler
        • FocusEventArgs
        • FocusEventHandler
        • HelpEventArgs
        • HelpEventHandler
        • JavaScript.ClientEvent
        • JavaScript.ClientEventCollection
        • KeyEventArgs
        • KeyEventHandler
        • KeyPressEventArgs
        • KeyPressEventHandler
        • LayoutEventArgs
        • LayoutEventHandler
        • MouseEventArgs
        • MouseEventHandler
        • PaintEventArgs
        • PaintEventHandler
        • PinchEventArgs
        • PinchEventHandler
        • PreviewKeyDownEventArgs
        • PreviewKeyDownEventHandler
        • QueryContinueDragEventArgs
        • QueryContinueDragEventHandler
        • ResponsiveProfileChangedEventArgs
        • ResponsiveProfileChangedEventHandler
        • RotateEventArgs
        • RotateEventHandler
        • SwipeAxis
        • SwipeDirection
        • SwipeEventArgs
        • SwipeEventHandler
        • TouchEventArgs
        • TouchEventHandler
        • TrackEventArgs
        • TrackEventHandler
        • WebEventArgs
        • WebEventHandler
        • WidgetEventArgs
        • WidgetEventHandler
      • Cursor
      • Cursors
      • DataObject
      • Padding
      • Screen
      • SessionReference<T>
    • Buttons
      • Button
        • MenuButtonItemClickedEventArgs
        • MenuButtonItemClickedEventHandler
      • ButtonBase
      • CheckBox
      • RadioButton
      • SplitButton
    • Common Dialogs
      • ColorDialog
      • CommonDialog
      • FileDialog
      • FileDialogLoadPathEventArgs
      • FileDialogLoadPathEventHandler
      • FileDialogRootCollection
      • FileDialogUI
      • FolderBrowserDialog
      • FolderBrowserDialogUI
      • OpenFileDialog
      • SaveFileDialog
    • Containers
      • Accordion
        • Accordion.PanelCollection
        • AccordionAction
        • AccordionCancelEventArgs
        • AccordionCancelEventHandler
        • AccordionEventArgs
        • AccordionEventHandler
        • AccordionPanel
      • ContainerControl
        • AcceleratorEventArgs
        • AcceleratorEventHandler
      • DataRepeater
        • DataRepeaterAddRemoveItemsCancelEventArgs
        • DataRepeaterAddRemoveItemsCancelEventHandler
        • DataRepeaterAddRemoveItemsEventArgs
        • DataRepeaterAddRemoveItemsEventHandler
        • DataRepeaterDataErrorEventArgs
        • DataRepeaterDataErrorEventHandler
        • DataRepeaterItem
        • DataRepeaterItemCloneEventArgs
        • DataRepeaterItemCloneEventHandler
        • DataRepeaterItemEventArgs
        • DataRepeaterItemEventHandler
        • DataRepeaterItemValueEventArgs
        • DataRepeaterItemValueEventHandler
        • DataRepeaterLayoutStyles
      • Desktop
        • DesktopTaskBarItem
        • DesktopTaskBarItemClickEventArgs
        • DesktopTaskBarItemClickEventHandler
        • DesktopTaskBarItemCollection
        • DesktopTaskBarItemControl
        • DesktopTaskBarItemDateTime
      • FlexLayoutPanel
        • FlexLayoutStyle
      • FlowLayoutPanel
        • FlowDirection
      • Form
        • CloseReason
        • FormBorderStyle
        • FormClosedEventArgs
        • FormClosedEventHandler
        • FormClosingEventArgs
        • FormClosingEventHandler
        • FormStartPosition
        • FormWindowState
        • MdiClient
        • MdiTabProperties
      • GroupBox
      • Page
      • Panel
      • ScrollableControl
        • ScrollEventArgs
        • ScrollEventHandler
      • SlideBar
      • SplitContainer
        • FixedPanel
        • SplitterCancelEventArgs
        • SplitterCancelEventHandler
        • SplitterEventArgs
        • SplitterEventHandler
        • SplitterPanel
      • StatusBar
        • StatusBar.StatusBarPanelCollection
        • StatusBarControl
        • StatusBarPanel
        • StatusBarPanelAutoSize
        • StatusBarPanelBorderStyle
        • StatusBarPanelClickEventArgs
        • StatusBarPanelClickEventHandler
      • TabControl
        • TabAlignment
        • TabControl.TabPageCollection
        • TabControlAction
        • TabControlCancelEventArgs
        • TabControlCancelEventHandler
        • TabControlEventArgs
        • TabControlEventHandler
        • TabPage
        • TabSizeMode
      • TableLayoutPanel
        • ColumnStyle
        • RowStyle
        • TableLayoutColumnStyleCollection
        • TableLayoutControlCollection
        • TableLayoutPanelCellPosition
        • TableLayoutPanelGrowStyle
        • TableLayoutRowStyleCollection
        • TableLayoutSettings
        • TableLayoutStyle
        • TableLayoutStyleCollection
      • ToolBar
        • ToolBar.ToolBarButtonCollection
        • ToolBarButton
        • ToolBarButtonClickEventArgs
        • ToolBarButtonClickEventHandler
        • ToolBarButtonSizeMode
        • ToolBarButtonStyle
        • ToolBarTextAlign
      • UserControl
      • UserPopup
    • Content
      • AspNetPanel
      • Canvas
        • CanvasCompositeOperation
        • CanvasLineCap
        • CanvasLineJoin
        • CanvasRepeatPattern
        • CanvasTextAlign
        • CanvasTextBaseline
      • HtmlPanel
        • HtmlPanelElementClickArgs
        • HtmlPanelElementClickHandler
      • IFramePanel
      • ImageList
        • ImageList.ImageCollection
        • ImageListEntry
      • Label
      • Line
      • LinkLabel
        • LinkArea
        • LinkLabelLinkClickedEventArgs
        • LinkLabelLinkClickedEventHandler
      • PdfViewer
        • PdfViewerType
      • PictureBox
      • ProgressBar
      • ScrollBar
        • HScrollBar
        • HScrollProperties
        • ScrollEventArgs
        • ScrollEventHandler
        • ScrollProperties
        • VScrollBar
        • VScrollProperties
      • Shape
        • Shape.Border
      • Spacer
      • Upload
        • CaptureMode
        • UploadedEventArgs
        • UploadedEventHandler
        • UploadErrorEventArgs
        • UploadErrorEventHandler
        • UploadErrorType
        • UploadingEventArgs
        • UploadingEventHandler
        • UploadProgressEventArgs
        • UploadProgressEventHandler
      • WebBrowser
        • WebBrowserDocumentCompletedEventArgs
        • WebBrowserDocumentCompletedEventHandler
      • Widget
        • WebRequestEventArgs
        • WebRequestHandler
    • Data Binding
      • Binding
      • BindingCompleteContext
      • BindingCompleteEventArgs
      • BindingCompleteEventHandler
      • BindingCompleteState
      • BindingContext
      • BindingManagerBase
      • BindingManagerDataErrorEventArgs
      • BindingManagerDataErrorEventHandler
      • BindingMemberInfo
      • BindingNavigator
      • BindingsCollection
      • BindingSource
      • Command
      • Command<T>
      • CommandArgs
      • CommandArgs<T>
      • CommandManager
      • ControlBindingsCollection
      • ControlUpdateMode
      • ConvertEventArgs
      • ConvertEventHandler
      • CurrencyManager
      • DataSourceUpdateMode
      • IBindableComponent
      • IBinding
      • ICurrencyManagerProvider
      • ItemChangedEventArgs
      • ItemChangedEventHandler
      • ListBindingHelper
      • PropertyManager
    • Editors
      • CharacterCasing
      • ComponentTool
      • ComponentToolCollection
      • DateTimePicker
      • DomainUpDown
        • DomainUpDown.DomainUpDownItemCollection
      • InputType
      • LabelWrapper
      • MaskedTextBox
        • TypeValidationEventArgs
        • TypeValidationEventHandler
      • MonthCalendar
        • DateRangeEventArgs
        • DateRangeEventHandler
        • SelectionRange
      • NumericUpDown
      • TagTextBox
        • TagTextBoxEventArgs
        • TagTextBoxEventHandler
        • TagTextBoxMousEventArgs
        • TagTextBoxMousEventHandler
        • TagTextBoxRenderEventArgs
        • TagTextBoxRenderEventHandler
      • TextBox
      • TextBoxBase
      • TextBoxMode
      • TextBoxType
      • TimeUpDown
        • TimeUpDownFormat
      • ToolClickEventArgs
      • ToolClickEventHandler
      • TrackBar
      • TypedTextBox
      • UpDownBase
    • Enumerations
      • AccessibleRole
      • AnchorStyles
      • Appearance
      • AutoComplete
      • AutoCompleteMode
      • AutoScaleMode
      • AutoSizeMode
      • AutoValidate
      • BorderStyle
      • BoundsSpecified
      • CheckState
      • ColorDepth
      • ComboBoxStyle
      • ControlStyles
      • DataFormats
      • DataFormats.Format
      • DateTimePickerFormat
      • Day
      • DialogResult
      • Display
      • DockStyle
      • DragAction
      • DragDropEffects
      • GetChildAtPointSkip
      • HeaderPosition
      • HorizontalAlignment
      • ImageLayout
      • ImagePosition
      • ImeMode
      • Keys
      • LabelPosition
      • LeftRightAlignment
      • LineStyle
      • LinkBehavior
      • MaskFormat
      • MouseButtons
      • ObjectFit
      • Orientation
      • PanelAutoShowMode
      • PictureBoxSizeMode
      • Placement
      • PlacementMode
      • Position
      • ProgressBarStyle
      • RightToLeft
      • ScrollBars
      • ScrollEventType
      • ScrollOrientation
      • SelectionMode
      • Shortcut
      • SizeType
      • SortOrder
      • TabOrderManagerDirection
      • TextDataFormat
      • TextImageRelation
      • TickStyle
      • ValidationConstraints
      • VerticalAlignment
    • Extenders
      • Animation
        • Animation.Properties
        • AnimationEventArgs
        • AnimationEventHandler
        • AnimationTiming
      • ErrorAnimationType
      • ErrorBlinkStyle
      • ErrorIconAlignment
      • ErrorProvider
        • ErrorProviderErrorChangedEventArgs
        • ErrorProviderErrorChangedHandler
      • HelpTip
      • JavaScript
        • JavaScript.ClientEvent
        • JavaScript.ClientEventCollection
      • Rotation
        • Rotation.Properties
      • StyleSheet
      • TabOrderManager
      • ToolTip
      • ToolTipIcon
      • Validation
        • CurrencyValidationRule
        • DecimalValidationRule
        • EmailValidationRule
        • IntegerValidationRule
        • RegexValidationRule
        • RequiredValidationRule
        • TelephoneValidationRule
        • ValidationEventArgs
        • ValidationEventHandler
        • ValidationRule
    • Interfaces
      • IButtonControl
      • ICommand
      • ICommandSource
      • IContainerControl
      • IDataObject
      • IDropTarget
      • IErrorProvider
      • IImage
      • ILabel
      • IModified
      • IReadOnly
      • IUserData
      • IValidation
    • Lists & Grids
      • CheckedListBox
        • CheckedListBox.CheckedIndexCollection
        • CheckedListBox.CheckedObjectCollection
        • CheckedListBox.ObjectCollection
        • ItemCheckEventArgs
        • ItemCheckEventHandler
      • ComboBox
        • ComboBox.ObjectCollection
      • DataGridView
        • BaseCollection
        • DataGridView.CustomSummary
        • DataGridView.HitTestInfo
        • DataGridView.HitTestType
        • DataGridViewAutoSizeColumnMode
        • DataGridViewAutoSizeColumnsMode
        • DataGridViewAutoSizeRowMode
        • DataGridViewAutoSizeRowsMode
        • DataGridViewBand
        • DataGridViewBindingCompleteEventArgs
        • DataGridViewBindingCompleteEventHandler
        • DataGridViewButtonCell
        • DataGridViewButtonColumn
        • DataGridViewCell
        • DataGridViewCellBorderStyle
        • DataGridViewCellCancelEventArgs
        • DataGridViewCellCancelEventHandler
        • DataGridViewCellCollection
        • DataGridViewCellCommandEventArgs
        • DataGridViewCellCommandEventHandler
        • DataGridViewCellContextMenuNeededEventArgs
        • DataGridViewCellContextMenuNeededEventHandler
        • DataGridViewCellErrorTextNeededEventArgs
        • DataGridViewCellErrorTextNeededEventHandler
        • DataGridViewCellEventArgs
        • DataGridViewCellEventHandler
        • DataGridViewCellFormattingEventArgs
        • DataGridViewCellFormattingEventHandler
        • DataGridViewCellMouseEventArgs
        • DataGridViewCellMouseEventHandler
        • DataGridViewCellPaintEventArgs
        • DataGridViewCellPaintEventHandler
        • DataGridViewCellParsingEventArgs
        • DataGridViewCellParsingEventHandler
        • DataGridViewCellStateChangedEventArgs
        • DataGridViewCellStateChangedEventHandler
        • DataGridViewCellStyle
        • DataGridViewCellStyleContentChangedEventArgs
        • DataGridViewCellStyleContentChangedEventHandler
        • DataGridViewCellStyleScopes
        • DataGridViewCellToolTipTextNeededEventArgs
        • DataGridViewCellToolTipTextNeededEventHandler
        • DataGridViewCellValidatingEventArgs
        • DataGridViewCellValidatingEventHandler
        • DataGridViewCellValueEventArgs
        • DataGridViewCellValueEventHandler
        • DataGridViewCheckBoxCell
        • DataGridViewCheckBoxColumn
        • DataGridViewChildRowCollection
        • DataGridViewClipboardCopyMode
        • DataGridViewCollectionChangeEventArgs
        • DataGridViewColumn
        • DataGridViewColumnCollection
        • DataGridViewColumnEventArgs
        • DataGridViewColumnEventHandler
        • DataGridViewColumnHeaderCell
        • DataGridViewColumnHeadersHeightSizeMode
        • DataGridViewColumnSortMode
        • DataGridViewColumnsSortMode
        • DataGridViewColumnStateChangedEventArgs
        • DataGridViewColumnStateChangedEventHandler
        • DataGridViewComboBoxCell
        • DataGridViewComboBoxCell.ObjectCollection
        • DataGridViewComboBoxColumn
        • DataGridViewComboBoxEditingControl
        • DataGridViewContentAlignment
        • DataGridViewDataErrorEventArgs
        • DataGridViewDataErrorEventHandler
        • DataGridViewDataReadEventArgs
        • DataGridViewDataReadEventHandler
        • DataGridViewDataUpdatedEventArgs
        • DataGridViewDataUpdatedEventHandler
        • DataGridViewDateTimePickerCell
        • DataGridViewDateTimePickerColumn
        • DataGridViewDateTimePickerEditingControl
        • DataGridViewEditingControlShowingEventArgs
        • DataGridViewEditingControlShowingEventHandler
        • DataGridViewEditMode
        • DataGridViewElement
        • DataGridViewElementStates
        • DataGridViewHeaderCell
        • DataGridViewImageCell
        • DataGridViewImageCellLayout
        • DataGridViewImageColumn
        • DataGridViewLinkCell
        • DataGridViewLinkColumn
        • DataGridViewMaskedTextBoxCell
        • DataGridViewMaskedTextBoxColumn
        • DataGridViewMaskedTextBoxEditingControl
        • DataGridViewNumericUpDownCell
        • DataGridViewNumericUpDownColumn
        • DataGridViewNumericUpDownEditingControl
        • DataGridViewRow
        • DataGridViewRowCancelEventArgs
        • DataGridViewRowCancelEventHandler
        • DataGridViewRowCollection
        • DataGridViewRowErrorTextNeededEventArgs
        • DataGridViewRowErrorTextNeededEventHandler
        • DataGridViewRowEventArgs
        • DataGridViewRowEventHandler
        • DataGridViewRowHeaderCell
        • DataGridViewRowHeadersWidthSizeMode
        • DataGridViewRowHeightInfoNeededEventArgs
        • DataGridViewRowHeightInfoNeededEventHandler
        • DataGridViewRowsAddedEventArgs
        • DataGridViewRowsAddedEventHandler
        • DataGridViewRowsRemovedEventArgs
        • DataGridViewRowsRemovedEventHandler
        • DataGridViewRowStateChangedEventArgs
        • DataGridViewRowStateChangedEventHandler
        • DataGridViewSelectedCellCollection
        • DataGridViewSelectedColumnCollection
        • DataGridViewSelectedRowCollection
        • DataGridViewSelectionMode
        • DataGridViewSortCompareEventArgs
        • DataGridViewSortCompareEventHandler
        • DataGridViewSortSelectionMode
        • DataGridViewSummaryRow
        • DataGridViewTextBoxCell
        • DataGridViewTextBoxColumn
        • DataGridViewTextBoxEditingControl
        • DataGridViewToolClickEventArgs
        • DataGridViewToolClickEventHandler
        • DataGridViewTriState
        • IDataGridViewEditingControl
        • InputType
        • ScrollEventArgs
        • ScrollEventHandler
        • SummaryRowPosition
        • SummaryType
        • TextBoxMode
        • TextBoxType
      • ListBox
        • ListBox.ObjectCollection
        • ListBox.SelectedIndexCollection
        • ListBox.SelectedObjectCollection
      • ListControl
        • ListControlConvertEventArgs
        • ListControlConvertEventHandler
      • ListView
        • CacheVirtualItemsEventArgs
        • CacheVirtualItemsEventHandler
        • ColumnClickEventArgs
        • ColumnClickEventHandler
        • ColumnHeader
        • ColumnHeaderAutoResizeStyle
        • ColumnHeaderStyle
        • ColumnReorderedEventArgs
        • ColumnReorderedEventHandler
        • ColumnWidthChangedEventArgs
        • ColumnWidthChangedEventHandler
        • GridLineStyle
        • ImageColumnHeader
        • ItemCheckedEventArgs
        • ItemCheckedEventHandler
        • ItemClickEventArgs
        • ItemClickEventHandler
        • ItemMouseHoverEventArgs
        • ItemMouseHoverEventHandler
        • ItemSelectionChangedEventArgs
        • ItemSelectionChangedEventHandler
        • LabelEditEventArgs
        • LabelEditEventHandler
        • ListView.CheckedIndexCollection
        • ListView.CheckedListViewItemCollection
        • ListView.ColumnHeaderCollection
        • ListView.ListViewItemCollection
        • ListView.SelectedIndexCollection
        • ListView.SelectedListViewItemCollection
        • ListViewBindingCompleteEventArgs
        • ListViewBindingCompleteEventEventHandler
        • ListViewDataUpdatedEventArgs
        • ListViewDataUpdatedEventHandler
        • ListViewItem
        • ListViewItem.ListViewSubItem
        • ListViewItem.ListViewSubItemCollection
        • ListViewItemDragEventArgs
        • ListViewItemDragEventHandler
        • ListViewItemStates
        • ListViewVirtualItemsSelectionRangeChangedEventArgs
        • ListViewVirtualItemsSelectionRangeChangedEventHandler
        • RetrieveVirtualItemEventArgs
        • RetrieveVirtualItemEventHandler
        • SearchForVirtualItemEventArgs
        • SearchForVirtualItemEventHandler
        • View
      • ListViewComboBox
      • PropertyGrid
        • GridItem
        • GridItemCollection
        • GridItemType
        • PropertySort
        • PropertyValueChangedEventArgs
        • PropertyValueChangedEventHandler
        • PropertyValueDataErrorEventArgs
        • PropertyValueDataErrorEventHandler
        • PropertyValueFormattingEventArgs
        • PropertyValueFormattingEventHandler
        • SelectedGridItemBeginEditEventArgs
        • SelectedGridItemBeginEditEventHandler
        • SelectedGridItemChangedEventArgs
        • SelectedGridItemChangedEventHandler
        • SelectedGridItemEndEditEventArgs
        • SelectedGridItemEndEditEventHandler
      • TreeView
        • ItemDragEventArgs
        • ItemDragEventHandler
        • NodeLabelEditEventArgs
        • NodeLabelEditEventHandler
        • TreeNode
        • TreeNodeCollection
        • TreeNodeMouseClickEventArgs
        • TreeNodeMouseClickEventHandler
        • TreeNodeMouseHoverEventArgs
        • TreeNodeMouseHoverEventHandler
        • TreeViewAction
        • TreeViewCancelEventArgs
        • TreeViewCancelEventHandler
        • TreeViewEventArgs
        • TreeViewEventHandler
        • TreeViewNodeDragEventArgs
        • TreeViewNodeDragEventHandler
      • TreeViewComboBox
      • UserComboBox
    • Menus
      • CheckedMenuItem
      • ContextMenu
      • LinkMenuItem
      • MainMenu
      • Menu
      • Menu.MenuItemCollection
      • MenuBar
      • MenuItem
      • MenuItemEventArgs
      • MenuItemEventHandler
      • MenuItemSizeMode
      • MenuMerge
    • Notifications
      • AlertBox
        • MessageBoxIcon
      • MessageBox
        • MessageBoxButtons
        • MessageBoxDefaultButton
        • MessageBoxIcon
      • Toast
    • Other Components
      • Timer
  • Wisej.Base
    • General
      • Component
      • Cookie
        • Cookie.SameSiteMode
      • CookieCollection
      • PostbackPropertyAttribute
      • TextUtils
    • Responsive
      • ResponsiveProfile
      • ResponsiveProfileCollection
      • ResponsivePropertyAttribute
  • Wisej.Core
    • General
      • BrowserStorage
      • CookieStorage
      • DynamicObject
      • FileSystemProvider
      • HealthCheck
      • HttpContext
      • HttpCookie
        • SameSiteMode
      • HttpCookieCollection
      • HttpFileCollection
      • HttpPostedFile
      • HttpRequest
      • HttpResponse
      • IEventFilter
      • IFileSystemProvider
      • LocalStorage
      • MimeTypes
      • SessionStorage
      • SynchronizedList<T>
      • WebMethodAttribute
      • WisejEventArgs
        • WisejEventArgs.KeyboardInfo
        • WisejEventArgs.PointerInfo
      • WisejResourcesAttribute
      • WisejSerializer
      • WisejSerializerOptions
      • WisejSerializerOptionsAttribute
    • Interfaces
      • IWisejComponent
      • IWisejControl
      • IWisejDataStore
      • IWisejEditorService
      • IWisejExtenderProvider
      • IWisejHandler
      • IWisejSerializable
      • IWisejWindow
  • Wisej.Web.Markup
    • Extensions
      • BindingExtensions
      • ButtonExtensions
      • CheckedListBoxExtensions
      • ComboBoxExtensions
      • ControlExtensions
      • DateTimePickerExtensions
      • FlexLayoutPanelExtensions
      • FlowLayoutPanelExtensions
      • FormExtensions
      • GroupBoxExtensions
      • IButtonControlExtensions
      • ICommandSourceExtensions
      • IErrorProviderExtensions
      • IImageExtensions
      • ILabelExtensions
      • IModifiedExtensions
      • IReadOnlyExtensions
      • LabelExtensions
      • LineExtensions
      • LinkLabelExtensions
      • ListBoxExtensions
      • ListControlExtensions
      • MonthCalendarExtenestions
      • NumericUpDownExtensions
      • PageExtensions
      • PanelExtensions
      • PictureBoxExtensions
      • ProgressBarExtensions
      • RadioButtonExtensions
      • ScrollableControlExtensions
      • ScrollBarExtensions
      • ShapeExtensions
      • SplitterControlExtensions
      • StatusBarExtensions
      • TabControlExtensions
      • TableLayoutPanelExtensions
      • TabPageExtensions
      • TextBoxExtensions
      • TimerExtensions
      • TimeUpDownExtensions
      • ToolBarButtonExtensions
      • ToolBarExtensions
      • TrackBarExtensions
      • TreeNodeExtensions
      • TreeViewExtensions
      • UpDownControlExtensions
      • WebBrowserExtensions
  • Wisej.Web.VisualBasic
    • Extensions
      • Interaction
      • MsgBoxResult
      • MsgBoxStyle
  • Wisej.Services
    • General
      • InjectAttribute
      • ServiceLifetime
      • ServiceProvider
  • System
    • Extensions
      • DateTimeExtensions
      • FontExtensions
      • JSON
      • Markdown
      • StringExtensions
  • Wisej.Resources
    • Resources
      • ComponentResourceManager
      • ResourceManager
Powered by GitBook
On this page
  • Properties
  • ActiveProfile
  • Browser
  • ClientCertificate
  • ClientId
  • Clients
  • CommandManager
  • CommonAppDataPath
  • CommonAppDataRegistry
  • CompanyName
  • Configuration
  • Cookies
  • Current
  • CurrentCulture
  • Desktop
  • EnableUnloadConfirmation
  • ExecutablePath
  • FavIcon
  • FavIconSource
  • Hash
  • IsAuthenticated
  • IsDisposed
  • IsExpired
  • IsSecure
  • IsTerminated
  • IsWebSocket
  • LicenseInfo
  • LicenseKey
  • MainPage
  • OpenForms
  • OpenPages
  • Platform
  • ProductName
  • ProductVersion
  • QueryString
  • Referrer
  • RightToLeft
  • RuntimeMode
  • ServerName
  • ServerPort
  • ServerVariables
  • Services
  • Session
  • SessionCount
  • SessionId
  • ShowConsole
  • ShowLoader
  • StartupPath
  • StartupUri
  • StartupUrl
  • Theme
  • Title
  • Uri
  • Url
  • User
  • UserAgent
  • UserHostAddress
  • UserHostName
  • UserIdentity
  • UserLanguages
  • Methods
  • AddEventFilter(filter)
  • AddTranslation(text, translation)
  • AlertAsync(message)
  • Call(function, args)
  • Call(function, callback, args)
  • CallAsync(function, args)
  • CancelFullScreen()
  • ConfirmAsync(message)
  • Dispose()
  • Download(image, fileName, ondownload)
  • Download(stream, fileName, ondownload)
  • Download(filePath, fileName, ondownload)
  • DownloadAndOpen(target, filePath, fileName, ondownload)
  • DownloadAndOpen(target, image, fileName, ondownload)
  • DownloadAndOpen(target, stream, fileName, ondownload)
  • EndPolling()
  • Eval(script)
  • Eval(script, callback)
  • EvalAsync(script)
  • Exit()
  • FindComponent(match)
  • FindComponents(match)
  • GetInstance<T>(reference, builder)
  • LoadAssembly(nameOrFile)
  • LoadComponent(nameOrFile, className)
  • LoadPackages(packages, callback)
  • LoadPackagesAsync(packages)
  • LoadTheme(name, mixins)
  • MapPath(path)
  • Navigate(url, target)
  • Navigate(url, target, onclose)
  • OpenWindow(url, target, windowFeatures, onclose)
  • Play(type)
  • Play(soundUrl)
  • Post(callback)
  • Print(control)
  • Print()
  • PromptAsync(message, defaultValue)
  • RefreshSessionId()
  • Reload()
  • RemoveEventFilter(filter)
  • RequestFullScreen()
  • RunInContext(context, action)
  • SetInstance<T>(reference, instance)
  • SetSessionTimeout(seconds)
  • StartPolling(interval)
  • StartTask(action)
  • StartTask<T>(action)
  • StartTimer(dueTime, period, callback)
  • Update(context, action)
  • Events
  • ActiveWindowChanged
  • ApplicationExit
  • ApplicationRefresh
  • ApplicationStart
  • BeforeInstallPrompt
  • BeginRequest
  • BrowserSizeChanged
  • BrowserTabActivated
  • BrowserTabDeactivated
  • CultureChanged
  • EndRequest
  • FocusedControlChanged
  • HashChanged
  • Idle
  • ImpersonationBegin
  • ImpersonationEnd
  • LicenseError
  • ResponsiveProfileChanged
  • RightToLeftChanged
  • SessionTimeout
  • ThemeChanged
  • ThreadException
  • Implements

Was this helpful?

Export as PDF
  1. Wisej.Web
  2. General

Application

Wisej.Web.Application

Last updated 11 days ago

Was this helpful?

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represent a Wisej application session. Provides methods and events to manage the application in the context of the current session.

public class Application : IWisejComponent, IDisposable, IWisejSynchronized
Public Class Application
    Inherits IWisejComponent
    Implements IDisposable, IWisejSynchronized

This class provides several static methods, properties and events that allow the application to manage all sorts of features related to the current session:

  • Save and retrieve session variable. Use to store and retrieve session variable. The property is a dynamic object and a , therefore you can access its properties directly or through the indexer.


    Application.Session.myValue = 12;
    Application.Session["myValue"] = 12;
  
  • Manage cookies. Use to manage browser's cookies.

  • Read server variables. Use to retrieve all the data made available by the server. Some of the variables in the collection are also available directly: , , , etc.

  • Read the application's URL. Use , , , and .

  • Read the application's system information. Use , , , etc.

  • Listen to the application's global events. See , , , , , , and many more.

  • Retrieve browser related information. Use the to read the client browser type, OS, version, capabilities, screen size, browser size, language, and state. The object is updated automatically when the user resizes the browser or the page is reloaded.

  • Control the client browser. Start a , execute JavaScript functions or scriptlets using or . Make the browser navigate to a different URL using or simply the page.

  • Manage the main page or current desktop. lets you change the object that fills the browser and "navigate" from page to page. lets you change the active object on the client browser.

  • Manage all live components in the session. Through the class you can find, iterate, inspect all live components of any type. See for all the currently created (visible or invisible) instances of . returns all the created objects. and provide an easy way to find any component in the session or to iterate the list of components that match a custom expression.

  • Start background tasks in context. provides a powerful way to start a background task on the server that can keep interacting with the client browser while running independently.

  • Manage the application's theme. Use to load a Wisej theme into the application. Or use the object to read all sorts of information from the current .

  • Terminate the application without waiting for the session to timeout. Use to terminate the current session and free all the related memory.

Properties

This is the profile that best matches the current browser on the client. It is updated automatically on every request.


var current = Application.Current;
var thread = new Thread(() => {
  Application.Update(current, () => {
  
    // code here is running in context.
    
  });
});

This property attaches the window.onbeforeunload event. See https://developer.mozilla.org/en-US/docs/Web/API/WindowEventHandlers/onbeforeunload. It's not possible to determine whether the page is being unloaded because the user is trying to close the tab, close the browser, or is refreshing the page, or is taking any other action that may reload the page.

These are the currently available fields (may change in future releases):

  • Valid: Whether the license is valid. Note that a license may be expired and valid if the product release date is within the license expiration date.

  • ProductName: Full name of the licensed product.

  • CustomerName: Name of the registered customer that owns the license.

  • ExpirationDate: Expiration date for the product free updates.

Retrieve the values either using a dynamic object or a property indexer:


  string productName = Application.LicenseInfo.ProductName;
  string customerName = Application.LicenseInfo["CustomerName"];

static class Program
{
  static Program()
  {
    Application.LicenseKey = "...";
  }
}

This value is an empty string in most cases, since it contains the URL of the first non Wisej.NET page loaded in the browser, from which a user has clicked an hyperlink to navigate to the Wisej.NET application.

The value of this property is updated automatically when the current language changes if the value of "rightToLeft" in the application configuration file is set to "auto".

Displays a simple HTMl only debug console. Works with any browser also when the developer tools are not available.


// create a new custom theme cloned from the current theme.
var myTheme = new ClientTheme("MyTheme", Application.Theme);

// alter the buttonFace color.
myTheme.Colors.buttonFace = "red";

// update the current session using the new custom theme.
Application.Theme = myTheme;

You may also alter a global theme shared by all sessions.



// change the buttonFace color in the current theme.
// if the theme is one of the global themes, i.e. it was loaded
// using Application.LoadTheme(name), then the change is also global.
Application.Theme.Colors.buttonFace = "red";

// since the theme objects are all dynamic and use a special DynamicObject
// class part of the Wisej Framework, you can also use a string indexer
// to address any field.
Application.Theme.Colors["buttonFace"] = "red";

Methods

Adds an event filter to monitor all the incoming events before they are routed to their respective component.

Parameter
Type
Description

filter

Adds the text and corresponding translation to the default locale on the client.

Parameter
Type
Description

text

The text to translate.

translation

The translation override.

Instructs the browser to display a dialog with an optional message, and to wait until the user dismisses the dialog.

Parameter
Type
Description

message

A string you want to display in the alert dialog.

Executes the JavaScript function on the client.

Parameter
Type
Description

function

The name of the function to execute.

args

The arguments to pass to the function.

Executes the JavaScript function on the client and receives the return value (or null) in the callback method.

Parameter
Type
Description

function

The name of the function to execute.

callback

Asynchronous callback method that receives the return value.

args

The arguments to pass to the function.

Parameter
Type
Description

function

The name of the function to execute.

args

The arguments to pass to the function.

Cancels the fullscreen mode.

Instructs the browser to display a dialog with an optional message, and to wait until the user either confirms or cancels the dialog. until the user dismisses the dialog.

Parameter
Type
Description

message

A string you want to display in the confirm dialog.

Downloads the specified file on the client.

Parameter
Type
Description

image

fileName

The name of the file to save on the client.

Optional callback invoked when fileName is downloaded.

Downloads the specified image to the client.

Parameter
Type
Description

stream

fileName

The name of the file to save on the client.

Optional callback invoked when fileName is downloaded.

Downloads the bytes in the stream to the client.

Parameter
Type
Description

filePath

The file name the client will use to save the stream.

Optional callback invoked when fileName is downloaded.

Downloads the specified file on the client.

Parameter
Type
Description

target

Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.

filePath

The file to download.

The name of the file to save on the client.

Optional callback invoked when fileName is downloaded.

Downloads the specified image to the client.

Parameter
Type
Description

target

Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.

image

The image to download.

fileName

The name of the file to save on the client.

Optional callback invoked when fileName is downloaded.

Downloads the bytes in the stream to the client.

Parameter
Type
Description

target

Specifies where to open the file. Leave empty or use "_self" to open in the current tab, _blank to open in a new tab.

stream

The stream to send to the client.

fileName

The file name the client will use to save the stream.

Optional callback invoked when fileName is downloaded.

Stops the polling requests from the client.

Executes the JavaScript script on the client.

Parameter
Type
Description

script

The script to evaluate.

Executes the JavaScript script on the client and receives the return value (or null) in the callback method.

Parameter
Type
Description

script

The script to evaluate.

callback

Asynchronous callback method that receives the return value.

Parameter
Type
Description

script

The script to evaluate.

Terminates the application and the corresponding session.

Find the first component that matches the conditions defined in the predicate function.

Parameter
Type
Description

match

This method lets an application find any live component in the current session.


  // Find the first component that is a Button with Text = "OK"
  var button = Application.FindComponent(c => c is Button && ((Button)c).Text == "OK");

Finds all the components that match the conditions in the predicate function.

Parameter
Type
Description

match

This method lets an application iterate through all the live components in the current session.


  // List all text boxes that are read only in all forms.
  var list = Application.FindComponents(c => c is TextBox && ((TextBox)c).ReadOnly);

Returns a session-static instance of T .Since 3.2.7

Parameter
Type
Description

T

Type of the singleton object.

Thread-static reference to the T singleton.

Optional method for the creation of an instance of T .



public class MyStatics {

  // Thread-static singleton.
  [ThreadStatic] private static SessionReference<MyStatics> _instance;
  
  // Previously static fields (or properties).
  public int Counter;

  // Session singleton.
  public MyStatics Instance
    => Application.GetInstance(ref _instance);
    
  public static void DoSomething()
  {
    // was MyStatics.Counter++;
    MyStatics.Instance.Counter++;
  }
}

If the class a private constructor (to simulate a static class) or required initialization code or arguments, use the optional builder method:



public class MyStatics {

  private MyStatics() { };
  
  // Thread-static singleton.
  [ThreadStatic] private static SessionReference<MyStatics> _instance;
  
  // Previously static fields (or properties).
  public int Counter;

  // Session singleton.
  public MyStatics Instance
    => Application.GetInstance(ref _instance, () => new MyStatics());
    
  public static void DoSomething()
  {
    // was MyStatics.Counter++;
    MyStatics.Instance.Counter++;
  }
}

Loads an assembly given the file name or path.

Parameter
Type
Description

nameOrFile

The file name or full path for the assembly to load.

This method loads the assembly and, if the assembly contains Wisej components that need embedded resources - like JavaScript classes or CSS styles - that are embedded in the assembly, notifies the client with the URL to load the additional resources dynamically.

Creates an instance of the specified component from the assembly.

Parameter
Type
Description

nameOrFile

The file name or full path for the assembly to load.

className

Loads the JavaScript files indicated in the packages list.

Parameter
Type
Description

packages

List of the JavaScript files to load.

Optional callback returns whether all the scripts have been loaded successfully.

Loads the JavaScript files indicated in the packages list asynchronously.

Parameter
Type
Description

packages

List of the JavaScript files to load.

Changes the current theme.

Parameter
Type
Description

name

Name of the theme resource. Use only the name without the path and without the extension.

Optional list of theme mixins. If null, the default theme mixins are always applied.

Returns the full file path in relation to the application's project directory.

Parameter
Type
Description

path

Navigate to the specified URL.

Parameter
Type
Description

url

URL to navigate to.

The target browser window: _self, _blank, etc.

Navigate to the specified URL in a new browser tab and receive an optional callback when the tab is closed.

Parameter
Type
Description

url

URL to navigate to.

target

The target browser window, cannot be _self and cannot be empty.

onclose

Callback function invoked when the browser tab is closed. Can be null.

Opens the specified URL in a browser's popup window and receive an optional callback when the tab is closed.

Parameter
Type
Description

url

URL to navigate to.

target

The target browser window, cannot be _self and cannot be empty.

windowFeatures

A string containing a comma-separated list of window features in the form name=value — or for boolean features, just name. These features include options such as the window's default size and position, whether or not to open a minimal popup window, and so forth.

onclose

Callback function invoked when the browser popup window is closed. Can be null.

Plays one of the built-in sounds

Parameter
Type
Description

type

Plays a sound.

Parameter
Type
Description

soundUrl

A string representing either a sound file URL or a base64 data URL.

Executes the callback method after all processing is completed and before updating the client.

Parameter
Type
Description

callback

Method to invoke after the request has completed but before sending the response to the server.

The Post() method is similar to the BeginInvoke() method used by desktop applications. It allows you to execute a block of code out of sync with the current execution flow.



void Test() {

  Application.Post(() => {
    this.listBox.Items.Add("1");
  });
  
  this.listBox.Items.Add("2");
  
  // The items will be added in this order: "2", "1".
}

Prints the specified control.

Parameter
Type
Description

control

The control to print, can be a window, a page or a single control.

The control is printed without the caption or the borders, if present.

Prints the entire browser window.

Instructs the browser to display a dialog with an optional message prompting the user to input some text, and to wait until the user either submits the text or cancels the dialog.

Parameter
Type
Description

message

A string of text to display to the user.

An optoional string containing the default value displayed in the text input field.

Generates a new session id without losing the session.Since 3.5.2

Use this method after a successful login to prevent potential session fixation attacks.

Causes the application to reload on the browser.

Removes the filter from the list of registered event filters.

Parameter
Type
Description

filter

Requests the browser to enable fullscreen mode if supported.

Executes the callback in context.

Parameter
Type
Description

context

action

Function to execute in context. The code in the function can access all the static Application properties when executed from an out-of-bound thread.

Replaces the object assigned to a session-static singleton.Since 3.5.2

Parameter
Type
Description

T

Type of the session-static object.

Thread-static reference to the T singleton.

instance

New value to assign to the session-static storage.

Sets the current session timeout in seconds.

Parameter
Type
Description

seconds

Instructs the client to start polling the server for UI changes at the specified interval when a WebSocket connection is not available.

Parameter
Type
Description

interval

Polling interval in milliseconds. The minimum is 1000ms.



// this has not effect when the client and server are connected using WebSocket.
Application.StartPolling(1000);

Application.StartTask(() => {

  for (int i = 0; i < 100; i++) {
    this.label1.Text = "Counting..." + i;
    Thread.Sleep(1000);
  }
  
  // this has not effect when the client and server are NOT connected using WebSocket.
  Application.Update(this);

  // this has not effect when the client and server are connected using WebSocket.
  Application.EndPolling();

});

Throws:

Parameter
Type
Description

action

Start method invoked by the new task when it starts up.


Application.StartTask(() => {

  for (int i = 0; i < 100; i++) {
  
    this.label1.Text = "Counting..." + i;
    
    // just wait a bit or it's too fast.
    Thread.Sleep(1000);
    Application.Update(this);
  }
});
Parameter
Type
Description

T

action

Start method invoked by the new task when it starts up.


string text = await Application.StartTask(() => {

  string value = "";
  for (int i = 0; i < 100; i++) {
  
    value += i.ToString();
    
    // just wait a bit or it's too fast.
    Thread.Sleep(100);
  }
  return value;
});

this.label.Text = text;
Application.Update(this);

Note that you don't have to specify the type in the angular brackets, the compiler will automatically detect the type from the return value of the asynchronous function.

Parameter
Type
Description

dueTime

The amount of time, in milliseconds, to delay before invoking the callback .

period

The time interval between invocations, in milliseconds.

callback

A callback method to invoke at the specified intervals.

Executes the optional callback in context and pushes all the pending updates to the client when in WebSocket mode.

Parameter
Type
Description

context

Function to execute in context. The code in the function can access all the static Application properties when executed from an out-of-bound thread.

Use this method when you need to update the client asynchronously from an out-of-bound thread (different thread, not originating from a client request). You can call this method at the end of the code that updates the UI:


Application.StartTask(() => {

    for (int i = 0; i < 100; i++) {
    
      this.label1.Text = "Counting..." + i;
      
      // just wait a bit or it's too fast.
      Thread.Sleep(1000);
    }
    
    Application.Update(this);

});

Or you can use the optional action function to enclose the code that updates the UI in a block and ensure that the client is updated when the code block exits:


Application.StartTask(() => {

    Application.Update(this, () => {
    
      for (int i = 0; i < 100; i++) {
    
        this.label1.Text = "Counting..." + i;
      
        // just wait a bit or it's too fast.
        Thread.Sleep(1000);
      }
    });

});

Events

Set e.Handled to true if your application takes care of impersonation; otherwise false to let the default implementation attempt to impersonate the user. This event is not related to a session. It is best to attach to this event from a static type initializer, otherwise each listener will be called for every thread, regardless of the session. The default implementation in Wisej.NET is supported only in .NET Framework and the Windows platform.

Set e.Handled to true if your application takes care of impersonation; otherwise false to let the default implementation attempt to impersonate the user. This event is not related to a session. It is best to attach to this event from a static type initializer, otherwise each listener will be called for every thread, regardless of the session. The default implementation in Wisej.NET is supported only in .NET Framework and the Windows platform.

The default behavior built-in Wisej is to display a dialog asking the user to prolong the session. Set Handled to true to stop the default behavior.

Implements

Name
Description

All wisej components implement this interface.

There is a lot more exposed by the class. You can inspect all the properties and methods in Visual Studio through IntelliSense or online at .

ActiveProfile

: Returns or sets the current client responsive profile.

Browser

: Returns or the client browser's information.

ClientCertificate

: EXPERIMENTAL: Provides the client certificate fields issued by the client in response to the server's request for the client's identity.Since 3.5.6

ClientId

: Returns the current unique client id.

Clients

: Returns a collection of all the unique client browsers using the application.

CommandManager

: Returns the current .

CommonAppDataPath

: Returns the path for the application data that is shared among all users.

CommonAppDataRegistry

: Returns the registry key for the application data that is shared among all users.

CompanyName

: Returns the company name associated with the application stored in the .

Configuration

: Returns the current .

Cookies

: Collection of cookies.

Current

: Returns the application component instance that an application can store and use later to restore the context when updating client widgets during an out-of-bound call using the method.

Threads that are not started using don't have any knowledge of the current session and don't have a way to communicate with the client The property returns the instance of the class that is bound to the current session. It can be used just like any other component with the method or to restore the session for the current thread. The advantage of using instead of the instance of a control or a page is to avoid to keep a reference to a component that may be disposed by the application.

CurrentCulture

: Returns or sets the current for the session.

Desktop

: Returns or sets the current Desktop.

EnableUnloadConfirmation

: Returns or sets whether the browser will ask the user to confirm unloading the current page.

ExecutablePath

: Returns the path for the application's main assembly.

FavIcon

: Returns or sets the favicon to display in the browser.

FavIconSource

: Returns or sets the URL to the favicon to display in the browser.

Hash

: Returns or sets the hash part of the URL on the client.

IsAuthenticated

: Returns a value indicating whether the session has been authenticated.

IsDisposed

: Indicates that the current application instance, which corresponds to the session, has been terminated and disposed.

IsExpired

: Returns true when the current session has expired.

IsSecure

: Returns true if this session is running in secure mode (https:// and wss://)

IsTerminated

: Returns true when the current session has been terminated.

IsWebSocket

: Returns true if the current session is connected using WebSocket.

LicenseInfo

: Returns a dynamic object containing the currently loaded license information.Since 3.1.3

LicenseKey: License key loaded from web.config or assigned to .

LicenseKey

: Returns or sets the runtime server license key.

Setting the programmatically has to be done before the application is loaded. The best place is the static constructor for the Program static class, or the static constructor of the main window (if defined in Default.js).

MainPage

: Returns or sets the current full page window.

OpenForms

: Returns a collection of open forms owned by the application.

OpenPages

: Returns a collection of open pages owned by the application.

Platform

: The name of the currently loaded platform.

ProductName

: Returns the product name associated with this application.

ProductVersion

: Returns the product version associated with this application stored either in or .

QueryString

: Returns the parameters used to launch the application.

Referrer

: Returns the original URL from the first "HTTP_REFERER" header. Corresponds to the new custom server variable "ORIGINAL_REFERRER".

RightToLeft

: Returns or sets whether all the controls in the applications should operate using the right-to-left mode.

RuntimeMode

: Returns true when the application is running in not in design, debug or test mode.

ServerName

: Returns the server's host name, DNS alias, or IP address as it would appear in self-referencing URLs.

ServerPort

: Returns the port number to which the request was sent.

ServerVariables

: Returns the server variables.

Services

: Returns the implementation used by Wisej.NET to manage Dependency Injection across the application.Since 3.1

Session

: Provides a generic storage for session-based objects.

SessionCount

: Returns the total number of currently active sessions.

SessionId

: Returns the unique current session ID.

ShowConsole

: Shows or hides the debug console on the browser.

ShowLoader

: Returns or sets whether the browser is blocked by the Ajax loader.

StartupPath

: Returns the root path of the web application.

StartupUri

: Returns the URI used to start the application.

StartupUrl

: Returns the URL used to start the application.

Theme

: Returns or sets the current .

You can create and modify a new custom theme using the class. The new theme can be based on an existing theme, can be empty, or can be initialized from a JSON string.

Title

: Returns or sets the page title in the browser.

Uri

: Returns the current used either to launch or reload the application. It may be different from .

Url

: Returns the current URL used either to launch or reload the application. It may be different from .

User

: Returns the security information for the current request.

UserAgent

: Returns the raw user agent string of the client browser.

UserHostAddress

: Returns the IP host address of the remote client.

UserHostName

: Returns the DNS name of the remote client.

UserIdentity

: Returns the type for the current user.

UserLanguages

: Gets a sorted string array of client language preferences.

AddEventFilter(filter)

An object that implements the interface to add to the filter list.

AddTranslation(text, translation)

AlertAsync(message)

Returns: . An awaitable that represents the asynchronous operation.

Call(function, args)

Call(function, callback, args)

CallAsync(function, args)

Asynchronously executes the JavaScript function on the client and returns an awaitable with the result of the remote call.

Returns: . An awaitable that represents the asynchronous operation.

CancelFullScreen()

ConfirmAsync(message)

Returns: . An awaitable that represents the asynchronous operation.

Dispose()

Download(image, fileName, ondownload)

ondownload

Download(stream, fileName, ondownload)

ondownload

Download(filePath, fileName, ondownload)

fileName

ondownload

DownloadAndOpen(target, filePath, fileName, ondownload)

fileName

ondownload

DownloadAndOpen(target, image, fileName, ondownload)

ondownload

DownloadAndOpen(target, stream, fileName, ondownload)

ondownload

EndPolling()

Eval(script)

Eval(script, callback)

EvalAsync(script)

Asynchronously executes the JavaScript script on the client and returns an awaitable with the result of the remote call.

Returns: . An awaitable that represents the asynchronous operation.

Exit()

FindComponent(match)

A custom expression used to match the to find.

Returns: . The first qualified by the match expression.

FindComponents(match)

A custom expression used to match the list of objects to find.

Returns: . The list of instances qualified by the match expression.

GetInstance<T>(reference, builder)

reference

builder

Returns: . The singleton instance of T associated with the current session.

This utility method simplifies the management of session-static (or session singleton) instances. It should be used to convert traditional static variables to session-static instances when changing an application designed for single users to a multi-user system. The code below shows how to use this feature together with the to manage session-static instances and, at the same time, improve the speed of the code that relies on the singleton objects. Using the backing field allows the code that retrieves the session-static instance to quickly check the last instance and compare the session id and avoid accessing the dictionary for every access within the same request. Otherwise the code would have to always store a local variable in order to speed up multiple operations using the same static field.

LoadAssembly(nameOrFile)

Returns: . The loaded .

LoadComponent(nameOrFile, className)

Returns: . An instance of a Wisej component implementing the interface.

LoadPackages(packages, callback)

callback

Scripts are cached using the name specified in the item and loaded only once.

LoadPackagesAsync(packages)

Returns: .

Scripts are cached using the name specified in the item and loaded only once.

LoadTheme(name, mixins)

mixins

MapPath(path)

Returns: . The full path relative to the current application's root directory.

Navigate(url, target)

target

Navigate(url, target, onclose)

OpenWindow(url, target, windowFeatures, onclose)

Play(type)

One of value that identifies the sound to play.

Play(soundUrl)

Post(callback)

Print(control)

Print()

PromptAsync(message, defaultValue)

defaultValue

Returns: . An awaitable that represents the asynchronous operation.

RefreshSessionId()

Reload()

RemoveEventFilter(filter)

An object that implements the interface to remove from the filter list.

RequestFullScreen()

RunInContext(context, action)

The application context to update. It can be any Wisej component or the returned by the property .

SetInstance<T>(reference, instance)

reference

SetSessionTimeout(seconds)

StartPolling(interval)

Calling this method when is true has no effect. Use client side polling when you know that your code will start a background task that needs to update the client asynchronously (push updates) and your server or clients don't support WebSocket connections. Once the background tasks are completed call to reduce the incoming requests from the client.

The interval specified is less than 1.

StartTask(action)

Starts a new task within the current application context and returns immediately. See also .

Returns: . An awaitable .

The task runs in the background but it's still capable of updating the client asynchronously when working with WebSocket by calling the method to push the UI updates to the client browser. If you want to support background updates for clients or servers that can't use the WebSocket connection, you can either add a component to the parent container to force period requests to the server, or you can use the and methods.

StartTask<T>(action)

Starts a new task with a return value within the current application context and returns immediately. See also .

Returns: .

The task runs in the background but it's still capable of updating the client asynchronously when working with WebSocket by calling the method to push the UI updates to the client browser. The generics overload of allows the task to return a value. You can use this with the async/await pattern and asynchronously wait for the task to complete. If you want to support background updates for clients or servers that can't use the WebSocket connection, you can either add a component to the parent container to force period requests to the server, or you can use the and methods.

StartTimer(dueTime, period, callback)

Starts a bound to the current session context.

Returns: . An instance of .

You must save a reference to the returned or the Garbage Collector will stop and dispose the timer. To alter the invocation period user Timer.Changer(), or stop the timer simply use Timer.Dispose(). See .

Update(context, action)

The application context to update. It can be any Wisej component or the returned by the property .

action

ActiveWindowChanged

Fired when the active window changes.

ApplicationExit

Fired when the application is about to shut down.

ApplicationRefresh

Fired when the application is reloaded in the browser because the user hit refresh or changed the URL.

ApplicationStart

Fired when the application is started, after the Main method is called.

BeforeInstallPrompt

Fired when the browser fires the "beforeinstallprompt" event. Corresponds to .

BeginRequest

Fired at the beginning of every request.

BrowserSizeChanged

Fired when the user resizes the browser.

BrowserTabActivated

Fired when the user activates the browser tab.

BrowserTabDeactivated

Fired when the user deactivates the browser tab.

CultureChanged

Fired when the changes.

EndRequest

Fired at the end of every request.

FocusedControlChanged

Fired when the focused control changes.

HashChanged

Fired when the hash part of the URL changes on the client side.

Idle

Fired when the current thread has completed processing all the events and before the response is sent back to the client.

ImpersonationBegin

Fired right after , only when is set to true, to allow user code to take over the thread impersonation operations.

ImpersonationEnd

Fired at the end of every request when impersonation is enabled in the JSON configuration file.

LicenseError

Fired when a license error occurs.

ResponsiveProfileChanged

Fired when the active responsive profile is changed.

RightToLeftChanged

Fired when the value changes.

SessionTimeout

Fired when the session is about to time out.

ThemeChanged

Fired when the current theme is changed.

ThreadException

Fired when a thread exception is thrown.

Application
docs.wisej
ClientProfile
ClientBrowser
X509Certificate2
String
ClientCollection
String
RegistryKey
String
AssemblyCompanyAttribute
Configuration
Configuration
CookieCollection
CultureInfo
CultureInfo
Desktop
Boolean
String
Image
String
String
Boolean
Boolean
Boolean
Boolean
Boolean
Boolean
Object
String
Page
FormCollection
PageCollection
ClientPlatform
String
String
AssemblyInformationalVersionAttribute
AssemblyFileVersionAttribute
NameValueCollection
String
Boolean
Boolean
String
Int32
NameValueCollection
ServiceProvider
ServiceProvider
Object
Int32
String
Boolean
Boolean
String
Uri
String
ClientTheme
ClientTheme
ClientTheme
String
IPrincipal
String
String
String
WindowsIdentity
WindowsIdentity
String[]
Task
Task
Task
Task<Object>
Task
Task<Boolean>
Task
Task
Task<Object>
Task
IWisejComponent
IWisejComponent
IList<IWisejComponent>
IWisejComponent
T
ThreadStaticAttribute
ThreadStaticAttribute
Assembly
Assembly
IWisejComponent
IWisejComponent
Package
Task<Boolean>
Package
String
Task<String>
Task
ArgumentOutOfRangeException
background-tasks
Task
Task
background-tasks
Task<T>
Timer
Timer
Timer
Timer
system.threading
EventHandler
EventHandler
EventHandler
EventHandler
EventHandler
BeforeInstallPromptEvent
RequestEventHandler
EventHandler
EventHandler
EventHandler
RequestEventHandler
EventHandler
HashChangedEventHandler
EventHandler
HandledEventHandler
LicenseErrorEventHandler
ResponsiveProfileChangedEventHandler
HandledEventHandler
EventHandler
ThreadExceptionEventHandler
Dictionary
Page
Desktop
Application
Form
Page
ClientTheme
Session
Cookies
ServerVariables
ServerPort
ServerName
UserAgent
Uri
Url
StartupUri
StartupUrl
StartupPath
ProductName
ProductVersion
SessionTimeout
BeginRequest
ApplicationStart
ApplicationExit
ApplicationRefresh
BrowserSizeChanged
ResponsiveProfileChanged
CultureChanged
Browser
Browser
Download
Call
Eval
Navigate
Reload
MainPage
Desktop
OpenForms
OpenPages
FindComponent
FindComponents
StartTask
LoadTheme
Theme
Exit
CommandManager
CommandManager
IWisejComponent
Update
Application
StartTask
Current
Update
RunInContext
Current
LicenseKey
LicenseKey
Uri
Uri
StartupUri
String
StartupUrl
IsWebSocket
EndPolling
Timer
Update
StartPolling
EndPolling
Timer
Update
StartTask
StartPolling
EndPolling
EventHandler
CurrentCulture
EventHandler
RightToLeft
IEventFilter
IEventFilter
String
String
String
String
Object[]
String
Action<Object>
Object[]
String
Object[]
String
Image
String
Action<String>
Stream
String
Action<String>
String
String
Action<String>
String
String
String
Action<String>
String
Image
String
Action<String>
String
Stream
String
Action<String>
String
String
Action<Object>
String
Predicate<IWisejComponent>
Predicate
IWisejComponent
Predicate<IWisejComponent>
Predicate
IWisejComponent
SessionReference<T>
Func<T>
String
String
String
IEnumerable<Package>
Action<Boolean>
IEnumerable<Package>
String
String[]
String
String
String
String
String
Action
String
String
String
Action
MessageBoxIcon
MessageBoxIcon
String
Action
IWisejControl
String
String
IEventFilter
IEventFilter
IWisejComponent
Action
SessionReference<T>
T
Int32
Int32
Action
Func<T>
Int32
Int32
Action
IWisejComponent
Action
IWisejComponent
IWisejComponent
Current
IWisejComponent
Current
HandledEventHandler
ThreadBegin
Impersonate