HtmlTextWriter.GetAttributeKey(String) メソッド

定義

名前空間:

System.Web.UI

アセンブリ:

System.Web.dll

指定した属性に対応する HtmlTextWriterAttribute 列挙値を取得します。

protected:
 System::Web::UI::HtmlTextWriterAttribute GetAttributeKey(System::String ^ attrName);

protected System.Web.UI.HtmlTextWriterAttribute GetAttributeKey (string attrName);

member this.GetAttributeKey : string -> System.Web.UI.HtmlTextWriterAttribute

Protected Function GetAttributeKey (attrName As String) As HtmlTextWriterAttribute

パラメーター

attrName

String

HtmlTextWriterAttribute の取得対象となる属性を格納している文字列。

戻り値

HtmlTextWriterAttribute

指定した属性の HtmlTextWriterAttribute 列挙値。属性が列挙型のメンバーでない場合は無効な HtmlTextWriterAttribute 値。

例

次のコード例では、 メソッドをオーバーライドする クラスから派生した クラスを HtmlTextWriter 使用する方法を RenderBeginTag 示します。 オーバーライドは、 フィールドと等しいFontかどうかをtagKeyチェックします。これは、マークアップ要素がレンダリングされることを示<font>します。 その場合、オーバーライドは メソッドを IsAttributeDefined 呼び出して、 要素に 属性が <font> 含まれている Size かどうかを調べます。 が IsAttributeDefined 返された false場合、メソッドは AddAttribute メソッドを GetAttributeKey 呼び出します。これにより、 Size が定義され、その値が に 30pt設定されます。

// If the tagKey parameter is set to a <font> element
// but a size attribute is not defined on the element,
// the AddStyleAttribute method adds a size attribute
// and sets it to 30 point.
if ( tagKey == HtmlTextWriterTag::Font )
{
   if (  !IsAttributeDefined( HtmlTextWriterAttribute::Size ) )
   {
      AddAttribute( GetAttributeKey( "size" ), "30pt" );
   }
}

// If the tagKey parameter is set to a <font> element
// but a size attribute is not defined on the element,
// the AddStyleAttribute method adds a size attribute
// and sets it to 30 point. 
if (tagKey == HtmlTextWriterTag.Font)
{
    if (!IsAttributeDefined(HtmlTextWriterAttribute.Size))
    {
        AddAttribute(GetAttributeKey("size"), "30pt");
    }
}

' If the tagKey parameter is set to a <font> element
' but a size attribute is not defined on the element,
' the AddStyleAttribute method adds a size attribute
' and sets it to 30 point. 
If tagKey = HtmlTextWriterTag.Font Then
    If Not IsAttributeDefined(HtmlTextWriterAttribute.Size) Then
        AddAttribute(GetAttributeKey("size"), "30pt")
    End If
End If

注釈

が null または空の文字列 ("") の場合、または属性名のテーブルに見つからない場合attrNameは、オブジェクトにHtmlTextWriterAttribute型指定された値 -1 が返されます。

こちらもご覧ください

• TextWriter
• HtmlTextWriterAttribute
• RenderBeginTag
• IsAttributeDefined
• AddAttribute