HyperLinkDesigner.GetDesignTimeHtml Метод

Определение

Пространство имен:

System.Web.UI.Design.WebControls

Сборка:

System.Design.dll

Получает разметку, используемую для отрисовки связанного элемента управления во время разработки.

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

public override string GetDesignTimeHtml ();

override this.GetDesignTimeHtml : unit -> string

Public Overrides Function GetDesignTimeHtml () As String

Возвращаемое значение

String

Строка, содержащая разметку, используемую для отрисовки связанной гиперссылки во время разработки.

Примеры

В следующем примере кода показано, как наследовать CustomHyperLinkDesigner класс из HyperLinkDesigner класса. Он переопределяет GetDesignTimeHtml метод, чтобы указать значение по умолчанию для Text свойства, если исходное значение для Text является пустой строкой (""). Это гарантирует, что связанный элемент управления будет отображаться во время разработки.

Этот пример кода является частью более крупного примера, предоставленного HyperLinkDesigner для класса.

// 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

Комментарии

Метод GetDesignTimeHtml создает разметку времени разработки для связанного HyperLink элемента управления. Метод сначала сохраняет локальные копии TextNavigateUrlсвойств и ImageUrl свойств, а также дочернюю коллекциюControls. Он предоставляет значения по умолчанию для этих свойств, если исходные значения являются null пустыми. Затем GetDesignTimeHtml метод вызывает базовый GetDesignTimeHtml метод для создания разметки и восстанавливает свойства и коллекцию дочерних элементов управления в исходные значения при необходимости.

См. также раздел

• HyperLink
• GetDesignTimeHtml()
• ControlDesigner