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 方法。 程序代碼會先呼叫的兩個不同多載和 兩個不同的 多載AddAttributeAddStyleAttribute，再呼叫 RenderBeginTag 方法，將專案轉<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如果 屬性不是其中一個HtmlTextWriterAttribute值，或屬性在運行時間之前未知，請使用 方法的多AddAttribute(String, String)載。

對於任何指定標記項目的實例，類別 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) 載，以確保名為 myattribute的自定義屬性及其值不會針對 <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如果 屬性不是其中一個HtmlTextWriterAttribute值，或屬性在運行時間和編碼需要之前未知，請使用 方法的多AddAttribute(String, String, Boolean)載。

對於任何指定標記項目的實例，類別 HtmlTextWriter 會維護該專案的屬性清單。 RenderBeginTag呼叫 方法時，方法新增AddAttribute的任何屬性會轉譯為專案的開頭標記。 接著會從 HtmlTextWriter 物件清除屬性清單。

AddAttribute(String, String, Boolean)如果屬性可以包含引號 (“) 、小於符號 < () 或連字元 (&) ，請使用 設定true為 的方法fEncode。 方法呼叫會將 屬性編碼，以符合要求裝置的需求。 如果您知道不會產生這些字元，或者您知道屬性已經編碼，您可以設定 fEncode 為 false。

如果屬性類型為 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只有在繼承自 HtmlTextWriter 類別時，才使用 方法的多AddAttribute(String, String, HtmlTextWriterAttribute)載。 它可讓您為屬性建立新的 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。 方法呼叫會將 屬性編碼，以符合要求裝置的需求。 如果您知道不會產生這些字元，或者您知道屬性已經編碼，您可以設定 fEncode 為 false。

如果屬性類型為 Style，即使 fEncode 為 true，值也不會編碼。 請確定樣式值符合 CSS 規範，且不包含惡意代碼。

轉譯標記項目的編碼模式如下所示：

• AddAttribute使用 方法，將任何屬性新增至 專案。

• 使用 RenderBeginTag 方法。

• 視需要使用其他方法來呈現元素的開頭和結尾標記之間找到的內容。

• 使用 RenderEndTag 方法。

另請參閱

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