HelpTip

Wisej.Web.HelpTip

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Component

  • Component

    • HelpTip

Represents a small rectangular pop-up window that displays a brief help text next to a control when it gets activated (focused).

C#

public class HelpTip : Component, IExtenderProvider

VB.NET

Public Class HelpTip
    Inherits Component
    Implements IExtenderProvider

Constructors

HelpTip()

Initializes a new instance of the HelpTip without a specified container.

HelpTip(container)

Initializes a new instance of the HelpTip class with a specified container.

Name	Type	Description
container	IContainer	An IContainer that represents the container of the HelpTip extender.

Properties

Active

Boolean: Returns or sets whether the HelpTip provider is currently active. (Default: True)

Alignment

Placement: Returns or sets the position of the HelpTip in relation to the target control. (Default: RightMiddle)

AllowHtml

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

AutoPopDelay

Int32: Returns or sets the period of time the HelpTip remains visible if the pointer is stationary on a control with specified HelpTip text. (Default: 0)

BackColor

Color: Returns or sets the background color for the HelpTip. (Default: Color [Empty])

ForeColor

Color: Returns or sets the foreground color for the HelpTip. (Default: Color [Empty])

HelpTipIcon

ToolTipIcon: Returns or sets a value that defines the type of icon to be displayed alongside the HelpTip text. (Default: Default)

InitialDelay

Int32: Returns or sets the time that passes before the HelpTip appears. (Default: 0)

Tag

Object: Returns or sets the object that contains programmer-supplied data associated with the HelpTip. (Default: null)

Methods

CanExtend(target)

Returns true if the HelpTip can offer an extender property to the specified target component.

Parameter	Type	Description
target	Object	The target object to add an extender property to.

Returns: Boolean. true if the HelpTip class can offer one or more extender properties; otherwise, false.

Clear()

Removes all HelpTip text currently associated with the HelpTip component.

Dispose(disposing)

Parameter	Type	Description
disposing	Boolean

GetHelpTip(control)

Retrieves the HelpTip text associated with the specified control.

Parameter	Type	Description
control	Control	The Control for which to retrieve the HelpTip text.

Returns: String. A String containing the HelpTip text for the specified control.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

SetHelpTip(control, caption)

Associates HelpTip text with the specified control.

Parameter	Type	Description
control	Control	The Control to associate the HelpTip text with.
caption	String	The HelpTip text to display when the pointer is on the control.

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.