ControlValuePropertyAttribute クラスとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

ControlValuePropertyAttribute クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

実行時に ControlParameter オブジェクトのバインド先となるコントロールの既定のプロパティを指定します。このクラスは継承できません。

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

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Class)> _
Public NotInheritable Class
 ControlValuePropertyAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As ControlValuePropertyAttribute

[AttributeUsageAttribute(AttributeTargets.Class)] 
public sealed class ControlValuePropertyAttribute
 : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Class)] 
public ref class ControlValuePropertyAttribute
 sealed : public Attribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Class) */ 
public final class ControlValuePropertyAttribute
 extends Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Class) 
public final class ControlValuePropertyAttribute
 extends Attribute

解説

ControlParameter オブジェクトを定義する場合、通常は ControlID プロパティと PropertyName プロパティの両方を設定することにより、コントロールのプロパティをパラメータにバインドします。PropertyName プロパティが設定されていない場合は、既定のプロパティが使用されます。ControlValuePropertyAttribute 属性をコントロールに適用することで、実行時に ControlParameter オブジェクトのバインド先となる、そのコントロールの既定のプロパティが指定されます。

属性の使用方法については、「属性を使用したメタデータの拡張」を参照してください。

ControlValuePropertyAttribute クラスのインスタンスの初期プロパティ値の一覧については、ControlValuePropertyAttribute コンストラクタのトピックを参照してください。

使用例

既定のプロパティと値を指定する ControlValuePropertyAttribute 属性をカスタムコントロールに適用する方法を次のコード例に示します。

Visual Basic

Imports System.ComponentModel
Imports System.Web.UI

Namespace Samples.AspNet.VB.Controls

    ' Set ControlValueProperty attribute to specify the default
    ' property of this control that a ControlParameter object 
    ' binds to at run time.
    <DefaultProperty("Text"), ControlValueProperty("Text",
 "DefaultText")> Public Class
 SimpleCustomControl
        Inherits System.Web.UI.WebControls.WebControl

        Dim _text As String

        <Bindable(True), Category("Appearance"),
 DefaultValue("")> Property
 [Text]() As String
            Get
                Return _text
            End Get

            Set(ByVal Value As
 String)
                _text = Value
            End Set
        End Property

        Protected Overrides Sub
 Render(ByVal output As System.Web.UI.HtmlTextWriter)
            output.Write([Text])
        End Sub

    End Class

End Namespace

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Text;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace Samples.AspNet.CS.Controls
{
    // Set ControlValueProperty attribute to specify the default
    // property of this control that a ControlParameter object 
    // binds to at run time.
    [DefaultProperty("Text")]
    [ControlValueProperty("Text", "Default Text")]
    public class SimpleCustomControl : WebControl
    {
        private string text;

        [Bindable(true)]
        [Category("Appearance")]
        [DefaultValue("")]
        public string Text
        {
            get
            {
                return text;
            }
            set
            {
                text = value;
            }
        }

        protected override void Render(HtmlTextWriter
 output)
        {
            output.Write(Text);
        }
    }
}