DesktopTaskBarItem

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Component
  • Component
    • DesktopTaskBarItem

Represents a component in the Desktop control's taskbar.

C#

public class DesktopTaskBarItem : Component

VB.NET

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.

Name	Type	Description
text	String	The text to display on the new DesktopTaskBarItem.

Properties

AllowHtml

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

Enabled

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

Image

Image: Returns or sets the image that is displayed in a DesktopTaskBarItem. (Default: null)

ImagePosition

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

ImageSource

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

Name

String: Returns or sets the name of the DesktopTaskBarItem. (Default: "")

Parent

Desktop: Returns the Desktop control that the taskbar item button is assigned to. (Default: null)

Position

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

Tag

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

Text

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

ToolTipText

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

Visible

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

Methods

Dispose(disposing)

Releases the resources used by the DesktopTaskBarItem.

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

OnAddReferences(items)

Returns a collection of referenced components or collection of components.

Parameter	Type	Description
items	IList

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

Update()

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

Inherited By

Name	Description
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.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IWisejComponent	All wisej components implement this interface.
IWisejSerializable	Allows an object to serialize itself.