This documentation is archived and is not being maintained.

LoginViewDesigner.GetEmptyDesignTimeHtml Method

Gets the markup that renders a placeholder for the associated control at design time when the current template is not defined.

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

protected override string GetEmptyDesignTimeHtml()

Return Value

Type: System.String
A string containing markup text that renders to a placeholder on the design surface.

The GetEmptyDesignTimeHtml method first formats a string message that specifies the name of the current template of the associated LoginView control and also specifies that the template is empty. Then the GetEmptyDesignTimeHtml generates the markup for a placeholder containing that message.

The following code example shows how to override the GetEmptyDesignTimeHtml 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 generates the markup for a placeholder that includes the names of all the RoleGroup objects that are defined for the associated control.

// Generate the design-time markup for the control  
// when the template is empty. 
protected override string GetEmptyDesignTimeHtml()
{
    // Generate a design-time placeholder containing the names of all 
    // the role groups.
    MyLoginView myLoginViewCtl = (MyLoginView)ViewControl;
    RoleGroupCollection roleGroups = myLoginViewCtl.RoleGroups;
    string roleNames = null;

    // If there are any role groups, form a string of their names. 
    if (roleGroups.Count > 0)
    {
        roleNames = "Role Groups: <br /> &nbsp;&nbsp;" + 
            roleGroups[0].ToString();

        for( int rgX = 1; rgX < roleGroups.Count; rgX++ )
            roleNames += 
                "<br /> &nbsp;&nbsp;" + roleGroups[rgX].ToString();
    }
    return CreatePlaceHolderDesignTimeHtml( roleNames);
} // GetEmptyDesignTimeHtml

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: