HtmlTextWriter.AddAttribute HtmlTextWriter.AddAttribute HtmlTextWriter.AddAttribute HtmlTextWriter.AddAttribute Method

定義

HtmlTextWriter オブジェクトが後続の RenderBeginTag メソッドの呼び出しで作成する要素の開始タグに、指定されたマークアップ属性および値を追加します。Adds the specified markup attribute and value to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method.

オーバーロード

AddAttribute(String, String) AddAttribute(String, String) AddAttribute(String, String) AddAttribute(String, String)

HtmlTextWriter オブジェクトが後続の RenderBeginTag メソッドの呼び出しで作成する要素の開始タグに、指定されたマークアップ属性および値を追加します。Adds the specified markup attribute and value to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method.

AddAttribute(HtmlTextWriterAttribute, String) AddAttribute(HtmlTextWriterAttribute, String) AddAttribute(HtmlTextWriterAttribute, String) AddAttribute(HtmlTextWriterAttribute, String)

HtmlTextWriter オブジェクトが後続の RenderBeginTag メソッドの呼び出しで作成する要素の開始タグに、マークアップ属性および属性値を追加します。Adds the markup attribute and the attribute value to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method.

AddAttribute(String, String, Boolean) AddAttribute(String, String, Boolean) AddAttribute(String, String, Boolean) AddAttribute(String, String, Boolean)

オプションのエンコーディングを使用して、HtmlTextWriter オブジェクトが後続の RenderBeginTag メソッドの呼び出しで作成する要素の開始タグに、指定されたマークアップ属性および値を追加します。Adds the specified markup attribute and value to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method, with optional encoding.

AddAttribute(String, String, HtmlTextWriterAttribute) AddAttribute(String, String, HtmlTextWriterAttribute) AddAttribute(String, String, HtmlTextWriterAttribute) AddAttribute(String, String, HtmlTextWriterAttribute)

HtmlTextWriter オブジェクトが後続の RenderBeginTag メソッドの呼び出しで作成する要素の開始タグに、HtmlTextWriterAttribute 列挙値と共に、指定されたマークアップ属性および値を追加します。Adds the specified markup attribute and value, along with an HtmlTextWriterAttribute enumeration value, to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method.

AddAttribute(HtmlTextWriterAttribute, String, Boolean) AddAttribute(HtmlTextWriterAttribute, String, Boolean) AddAttribute(HtmlTextWriterAttribute, String, Boolean) AddAttribute(HtmlTextWriterAttribute, String, Boolean)

オプションのエンコーディングを使用して、HtmlTextWriter オブジェクトが後続の RenderBeginTag メソッドの呼び出しで作成する要素の開始タグに、マークアップ属性および属性値を追加します。Adds the markup attribute and the attribute value to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method, with optional encoding.

AddAttribute(String, String) AddAttribute(String, String) AddAttribute(String, String) AddAttribute(String, String)

HtmlTextWriter オブジェクトが後続の RenderBeginTag メソッドの呼び出しで作成する要素の開始タグに、指定されたマークアップ属性および値を追加します。Adds the specified markup attribute and value to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method.

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 String String String

追加する属性の名前を格納している文字列。A string containing the name of the attribute to add.

value
String String String String

属性に割り当てる値を格納している文字列。A string containing the value to assign to the attribute.

次のコード例を呼び出す方法を示します、AddAttributeメソッドを呼び出す前に、RenderBeginTagメソッド。The following code example demonstrates how to call the AddAttribute method before calling the RenderBeginTag method. コードの 2 つの異なるオーバー ロードを呼び出してAddAttributeの 2 つの異なるオーバー ロードとAddStyleAttributeを呼び出す前に、RenderBeginTagをレンダリングするメソッド、<span>要素を出力ストリーム。The code calls two different overloads of AddAttribute and two different overloads of AddStyleAttribute before it calls the RenderBeginTag method to render a <span> element to the output stream. AddAttribute(String, String)という名前のカスタム属性を定義するメソッドが使用されるCustomAttributeとという名前のカスタム値CustomAttributeValue<span>このコードをレンダリングする要素。The AddAttribute(String, String) method is used to define the custom attribute named CustomAttribute and the custom value named CustomAttributeValue for the <span> element that this code renders.

// 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値、または実行時までに、属性が不明である場合。Use the AddAttribute overload of the AddAttribute(String, String) method if the attribute is not one of the HtmlTextWriterAttribute values, or if the attribute is not known until run time.

