HtmlTextWriter.AddAttribute 方法

定义

命名空间:

System.Web.UI

程序集:

System.Web.dll

将指定的标记属性和值添加到 HtmlTextWriter 对象创建的元素的开始标记，随后调用 RenderBeginTag 方法。

重载

AddAttribute(String, String)	将指定的标记属性和值添加到 HtmlTextWriter 对象创建的元素的开始标记，随后调用 RenderBeginTag 方法。
AddAttribute(HtmlTextWriterAttribute, String)	将标记属性和属性值添加到 HtmlTextWriter 对象创建的元素的开始标记，随后调用 RenderBeginTag 方法。
AddAttribute(String, String, Boolean)	将指定的标记属性和值添加到 HtmlTextWriter 对象创建的元素的开始标记，随后使用可选编码调用 RenderBeginTag 方法。
AddAttribute(String, String, HtmlTextWriterAttribute)	将指定的标记属性、值以及 HtmlTextWriterAttribute 枚举值添加到 HtmlTextWriter 对象创建的元素的开始标记，随后调用 RenderBeginTag 方法。
AddAttribute(HtmlTextWriterAttribute, String, Boolean)	将标记属性和属性值添加到 HtmlTextWriter 对象创建的元素的开始标记中，随后使用可选编码调用 RenderBeginTag 方法。

AddAttribute(String, String)

将指定的标记属性和值添加到 HtmlTextWriter 对象创建的元素的开始标记，随后调用 RenderBeginTag 方法。

public:
 virtual void AddAttribute(System::String ^ name, System::String ^ value);

public virtual void AddAttribute (string name, string value);

abstract member AddAttribute : string * string -> unit
override this.AddAttribute : string * string -> unit

Public Overridable Sub AddAttribute (name As String, value As String)

参数

name

String

包含要添加的属性名称的字符串。

value

String

包含要分配给该属性的值的字符串。

示例

下面的代码示例演示如何在调用 方法之前调用 AddAttributeRenderBeginTag 方法。 代码在调用 AddAttribute 方法以将元素呈现到输出流之前，会调用 RenderBeginTag 的AddStyleAttribute两个不同的重载和 的两个不同的<span>重载。 方法 AddAttribute(String, String) 用于为此代码呈现的元素定义名为 的 CustomAttribute 自定义属性和名为 CustomAttributeValue<span> 的自定义值。

// Set attributes and values along with attributes and styles  
// attribute defined for a <span> element.
writer.AddAttribute(HtmlTextWriterAttribute.Onclick, "alert('Hello');");
writer.AddAttribute("CustomAttribute", "CustomAttributeValue");
writer.AddStyleAttribute(HtmlTextWriterStyle.Color, "Red");
writer.AddStyleAttribute("Customstyle", "CustomStyleValue");
writer.RenderBeginTag(HtmlTextWriterTag.Span);
// Create a space and indent the markup inside the 
// <span> element.
writer.WriteLine();
writer.Indent++;

' Set attributes and values along with attributes and styles
' attribute defined for a <span> element.
writer.AddAttribute(HtmlTextWriterAttribute.Onclick, "alert('Hello');")
writer.AddAttribute("CustomAttribute", "CustomAttributeValue")
writer.AddStyleAttribute(HtmlTextWriterStyle.Color, "Red")
writer.AddStyleAttribute("CustomStyle", "CustomStyleValue")
writer.RenderBeginTag(HtmlTextWriterTag.Span)

'  Create a space and indent the markup inside the 
' <span> element.
writer.WriteLine()
writer.Indent += 1

注解

AddAttribute如果特性不是值之AddAttribute(String, String)一HtmlTextWriterAttribute，或者属性直到运行时才知道，请使用 方法的重载。

对于任何给定标记元素的实例， HtmlTextWriter 类维护该元素的属性列表。 RenderBeginTag调用 方法时，方法AddAttribute添加的任何属性都呈现到 元素的开始标记中。 然后， HtmlTextWriter 从 对象中清除属性列表。

呈现标记元素的编码模式如下所示：

• AddAttribute使用 方法向 元素添加任何属性。

• 使用 RenderBeginTag 方法。

• 根据需要使用其他方法呈现元素的开始标记和结束标记之间找到的内容。

• 使用 RenderEndTag 方法。

另请参阅

• TextWriter
• RenderBeginTag
• RenderEndTag()
• AddStyleAttribute

AddAttribute(HtmlTextWriterAttribute, String)

将标记属性和属性值添加到 HtmlTextWriter 对象创建的元素的开始标记，随后调用 RenderBeginTag 方法。

public:
 virtual void AddAttribute(System::Web::UI::HtmlTextWriterAttribute key, System::String ^ value);

public virtual void AddAttribute (System.Web.UI.HtmlTextWriterAttribute key, string value);

abstract member AddAttribute : System.Web.UI.HtmlTextWriterAttribute * string -> unit
override this.AddAttribute : System.Web.UI.HtmlTextWriterAttribute * string -> unit

Public Overridable Sub AddAttribute (key As HtmlTextWriterAttribute, value As String)

