Skip to content

ControlCoverage.md

Latest commit

 

History

History
426 lines (324 loc) · 26.3 KB

ControlCoverage.md

File metadata and controls

426 lines (324 loc) · 26.3 KB

Control Coverage Reference

Can I migrate this control? This is the complete reference for all BWFC components and the Web Forms controls that are not covered.

For the full control translation rules (attribute mappings, code examples, before/after), see the Copilot migration skill.

Coverage Summary

Metric Value
Primary Web Forms controls 58
Supporting components (field columns, styles, infrastructure, helpers) 96
Total Razor components shipped 154
Migration shims (compile-compatible APIs) 14
Web Forms control categories covered 9 (Editor, Data, Validation, Navigation, Login, AJAX, Infrastructure, Field Columns, Style Sub-Components)
Enums 54
Utility/infrastructure C# classes 197+
WingtipToys PoC coverage 96.6% (28 of 29 control types used)
Controls with no BWFC equivalent See Not Supported

Complexity Rating Guide

Rating Meaning Typical Effort
Trivial Remove asp: and runat="server". Done. < 1 minute
Easy Remove prefixes + add @bind or adjust one attribute. 1–5 minutes
Medium Data binding rewiring, template context variables, lifecycle method changes. 5–30 minutes
Complex Architecture decisions required — data access, auth, state management. 30+ minutes

Editor Controls (28 components)

Control BWFC? Complexity Key Changes Gotchas
AdRotator ✅ Easy Remove asp:, runat Configure ad data via component properties
BulletedList ✅ Easy Remove asp:, runat; bind Items DisplayMode and BulletStyle preserved
Button ✅ Trivial Remove asp:, runat OnClick is now EventCallback — no (sender, e) signature
Calendar ✅ Easy Remove asp:, runat SelectionMode is an enum — use CalendarSelectionMode.Day
Chart ✅ Complex Remove asp:, runat JS interop for rendering; use <ChartSeries>, <ChartArea>, <ChartLegend> children
CheckBox ✅ Easy Remove asp:, runat; add @bind-Checked Two-way binding requires @bind-Checked
CheckBoxList ✅ Easy Remove asp:, runat; bind Items Same list binding pattern as DropDownList
DropDownList ✅ Easy Remove asp:, runat; bind Items + @bind-SelectedValue Bind both the items collection and selected value
FileUpload ✅ Easy Remove asp:, runat Uses Blazor InputFile internally — HasFile, SaveAs() work
HiddenField ✅ Trivial Remove asp:, runat Value property preserved
HyperLink ✅ Trivial Remove asp:, runat; ~/ → / URL prefix conversion is Layer 1 automated
Image ✅ Trivial Remove asp:, runat; ~/ → / ImageUrl preserved
ImageButton ✅ Trivial Remove asp:, runat; ~/ → / OnClick is EventCallback
ImageMap ✅ Easy Remove asp:, runat Define hotspot regions via component properties
Label ✅ Trivial Remove asp:, runat Text, CssClass, AssociatedControlID preserved
LinkButton ✅ Trivial Remove asp:, runat CommandName/CommandArgument preserved
ListBox ✅ Easy Remove asp:, runat; bind Items Same binding pattern as DropDownList
Literal ✅ Trivial Remove asp:, runat Text and Mode preserved
Localize ✅ Trivial Remove asp:, runat Resource-based text
MultiView ✅ Easy Remove asp:, runat Use with <View> child components
Panel ✅ Trivial Remove asp:, runat Renders <div> — same as Web Forms
PlaceHolder ✅ Trivial Remove asp:, runat Renders no HTML — structural container only
RadioButton ✅ Easy Remove asp:, runat GroupName preserved
RadioButtonList ✅ Easy Remove asp:, runat; bind Items Same list binding pattern
Substitution ✅ Easy Remove asp:, runat Uses Func<HttpContext, string> callback; renders output directly
Table ✅ Easy Remove asp:, runat Use with <TableRow> and <TableCell> children
TextBox ✅ Easy Remove asp:, runat; add @bind-Text TextMode preserved — note Multiline (not MultiLine)
View ✅ Trivial Remove asp:, runat Used inside MultiView

