SAIFHoverHelp¶
SAIFHoverHelp is a Label subclass that renders a help icon alongside a positioned tooltip popup, letting host pages attach contextual help text to a form field without building the icon/popup markup themselves.
Purpose¶
- Render a consistent help-icon + popup pattern for contextual field help across SAIF pages.
- Let the popup be anchored at one of eight relative positions (
PopupPosition) and sized (PanelWidth).
Context¶
- Namespace:
SAIF.Presentation.Web.Controls.V2 - Assembly/package: Compiled into
SAIF.BOF.Presentation.Web.Infragistics103*
Public members¶
| Member | Signature | Purpose |
|---|---|---|
HelpText |
Public Property HelpText As String |
The help content displayed in the hover popup. |
PanelWidth |
Public Property PanelWidth As Integer |
Width in pixels of the rendered popup panel; defaults to 250. |
PopupPosition |
Public Property PopupPosition As HoverHelpPopupPosition |
Anchors the popup relative to the help icon (e.g. top-left, bottom-center); defaults to TopCenter. |
Inherited public members¶
SAIFHoverHelp inherits from Label (System.Web.UI.WebControls), a framework base class rather than a documented SAIF dependency library.
| Member | Signature | Purpose |
|---|---|---|
AssociatedControlID |
Public Property AssociatedControlID As String |
Links the label to another control for accessibility purposes. |
Text |
Public Property Text As String |
Label text rendered by the control when used as a standard framework label. |
Attributes |
Public ReadOnly Property Attributes As AttributeCollection |
Collection of arbitrary HTML attributes rendered on the control's outer tag. |
CssClass |
Public Property CssClass As String |
CSS class name(s) rendered on the control's outer tag. |
Font |
Public ReadOnly Property Font As FontInfo |
Font styling applied to the rendered element. |
ForeColor |
Public Property ForeColor As Color |
Foreground text color applied to the rendered label. |
Style |
Public ReadOnly Property Style As CssStyleCollection |
Inline CSS style declarations rendered on the outer tag. |
ToolTip |
Public Property ToolTip As String |
Text shown as a native tooltip when hovering the rendered element. |
Standard Label/Control members (ID, ClientID, Controls, Visible, DataBind, FindControl, etc.) are not re-documented here as they are unmodified framework behavior**.
Behavioral notes¶
HoverHelp_InitsetsCssClass = "HoverHelpV2"and registersHoverHelp.js.RenderaddsPanelWidth/Positionas HTML attributes, and composes a help-textLabelplus a default help iconImage(/Resources/Images/DefaultHelpImage.gif) into its child controls before delegating to the baseRender.- The help icon is marked non-enableable via
Utilities.SetControlManagerEnableable(HelpImage, False), excluding it from the control-manager's enable/disable attribute tagging convention*.
Constraints and usage notes¶
- Requires
HoverHelp.jsto be deployed at/Resources/Scripts/Controls/HoverHelp.jsfor the popup show/hide interaction to function; the script's client-side logic could not be verified from this library's source**.
Note: Statements marked with * were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts. Statements marked with ** could not be confirmed; treat as unknown until verified.
Sources¶
- SAIF.Presentation.Web.Controls.V2\SAIFHoverHelp.vb