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. このコードAddAttributeは、 RenderBeginTagメソッドを呼び出して出力ストリームに要素AddStyleAttribute<span>表示する前に、の2つの異なるオーバーロードと2つの異なるオーバーロードを呼び出します。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. メソッドを使用して、という名前CustomAttributeのカスタム属性と、このCustomAttributeValueコードが<span>レンダリングする要素に対してという名前のカスタム値を定義します。 AddAttribute(String, String)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(String, String)でもない場合、または属性が実行時までわからない場合は、メソッドのオーバーロードを使用します。AddAttribute HtmlTextWriterAttributeUse 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. メソッドが呼び出されると、 AddAttributeメソッドによって追加されたすべての属性が要素の開始タグにレンダリングされます。 RenderBeginTagWhen 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. メソッドが呼び出されると、 AddAttributeメソッドによって追加されたすべての属性が要素の開始タグにレンダリングされます。 RenderBeginTagWhen 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(String, String, Boolean)でもない場合、または実行時とエンコードが必要になるまで属性がわからない場合は、メソッドのオーバーロードを使用します。AddAttribute HtmlTextWriterAttributeUse 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. メソッドが呼び出されると、 AddAttributeメソッドによって追加されたすべての属性が要素の開始タグにレンダリングされます。 RenderBeginTagWhen 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.

属性に引用符 ( fEncode ") true、小なり記号 (<)、またはアンパサンド (&) が含まれている可能性がある場合は、をに設定してメソッドを使用します。AddAttribute(String, String, Boolean)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の場合、 fEndodetrueであっても値はエンコードされません。If 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.

注釈

メソッドのオーバーロードはAddAttributeHtmlTextWriterクラスから継承する場合にのみ使用します。 AddAttribute(String, String, HtmlTextWriterAttribute)Use the AddAttribute overload of the AddAttribute(String, String, HtmlTextWriterAttribute) method only when inheriting from the HtmlTextWriter class. 属性の新しいnameペアとkeyペアを作成できます。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)メソッドを使用して、 <img>要素のAlt属性に割り当てられている文字列値が、要求元のデバイス用にエンコードされていることを確認する方法を示します。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. メソッドが呼び出されると、にAddAttributeよって追加された属性は、要素の開始タグにレンダリングされます。 RenderBeginTagWhen 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.

属性に引用符 ( fEncode ") true、小なり記号 (<)、またはアンパサンド (&) が含まれている可能性がある場合は、をに設定してメソッドを使用します。AddAttribute(HtmlTextWriterAttribute, String, Boolean)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の場合、 fEncodetrueであっても値はエンコードされません。If 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.

こちらもご覧ください

適用対象