ControlDesigner.CreatePlaceHolderDesignTimeHtml Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides a simple rectangular placeholder representation that displays the type and ID of the control.
Overloads
| CreatePlaceHolderDesignTimeHtml() |
Provides a simple rectangular placeholder representation that displays the type and ID of the control. |
| CreatePlaceHolderDesignTimeHtml(String) |
Provides a simple rectangular placeholder representation that displays the type and ID of the control, and also additional specified instructions or information. |
CreatePlaceHolderDesignTimeHtml()
Provides a simple rectangular placeholder representation that displays the type and ID of the control.
protected:
System::String ^ CreatePlaceHolderDesignTimeHtml();protected string CreatePlaceHolderDesignTimeHtml ();member this.CreatePlaceHolderDesignTimeHtml : unit -> stringProtected Function CreatePlaceHolderDesignTimeHtml () As StringReturns
A string that contains design-time HTML markup providing basic 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(Exception) 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.
See also
Applies to
CreatePlaceHolderDesignTimeHtml(String)
Provides a simple rectangular placeholder representation that displays the type and ID of the control, and also additional specified instructions or information.
protected:
System::String ^ CreatePlaceHolderDesignTimeHtml(System::String ^ instruction);protected string CreatePlaceHolderDesignTimeHtml (string instruction);member this.CreatePlaceHolderDesignTimeHtml : string -> stringProtected Function CreatePlaceHolderDesignTimeHtml (instruction As String) As StringParameters
- instruction
- String
A string that contains text and markup to add to the HTML output.
Returns
A string that contains design-time HTML markup providing information about 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 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.");
}
' 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
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(Exception) 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.
