LoginDesigner.GetDesignTimeHtml(DesignerRegionCollection) Método

Definição

Namespace:

System.Web.UI.Design.WebControls

Assembly:

System.Design.dll

Obtém a marcação que é usada para renderizar o controle associado em tempo de design e preenche uma coleção de regiões de designer.

public:
 override System::String ^ GetDesignTimeHtml(System::Web::UI::Design::DesignerRegionCollection ^ regions);

public override string GetDesignTimeHtml (System.Web.UI.Design.DesignerRegionCollection regions);

override this.GetDesignTimeHtml : System.Web.UI.Design.DesignerRegionCollection -> string

Public Overrides Function GetDesignTimeHtml (regions As DesignerRegionCollection) As String

Parâmetros

regions

DesignerRegionCollection

Um DesignerRegionCollection ao qual as definições das regiões selecionáveis e clicáveis na exibição de tempo de design do controle são adicionadas.

Retornos

String

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

Exemplos

O exemplo de código a seguir mostra como substituir o GetDesignTimeHtml método em uma classe herdada da LoginDesigner classe para alterar a aparência de um controle derivado do Login controle em tempo de design. O exemplo desenha uma borda azul tracejada ao redor do controle para tornar sua extensão mais visível, se a BorderStyle propriedade do controle for o NotSet valor ou None .

// Generate the design-time markup.
public override string GetDesignTimeHtml()
{
    // Make the control more visible in the designer.  If the border 
    // style is None or NotSet, change the border to a blue dashed line. 
    MyLogin myLoginCtl = (MyLogin)ViewControl;
    string markup = null;

    // Check if the border style should be changed.
    if (myLoginCtl.BorderStyle == BorderStyle.NotSet ||
        myLoginCtl.BorderStyle == BorderStyle.None)
    {
        BorderStyle oldBorderStyle = myLoginCtl.BorderStyle;
        Color oldBorderColor = myLoginCtl.BorderColor;

        // Set the design time properties and catch any exceptions.
        try
        {
            myLoginCtl.BorderStyle = BorderStyle.Dashed;
            myLoginCtl.BorderColor = Color.Blue;

            // Call the base method to generate the markup.
            markup = base.GetDesignTimeHtml();
        }
        catch (Exception ex)
        {
            markup = GetErrorDesignTimeHtml(ex);
        }
        finally
        {
            // It is not necessary to restore the border properties 
            // to their original values because the ViewControl 
            // was used to reference the associated control and the 
            // UsePreviewControl was not overridden.  

            // myLoginCtl.BorderStyle = oldBorderStyle;
            // myLoginCtl.BorderColor = oldBorderColor;
        }
    }
    else
    {
        // Call the base method to generate the markup.
        markup = base.GetDesignTimeHtml();
    }

    return markup;
} // GetDesignTimeHtml

' Generate the design-time markup.
Public Overrides Function GetDesignTimeHtml() As String

    ' Make the control more visible in the designer.  If the border 
    ' style is None or NotSet, change the border to a blue dashed line. 
    Dim myLoginCtl As MyLogin = CType(ViewControl, MyLogin)
    Dim markup As String = Nothing

    ' Check if the border style should be changed.
    If (myLoginCtl.BorderStyle = BorderStyle.NotSet Or _
        myLoginCtl.BorderStyle = BorderStyle.None) Then

        Dim oldBorderStyle As BorderStyle = myLoginCtl.BorderStyle
        Dim oldBorderColor As Color = myLoginCtl.BorderColor

        ' Set the design time properties and catch any exceptions.
        Try
            myLoginCtl.BorderStyle = BorderStyle.Dashed
            myLoginCtl.BorderColor = Color.Blue

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

        Catch ex As Exception
            markup = GetErrorDesignTimeHtml(ex)

        Finally
            ' It is not necessary to restore the border properties 
            ' to their original values because the ViewControl 
            ' was used to reference the associated control and the 
            ' UsePreviewControl was not overridden.  

            ' myLoginCtl.BorderStyle = oldBorderStyle
            ' myLoginCtl.BorderColor = oldBorderColor
        End Try

    Else
        ' Call the base method to generate the markup.
        markup = MyBase.GetDesignTimeHtml()
    End If

    Return markup

End Function ' GetDesignTimeHtml

Comentários

O GetDesignTimeHtml método cria um EditableDesignerRegion objeto para a LayoutTemplate propriedade do controle associado Login e o adiciona ao DesignerRegionCollection objeto referenciado pelo regions parâmetro . O GetDesignTimeHtml método usa o GetDesignTimeHtml método base para gerar a marcação para a renderização de tempo de design do Login controle.

Notas aos Herdeiros

Se você substituir o GetDesignTimeHtml(DesignerRegionCollection) método, certifique-se de chamar o GetDesignTimeHtml() método base porque, eventualmente, por meio de vários níveis de substituição, chama no Login controle ou uma cópia do controle para gerar a marcação.

Confira também

• Login
• LayoutTemplate
• EditableDesignerRegion
• DesignerRegionCollection
• GetDesignTimeHtml()