HtmlTextWriter.GetAttributeKey(String) HtmlTextWriter.GetAttributeKey(String) HtmlTextWriter.GetAttributeKey(String) HtmlTextWriter.GetAttributeKey(String) Method

定義

指定した属性に対応する HtmlTextWriterAttribute 列挙値を取得します。Obtains the corresponding HtmlTextWriterAttribute enumeration value for the specified attribute.

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

HtmlTextWriterAttribute の取得対象となる属性を格納している文字列。A string that contains the attribute for which to obtain the HtmlTextWriterAttribute.

戻り値

指定した属性の HtmlTextWriterAttribute 列挙値。属性が列挙型のメンバーでない場合は無効な HtmlTextWriterAttribute 値。The HtmlTextWriterAttribute enumeration value for the specified attribute; otherwise, an invalid HtmlTextWriterAttribute value if the attribute is not a member of the enumeration.

次のコード例は、 HtmlTextWriterクラスから派生したクラスを使用して、 RenderBeginTagメソッドをオーバーライドする方法を示しています。The following code example demonstrates how to use a class, derived from the HtmlTextWriter class, that overrides the RenderBeginTag method. オーバーライドは、がtagKeyフィールドとFont等しいかどうかを確認します<font> 。これは、マークアップ要素がレンダリングされることを示します。The override checks whether tagKey is equal to the Font field, which indicates that a <font> markup element will be rendered. その場合、オーバーライドはIsAttributeDefinedメソッドを呼び出して、要素に<font> Size属性が含まれているかどうかを確認します。If so, the override calls the IsAttributeDefined method to find out whether the <font> element contains a Size attribute. IsAttributeDefinedを返すfalse場合AddAttribute 30pt、メソッドはを定義し、その値をに設定するメソッドを呼び出します。Size GetAttributeKeyIf the IsAttributeDefined returns false, the AddAttribute method calls the GetAttributeKey method, which defines the Size and sets its value to 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

注釈

attrName HtmlTextWriterAttributeまたは空の文字列 ("") の場合、または属性名のテーブルに見つからない場合は、オブジェクトに型指定された値-1 が返されます。 nullIf attrName is null or an empty string (""), or cannot be found in the table of attribute names, the value -1, typed to an HtmlTextWriterAttribute object, is returned.

適用対象

こちらもご覧ください