HoverHelp

HoverHelp is the help-specific specialization of HoverPicture: it defaults to a bundled help icon (/Resources/Images/DefaultHelpImage.gif) and adds a Fill(clsHelpText) overload that lets callers populate the popup directly from a clsHelpText business object retrieved from the APPLICATION_HELP_* tables, rather than passing raw text. (BR-AJAX-043)

Purpose

• Defaults its trigger image to a bundled help icon so pages get a consistent help affordance without configuring an image per instance. (BR-AJAX-043)
• Adds Fill(clsHelpText) so the popup can be populated directly from a retrieved help-text business object, connecting this UI control to the APPLICATION_HELP_MASTER/APPLICATION_HELP_DETAIL data model. (BR-AJAX-020)

Context

• Namespace: SAIF.Presentation.Web.Controls.V2.AJAX
• Assembly/package: SAIF.Presentation.Web.Controls.AJAX.Infragistics111 (packaged in SAIF.BOF.Presentation.Web.Infragistics111)
• Base class: HoverPicture

Public members

Member	Signature	Purpose
Fill	Overloads Sub Fill(inHelpObject As clsHelpText)	Assigns ContentText = inHelpObject.HelpText; ignores a Nothing argument, leaving existing content unchanged (BR-AJAX-020)

Inherited public members

Members in this section are inherited from HoverPicture in SAIF.Presentation.Web.Controls.AJAX.Infragistics111. They are available on this type through inheritance.

Member	Signature	Purpose	Origin
ControlImageURL	Property ControlImageURL As String (default /Resources/Images/DefaultHelpImage.gif)	URL of the image rendered as the hover trigger	SAIF.Presentation.Web.Controls.AJAX.Infragistics111 — HoverPicture
ContentPanelWidth	Property ContentPanelWidth As Unit	Width applied to the composed HoverPanel	SAIF.Presentation.Web.Controls.AJAX.Infragistics111 — HoverPicture
Fill	Overloads Sub Fill(text As String)	Sets the composed HoverPanel's ContentText to the supplied text	SAIF.Presentation.Web.Controls.AJAX.Infragistics111 — HoverPicture
RootObject	ReadOnly Property RootObject As Object	The hosting page's Model property value	SAIF.Presentation.Web.Controls.AJAX.Infragistics111 — SAIFAJAXControlAncestor
IsFirefox	ReadOnly Property IsFirefox As Boolean	Browser-capability test for the current request	SAIF.Presentation.Web.Controls.AJAX.Infragistics111 — SAIFAJAXControlAncestor

Behavioral notes

• Passing Nothing to Fill(clsHelpText) is a deliberate no-op rather than a null-reference error, so a failed or empty help lookup simply leaves the control unchanged (typically showing no popup at all). (BR-AJAX-020)
• Because clsHelpText.HelpText may come from data entered into APPLICATION_HELP_DETAIL, and ContentText is rendered unencoded, this control carries the same unencoded-output exposure as its HoverPicture/HoverPanel ancestors if the stored help text is not trusted. (BR-AJAX-015)

Constraints and usage notes

• The default image path /Resources/Images/DefaultHelpImage.gif is a hosting-environment contract: consuming applications must publish that asset, since it is not packaged with this library's compiled output. (BR-AJAX-043)

Related documentation

• Index
• Overview
• Architecture
• Business rules
• Database tables
• API reference

Sources

• SAIF.Presentation.Web.Controls.AJAX.Infragistics111/HoverHelp.vb