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)	HtmlTextWriter オブジェクトが後続の RenderBeginTag メソッドの呼び出しで作成する要素の開始タグに、HtmlTextWriterAttribute 列挙値と共に、指定されたマークアップ属性および値を追加します。
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

属性に割り当てる値を格納している文字列。

例

次のコード例では、 メソッドを呼び出す前に メソッドを AddAttribute 呼び出す方法を RenderBeginTag 示します。 コードは、 の 2 つの異なるオーバーロード AddAttribute と の 2 つの異なるオーバーロード AddStyleAttribute を呼び出してから、 メソッドを 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 値の AddAttribute(String, String) 1 つ 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(HtmlTextWriterAttribute, String)オーバーロードをAddAttribute使用してマークアップ要素に属性をOnclick追加し、その値を次の ECMAScript コードに設定する方法を示しています。

alert('Hello');  

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

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

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

注釈

メソッドのオーバーロードをAddAttributeAddAttribute(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使用して、 という名前myattributeのAddAttribute(String, String, Boolean)カスタム属性とその値が 要素に対してエンコードされないようにする方法を<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(String, String, Boolean) 1 つ HtmlTextWriterAttribute でない場合、または実行時とエンコードが必要になるまで属性が不明な場合は、 メソッドのオーバーロードを使用します。

指定されたマークアップ要素のインスタンスの場合、 クラスは HtmlTextWriter 、その要素の属性の一覧を保持します。 メソッドが RenderBeginTag 呼び出されると、メソッドによって AddAttribute 追加されたすべての属性が 要素の開始タグにレンダリングされます。 その後、属性の一覧が オブジェクトから HtmlTextWriter クリアされます。

属性にAddAttribute(String, String, Boolean)引用符 (")、より小さい記号< ()、またはアンパサンド (&) を含めることができる場合は、 メソッドfEncodeを にtrue設定して使用します。 メソッド呼び出しは、要求するデバイスの要件を満たすように 属性をエンコードします。 これらの文字が生成されないことがわかっている場合、または属性が既にエンコードされていることがわかっている場合は、 を にfalse設定fEncodeできます。

属性の型が の場合、 Styleが であっても値はtrueエンコードfEndodeされません。 スタイル値が CSS に準拠しており、悪意のあるコードが含まれていないことを確認します。

マークアップ要素をレンダリングするためのコーディング パターンは次のとおりです。

• 要素に AddAttribute 属性を追加するには、 メソッドを使用します。

• RenderBeginTag メソッドを使用します。

• 必要に応じて他のメソッドを使用して、要素の開始タグと終了タグの間にあるコンテンツをレンダリングします。

• RenderEndTag メソッドを使用します。

こちらもご覧ください

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

AddAttribute(String, String, HtmlTextWriterAttribute)

HtmlTextWriter オブジェクトが後続の RenderBeginTag メソッドの呼び出しで作成する要素の開始タグに、HtmlTextWriterAttribute 列挙値と共に、指定されたマークアップ属性および値を追加します。

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)使用して、要素の属性<img>にAlt割り当てられている文字列値が要求側のデバイスに対してエンコードされるようにする方法を示します。

// 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()

注釈

メソッドのオーバーロードをAddAttributeAddAttribute(HtmlTextWriterAttribute, String, Boolean)使用して、省略可能なエンコードを使用して標準マークアップ属性をレンダリングします。

指定されたマークアップ要素のインスタンスの場合、 クラスは HtmlTextWriter 、その要素の属性の一覧を保持します。 メソッドが RenderBeginTag 呼び出されると、 によって AddAttribute 追加されたすべての属性が 要素の開始タグにレンダリングされます。 その後、属性の一覧が オブジェクトから HtmlTextWriter クリアされます。

属性にAddAttribute(HtmlTextWriterAttribute, String, Boolean)引用符 (")、より小さい記号< ()、またはアンパサンド (&) を含めることができる場合は、 メソッドfEncodeを にtrue設定して使用します。 メソッド呼び出しは、要求するデバイスの要件を満たすように 属性をエンコードします。 これらの文字が生成されないことがわかっている場合、または属性が既にエンコードされていることがわかっている場合は、 を にfalse設定fEncodeできます。

属性の型が の場合、 Styleが であっても値はtrueエンコードfEncodeされません。 スタイル値が CSS に準拠しており、悪意のあるコードが含まれていないことを確認します。

マークアップ要素をレンダリングするためのコーディング パターンは次のとおりです。

• 要素に AddAttribute 属性を追加するには、 メソッドを使用します。

• RenderBeginTag メソッドを使用します。

• 必要に応じて他のメソッドを使用して、要素の開始タグと終了タグの間にあるコンテンツをレンダリングします。

• RenderEndTag メソッドを使用します。

こちらもご覧ください

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