All pages
Powered by GitBook
1 of 7

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

DesktopTaskBarItemClickEventArgs

Wisej.Web.DesktopTaskBarItemClickEventArgs

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

  • MouseEventArgs

    • DesktopTaskBarItemClickEventArgs

Provides data for the ItemClick event.

Constructors

DesktopTaskBarItemClickEventArgs(item, button, clicks)

Initializes a new instance of the class.

Name
Type
Description

Properties

Item

: Returns or sets the that was clicked.

Used By

Name
Description

item

DesktopTaskBarItem

The DesktopTaskBarItem that was clicked.

button

MouseButtons

One of the MouseButtons values that indicate which mouse button was pressed.

clicks

Int32

The number of times a mouse button was pressed.

DesktopTaskBarItemClickEventHandler

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

Public Class DesktopTaskBarItemClickEventArgs
    Inherits MouseEventArgs
DesktopTaskBarItemClickEventArgs
DesktopTaskBarItem
DesktopTaskBarItem
public class DesktopTaskBarItemClickEventArgs : MouseEventArgs

DesktopTaskBarItem

Wisej.Web.DesktopTaskBarItem

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

  • Component

    • Component

Represents a component in the control's taskbar.

Constructors

DesktopTaskBarItem()

Initializes a new instance of the class.

DesktopTaskBarItem(text)

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

Name
Type
Description

Properties

AllowHtml

: Returns or sets a value indicating that the control can display html in the Text property.

Enabled

: Returns or sets whether the button is enabled.

Image

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

ImagePosition

: Returns or sets the position of the within this taskbar item.

ImageSource

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

Name

: Returns or sets the name of the .

Parent

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

Position

: Returns or sets the position of this within the taskbar in the parent .

Tag

: Returns or sets the object that contains user data.

Text

: Returns or sets the text displayed on the taskbar item.

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

ToolTipText

: Returns or sets the text that appears as a ToolTip for the taskbar item.

Visible

: Returns or sets whether the taskbar item is visible or hidden.

Methods

Update()

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

Inherited By

Name
Description

Implements

Name
Description

DesktopTaskBarItemControl

Wisej.Web.DesktopTaskBarItemControl

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

  • Component

    • Component

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

Constructors

DesktopTaskBarItemControl()

Initializes a new instance of .

Properties

Control

: Returns or sets the to be hosted.

Parent

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

Implements

Name
Description

DesktopTaskBarItemDateTime

Wisej.Web.DesktopTaskBarItemDateTime

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

DesktopTaskBarItemClickEventHandler

Wisej.Web.DesktopTaskBarItemClickEventHandler

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Represents the method that will handle the event of a .

text

String

The text to display on the new DesktopTaskBarItem.

DesktopTaskBarItemControl

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

DesktopTaskBarItemDateTime

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

IWisejComponent

All wisej components implement this interface.

IWisejSerializable

Allows an object to serialize itself.

DesktopTaskBarItem
Desktop
Public Class DesktopTaskBarItem
    Inherits Component
DesktopTaskBarItem
DesktopTaskBarItem
Boolean
Boolean
Image
DesktopTaskBarItem
ImagePosition
Image
String
DesktopTaskBarItem
String
DesktopTaskBarItem
Desktop
Desktop
LeftRightAlignment
DesktopTaskBarItem
Desktop
Object
String
String
Boolean
public class DesktopTaskBarItem : Component

IWisejComponent

All wisej components implement this interface.

IWisejSerializable

Allows an object to serialize itself.

DesktopTaskBarItem
DesktopTaskBarItemControl
Desktop
Control
Public Class DesktopTaskBarItemControl
    Inherits DesktopTaskBarItem
DesktopTaskBarItemControl
Control
Control
Desktop
Desktop
public class DesktopTaskBarItemControl : DesktopTaskBarItem

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.

Implements

Name
Description

All wisej components implement this interface.

Allows an object to serialize itself.

Component
Component
Parameters
Name
Type
Description

sender

The source of the event.

e

A that contains the event data.

Fired By

Name
Description

Fired when a on the is clicked.

Fired when a on the is double clicked.

ItemClick
Desktop
Public Delegate Sub DesktopTaskBarItemClickEventHandler(ByVal sender As [Object], ByVal e As DesktopTaskBarItemClickEventArgs)
public delegate void DesktopTaskBarItemClickEventHandler(Object sender, DesktopTaskBarItemClickEventArgs e)

Desktop

Wisej.Web.Desktop

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.0.0.0)

Object
DesktopTaskBarItemClickEventArgs
DesktopTaskBarItemClickEventArgs
Desktop.ItemClick
DesktopTaskBarItem
Desktop
Desktop.ItemDoubleClick
DesktopTaskBarItem
Desktop
IWisejComponent
IWisejSerializable

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.

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.