参数

key

HtmlTextWriterAttribute

表示将标记属性添加到输出流的 HtmlTextWriterAttribute。

value

String

包含要分配给该属性的值的字符串。

示例

下面的代码示例演示如何使用 AddAttribute 方法的 AddAttribute(HtmlTextWriterAttribute, String) 重载将属性添加到 Onclick 标记元素，然后将其值设置为以下 ECMAScript 代码：

alert('Hello');  

writer->AddAttribute( HtmlTextWriterAttribute::Onclick, "alert('Hello');" );

writer.AddAttribute(HtmlTextWriterAttribute.Onclick, "alert('Hello');");

writer.AddAttribute(HtmlTextWriterAttribute.Onclick, "alert('Hello');")

注解

AddAttribute使用 方法的AddAttribute(HtmlTextWriterAttribute, String)重载呈现标准标记属性。

对于任何给定标记元素的实例， HtmlTextWriter 类维护该元素的属性列表。 RenderBeginTag调用 方法时，由 AddAttribute 方法添加的任何属性都呈现到 元素的开始标记中。 然后， HtmlTextWriter将从 中清除属性列表。

呈现标记元素的编码模式如下所示：

• AddAttribute使用 方法向 元素添加任何属性。

• 使用 RenderBeginTag 方法。

• 根据需要使用其他方法呈现元素的开始标记和结束标记之间找到的内容。

• 使用 RenderEndTag 方法。

另请参阅

• TextWriter
• RenderBeginTag
• RenderEndTag()

AddAttribute(String, String, Boolean)

将指定的标记属性和值添加到 HtmlTextWriter 对象创建的元素的开始标记，随后使用可选编码调用 RenderBeginTag 方法。

public:
 virtual void AddAttribute(System::String ^ name, System::String ^ value, bool fEndode);

public virtual void AddAttribute (string name, string value, bool fEndode);

abstract member AddAttribute : string * string * bool -> unit
override this.AddAttribute : string * string * bool -> unit

Public Overridable Sub AddAttribute (name As String, value As String, fEndode As Boolean)

参数

name

String

包含要添加的属性名称的字符串。

value

String

包含要分配给该属性的值的字符串。

fEndode

Boolean

若对属性及其值进行编码，则为 true；否则，为 false。

示例

下面的代码示例演示如何使用 AddAttribute 方法的AddAttribute(String, String, Boolean)重载来确保未为<img>元素编码名为 myattribute的自定义属性及其值。

// Control the encoding of attributes.
// Simple known values do not need encoding.
writer->AddAttribute( HtmlTextWriterAttribute::Alt, "Encoding, \"Required\"", true );
writer->AddAttribute( "myattribute", "No "encoding " required", false );
writer->RenderBeginTag( HtmlTextWriterTag::Img );
writer->RenderEndTag();
writer->WriteLine();

// Control the encoding of attributes. 
// Simple known values do not need encoding.
writer.AddAttribute(HtmlTextWriterAttribute.Alt, "Encoding, \"Required\"", true);
writer.AddAttribute("myattribute", "No "encoding " required", false);
writer.RenderBeginTag(HtmlTextWriterTag.Img);
writer.RenderEndTag();
writer.WriteLine();

' Control the encoding of attributes.
' Simple known values do not need encoding.
writer.AddAttribute(HtmlTextWriterAttribute.Alt, "Encoding, ""Required""", True)
writer.AddAttribute("myattribute", "No "encoding " required", False)
writer.RenderBeginTag(HtmlTextWriterTag.Img)
writer.RenderEndTag()
writer.WriteLine()

注解

AddAttribute如果特性不是值之AddAttribute(String, String, Boolean)一HtmlTextWriterAttribute，或者属性在运行时需要编码之前未知，请使用 方法的重载。

对于任何给定标记元素的实例， HtmlTextWriter 类维护该元素的属性列表。 RenderBeginTag调用 方法时，方法AddAttribute添加的任何属性都呈现到 元素的开始标记中。 然后， HtmlTextWriter 从 对象中清除属性列表。

AddAttribute(String, String, Boolean)如果特性可能包含引号 (“) 、小于符号 () < 或和号 (&) ，请使用 设置为 true的方法fEncode。 方法调用将对 属性进行编码以满足请求设备的要求。 如果知道不会生成任何这些字符，或者知道属性已编码，则可以将 设置为 fEncodefalse。

如果属性类型为 Style，则即使 fEndode 值为 true，也不会对值进行编码。 确保样式值符合 CSS 且不包含恶意代码。

呈现标记元素的编码模式如下所示：

• AddAttribute使用 方法向 元素添加任何属性。

• 使用 RenderBeginTag 方法。

• 根据需要使用其他方法呈现元素的开始标记和结束标记之间找到的内容。

• 使用 RenderEndTag 方法。

另请参阅

• TextWriter
• HttpRequest
• RenderBeginTag
• HtmlTextWriterAttribute
• HtmlAttributeEncode(String, TextWriter)

AddAttribute(String, String, HtmlTextWriterAttribute)

将指定的标记属性、值以及 HtmlTextWriterAttribute 枚举值添加到 HtmlTextWriter 对象创建的元素的开始标记，随后调用 RenderBeginTag 方法。

protected:
 virtual void AddAttribute(System::String ^ name, System::String ^ value, System::Web::UI::HtmlTextWriterAttribute key);

protected virtual void AddAttribute (string name, string value, System.Web.UI.HtmlTextWriterAttribute key);

abstract member AddAttribute : string * string * System.Web.UI.HtmlTextWriterAttribute -> unit
override this.AddAttribute : string * string * System.Web.UI.HtmlTextWriterAttribute -> unit

Protected Overridable Sub AddAttribute (name As String, value As String, key As HtmlTextWriterAttribute)

参数

name

String

包含要添加的属性名称的字符串。

value

String

包含要分配给该属性的值的字符串。

key

HtmlTextWriterAttribute

表示属性的 HtmlTextWriterAttribute。

注解

AddAttribute仅当从 类继承时，才使用 方法的AddAttribute(String, String, HtmlTextWriterAttribute)HtmlTextWriter重载。 它使你可以为属性创建新的 name 和 key 对。

另请参阅

• TextWriter
• RenderBeginTag
• HtmlTextWriterAttribute

AddAttribute(HtmlTextWriterAttribute, String, Boolean)

将标记属性和属性值添加到 HtmlTextWriter 对象创建的元素的开始标记中，随后使用可选编码调用 RenderBeginTag 方法。

public:
 virtual void AddAttribute(System::Web::UI::HtmlTextWriterAttribute key, System::String ^ value, bool fEncode);

public virtual void AddAttribute (System.Web.UI.HtmlTextWriterAttribute key, string value, bool fEncode);

abstract member AddAttribute : System.Web.UI.HtmlTextWriterAttribute * string * bool -> unit
override this.AddAttribute : System.Web.UI.HtmlTextWriterAttribute * string * bool -> unit

Public Overridable Sub AddAttribute (key As HtmlTextWriterAttribute, value As String, fEncode As Boolean)

参数

key

HtmlTextWriterAttribute

表示将标记属性添加到输出流的 HtmlTextWriterAttribute。

value

String

包含要分配给该属性的值的字符串。

fEncode

Boolean

若对属性及其值进行编码，则为 true；否则，为 false。

示例

下面的代码示例演示如何使用 AddAttribute(HtmlTextWriterAttribute, String, Boolean) 方法确保为请求设备编码分配给 Alt 元素属性 <img> 的字符串值。

// Control the encoding of attributes.
// Simple known values do not need encoding.
writer->AddAttribute( HtmlTextWriterAttribute::Alt, "Encoding, \"Required\"", true );
writer->AddAttribute( "myattribute", "No "encoding " required", false );
writer->RenderBeginTag( HtmlTextWriterTag::Img );
writer->RenderEndTag();
writer->WriteLine();

// Control the encoding of attributes. 
// Simple known values do not need encoding.
writer.AddAttribute(HtmlTextWriterAttribute.Alt, "Encoding, \"Required\"", true);
writer.AddAttribute("myattribute", "No "encoding " required", false);
writer.RenderBeginTag(HtmlTextWriterTag.Img);
writer.RenderEndTag();
writer.WriteLine();

' Control the encoding of attributes.
' Simple known values do not need encoding.
writer.AddAttribute(HtmlTextWriterAttribute.Alt, "Encoding, ""Required""", True)
writer.AddAttribute("myattribute", "No "encoding " required", False)
writer.RenderBeginTag(HtmlTextWriterTag.Img)
writer.RenderEndTag()
writer.WriteLine()

注解

AddAttribute使用 方法的AddAttribute(HtmlTextWriterAttribute, String, Boolean)重载来呈现具有可选编码的标准标记属性。

对于任何给定标记元素的实例， HtmlTextWriter 类维护该元素的属性列表。 RenderBeginTag调用 方法时，由 AddAttribute 添加的任何属性都呈现到 元素的开始标记中。 然后， HtmlTextWriter 从 对象中清除属性列表。

AddAttribute(HtmlTextWriterAttribute, String, Boolean)如果特性可能包含引号 (“) 、小于符号 () < 或和号 (&) ，请使用 设置为 true的方法fEncode。 方法调用将对 属性进行编码以满足请求设备的要求。 如果知道不会生成任何这些字符，或者知道属性已编码，则可以将 设置为 fEncodefalse。

如果属性类型为 Style，则即使 fEncode 值为 true，也不会对值进行编码。 确保样式值符合 CSS 且不包含恶意代码。

呈现标记元素的编码模式如下所示：

• AddAttribute使用 方法向 元素添加任何属性。

• 使用 RenderBeginTag 方法。

• 根据需要使用其他方法呈现元素的开始标记和结束标记之间找到的内容。

• 使用 RenderEndTag 方法。

另请参阅

• TextWriter
• HttpRequest
• RenderBeginTag
• HtmlTextWriterAttribute
• HtmlAttributeEncode(String, TextWriter)