Export (0) Print
Expand All

ControlDesigner.CreatePlaceHolderDesignTimeHtml Method (String)

Provides a simple rectangular placeholder representation that displays the type and ID of the control, and also additional specified instructions or information.

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

protected string CreatePlaceHolderDesignTimeHtml(
	string instruction
)

Parameters

instruction
Type: System.String

A string that contains text and markup to add to the HTML output.

Return Value

Type: System.String
A string that contains design-time HTML markup providing information about the control.

Notes to Inheritors

The typical design pattern is to try to get HTML markup through the associated control, and then if an error is encountered, call the GetErrorDesignTimeHtml method. If no markup is returned by the control, call the GetEmptyDesignTimeHtml method, which if it is not overridden to provide specific markup, calls the CreatePlaceHolderDesignTimeHtml method, which should contain information about the type and ID of the control.

The following code example demonstrates how to override the GetDesignTimeHtml method in a templated control designer. A string is then passed as the instruction parameter in a call to the CreatePlaceHolderDesignTimeHtml method, which provides the design-time HTML markup.

This code example is part of a larger example provided for the TemplateGroups property.

// Add instructions to the placeholder view of the control 
public override string GetDesignTimeHtml()
{
    return CreatePlaceHolderDesignTimeHtml("Click here and use " +
        "the task menu to edit the templates.");
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft