GetDesignTimeHtml Method (DesignerRegionCollection)
Collapse the table of content
Expand the table of content

LoginViewDesigner.GetDesignTimeHtml Method (DesignerRegionCollection)


Gets the markup that is used to render the associated control at design time and populates a collection of designer regions.

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

public override string GetDesignTimeHtml(
	DesignerRegionCollection regions


Type: System.Web.UI.Design.DesignerRegionCollection

A DesignerRegionCollection to which definitions of the selectable and clickable regions in the design-time view of the LoginView are added.

Return Value

Type: System.String

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

The GetDesignTimeHtml method creates an EditableDesignerRegion object for a template editing area on the visual designer surface, and then initializes it as a template. If no templates are defined, a string is displayed that prompts you to click to begin editing. A predefined constant is used to generate the returned markup.

Notes to Inheritors:

This GetDesignTimeHtml overload does not call on its base method or the LoginView 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
© 2015 Microsoft