LoginViewDesigner.GetDesignTimeHtml Method ()


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the markup that is used to render the associated control at design time.

Namespace:   System.Web.UI.Design.WebControls
Assembly:  System.Design (in System.Design.dll)

public override string GetDesignTimeHtml()

Return Value

Type: System.String

A string containing the markup used to render the LoginView at design time.

The GetDesignTimeHtml method sets the template index of the associated LoginView control to the current design-time index, and then causes the associated control to recreate and data bind its child controls, if necessary. Next, the GetDesignTimeHtml calls the GetDesignTimeHtml base method to generate the markup.

Notes to Inheritors:

If you override the GetDesignTimeHtml method, be sure to call the GetDesignTimeHtml base method because it eventually, through several override levels, calls on the LoginView control or a copy of the control to generate the markup.

The following code example shows how to override the GetDesignTimeHtml method in a class that is inherited from the LoginViewDesigner class to change the appearance of a control that is derived from the LoginView class at design time. The example draws an orange border around the control to make its extent more visible.

// Generate the design-time markup.
public override string GetDesignTimeHtml(DesignerRegionCollection regions)
    // Make the control more visible in the designer.   
    // Enclose the markup in a table with an orange border. 
    const string openTableMarkup =
        "<table><tr><td style=\"border:4 solid #FF7F00;\">";
    const string closeTableMarkup = "</td></tr></table>";

    // Call the base method to generate the markup.
    string markup = base.GetDesignTimeHtml(regions);

    return openTableMarkup + markup + closeTableMarkup;

} // GetDesignTimeHtml

.NET Framework
Available since 2.0
Return to top