ControlValuePropertyAttribute

.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

C#

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

C++

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

J#

/** @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

C#

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);
        }
    }
}

.NET Framework のセキュリティ

• AspNetHostingPermission  (ホスト環境での動作に必要なアクセス許可)要求値 : LinkDemand; アクセス許可値 : Minimal。

継承階層

System.Object
   System.Attribute
    System.Web.UI.ControlValuePropertyAttribute

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

参照

関連項目
ControlValuePropertyAttribute メンバ
System.Web.UI 名前空間
Attribute
ControlParameter
ControlID
PropertyName
Name
DefaultValue

ControlValuePropertyAttribute コンストラクタ (String, Type, String)

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

指定したプロパティ名と既定値を使用して、ControlValuePropertyAttribute クラスの新しいインスタンスを初期化します。既定値は指定したデータ型に変換されます。

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

Visual Basic (宣言)

Public Sub New ( _
    name As String, _
    type As Type, _
    defaultValue As String _
)

Visual Basic (使用法)

Dim name As String
Dim type As Type
Dim defaultValue As String

Dim instance As New ControlValuePropertyAttribute(name,
 type, defaultValue)

C#

public ControlValuePropertyAttribute (
    string name,
    Type type,
    string defaultValue
)

C++

public:
ControlValuePropertyAttribute (
    String^ name, 
    Type^ type, 
    String^ defaultValue
)

J#

public ControlValuePropertyAttribute (
    String name, 
    Type type, 
    String defaultValue
)

JScript

public function ControlValuePropertyAttribute
 (
    name : String, 
    type : Type, 
    defaultValue : String
)

パラメータ

name

コントロールの既定のプロパティ。

type

既定値の変換先となる Type。

defaultValue

既定のプロパティの既定値。

解説

このコンストラクタを使用して、指定したプロパティ名と既定値で ControlValuePropertyAttribute クラスの新しいインスタンスを作成します。また、このコンストラクタは、既定値を type パラメータで指定されたデータ型に変換しようとします。既定値を変換できない場合、DefaultValue プロパティは設定されません。ControlValuePropertyAttribute クラスのインスタンスの初期プロパティ値を次の表に示します。

プロパティ	初期値
Name	name パラメータの値。
DefaultValue	値を type パラメータで指定されたデータ型に変換できる場合は、defaultValue パラメータの値。

プラットフォーム

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

参照

関連項目
ControlValuePropertyAttribute クラス
ControlValuePropertyAttribute メンバ
System.Web.UI 名前空間
Type
Name
DefaultValue

ControlValuePropertyAttribute コンストラクタ (String, Object)

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

指定したプロパティ名と既定値を使用して、ControlValuePropertyAttribute クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    name As String, _
    defaultValue As Object _
)

Visual Basic (使用法)

Dim name As String
Dim defaultValue As Object

Dim instance As New ControlValuePropertyAttribute(name,
 defaultValue)

C#

public ControlValuePropertyAttribute (
    string name,
    Object defaultValue
)

C++

public:
ControlValuePropertyAttribute (
    String^ name, 
    Object^ defaultValue
)

J#

public ControlValuePropertyAttribute (
    String name, 
    Object defaultValue
)

JScript

public function ControlValuePropertyAttribute
 (
    name : String, 
    defaultValue : Object
)

パラメータ

name

コントロールの既定のプロパティ。

defaultValue

既定のプロパティの既定値。

解説

このコンストラクタを使用して、指定したプロパティ名と既定値で ControlValuePropertyAttribute クラスの新しいインスタンスを作成します。ControlValuePropertyAttribute クラスのインスタンスの初期プロパティ値を次の表に示します。

プロパティ	初期値
Name	name パラメータの値。
DefaultValue	defaultValue パラメータの値。

使用例

既定のプロパティと値を指定する ControlValuePropertyAttribute 属性をカスタム コントロールに適用する方法を次のコード例に示します。このコンストラクタは、この属性を表す ControlValuePropertyAttribute オブジェクトを作成するために、ASP.NET によって内部的に呼び出されます。

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

C#

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);
        }
    }
}

プラットフォーム

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

参照

関連項目
ControlValuePropertyAttribute クラス
ControlValuePropertyAttribute メンバ
System.Web.UI 名前空間
Name
DefaultValue

ControlValuePropertyAttribute コンストラクタ (String)

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

指定したプロパティ名を使用して、ControlValuePropertyAttribute クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    name As String _
)

Visual Basic (使用法)

Dim name As String

Dim instance As New ControlValuePropertyAttribute(name)

C#

public ControlValuePropertyAttribute (
    string name
)

C++

public:
ControlValuePropertyAttribute (
    String^ name
)

J#

public ControlValuePropertyAttribute (
    String name
)

JScript

public function ControlValuePropertyAttribute
 (
    name : String
)

パラメータ

name

コントロールの既定のプロパティ。

解説

このコンストラクタを使用して、指定したプロパティ名で ControlValuePropertyAttribute クラスの新しいインスタンスを作成します。ControlValuePropertyAttribute クラスのインスタンスの初期プロパティ値を次の表に示します。

プロパティ	初期値
Name	name パラメータの値。

使用例

既定のプロパティを指定する ControlValuePropertyAttribute 属性をカスタム コントロールに適用する方法を次のコード例に示します。このコンストラクタは、この属性を表す ControlValuePropertyAttribute オブジェクトを作成するために、ASP.NET によって内部的に呼び出されます。

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")>
 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

C#

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")]
    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);
        }
    }
}

プラットフォーム

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

参照

関連項目
ControlValuePropertyAttribute クラス
ControlValuePropertyAttribute メンバ
System.Web.UI 名前空間
Name

ControlValuePropertyAttribute コンストラクタ

ControlValuePropertyAttribute クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

名前	説明
ControlValuePropertyAttribute (String)	指定したプロパティ名を使用して、ControlValuePropertyAttribute クラスの新しいインスタンスを初期化します。
ControlValuePropertyAttribute (String, Object)	指定したプロパティ名と既定値を使用して、ControlValuePropertyAttribute クラスの新しいインスタンスを初期化します。
ControlValuePropertyAttribute (String, Type, String)	指定したプロパティ名と既定値を使用して、ControlValuePropertyAttribute クラスの新しいインスタンスを初期化します。既定値は指定したデータ型に変換されます。

参照

関連項目

ControlValuePropertyAttribute クラス
ControlValuePropertyAttribute メンバ
System.Web.UI 名前空間
Name

ControlValuePropertyAttribute プロパティ

パブリック プロパティ

	名前	説明
	DefaultValue	コントロールの既定のプロパティの既定値を取得します。
	Name	コントロールの既定のプロパティを取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)

参照

関連項目

ControlValuePropertyAttribute クラス
System.Web.UI 名前空間
Attribute
ControlParameter
ControlID
PropertyName
Name
DefaultValue

ControlValuePropertyAttribute メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 ( Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 ( Attribute から継承されます。)
	GetHashCode	オーバーライドされます。 このインスタンスのハッシュ コードを返します。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 ( Attribute から継承されます。)
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 ( Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 ( Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

ControlValuePropertyAttribute クラス
System.Web.UI 名前空間
Attribute
ControlParameter
ControlID
PropertyName
Name
DefaultValue

ControlValuePropertyAttribute メンバ

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

ControlValuePropertyAttribute データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	ControlValuePropertyAttribute	オーバーロードされます。 ControlValuePropertyAttribute クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	DefaultValue	コントロールの既定のプロパティの既定値を取得します。
	Name	コントロールの既定のプロパティを取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 (Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 (Attribute から継承されます。)
	GetHashCode	オーバーライドされます。 このインスタンスのハッシュ コードを返します。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 (Attribute から継承されます。)
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 (Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

ControlValuePropertyAttribute クラス
System.Web.UI 名前空間
Attribute
ControlParameter
ControlID
PropertyName
Name
DefaultValue