LoginViewDesigner.GetEmptyDesignTimeHtml Method ()

 
System_CAPS_noteNote

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 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

.NET Framework
Available since 2.0
Return to top
Show: