HtmlTextWriter.OnAttributeRender(String, String, HtmlTextWriterAttribute) HtmlTextWriter.OnAttributeRender(String, String, HtmlTextWriterAttribute) HtmlTextWriter.OnAttributeRender(String, String, HtmlTextWriterAttribute) HtmlTextWriter.OnAttributeRender(String, String, HtmlTextWriterAttribute) Method

定義

指定したマークアップ属性とその値を現在のマークアップ要素にレンダリングするかどうかを決定します。Determines whether the specified markup attribute and its value can be rendered to the current markup element.

protected:
 virtual bool OnAttributeRender(System::String ^ name, System::String ^ value, System::Web::UI::HtmlTextWriterAttribute key);
protected virtual bool OnAttributeRender (string name, string value, System.Web.UI.HtmlTextWriterAttribute key);
abstract member OnAttributeRender : string * string * System.Web.UI.HtmlTextWriterAttribute -> bool
override this.OnAttributeRender : string * string * System.Web.UI.HtmlTextWriterAttribute -> bool
Protected Overridable Function OnAttributeRender (name As String, value As String, key As HtmlTextWriterAttribute) As Boolean

パラメーター

name
String String String String

レンダリングする属性の名前を格納している文字列。A string containing the name of the attribute to render.

value
String String String String

属性に割り当てる値を格納している文字列。A string containing the value that is assigned to the attribute.

key
HtmlTextWriterAttribute HtmlTextWriterAttribute HtmlTextWriterAttribute HtmlTextWriterAttribute

マークアップ属性に関連付けられた HtmlTextWriterAttributeThe HtmlTextWriterAttribute associated with the markup attribute.

戻り値

常に trueAlways true.

OnAttributeRenderメソッドをオーバーライドする方法を次のコード例に示します。The following code example shows how to override the OnAttributeRender method. OnAttributeRender Size 30pt AddAttribute 30pt属性がレンダリングされてSizeも、値がではない場合、オーバーライドは、メソッドを呼び出して属性を追加し、その値をに設定します。 SizeIf a Size attribute is rendered, but the Size value is not 30pt, the OnAttributeRender override calls the AddAttribute method to add a Size attribute and set its value to 30pt.

// If a size attribute is to be rendered, compare its value to 30 point.
// If it is not set to 30 point, add the attribute and set the value to 30,
// then return false.
protected override bool OnAttributeRender(string name,
    string value,
    HtmlTextWriterAttribute key)
{

    if (key == HtmlTextWriterAttribute.Size)
    {
        if (string.Compare(value, "30pt") != 0)
        {
            AddAttribute("size", "30pt");
            return false;
        }
    }

    // If the attribute is not a size attribute, use
    // the base functionality of the OnAttributeRender method.
    return base.OnAttributeRender(name, value, key);
}
' If a size attribute is to be rendered, compare its value to 30 point.
' If it is not set to 30 point, add the attribute and set the value to 30
' then return false.
Protected Overrides Function OnAttributeRender(name As String, _
    value As String, _
    key As HtmlTextWriterAttribute) _
As Boolean

    If key = HtmlTextWriterAttribute.Size Then
        If [String].Compare(value, "30pt") <> 0 Then
            AddAttribute("size", "30pt")
            Return False
        End If
    End If

    ' If the attribute is not a size attribute, use
    ' the base functionality of the OnAttributeRender method.
    Return MyBase.OnAttributeRender(name, value, key)
End Function 'OnAttributeRender

注釈

メソッドのクラス実装はHtmlTextWriter常にをtrue返します。 OnAttributeRenderThe HtmlTextWriter class implementation of the OnAttributeRender method always returns true. オーバーライドOnAttributeRenderは、属性がページに表示されるかどうかを判断できます。The OnAttributeRender overrides can determine whether an attribute will be rendered to the page.

注意 (継承者)

HtmlTextWriterクラスから継承する場合、 OnAttributeRender(String, String, HtmlTextWriterAttribute)メソッドfalseをオーバーライドして、属性がまったく表示されないようにしたり、特定の要素にレンダリングしたり、特定のマークアップに対してレンダリングしたりすることができます。If you inherit from the HtmlTextWriter class, you can override the OnAttributeRender(String, String, HtmlTextWriterAttribute) method to return false to prevent an attribute from being rendered at all, being rendered on a particular element, or being rendered for a particular markup. たとえばHtmlTextWriter 、から派生したオブジェクトがbgcolor属性を要素に<table>出力しないようにするには、をオーバーライドOnAttributeRender(String, String, HtmlTextWriterAttribute)し、 falsename渡すbgcolorときにを返します。プロパティ値がtableです。 TagNameFor example, if you do not want the object derived from HtmlTextWriter to render the bgcolor attribute to <table> elements, you can override the OnAttributeRender(String, String, HtmlTextWriterAttribute) and return false when name passes bgcolor and the TagName property value is table.

適用対象

こちらもご覧ください