Desktop

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • ScrollableControl
    • ContainerControl
      • Desktop

Represents a desktop container that can host floating windows.

C#

public class Desktop : ContainerControl, IWisejWindow, IWisejDesignTarget

VB.NET

Public Class Desktop
    Inherits ContainerControl
    Implements IWisejWindow, IWisejDesignTarget

Constructors

Desktop()

Initializes a new instance of the Desktop class.

Properties

Active

Boolean: Returns true if this desktop instance is the currently active desktop. It is the same as comparing the instance with Desktop. (Default: False)

AutoHideTaskbar

Boolean: Returns or sets whether the taskbar is hidden automatically when there are no opened windows or no windows with the property ShowInTaskbar set to true. (Default: False)

DisplayRectangle

Rectangle: Returns a rectangle that represents the inner dimensions of the Desktop control.

Default value is {X=0,Y=0,Width=200,Height=52} (System.Drawing.Rectangle)

Dock

DockStyle: Returns or sets which control borders are docked to its parent control and determines how a control is resized with its parent. (Default: None)

Height

Int32: Returns or sets the height of the page.

IsTaskbarVisible

Boolean: Returns whether the taskbar is currently visible. (Default: True)

Items

DesktopTaskBarItemCollection: Returns the collection of DesktopTaskBarItem controls displayed in the taskbar of the desktop control.

The default value is a new DesktopTaskBarItemCollection

Location

Point: Returns or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.

Size

Size: Returns the height and width of the page.

TaskbarAlignment

HorizontalAlignment: Return or sets the alignment of the Items in the taskbar. (Default: Left)

TaskbarPosition

Position: Return or sets the position of the taskbar to one of the four sides indicated by the Position values. (Default: Bottom)

TaskbarSize

Int32: Returns the height or width of the taskbar in the current theme, depending on the value of TaskbarPosition.

Text

String: Returns or sets the title of the Desktop. If the desktop is the main desktop, setting the text also changes the title in the browser. (Default: "")

Wallpaper

String: Returns or sets the wallpaper image. (Default: "")

Width

Int32: Returns or sets the width of the page.

Methods

Dispose(disposing)

Disposes the page and related resources.

Parameter	Type	Description
disposing	Boolean	true when this method is called by the application rather than a finalizer.

OnActivated(e)

Fires the Activated event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnAddReferences(items)

Returns a collection of referenced components or collection of components.

Parameter	Type	Description
items	IList

OnCreateControl()

Creates the page.

OnDeactivate(e)

Fires the Deactivate event.

Parameter	Type	Description
e	EventArgs	The EventArgs that contains the event data.

OnItemClick(e)

Fires the ItemClick event.

Parameter	Type	Description
e	DesktopTaskBarItemClickEventArgs	A DesktopTaskBarItemClickEventArgs that contains the event data.

OnItemDoubleClick(e)

Fires the ItemClick event.

Parameter	Type	Description
e	DesktopTaskBarItemClickEventArgs	A DesktopTaskBarItemClickEventArgs that contains the event data.

OnLoad(e)

Fires the Load event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnParentChanged(e)

Raises the ParentChanged event.

Parameter	Type	Description
e	EventArgs	A System.EventArgs that contains the event data.

OnParentVisibleChanged(e)

Fires the VisibleChanged event when the Visible property value of the control's container changes.

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

OnTaskbarAlignmentChanged(e)

Fires the TaskbarAlignmentChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnTaskbarPositionChanged(e)

Fires the TaskbarPositionChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnTaskbarVisibleChanged(e)

Fires the TaskbarVisibleChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

Events

Activated

EventHandler Fired when the desktop becomes active, and it's the new Desktop.

Deactivate

EventHandler Fired when the desktop is deactivated and it's no longer the Desktop.

ItemClick

DesktopTaskBarItemClickEventHandler Fired when a DesktopTaskBarItem on the Desktop is clicked.

ItemDoubleClick

DesktopTaskBarItemClickEventHandler Fired when a DesktopTaskBarItem on the Desktop is double clicked.

Load

EventHandler Fired before the desktop becomes visible for the first time.

TaskbarAlignmentChanged

EventHandler Occurs when the property TaskbarAlignment changes value.

TaskbarPositionChanged

EventHandler Occurs when the property TaskbarPosition changes value.

TaskbarVisibleChanged

EventHandler Occurs when the property AutoHideTaskbar is set to true and the TaskBar is either hidden or shown.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IBindableComponent	Bindable components implement this interface.
IContainerControl	Provides the functionality for a control to act as a parent for other controls.
IDropTarget	Controls that support drag & drop operations implement this interface.
IWisejComponent	All wisej components implement this interface.
IWisejControl	All wisej controls derived from the Control class must implement this interface.
IWisejWindow	All wisej top-level windows implement this interface.
IWisejSerializable	Allows an object to serialize itself.