HtmlTextWriter.EnterStyle Method

Definition

Writes the opening tag of a markup element that contains attributes that implement the layout and character formatting of the specified style.

Overloads

EnterStyle(Style)

Writes the opening tag of a <span> element that contains attributes that implement the layout and character formatting of the specified style.

EnterStyle(Style, HtmlTextWriterTag)

Writes the opening tag of a markup element that contains attributes that implement the layout and character formatting of the specified style.

EnterStyle(Style)

Writes the opening tag of a <span> element that contains attributes that implement the layout and character formatting of the specified style.

public:
 virtual void EnterStyle(System::Web::UI::WebControls::Style ^ style);
public virtual void EnterStyle (System.Web.UI.WebControls.Style style);
abstract member EnterStyle : System.Web.UI.WebControls.Style -> unit
override this.EnterStyle : System.Web.UI.WebControls.Style -> unit
Public Overridable Sub EnterStyle (style As Style)

Parameters

style
Style

A Style that specifies the layout and formatting to begin applying to the block of markup.

Examples

The following code example demonstrates how to use a custom class named TextSample, derived from the WebControl class, that uses the EnterStyle method to apply a ForeColor style to a string of text.

The EnterStyle method renders the HTML <span style="color:Navy;">. The ExitStyle method call closes the <span> element after the text has been rendered.

Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Security.Permissions
Imports System.Drawing

' Create a custom class, named TextSample, that renders
' its Text property with styles applied by the
' EnterStyle and ExitStyle methods. 
Namespace AspNet.Samples

    <AspNetHostingPermission(SecurityAction.Demand, _
        Level:=AspNetHostingPermissionLevel.Minimal)> _
    <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
        Level:=AspNetHostingPermissionLevel.Minimal)> _
    Public Class TextSample
        Inherits Control

        ' Create an instance of the Style class.
        Private textStyle As Style = New Style()
        Private textMessage As String

        ' Create a Text property.
        Public Property Text() As String
            Get
                Return textMessage
            End Get
            Set(ByVal value As String)
                textMessage = value
            End Set
        End Property


        Protected Overrides Sub Render(ByVal writer As HtmlTextWriter)
            ' Set the value of the Text property.
            textMessage = "Hello, World!"

            ' Set the Style object's ForeColor
            ' property to Navy.
            textStyle.ForeColor = Color.Navy

            ' Render the Text property with the style.
            writer.WriteLine("The text property styled: ")
            writer.EnterStyle(textStyle)
            writer.Write(Text)
            writer.ExitStyle(textStyle)

            ' Use the WriteBreak method twice to render
            ' an empty line between the lines of rendered text.
            writer.WriteBreak()
            writer.WriteBreak()

            ' Render the Text property without the style.
            writer.WriteLine("The Text property unstyled: ")
            writer.Write(Text)
        End Sub
    End Class
End Namespace

Remarks

Use the EnterStyle method to apply styles, such as background color or border width, to a block of markup.

The EnterStyle and ExitStyle methods allow a device adapter or control to create markup that uses the character formatting of the specified style. Use the same value for style in the EnterStyle method that you use in the corresponding ExitStyle method.

The EnterStyle overload of the EnterStyle(Style) method renders the opening tag of a <span> element. This method then adds the necessary attributes and style attributes to the opening tag of the <span> element to display the settings specified by the Style object. If you want to render a different markup element to contain the attributes and style attributes, use the EnterStyle(Style, HtmlTextWriterTag) overload.

See also

Applies to

EnterStyle(Style, HtmlTextWriterTag)

Writes the opening tag of a markup element that contains attributes that implement the layout and character formatting of the specified style.

public:
 virtual void EnterStyle(System::Web::UI::WebControls::Style ^ style, System::Web::UI::HtmlTextWriterTag tag);
public virtual void EnterStyle (System.Web.UI.WebControls.Style style, System.Web.UI.HtmlTextWriterTag tag);
abstract member EnterStyle : System.Web.UI.WebControls.Style * System.Web.UI.HtmlTextWriterTag -> unit
override this.EnterStyle : System.Web.UI.WebControls.Style * System.Web.UI.HtmlTextWriterTag -> unit
Public Overridable Sub EnterStyle (style As Style, tag As HtmlTextWriterTag)

Parameters

style
Style

A Style that specifies the layout and formatting to begin applying to the block of markup.

tag
HtmlTextWriterTag

An HtmlTextWriterTag that specifies the opening tag of the markup element that will contain the style object specified in style.

Examples

The following code example demonstrates how to use a custom class named TextSample, derived from the WebControl class, that uses the EnterStyle method to apply a ForeColor style to a string of text.

The EnterStyle method renders the HTML <span style="color:Navy;">. The ExitStyle method call closes the <span> element after the text has been rendered.

Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Security.Permissions
Imports System.Drawing

' Create a custom class, named TextSample, that renders
' its Text property with styles applied by the
' EnterStyle and ExitStyle methods. 
Namespace AspNet.Samples

    <AspNetHostingPermission(SecurityAction.Demand, _
        Level:=AspNetHostingPermissionLevel.Minimal)> _
    <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
        Level:=AspNetHostingPermissionLevel.Minimal)> _
    Public Class TextSample
        Inherits Control

        ' Create an instance of the Style class.
        Private textStyle As Style = New Style()
        Private textMessage As String

        ' Create a Text property.
        Public Property Text() As String
            Get
                Return textMessage
            End Get
            Set(ByVal value As String)
                textMessage = value
            End Set
        End Property


        Protected Overrides Sub Render(ByVal writer As HtmlTextWriter)
            ' Set the value of the Text property.
            textMessage = "Hello, World!"

            ' Set the Style object's ForeColor
            ' property to Navy.
            textStyle.ForeColor = Color.Navy

            ' Render the Text property with the style.
            writer.WriteLine("The text property styled: ")
            writer.EnterStyle(textStyle)
            writer.Write(Text)
            writer.ExitStyle(textStyle)

            ' Use the WriteBreak method twice to render
            ' an empty line between the lines of rendered text.
            writer.WriteBreak()
            writer.WriteBreak()

            ' Render the Text property without the style.
            writer.WriteLine("The Text property unstyled: ")
            writer.Write(Text)
        End Sub
    End Class
End Namespace

Remarks

Use the EnterStyle method to apply styles, such as background color or border width, to a block of markup.

The EnterStyle and ExitStyle methods allow a device adapter or control to create markup that uses the character formatting of the specified style. Use the same value for style in the EnterStyle method that you use in the corresponding ExitStyle method.

The EnterStyle overload of the EnterStyle(Style, HtmlTextWriterTag) method renders the opening tag of the element specified by the tag parameter. The EnterStyle(Style, HtmlTextWriterTag) method then adds the necessary attributes and style attributes to the opening tag of the element to display the settings that are specified by the Style object. Use the EnterStyle(Style) overload to render the opening tag of a <span> element.

See also

Applies to