HtmlTextWriter.TagKey プロパティ

.NET Framework クラス ライブラリ リファレンス

HtmlTextWriter.TagKey プロパティ

指定したマークアップ要素の HtmlTextWriterTag 値を取得または設定します。

名前空間: System.Web.UI
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Protected Property TagKey As
 HtmlTextWriterTag

Visual Basic (使用法)

Dim value As HtmlTextWriterTag

value = Me.TagKey

Me.TagKey = value

C#

protected HtmlTextWriterTag TagKey { get; set;
 }

C++

protected:
property HtmlTextWriterTag TagKey {
    HtmlTextWriterTag get ();
    void set (HtmlTextWriterTag value);
}

J#

/** @property */
protected HtmlTextWriterTag get_TagKey ()

/** @property */
protected void set_TagKey (HtmlTextWriterTag
 value)

JScript

protected function get TagKey
 () : HtmlTextWriterTag

protected function set TagKey
 (value : HtmlTextWriterTag)

プロパティ値
開始タグが出力されるマークアップ要素。

例外

例外の種類	条件
ArgumentOutOfRangeException	プロパティ値が設定できません。

解説

TagKey プロパティは、HtmlTextWriter から継承するクラスにだけ使用されます。TagKey プロパティの読み取り、または設定は、RenderBeginTag メソッドの呼び出しでのみ行うようにしてください。このプロパティには、このメソッドの呼び出しでのみ値が設定されます。

使用例

HtmlTextWriter クラスから派生したクラスのオーバーライドされたバージョンの RenderBeforeContent メソッドを次のコード例に示します。この例では、TagKey プロパティの値を使用して、カスタム HtmlTextWriter オブジェクトを使用しているサーバー コントロールが <label> マークアップ要素を出力しているかどうかをチェックします。出力される場合、<label> 要素のテキストの書式を変更するための color 属性が red に設定された <font> 要素が返されます。

Visual Basic

' Override the RenderBeforeContent method to write
' a font element that applies red to the text in a Label element.
Protected Overrides Function
 RenderBeforeContent() As String
    ' Check to determine whether the element being rendered
    ' is a label element. If so, render the opening tag
    ' of the font element; otherwise, call the base method.
    If TagKey = HtmlTextWriterTag.Label Then
        Return "<font color=""red"">"
    Else
        Return MyBase.RenderBeforeContent()
    End If
End Function 'RenderBeforeContent

C#

// Override the RenderBeforeContent method to write
// a font element that applies red to the text in a Label element.
protected override string RenderBeforeContent()
{
    // Check to determine whether the element being rendered
    // is a label element. If so, render the opening tag
    // of the font element; otherwise, call the base method.
    if (TagKey == HtmlTextWriterTag.Label)
    {
        return "<font color=\"red\">";
    }
    else
    {
        return base.RenderBeforeContent();
    }
}

C++

// Override the RenderBeforeContent method to write
// a font element that applies red to the text in a Label element.

virtual String^ RenderBeforeContent() override
{
   
   // Check to determine whether the element being rendered
   // is a label element. If so, render the opening tag
   // of the font element; otherwise, call the base method.
   if ( TagKey == HtmlTextWriterTag::Label )
   {
      return "<font color=\"red\">";
   }
   else
   {
      return __super::RenderBeforeContent();
   }
}

J#

// Override the RenderBeforeContent method to write
// a font element that applies red to the text in a Label element.
protected String RenderBeforeContent()
{
    // Check to determine whether the element being rendered
    // is a label element. If so, render the opening tag
    // of the font element; otherwise, call the base method.
    if (get_TagKey().Equals(HtmlTextWriterTag.Label)) {
        return "<font color=\"red\">";
    }
    else {
        return super.RenderBeforeContent();
    }
} //RenderBeforeContent

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
HtmlTextWriter クラス
HtmlTextWriter メンバ
System.Web.UI 名前空間
TextWriter
HtmlTextWriterTag
RenderBeginTag
TagName