Skip to content

BannerControlV2

BannerControlV2 is the revised-look successor to BannerControl, reading SITEBANNERV2.XML instead of SITEBANNER.XML and applying the same environment-conditional visibility rules and logout flow, updated for the 2009 menu redesign*.

Purpose

  • Render the revised-style site banner (print and interactive display variants) from SITEBANNERV2.XML.
  • Apply the same environment-conditional defaults for banner/feedback/logout visibility as BannerControl (BR-V2-001).
  • Suppress logout/interactive-feedback UI on the login application, matching BannerControl behavior (BR-V2-002).
  • Handle the logout postback identically to BannerControl: abandon session, clear cookies, redirect to login.

Context

  • Namespace: SAIF.Presentation.Web.Controls.V2
  • Assembly/package: Compiled into SAIF.BOF.Presentation.Web.Infragistics103*

Public members

Member Signature Purpose
New() Public Sub New() Constructs the control and wires the logout/feedback link controls into the control tree.
New(tag) Public Sub New(ByVal tag As HtmlTextWriterTag) Constructs the control specifying the root HTML tag used for rendering, distinguishing this control from BannerControl's single parameterless constructor.
MenuNavigate Public Event MenuNavigate(ByVal Application As String, ByVal page As String) Raised after a successful logout so host pages can react to navigation away from the current application.
ShowInternalDisplayBanner Public Property ShowInternalDisplayBanner As Boolean Controls whether the interactive display banner is shown for internal clients.
DisplayBannerLogout Public Property DisplayBannerLogout As Boolean Determines whether the logout link renders in the display banner.
DisplayBannerFeedback Public Property DisplayBannerFeedback As Boolean Determines whether the feedback link renders in the display banner.
PrintPageTitle Public Property PrintPageTitle As String Title text substituted into the print-variant banner markup; defaults to an empty string.
LoggingIn Public Property LoggingIn As Boolean Indicates the current page is the login screen, suppressing the logout link.

Inherited public members

BannerControlV2 inherits from WebControl (System.Web.UI.WebControls), a framework base class rather than a documented SAIF dependency library.

Member Signature Purpose
AccessKey Public Property AccessKey As String Keyboard shortcut character used to move focus to the rendered banner element.
Attributes Public ReadOnly Property Attributes As AttributeCollection Collection of arbitrary HTML attributes rendered on the control's outer tag.
BackColor Public Property BackColor As Color Background color applied to the rendered banner element.
ForeColor Public Property ForeColor As Color Foreground (text) color applied to the rendered banner element.
BorderColor Public Property BorderColor As Color Border color applied to the rendered banner element.
BorderStyle Public Property BorderStyle As BorderStyle Border line style applied to the rendered banner element.
BorderWidth Public Property BorderWidth As Unit Border width applied to the rendered banner element.
CssClass Public Property CssClass As String CSS class name(s) rendered on the control's outer tag.
Enabled Public Property Enabled As Boolean Controls whether the rendered banner control participates in enabled-state behavior.
Font Public ReadOnly Property Font As FontInfo Font styling applied to the rendered outer element.
Height Public Property Height As Unit Height of the rendered banner element.
Width Public Property Width As Unit Width of the rendered banner element.
Style Public ReadOnly Property Style As CssStyleCollection Inline CSS style declarations rendered on the outer tag.
TabIndex Public Property TabIndex As Short Tab order of the rendered element among focusable page elements.
ToolTip Public Property ToolTip As String Text shown as a native tooltip when hovering the rendered element.

Standard WebControl/Control members (ID, ClientID, Controls, Visible, DataBind, FindControl, etc.) are not re-documented here as they are unmodified framework behavior**.

Behavioral notes

  • Functionally mirrors BannerControl's OnInit/Render/logout-click logic, but reads SITEBANNERV2.XML and supports an additional constructor overload accepting an HtmlTextWriterTag.
  • See Banner rendering and logout for the full step-by-step operation shared with BannerControl.

Constraints and usage notes

  • Depends on SAIF.Framework's AppGlobal.EnvironmentService for internal/external client detection, same as BannerControl*.
  • The SITEBANNERV2.XML resource must exist at the resolved runtime path, or no display banner renders.

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\BannerControlV2.vb