HyperLinkDesigner.GetDesignTimeHtml Método

Definição

Namespace:

System.Web.UI.Design.WebControls

Assembly:

System.Design.dll

Obtém a marcação usada para renderizar o controle associado em tempo de design.

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

public override string GetDesignTimeHtml();

override this.GetDesignTimeHtml : unit -> string

Public Overrides Function GetDesignTimeHtml () As String

Retornos

String

Uma cadeia de caracteres que contém a marcação usada para renderizar o controle de hiperlink associado em tempo de design.

Exemplos

O exemplo de código a seguir mostra como derivar a CustomHyperLinkDesigner classe da HyperLinkDesigner classe. Ele substitui o GetDesignTimeHtml método para fornecer um valor padrão para a Text propriedade se o valor Text original for uma cadeia de caracteres vazia (""). Isso garante que o controle associado fique visível no momento do design.

Este exemplo de código faz parte de um exemplo maior fornecido para a HyperLinkDesigner classe.

// Derive the CustomHyperLinkDesigner from the HyperLinkDesigner.
public class CustomHyperLinkDesigner : HyperLinkDesigner
{
    // Override the GetDesignTimeHtml to set the CustomHyperLink Text 
    // property so that it displays at design time.
    public override string GetDesignTimeHtml()
    {
        CustomHyperLink hype = (CustomHyperLink)Component;
        string designTimeMarkup = null;

        // Save the original Text and note if it is empty.
        string text = hype.Text;
        bool noText = (text.Trim().Length == 0);

        try
        {
            // If the Text is empty, supply a default value.
            if (noText)
                hype.Text = "Click here.";

            // Call the base method to generate the markup.
            designTimeMarkup = base.GetDesignTimeHtml();
        }
        catch (Exception ex)
        {
            // If an error occurs, generate the markup for an error message.
            designTimeMarkup = GetErrorDesignTimeHtml(ex);
        }
        finally
        {
            // Restore the original value of the Text, if necessary.
            if (noText)
                hype.Text = text;
        }

        // If the markup is empty, generate the markup for a placeholder.
        if(designTimeMarkup == null || designTimeMarkup.Length == 0)
            designTimeMarkup = GetEmptyDesignTimeHtml();

        return designTimeMarkup;
    } // GetDesignTimeHtml
} // CustomHyperLinkDesigner

' Derive the CustomHyperLinkDesigner from the HyperLinkDesigner.
Public Class CustomHyperLinkDesigner
    Inherits HyperLinkDesigner

    ' Override the GetDesignTimeHtml to set the CustomHyperLink Text
    ' property so that it displays at design time.
    Public Overrides Function GetDesignTimeHtml() As String

        Dim hype As CustomHyperLink = CType(Component, CustomHyperLink)
        Dim designTimeMarkup As String = Nothing

        ' Save the original Text and note if it is empty.
        Dim text As String = hype.Text
        Dim noText As Boolean = (text.Trim().Length = 0)

        Try
            ' If the Text is empty, supply a default value.
            If noText Then
                hype.Text = "Click here."
            End If

            ' Call the base method to generate the markup.
            designTimeMarkup = MyBase.GetDesignTimeHtml()

        Catch ex As Exception
            ' If an error occurs, generate the markup for an error message.
            designTimeMarkup = GetErrorDesignTimeHtml(ex)

        Finally
            ' Restore the original value of the Text, if necessary.
            If noText Then
                hype.Text = text
            End If
        End Try

        ' If the markup is empty, generate the markup for a placeholder.
        If ((designTimeMarkup = Nothing) Or _
            (designTimeMarkup.Length = 0)) Then
            designTimeMarkup = GetEmptyDesignTimeHtml()
        End If

        Return designTimeMarkup

    End Function ' GetDesignTimeHtml
End Class

Comentários

O GetDesignTimeHtml método gera a marcação de tempo de design para o controle associado HyperLink . Primeiro, o método salva cópias locais do Text, NavigateUrle ImageUrl das propriedades, bem como da Controls coleção filho. Ele fornece valores padrão para essas propriedades se os valores originais estiverem ou estiverem null em branco. Em GetDesignTimeHtml seguida, o método chama o GetDesignTimeHtml método base para gerar a marcação e restaura as propriedades e a coleção de controle filho para seus valores originais, se necessário.

Confira também

• HyperLink
• GetDesignTimeHtml()
• ControlDesigner