任意の指定したマークアップ要素のインスタンスをHtmlTextWriterクラスは、その要素の属性のリストを保持します。For an instance of any given markup element, the HtmlTextWriter class maintains a list of attributes for that element. ときに、RenderBeginTagメソッドが呼び出されると、任意の属性によって追加された、AddAttributeメソッドは、要素の開始タグに表示されます。When the RenderBeginTag method is called, any attributes added by the AddAttribute method are rendered to the opening tag of the element. 属性の一覧がから消去し、HtmlTextWriterオブジェクト。The list of attributes is then cleared from the HtmlTextWriter object.

マークアップ要素をレンダリングするためのコーディング パターンは次のとおりです。The coding pattern for rendering markup elements is as follows:

  • 使用して、AddAttribute要素に属性を追加するメソッド。Use the AddAttribute method to add any attributes to the element.

  • RenderBeginTag メソッドを使用します。Use the RenderBeginTag method.

  • 要素のタグと終了タグ間にあるコンテンツを表示するために、必要に応じてその他のメソッドを使用します。Use other methods as needed to render the content found between the element's opening and closing tags.

  • RenderEndTag メソッドを使用します。Use the RenderEndTag method.

こちらもご覧ください

AddAttribute(HtmlTextWriterAttribute, String) AddAttribute(HtmlTextWriterAttribute, String) AddAttribute(HtmlTextWriterAttribute, String) AddAttribute(HtmlTextWriterAttribute, String)

HtmlTextWriter オブジェクトが後続の RenderBeginTag メソッドの呼び出しで作成する要素の開始タグに、マークアップ属性および属性値を追加します。Adds the markup attribute and the attribute value to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method.

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 HtmlTextWriterAttribute HtmlTextWriterAttribute

出力ストリームに追加するマークアップ属性を表す HtmlTextWriterAttributeAn HtmlTextWriterAttribute that represents the markup attribute to add to the output stream.

value
String String String String

属性に割り当てる値を格納している文字列。A string containing the value to assign to the attribute.

次のコード例を使用する方法を示しています、AddAttributeのオーバー ロード、AddAttribute(HtmlTextWriterAttribute, String)を追加するメソッド、Onclickマークアップ要素に属性し、次の ECMAScript コードをその値を設定。The following code example shows how to use the AddAttribute overload of the AddAttribute(HtmlTextWriterAttribute, String) method to add an Onclick attribute to a markup element, and then set its value to the following ECMAScript code:

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

注釈

使用して、AddAttributeのオーバー ロード、AddAttribute(HtmlTextWriterAttribute, String)標準マークアップ属性をレンダリングするメソッド。Use the AddAttribute overload of the AddAttribute(HtmlTextWriterAttribute, String) method to render a standard markup attribute.

任意の指定したマークアップ要素のインスタンスをHtmlTextWriterクラスは、その要素の属性のリストを保持します。For an instance of any given markup element, the HtmlTextWriter class maintains a list of attributes for that element. ときに、RenderBeginTagメソッドが呼び出されると、によって追加されたすべての属性、AddAttributeメソッドは、要素の開始タグに表示されます。When the RenderBeginTag method is called, any attributes that are added by the AddAttribute method are rendered to the opening tag of the element. 属性の一覧がから消去し、HtmlTextWriterします。The list of attributes is then cleared from the HtmlTextWriter.

マークアップ要素をレンダリングするためのコーディング パターンは次のとおりです。The coding pattern for rendering markup elements is as follows:

  • 使用して、AddAttribute要素に属性を追加するメソッド。Use the AddAttribute method to add any attributes to the element.

  • RenderBeginTag メソッドを使用します。Use the RenderBeginTag method.

  • 要素のタグと終了タグ間にあるコンテンツを表示するために、必要に応じてその他のメソッドを使用します。Use other methods as needed to render the content found between the element's opening and closing tags.

  • RenderEndTag メソッドを使用します。Use the RenderEndTag method.

こちらもご覧ください

AddAttribute(String, String, Boolean) AddAttribute(String, String, Boolean) AddAttribute(String, String, Boolean) AddAttribute(String, String, Boolean)

オプションのエンコーディングを使用して、HtmlTextWriter オブジェクトが後続の RenderBeginTag メソッドの呼び出しで作成する要素の開始タグに、指定されたマークアップ属性および値を追加します。Adds the specified markup attribute and value to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method, with optional encoding.

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 String String String

追加する属性の名前を格納している文字列。A string containing the name of the attribute to add.

value
String String String String

属性に割り当てる値を格納している文字列。A string containing the value to assign to the attribute.

fEndode
Boolean Boolean Boolean Boolean

属性とその値をエンコードする場合は true。それ以外の場合は falsetrue to encode the attribute and its value; otherwise, false.