DisplayRectangle

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

Dock

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

Height

Int32: Returns or sets the height of the page.

IsTaskbarVisible

Boolean: Returns whether the taskbar is currently visible.

Items

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

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 content of the taskbar.

When using Left the

TaskbarPosition

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

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.

Wallpaper

String: Returns or sets the wallpaper image.

Width

Int32: Returns or sets the width of the page.

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

Bindable components implement this interface.

Provides the functionality for a control to act as a parent for other controls.

All wisej components implement this interface.

All wisej controls derived from the class must implement this interface.

All wisej top-level windows implement this interface.

Control
ScrollableControl

IWisejSerializable

Allows an object to serialize itself.

IBindableComponent
IContainerControl
IWisejComponent
IWisejControl
Control
IWisejWindow

DesktopTaskBarItemCollection

Wisej.Web.DesktopTaskBarItemCollection

Namespace: Wisej.Web

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

Name
Type
Description

Properties

IsReadOnly

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

Item(index)

: Returns or sets the at the specified index.

Item(name)

: Returns the identified by the name.

Methods

Add(text)

Adds a with the specified text to the collection.

Parameter
Type
Description

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

Add(item)

Adds a to the collection.

Parameter
Type
Description

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

Throws:

  • The being added to the collection is null.

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

AddRange(items)

Adds an array of to the collection.

Parameter
Type
Description

Clear()

Removes all objects from the collection.

Clear(dispose)

Removes and optionally disposes all objects from the collection.

Parameter
Type
Description

Contains(button)

Determines whether the specified is located within the collection.

Parameter
Type
Description

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

ContainsKey(key)

Determines whether the collection contains a with the specified key.

Parameter
Type
Description

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

GetEnumerator()

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

Returns: . An that represents the item collection.

IndexOf(button)

Returns the index within the collection of the specified .

Parameter
Type
Description

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

IndexOfKey(key)

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

Parameter
Type
Description

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

Insert(index, button)

Inserts the specified into the collection at the specified index.

Parameter
Type
Description

Throws:

  • The button parameter is null.

  • The button parameter's parent is not null.

  • The index parameter is less than zero or greater than the value of the property of the .

Remove(item)

Removes the specified from the collection.

Parameter
Type
Description

Throws:

  • The assigned to the item parameter is null.

RemoveAt(index)

Removes the located at the specified index within the collection.

Parameter
Type
Description

Throws:

  • The index parameter is less than zero or greater than or equal to the value of the property of the .

RemoveByKey(key)

Removes the with the specified key from the collection.

Parameter
Type
Description

owner

Desktop

The Desktop control that owns this collection.

text

String

The text for the DesktopTaskBarItem that is being added.

item

DesktopTaskBarItem

A DesktopTaskBarItem that represents the panel to add to the collection.

items

DesktopTaskBarItem[]

Array of DesktopTaskBarItem objects to add to the collection.

dispose

Boolean

Indicates whether the removed items should be disposed.

button

DesktopTaskBarItem

The DesktopTaskBarItem to locate in the collection.

key

String

The name of the item to find in the collection.

button

DesktopTaskBarItem

The DesktopTaskBarItem to locate in the collection.

key

String

The name of the DesktopTaskBarItem to find in the collection.

index

Int32

The zero-based index location where the panel is inserted.

button

DesktopTaskBarItem

A DesktopTaskBarItem representing the panel to insert.

item

DesktopTaskBarItem

The DesktopTaskBarItem representing the panel to remove from the collection.

index

Int32

The zero-based index of the item to remove.

key

String

The name of the DesktopTaskBarItem to remove from the collection.

DesktopTaskBarItemCollection
Boolean
DesktopTaskBarItem
DesktopTaskBarItem
DesktopTaskBarItem
DesktopTaskBarItem
DesktopTaskBarItem
DesktopTaskBarItem
DesktopTaskBarItem
DesktopTaskBarItem
Int32
ArgumentNullException
DesktopTaskBarItem
ArgumentException
DesktopTaskBarItem
DesktopTaskBarItem
DesktopTaskBarItem
DesktopTaskBarItem
DesktopTaskBarItem
Boolean
DesktopTaskBarItem
DesktopTaskBarItem
Boolean
DesktopTaskBarItem
DesktopTaskBarItem
IEnumerator
IEnumerator
DesktopTaskBarItem
Int32
DesktopTaskBarItem
DesktopTaskBarItem
Int32
DesktopTaskBarItem
DesktopTaskBarItem
ArgumentNullException
ArgumentException
ArgumentOutOfRangeException
Count
DesktopTaskBarItemCollection
DesktopTaskBarItem
ArgumentNullException
DesktopTaskBarItem
DesktopTaskBarItem
ArgumentOutOfRangeException
Count
DesktopTaskBarItemCollection
DesktopTaskBarItem