GetEmptyDesignTimeHtml Method

ControlDesigner.GetEmptyDesignTimeHtml Method ()

 

Retrieves the HTML markup to represent a Web server control at design time that will have no visual representation at run time.

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

protected virtual string GetEmptyDesignTimeHtml()

Return Value

Type: System.String

The HTML markup used to represent a control at design time that would otherwise have no visual representation. The default is a rectangle that contains the type and ID of the component.

The default behavior of the GetEmptyDesignTimeHtml method is to return a string that contains the name of the component. The GetEmptyDesignTimeHtml method should be called in the implementation of the GetDesignTimeHtml method when there is no design-time HTML markup.

The following code example demonstrates how to override the GetDesignTimeHtml method in a custom control designer. If the Text property for the associated control is empty, the GetDesignTimeHtml method calls GetEmptyDesignTimeHtml method. Otherwise, the GetDesignTimeHtml method creates and renders a Hyperlink control.

public override string GetDesignTimeHtml()
{
    if (simpleControl.Text.Length > 0)
    {
        string spec = "<a href='{0}.aspx'>{0}</a>";
        return String.Format(spec, simpleControl.Text);
    }
    else
        return GetEmptyDesignTimeHtml();
}

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft