GetDesignTimeHtml Method
Collapse the table of content
Expand the table of content

ControlDesigner.GetDesignTimeHtml Method ()

 

Retrieves the HTML markup that is used to represent the control at design time.

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

public virtual string GetDesignTimeHtml()

Return Value

Type: System.String

The HTML markup used to represent the control at design time.

Notes to Inheritors:

If you are creating a custom container control, make sure that you render the control and all child controls at design time, regardless of whether the Visible property is set to true or false.

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