CheckBoxDesigner.GetDesignTimeHtml Method

Reference

Definition

Namespace:: System.Web.UI.Design.WebControls

Assembly:: System.Design.dll

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.

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

public:
 override System::String ^ GetDesignTimeHtml();

public override string GetDesignTimeHtml ();

override this.GetDesignTimeHtml : unit -> string

Public Overrides Function GetDesignTimeHtml () As String

Returns

String

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

Examples

The following code example overrides the GetDesignTimeHtml method. If the CheckBox.Text property has not been set previously, a call to this method sets it to a string and displays that string on the design surface. If the Text property has already been set, the existing property value is displayed.

' Override the GetDesignTimeHtml method to display a border on the 
' control if the BorderStyle property has not been set by the user.
Public Overrides Function GetDesignTimeHtml() As String

    Dim sampleCheckBox As SampleCheckBox = CType(Component, _
        SampleCheckBox)
    Dim designTimeHtml As String = Nothing

    ' Check the control's BorderStyle property.
    If (sampleCheckBox.BorderStyle = BorderStyle.NotSet) Then

        ' Save the current value of the BorderStyle property.
        Dim oldBorderStyle As BorderStyle = _
            sampleCheckBox.BorderStyle

        ' Change the value of the BorderStyle property and 
        ' generate the design-time HTML.
        Try
            sampleCheckBox.BorderStyle = BorderStyle.Groove
            designTimeHtml = MyBase.GetDesignTimeHtml()

            ' If an exception occurs, call the GetErrorDesignTimeHtml
            ' method.
        Catch ex As Exception
            designTimeHtml = GetErrorDesignTimeHtml(ex)

            ' Restore the BorderStyle property to its original value.
        Finally
            sampleCheckBox.BorderStyle = oldBorderStyle
        End Try

    Else
        designTimeHtml = MyBase.GetDesignTimeHtml()
    End If

    Return designTimeHtml
End Function

Remarks

If the Text property is empty or consists only of white space, then the generated HTML contains the ID of the check box control; otherwise, the generated HTML contains the contents of the control's Text property.

Override this method to change the generated HTML.

Applies to

Поділитися через