Skip to content

HoverHelp

HoverHelp is the help-icon control that renders database-backed context help. It extends HoverPicture to default its trigger image to a standard help icon and adds a Fill(clsHelpText) overload that pulls hover content directly from a retrieved clsHelpText business object, implementing the rendering half of Retrieve help text for a screen field.

Purpose

  • Populates its hover content text directly from a clsHelpText business object's HelpText property, coupling this UI control to the library's single database-backed business object.
  • Defaults its trigger image to /Resources/Images/DefaultHelpImage.gif when the host page does not supply a custom ControlImageURL.

Context

  • Namespace: SAIF.Presentation.Web.Controls.V2.AJAX
  • Assembly/package: SAIF.Presentation.Web.Controls.AJAX.Infragistics103

Public members

Member Signature Purpose
ControlImageURL Overrides Property ControlImageURL() As String The trigger image URL; not browsable in the designer, defaults to the standard help icon at render time if unset
Fill Overloads Sub Fill(inHelpObject As clsHelpText) Sets the control's hover content text from a previously-retrieved clsHelpText instance's HelpText property

Inherited public members

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

Member Signature Purpose Origin
ContentText Property ContentText() As String The hover popup's content text SAIF.Presentation.Web.Controls.AJAX.Infragistics103 — HoverPicture
Fill Sub Fill(inContentText As String) Sets the hover content text directly from a plain string SAIF.Presentation.Web.Controls.AJAX.Infragistics103 — HoverPicture
PopupPosition Property PopupPosition() As AjaxControlToolkit.HoverMenuPopupPosition Where the hover popup appears relative to the trigger image SAIF.Presentation.Web.Controls.AJAX.Infragistics103 — HoverPicture
ContentPanelWidth Property ContentPanelWidth() As Integer The width of the hover popup panel SAIF.Presentation.Web.Controls.AJAX.Infragistics103 — HoverPicture

Behavioral notes

  • Only renders the trigger image and hover popup at all if ContentText is non-empty (inherited from HoverPicture) — an entry with no help text found produces no visible control.

Constraints and usage notes

  • Consuming pages typically call clsHelpText.GetHelpText(inDataportal, inApplicationCode, inReferenceKeyValue) themselves and pass the result to Fill(clsHelpText); this control does not call the retrieval factory itself.

Sources

  • SAIF.Presentation.Web.Controls.AJAX.Infragistics103\HoverHelp.vb