次のコード例を使用する方法を示しています、AddAttributeのオーバー ロード、AddAttribute(String, String, Boolean)メソッドという名前のカスタム属性をmyattributeの値がエンコードされていないと、<img>要素。The following code example shows how to use the AddAttribute overload of the AddAttribute(String, String, Boolean) method to ensure that a custom attribute, named myattribute, and its value are not encoded for an <img> element.

// Control the encoding of attributes.
// Simple known values do not need encoding.
writer->AddAttribute( HtmlTextWriterAttribute::Alt, "Encoding, \"Required\"", true );
writer->AddAttribute( "myattribute", "No &quot;encoding &quot; 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 &quot;encoding &quot; 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 &quot;encoding &quot; required", False)
writer.RenderBeginTag(HtmlTextWriterTag.Img)
writer.RenderEndTag()
writer.WriteLine()

注釈

使用して、AddAttributeのオーバー ロード、AddAttribute(String, String, Boolean)メソッド、属性は、のいずれかでがない場合、HtmlTextWriterAttribute値、または実行時までエンコーディング属性が不明である場合を必要とします。Use the AddAttribute overload of the AddAttribute(String, String, Boolean) method if the attribute is not one of the HtmlTextWriterAttribute values, or if the attribute is not known until run time and encoding is needed.

任意の指定したマークアップ要素のインスタンスをHtmlTextWriterクラスは、その要素の属性のリストを保持します。For an instance of any given markup element, the HtmlTextWriter class maintains a list of attributes for that element. ときに、RenderBeginTagメソッドが呼び出されると、任意の属性によって追加された、AddAttributeメソッドは、要素の開始タグに表示されます。When the RenderBeginTag method is called, any attributes added by the AddAttribute method are rendered to the opening tag of the element. 属性の一覧がから消去し、HtmlTextWriterオブジェクト。The list of attributes is then cleared from the HtmlTextWriter object.

使用して、AddAttribute(String, String, Boolean)メソッドfEncodeに設定true属性では、引用符 (")、小なり記号 (<) を含めることができます可能性がある場合や、アンパサンド (&)。Use the AddAttribute(String, String, Boolean) method with fEncode set to true, if the attribute can possibly contain a quotation mark ("), a less than sign (<), or an ampersand (&). メソッドの呼び出しでは、要求元のデバイスの要件を満たす属性がエンコードされます。The method call will encode the attribute to meet the requirements of the requesting device. 設定できるfEncodefalse属性が既にエンコードされていることがわかっている場合、またはこれらの文字のいずれもが生成されることをわかっている場合。You can set fEncode to false, if you know that none of these characters will be generated, or if you know that the attribute is already encoded.

属性の型が場合Style、値をエンコードしない場合でもfEndodetrueIf the attribute type is Style, the value won't be encoded even if fEndode is true. スタイルの値は CSS に準拠して、悪意のあるコードが含まれていないことを確認します。Ensure that the style value is CSS-compliant and doesn't contain malicious code.

マークアップ要素をレンダリングするためのコーディング パターンは次のとおりです。The coding pattern for rendering markup elements is as follows:

  • 使用して、AddAttribute要素に属性を追加するメソッド。Use the AddAttribute method to add any attributes to the element.

  • RenderBeginTag メソッドを使用します。Use the RenderBeginTag method.

  • 要素のタグと終了タグ間にあるコンテンツを表示するために、必要に応じてその他のメソッドを使用します。Use other methods as needed to render the content found between the element's opening and closing tags.

  • RenderEndTag メソッドを使用します。Use the RenderEndTag method.

こちらもご覧ください

AddAttribute(String, String, HtmlTextWriterAttribute) AddAttribute(String, String, HtmlTextWriterAttribute) AddAttribute(String, String, HtmlTextWriterAttribute) AddAttribute(String, String, HtmlTextWriterAttribute)

HtmlTextWriter オブジェクトが後続の RenderBeginTag メソッドの呼び出しで作成する要素の開始タグに、HtmlTextWriterAttribute 列挙値と共に、指定されたマークアップ属性および値を追加します。Adds the specified markup attribute and value, along with an HtmlTextWriterAttribute enumeration value, to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method.

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 String String String

追加する属性の名前を格納している文字列。A string containing the name of the attribute to add.

value
String String String String

属性に割り当てる値を格納している文字列。A string containing the value to assign to the attribute.

注釈

使用して、AddAttributeのオーバー ロード、AddAttribute(String, String, HtmlTextWriterAttribute)メソッドから継承する場合にのみ、HtmlTextWriterクラス。Use the AddAttribute overload of the AddAttribute(String, String, HtmlTextWriterAttribute) method only when inheriting from the HtmlTextWriter class. 新規作成することもできるnamekey属性のペア。It enables you to create new name and key pairs for attributes.

こちらもご覧ください

AddAttribute(HtmlTextWriterAttribute, String, Boolean) AddAttribute(HtmlTextWriterAttribute, String, Boolean) AddAttribute(HtmlTextWriterAttribute, String, Boolean) AddAttribute(HtmlTextWriterAttribute, String, Boolean)

オプションのエンコーディングを使用して、HtmlTextWriter オブジェクトが後続の RenderBeginTag メソッドの呼び出しで作成する要素の開始タグに、マークアップ属性および属性値を追加します。Adds the markup attribute and the attribute value to the opening tag of the element that the HtmlTextWriter object creates with a subsequent call to the RenderBeginTag method, with optional encoding.

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 HtmlTextWriterAttribute HtmlTextWriterAttribute

出力ストリームに追加するマークアップ属性を表す HtmlTextWriterAttributeAn HtmlTextWriterAttribute that represents the markup attribute to add to the output stream.

value
String String String String

属性に割り当てる値を格納している文字列。A string containing the value to assign to the attribute.

fEncode
Boolean Boolean Boolean Boolean

属性とその値をエンコードする場合は true。それ以外の場合は falsetrue to encode the attribute and its value; otherwise, false.

次のコード例は、使用する方法を示します、AddAttribute(HtmlTextWriterAttribute, String, Boolean)文字列値に割り当てられていることを確認する方法、Alt属性、<img>要素が要求元のデバイスのエンコードします。The following code example demonstrates how to use the AddAttribute(HtmlTextWriterAttribute, String, Boolean) method to ensure that the string value that is assigned to an Alt attribute for an <img> element is encoded for the requesting device.

// Control the encoding of attributes.
// Simple known values do not need encoding.
writer->AddAttribute( HtmlTextWriterAttribute::Alt, "Encoding, \"Required\"", true );
writer->AddAttribute( "myattribute", "No &quot;encoding &quot; 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 &quot;encoding &quot; 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 &quot;encoding &quot; required", False)
writer.RenderBeginTag(HtmlTextWriterTag.Img)
writer.RenderEndTag()
writer.WriteLine()

注釈

使用して、AddAttributeのオーバー ロード、AddAttribute(HtmlTextWriterAttribute, String, Boolean)オプションのエンコーディングでの標準マークアップ属性をレンダリングするメソッド。Use the AddAttribute overload of the AddAttribute(HtmlTextWriterAttribute, String, Boolean) method to render a standard markup attribute, with optional encoding.

任意の指定したマークアップ要素のインスタンスをHtmlTextWriterクラスは、その要素の属性のリストを保持します。For an instance of any given markup element, the HtmlTextWriter class maintains a list of attributes for that element. ときに、RenderBeginTagメソッドが呼び出されると、任意の属性によって追加された、AddAttribute要素の開始タグに表示されます。When the RenderBeginTag method is called, any attributes added by the AddAttribute are rendered to the opening tag of the element. 属性の一覧がから消去し、HtmlTextWriterオブジェクト。The list of attributes is then cleared from the HtmlTextWriter object.

使用して、AddAttribute(HtmlTextWriterAttribute, String, Boolean)メソッドfEncodeに設定true属性では、引用符 (")、小なり記号 (<) を含めることができます可能性がある場合や、アンパサンド (&)。Use the AddAttribute(HtmlTextWriterAttribute, String, Boolean) method with fEncode set to true, if the attribute can possibly contain a quotation mark ("), a less than sign (<), or an ampersand (&). メソッドの呼び出しでは、要求元のデバイスの要件を満たす属性がエンコードされます。The method call will encode the attribute to meet the requirements of the requesting device. 設定できるfEncodefalse属性が既にエンコードされていることがわかっている場合、またはこれらの文字のいずれもが生成されることをわかっている場合。You can set fEncode to false, if you know that none of these characters will be generated, or if you know that the attribute is already encoded.

属性の型が場合Style、値をエンコードしない場合でもfEncodetrueIf the attribute type is Style, the value won't be encoded even if fEncode is true. スタイルの値は CSS に準拠して、悪意のあるコードが含まれていないことを確認します。Ensure that the style value is CSS-compliant and doesn't contain malicious code.

マークアップ要素をレンダリングするためのコーディング パターンは次のとおりです。The coding pattern for rendering markup elements is as follows:

  • 使用して、AddAttribute要素に属性を追加するメソッド。Use the AddAttribute method to add any attributes to the element.

  • RenderBeginTag メソッドを使用します。Use the RenderBeginTag method.

  • 要素のタグと終了タグ間にあるコンテンツを表示するために、必要に応じてその他のメソッドを使用します。Use other methods as needed to render the content found between the element's opening and closing tags.

  • RenderEndTag メソッドを使用します。Use the RenderEndTag method.

こちらもご覧ください

適用対象