Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

• Component

  • Component

    • DesktopTaskBarItem

Represents a component in the Desktop control's taskbar.

public class DesktopTaskBarItem : Component

Public Class DesktopTaskBarItem
    Inherits Component

Constructors

DesktopTaskBarItem()

Initializes a new instance of the DesktopTaskBarItem class.

DesktopTaskBarItem(text)

Initializes a new instance of the DesktopTaskBarItem class and displays the specified text on the item.

Properties

Boolean: Returns or sets a value indicating that the control can display html in the Text property. (Default: False)

Boolean: Returns or sets whether the button is enabled. (Default: True)

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

ImagePosition: Returns or sets the position of the Image within this taskbar item. (Default: Left)

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

String: Returns or sets the name of the DesktopTaskBarItem.

Desktop: Returns the Desktop control that the taskbar item button is assigned to.

LeftRightAlignment: Returns or sets the position of this DesktopTaskBarItem within the taskbar in the parent Desktop. (Default: Left)

Object: Returns or sets the object that contains user data. (Default: null)

String: Returns or sets the text displayed on the taskbar item. (Default: "")

When AllowHtml is set to true, the text can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with "<br/>".

String: Returns or sets the text that appears as a ToolTip for the taskbar item. (Default: "")

Boolean: Returns or sets whether the taskbar item is visible or hidden. (Default: True)

Methods

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

Inherited By

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents the collection of DesktopTaskBarItem controls in a Desktop control.

public class DesktopTaskBarItemCollection : IList, ICollection, IEnumerable

Public Class DesktopTaskBarItemCollection
    Inherits IList
    Implements ICollection, IEnumerable

Constructors

DesktopTaskBarItemCollection(owner)

Initializes a new instance of the DesktopTaskBarItemCollection class.

Properties

IsReadOnly

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

Item(index)

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

Item(name)

DesktopTaskBarItem: Returns the DesktopTaskBarItem identified by the name.

Methods

Adds a DesktopTaskBarItem with the specified text to the collection.

Returns: DesktopTaskBarItem. A DesktopTaskBarItem that represents the item that was added to the collection.

Adds a DesktopTaskBarItem to the collection.

Returns: Int32. The zero-based index of the item in the collection.

Throws:

• ArgumentNullException The DesktopTaskBarItem being added to the collection is null.

• ArgumentException The parent of the DesktopTaskBarItem specified in the item parameter is not null.

Adds an array of DesktopTaskBarItem to the collection.

Removes all DesktopTaskBarItem objects from the collection.

Removes and optionally disposes all DesktopTaskBarItem objects from the collection.

Determines whether the specified DesktopTaskBarItem is located within the collection.

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

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

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

Returns an enumerator to use to iterate through the DesktopTaskBarItem objects in the collection.

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

Returns the index within the collection of the specified DesktopTaskBarItem.

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

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

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

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

Throws:

• ArgumentNullException The button parameter is null.

• ArgumentException The button 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 DesktopTaskBarItemCollection.

Removes the specified DesktopTaskBarItem from the collection.

Throws:

• ArgumentNullException The DesktopTaskBarItem assigned to the item parameter is null.

Removes the DesktopTaskBarItem 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 DesktopTaskBarItemCollection.

Removes the DesktopTaskBarItem with the specified key from the collection.

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

• Component

  • Component

    • DesktopTaskBarItem

      • DesktopTaskBarItemControl

Represents a component in the Desktop control's taskbar that can host any Control.

public class DesktopTaskBarItemControl : DesktopTaskBarItem

Public Class DesktopTaskBarItemControl
    Inherits DesktopTaskBarItem

Constructors

DesktopTaskBarItemControl()

Initializes a new instance of DesktopTaskBarItemControl.

Properties

Control

Control: Returns or sets the Control to be hosted. (Default: null)

Desktop: Returns the Desktop control that the taskbar item button is assigned to.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

Represents the method that will handle the ItemClick event of a Desktop.

public delegate void DesktopTaskBarItemClickEventHandler(Object sender, DesktopTaskBarItemClickEventArgs e)

Public Delegate Sub DesktopTaskBarItemClickEventHandler(ByVal sender As [Object], ByVal e As DesktopTaskBarItemClickEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

• Component

  • Component

    • DesktopTaskBarItem

      • DesktopTaskBarItemDateTime

Represents a DateTime component in the Desktop control's taskbar.

public class DesktopTaskBarItemDateTime : DesktopTaskBarItem

Public Class DesktopTaskBarItemDateTime
    Inherits DesktopTaskBarItem

Constructors

DesktopTaskBarItemDateTime()

Initializes a new instance of DesktopTaskBarItemDateTime setting the initial Position value to Right.

Properties

Position

LeftRightAlignment: Returns or sets the position of this DesktopTaskBarItem within the taskbar in the parent Desktop. (Default: Right)

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

• Control

  • ScrollableControl

    • ContainerControl

      • Desktop

Represents a desktop container that can host floating windows.

public class Desktop : ContainerControl, IWisejWindow, IWisejDesignTarget

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.

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)

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

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)

Int32: Returns or sets the height of the page.

Boolean: Returns whether the taskbar is currently visible.

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

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

Size: Returns the height and width of the page.

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

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

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

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: "")

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

Int32: Returns or sets the width of the page.

Events

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

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

DesktopTaskBarItemClickEventHandler Fired when a DesktopTaskBarItem on the Desktop is clicked.

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

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

EventHandler Occurs when the property TaskbarAlignment changes value.

EventHandler Occurs when the property TaskbarPosition changes value.

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

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.2.0.0)

• MouseEventArgs

  • DesktopTaskBarItemClickEventArgs

Provides data for the ItemClick event.

public class DesktopTaskBarItemClickEventArgs : MouseEventArgs

Public Class DesktopTaskBarItemClickEventArgs
    Inherits MouseEventArgs

Constructors

DesktopTaskBarItemClickEventArgs(item, button, clicks)

Initializes a new instance of the DesktopTaskBarItemClickEventArgs class.

Properties

Item

DesktopTaskBarItem: Returns or sets the DesktopTaskBarItem that was clicked.

Used By