ControlDesignerCreatePlaceHolderDesignTimeHtml Method
 

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)

Syntax
protected string CreatePlaceHolderDesignTimeHtml(
	string instruction
)
protected:
String^ CreatePlaceHolderDesignTimeHtml(
	String^ instruction
)
member CreatePlaceHolderDesignTimeHtml : 
        instruction:string -> string
Protected Function CreatePlaceHolderDesignTimeHtml (
	instruction As String
) As String

Parameters

instruction
Type:

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

Return Value

Type:

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.

Examples

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 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.");
}
' Add instructions to the placeholder view of the control
Public Overloads Overrides Function GetDesignTimeHtml() As String
    Return CreatePlaceHolderDesignTimeHtml("Click here and use " & _
        "the task menu to edit the templates.")
End Function
Version Information
.NET Framework
Available since 1.1
Return to top