Data Controls (8 components)

Control BWFC? Complexity Key Changes Gotchas
DataGrid ✅ Medium ItemType → TItem; SelectMethod → delegate or Items Built-in numeric pager — does not use PagerSettings
DataList ✅ Medium ItemType → TItem; SelectMethod → delegate or Items Template Context="Item" required
DataPager ✅ Medium Remove asp:, runat Works with PageableData controls
DetailsView ✅ Medium ItemType → TItem; SelectMethod → DataItem Single-record control — uses DataItem, not Items
FormView ✅ Medium ItemType → TItem; SelectMethod → DataItem RenderOuterTable="false" supported; single-record control
GridView ✅ Medium ItemType → TItem; SelectMethod → delegate or Items Add Context="Item" to templates; BoundField/TemplateField preserved
ListView ✅ Medium ItemType → TItem; SelectMethod → delegate or Items LayoutTemplate, GroupTemplate, GroupItemCount all supported
Repeater ✅ Medium ItemType → TItem; SelectMethod → delegate or Items SeparatorTemplate supported

Data Control Migration Pattern

All data controls follow the same pattern. When the original Web Forms markup uses SelectMethod, preserve it as a delegate reference (preferred). When it uses DataSource/DataBind(), use Items.

Option A — SelectMethod preserved as delegate (preferred when original used SelectMethod):

<!-- Web Forms -->
<asp:GridView ItemType="MyApp.Models.Product" SelectMethod="GetProducts" runat="server">
<!-- Blazor — SelectMethod as delegate -->
<GridView TItem="Product" SelectMethod="@productService.GetProducts">

Option B — Items binding (when original used DataSource/DataBind):

<!-- Web Forms -->
<asp:GridView ItemType="MyApp.Models.Product" runat="server">
<!-- Blazor -->
<GridView TItem="Product" Items="products">

Load data in the code-behind:

protected override async Task OnInitializedAsync()
{
    products = await ProductService.GetProductsAsync();
}

⚠️ DO NOT convert SelectMethod to Items= binding when the original Web Forms markup used SelectMethod. BWFC's DataBoundComponent<ItemType> has a native SelectMethod parameter of type SelectHandler<ItemType> that mirrors how Web Forms worked.

  • Collection controls (GridView, ListView, Repeater, DataList, DataGrid): use SelectMethod delegate or Items parameter
  • Single-record controls (FormView, DetailsView): use SelectMethod delegate or DataItem parameter

Validation Controls (7 components)

Control BWFC? Complexity Key Changes Gotchas
CompareValidator ✅ Trivial Remove asp:, runat ControlToCompare, ControlToValidate preserved
CustomValidator ✅ Easy Remove asp:, runat OnServerValidate is EventCallback
ModelErrorMessage ✅ Trivial Remove asp:, runat ModelStateKey preserved
RangeValidator ✅ Trivial Remove asp:, runat MinimumValue, MaximumValue, Type preserved
RegularExpressionValidator ✅ Trivial Remove asp:, runat ValidationExpression preserved
RequiredFieldValidator ✅ Trivial Remove asp:, runat ControlToValidate, ErrorMessage preserved
ValidationSummary ✅ Trivial Remove asp:, runat DisplayMode preserved

Validation controls are the easiest migration — nearly 1:1 attribute compatibility. Wrap validated forms in <EditForm> for full integration.

Navigation Controls (3 components)

Control BWFC? Complexity Key Changes Gotchas
Menu ✅ Medium Remove asp:, runat MenuItem structure preserved; dual rendering modes (horizontal/vertical)
SiteMapPath ✅ Medium Remove asp:, runat Provide SiteMapNode data programmatically
TreeView ✅ Medium Remove asp:, runat Node expansion state managed by component

Login Controls (7 components)

Control BWFC? Complexity Key Changes Gotchas
ChangePassword ✅ Complex Remove asp:, runat Wire auth provider via service; Orientation/TextLayout enums
CreateUserWizard ✅ Complex Remove asp:, runat Multi-step wizard; requires Identity service wiring
Login ✅ Complex Remove asp:, runat Wire auth provider via service
LoginName ✅ Easy Remove asp:, runat Uses AuthenticationState
LoginStatus ✅ Easy Remove asp:, runat Uses AuthenticationState
LoginView ✅ Easy Remove asp:, runat Uses AuthenticationState for template switching
PasswordRecovery ✅ Complex Remove asp:, runat 3-step wizard; requires Identity service wiring

Important: BWFC provides the UI components, but the underlying authentication system must be migrated separately. ASP.NET Membership → ASP.NET Core Identity is an architecture decision (Layer 3).

AJAX Controls (5 components)

Control BWFC? Complexity Key Changes Gotchas
ScriptManager ✅ Trivial Remove asp:, runat Migration stub — renders nothing. Include during migration, remove when stable.
ScriptManagerProxy ✅ Trivial Remove asp:, runat Migration stub — renders nothing. Use IJSRuntime for script registration.
Timer ✅ Easy Remove asp:, runat Interval-based tick events; no ScriptManager dependency in Blazor
UpdatePanel ✅ Trivial Remove asp:, runat Renders <div> or <span> — Blazor already does partial rendering
UpdateProgress ✅ Easy Remove asp:, runat Replace automatic UpdatePanel association with explicit bool IsLoading state

Note: ScriptManager and ScriptManagerProxy are intentional no-op stubs. They accept Web Forms attributes silently so your markup compiles, but they don't do anything. Blazor's rendering model replaces the need for AJAX partial postback infrastructure.

Infrastructure Controls (7 components)

These components support Master Page migration, page metadata, naming scopes, and layout infrastructure.

Control BWFC? Complexity Key Changes Gotchas
Content ✅ Easy <asp:Content> → <Content> Provides content to ContentPlaceHolder slots in MasterPage
ContentPlaceHolder ✅ Easy <asp:ContentPlaceHolder> → <ContentPlaceHolder> Defines replaceable content regions; renders ChildContent when no Content matches
MasterPage ✅ Medium .master → MasterPage.razor layout Uses @layout EmptyLayout; supports Head render fragment for <HeadContent>
WebFormsPage ✅ Easy Wrap page body in <WebFormsPage> Provides cascading values; renders <PageTitle> and <HeadContent> from IPageService
Page ✅ Easy Add <Page /> to layout Renders page title and meta tags from IPageService
NamingContainer ✅ Easy Wrap controls that need naming scope ClientID prefixing with UseCtl00Prefix option for full Web Forms compat
EmptyLayout ✅ Trivial Used internally by MasterPage Minimal @Body-only layout

Master Page Migration Pattern

@* MasterPage becomes a Blazor layout *@
@inherits LayoutComponentBase
@layout MasterPage

<ContentPlaceHolder ID="MainContent">
    @Body
</ContentPlaceHolder>

Field Column Components (4 components)

Used inside GridView, DetailsView, and DataGrid for column definitions.

Control BWFC? Complexity Key Changes Gotchas
BoundField ✅ Easy Remove asp:, runat DataField, HeaderText, DataFormatString preserved
ButtonField ✅ Easy Remove asp:, runat CommandName, ButtonType preserved
HyperLinkField ✅ Easy Remove asp:, runat DataNavigateUrlFields, DataTextField preserved
TemplateField ✅ Medium Remove asp:, runat HeaderTemplate, ItemTemplate, EditItemTemplate all supported

Style Sub-Components (66 components)

BWFC provides declarative style sub-components matching Web Forms' pattern for applying styles to control sub-elements. Use these as child elements inside their parent control.

Pattern

<GridView TItem="Product" Items="products">
    <HeaderStyle CssClass="grid-header" BackColor="#336699" ForeColor="White" />
    <RowStyle CssClass="grid-row" />
    <AlternatingRowStyle BackColor="#F7F7F7" />
</GridView>

Style Components by Parent Control

Parent Style Sub-Components
Calendar (9) CalendarDayHeaderStyle, CalendarDayStyle, CalendarNextPrevStyle, CalendarOtherMonthDayStyle, CalendarSelectedDayStyle, CalendarSelectorStyle, CalendarTitleStyle, CalendarTodayDayStyle, CalendarWeekendDayStyle
DataGrid (7) DataGridAlternatingItemStyle, DataGridEditItemStyle, DataGridFooterStyle, DataGridHeaderStyle, DataGridItemStyle, DataGridPagerStyle, DataGridSelectedItemStyle
DetailsView (10) DetailsViewAlternatingRowStyle, DetailsViewCommandRowStyle, DetailsViewEditRowStyle, DetailsViewEmptyDataRowStyle, DetailsViewFieldHeaderStyle, DetailsViewFooterStyle, DetailsViewHeaderStyle, DetailsViewInsertRowStyle, DetailsViewPagerStyle, DetailsViewRowStyle
FormView (7) FormViewEditRowStyle, FormViewEmptyDataRowStyle, FormViewFooterStyle, FormViewHeaderStyle, FormViewInsertRowStyle, FormViewPagerStyle, FormViewRowStyle
GridView (8) GridViewAlternatingRowStyle, GridViewEditRowStyle, GridViewEmptyDataRowStyle, GridViewFooterStyle, GridViewHeaderStyle, GridViewPagerStyle, GridViewRowStyle, GridViewSelectedRowStyle
TreeView (6) TreeViewHoverNodeStyle, TreeViewLeafNodeStyle, TreeViewNodeStyle, TreeViewParentNodeStyle, TreeViewRootNodeStyle, TreeViewSelectedNodeStyle
Login Controls (10) CheckBoxStyle, FailureTextStyle, HyperLinkStyle, InstructionTextStyle, LabelStyle, LoginButtonStyle, SuccessTextStyle, TextBoxStyle, TitleTextStyle, ValidatorTextStyle
Shared (6) AlternatingItemStyle, FooterStyle, HeaderStyle, ItemStyle, MenuItemStyle, SeparatorStyle
PagerSettings (3) DetailsViewPagerSettings, FormViewPagerSettings, GridViewPagerSettings

Utilities & Infrastructure (not Razor components)

These C# classes, base classes, and services support the component library. Migration developers should be aware of them.

Setup Requirements

// Program.cs — REQUIRED for BWFC services
builder.Services.AddBlazorWebFormsComponents();
@* _Imports.razor — RECOMMENDED for converted pages *@
@inherits WebFormsPageBase

Key Classes

Class Purpose
WebFormsPageBase Base class for converted pages — provides Page.Title, IsPostBack, Request, Response, Server, Session, Cache, ViewState, ClientScript, PostBack event, ResolveUrl(), GetRouteUrl()
ServiceCollectionExtensions AddBlazorWebFormsComponents() — registers all BWFC services (SessionShim, CacheShim, ServerShim, ClientScriptShim, ScriptManagerShim, IPageService, JS interop)
BaseWebFormsComponent Root base class — ID, ClientID, Visible, ViewState, lifecycle events (OnInit, OnLoad, OnPreRender, OnUnload), FindControl, theming, CaptureUnmatchedValues
BaseStyledComponent Adds CssClass, BackColor, ForeColor, BorderColor, BorderStyle, Font, Width, Height, ToolTip
DataBinder [Obsolete] Transitional DataBinder.Eval() support — use direct property access instead
ThemeProvider Cascades ThemeConfiguration to child components for Web Forms Themes/Skins emulation
ThemeConfiguration Registers ControlSkin entries by control type + SkinID

Helper Components

Component Purpose
BlazorWebFormsScripts Auto-loads BWFC JavaScript module via dynamic import
BlazorWebFormsHead Adds BWFC script tag to <head> via HeadContent
Eval Data-binding helper for DataBinder.Eval() expressions
WebFormsForm Interactive form component — captures form data via JS interop and feeds FormShim

Infrastructure & Shim Components

BWFC provides a comprehensive shim layer that enables Web Forms API calls to compile and function in Blazor without code changes. All shims are auto-registered by AddBlazorWebFormsComponents() and auto-wired on WebFormsPageBase.

Component Web Forms API Preserved How It Works
WebFormsPageBase Page.Title, Page.MetaDescription, Page.MetaKeywords, IsPostBack Base class for all pages via @inherits in _Imports.razor
ResponseShim Response.Redirect("~/path") Auto-strips ~/ prefix and .aspx extension; uses NavigationManager internally
RequestShim Request.Url, Request.QueryString["key"], Request.Cookies Reads current URL and query parameters from NavigationManager
FormShim Request.Form["key"], Request.Form.AllKeys, Request.Form.Count Dual-mode SSR+Interactive; requires <WebFormsForm> wrapper
SessionShim Session["key"], Session.Clear(), Session.Remove() Scoped in-memory dictionary — per-circuit lifetime
CacheShim Cache["key"], Cache.Insert(), Cache.Remove() Singleton in-memory cache
ServerShim Server.MapPath("~/path"), Server.HtmlEncode(), Server.UrlEncode() Maps virtual paths; delegates encoding to WebUtility
ClientScriptShim Page.ClientScript.RegisterStartupScript(), RegisterClientScriptBlock() Registers scripts via JS interop
ScriptManagerShim ScriptManager.GetCurrent(Page), RegisterStartupScript() Compatibility shim for ScriptManager API
ViewStateDictionary ViewState["key"] dictionary access In-memory dictionary (not serialized to page)
PostBack support __doPostBack(), IPostBackEventHandler, PostBackEventArgs PostBack event support with JS interop
ConfigurationManager ConfigurationManager.AppSettings["key"], ConnectionStrings["name"] Bridges to ASP.NET Core IConfiguration; call app.UseConfigurationManagerShim()
BundleConfig BundleTable.Bundles.Add(), ScriptBundle, StyleBundle No-op compile shim — compiles but does nothing
RouteConfig RouteTable.Routes.MapPageRoute(), Routes.Ignore() No-op compile shim — compiles but does nothing
WebFormsForm <form> POST data capture Blazor component — wraps forms to feed FormShim

Key insight: With AddBlazorWebFormsComponents() + @inherits WebFormsPageBase, code-behind files using Response.Redirect, Session, Request, IsPostBack, Page.Title, Cache, Server.MapPath, or ClientScript compile and run without modification. This shifts ~20% of previously-manual Layer 2 work into automatic Layer 1 coverage.

Migration Shims (14)

These drop-in shims allow Web Forms API calls to compile and function in Blazor. On WebFormsPageBase, most are auto-wired — no code changes needed.

Shim Web Forms API Usage on WebFormsPageBase
RequestShim Request.Cookies, Request.Form, Request.QueryString, Request.Url Request.* — auto-wired
FormShim Request.Form["key"], Request.Form.AllKeys, Request.Form.Count Request.Form["key"] — auto-wired via RequestShim
ResponseShim Response.Redirect(), Response.Cookies Response.Redirect() — auto-wired
SessionShim Session["key"], Session.Clear(), Session.Remove() Session["key"] — auto-wired
CacheShim Cache["key"], Cache.Insert(), Cache.Remove() Cache["key"] — auto-wired
ServerShim Server.MapPath(), Server.HtmlEncode(), Server.UrlEncode() Server.MapPath() — auto-wired
ClientScriptShim Page.ClientScript.RegisterStartupScript(), RegisterClientScriptBlock(), RegisterClientScriptInclude(), GetPostBackEventReference() ClientScript.* — auto-wired
ScriptManagerShim ScriptManager.GetCurrent(Page), ScriptManager.RegisterStartupScript() Via ScriptManager.GetCurrent(this)
ConfigurationManager ConfigurationManager.AppSettings["key"], ConfigurationManager.ConnectionStrings["name"] Call app.UseConfigurationManagerShim() in Program.cs
ViewStateDictionary ViewState["key"] dictionary-style access ViewState["key"] — auto-wired
PostBack support __doPostBack(), IPostBackEventHandler, PostBackEventArgs PostBack event — auto-wired with JS interop
BundleConfig BundleTable.Bundles.Add(), ScriptBundle, StyleBundle No-op shim — compiles but does nothing
RouteConfig RouteTable.Routes.MapPageRoute(), RouteTable.Routes.Ignore() No-op shim — compiles but does nothing
FormSubmitEventArgs N/A (new for Blazor) Used with <WebFormsForm OnSubmit="SetRequestFormData">

Custom Control Shims

These exist so Web Forms code-behind that references these types can compile:

Shim Purpose
WebControl Minimal compatibility shim for System.Web.UI.WebControls.WebControl
HtmlTextWriter Minimal compatibility shim for System.Web.UI.HtmlTextWriter
CompositeControl Minimal compatibility shim for System.Web.UI.WebControls.CompositeControl

Enums (54)

All Web Forms enums are faithfully reproduced in Enums/. Key examples: CalendarSelectionMode, TextBoxMode, GridLines, RepeatDirection, ValidationCompareOperator, FormViewMode, DetailsViewMode, ListViewItemType, ButtonType, BorderStyle, HorizontalAlign, VerticalAlign.

Controls NOT Supported by BWFC

These Web Forms controls have no BWFC equivalent. Each requires a different migration approach:

DataSource Controls — Replace with Service Injection

Control Migration Approach
SqlDataSource Replace with an injected service using EF Core or Dapper
ObjectDataSource Replace with an injected service calling your business layer
EntityDataSource Replace with an injected DbContext via DI
LinqDataSource Replace with LINQ queries in an injected service
SiteMapDataSource Build navigation data programmatically or from config
XmlDataSource Load XML in a service; bind to component properties

Pattern:

// Instead of <asp:SqlDataSource SelectCommand="SELECT * FROM Products">
// Inject a service:
@inject IProductService ProductService

@code {
    private List<Product> products = new();

    protected override async Task OnInitializedAsync()
    {
        products = await ProductService.GetProductsAsync();
    }
}

Other Unsupported Controls

Control Migration Approach
Wizard Implement as a multi-step Blazor component with state tracking
DynamicData controls Redesign — Blazor has no DynamicData equivalent
Web Parts (WebPartManager, WebPartZone, etc.) Redesign as Blazor components with drag-and-drop libraries
AJAX Control Toolkit extenders Find Blazor-native replacements (e.g., Radzen, MudBlazor) or build custom components
ContentPlaceHolder Supported — BWFC provides <ContentPlaceHolder>, <Content>, and <MasterPage> components. See Infrastructure Controls.

Coverage by Category — Visual Summary

Editor Controls (28)          ████████████████████████████████████████ 100% covered
Data Controls (8)             ████████████████████████████████████████ 100% covered
Validation Controls (7)       ████████████████████████████████████████ 100% covered
Navigation Controls (3)       ████████████████████████████████████████ 100% covered
Login Controls (7)            ████████████████████████████████████████ 100% covered
AJAX Controls (5)             ████████████████████████████████████████ 100% covered
Infrastructure Controls (7)   ████████████████████████████████████████ 100% covered
Field Column Components (4)   ████████████████████████████████████████ 100% covered
Style Sub-Components (66)     ████████████████████████████████████████ 100% covered
Utilities & Infrastructure    ████████████████████████████████████████ Shipped
DataSource Controls (6)       ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░   0% (by design)

DataSource controls are deliberately not covered. They represent a Web Forms-specific pattern (declarative data access in markup) that has no place in Blazor's service-injection architecture.

Cross-References