Style.AddAttributesToRender Method (HtmlTextWriter, WebControl)
Adds HTML attributes and styles that need to be rendered to the specified System.Web.UI.HtmlTextWriter and Web server control. This method is primarily used by control developers.
Assembly: System.Web (in System.Web.dll)
Public Overridable Sub AddAttributesToRender ( writer As HtmlTextWriter, owner As WebControl )
Parameters
- writer
-
Type:
System.Web.UI.HtmlTextWriter
An System.Web.UI.HtmlTextWriter that represents the output stream to render HTML content on the client.
- owner
-
Type:
System.Web.UI.WebControls.WebControl
A WebControl or WebControl derived object that represents the Web server control associated with the Style.
To render attributes and styles for a Web server control on the client, you typically call the HtmlTextWriter.AddAttribute and HtmlTextWriter.AddStyleAttribute methods to insert each attribute and style individually to the System.Web.UI.HtmlTextWriter output stream. To simplify the process, this method encapsulates all calls to the HtmlTextWriter.AddAttribute and HtmlTextWriter.AddStyleAttribute methods for every attribute and style associated with the Web Server control. All attributes and styles are inserted into the System.Web.UI.HtmlTextWriter output stream in a single method call. This method is typically overridden by control developers in derived classes to insert the appropriate attributes and styles to the System.Web.UI.HtmlTextWriter output stream for the class.
The following example demonstrates how to create a class that derives from the WebControl class. The base implementation of the AddAttributesToRender method is overridden to add attributes appropriate to the derived class in the System.Web.UI.HtmlTextWriter output stream.
Imports System Imports System.Web.UI Imports System.Web.UI.WebControls Namespace ControlTest ' Renders the following HTML: ' <span onclick="alert('Hello');" style="color:Red;">Custom Contents</span> Public Class MyWebControl Inherits WebControl Public Sub New() MyBase.New(HtmlTextWriterTag.Span) End Sub 'New <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _ Protected Overrides Sub AddAttributesToRender(writer As HtmlTextWriter) writer.AddAttribute(HtmlTextWriterAttribute.Onclick, "alert('Hello');") writer.AddStyleAttribute(HtmlTextWriterStyle.Color, "Red") MyBase.AddAttributesToRender(writer) End Sub 'AddAttributesToRender <System.Security.Permissions.PermissionSetAttribute(System.Security.Permissions.SecurityAction.Demand, Name:="FullTrust")> _ Protected Overrides Sub RenderContents(writer As HtmlTextWriter) writer.Write("Custom Contents") MyBase.RenderContents(writer) End Sub 'RenderContents End Class 'MyWebControl End Namespace 'ControlTest
Available since 1.1