ControlValuePropertyAttribute.Name プロパティ

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

ControlValuePropertyAttribute.Name プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

コントロールの既定のプロパティを取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 Name As String

Visual Basic (使用法)

Dim instance As ControlValuePropertyAttribute
Dim value As String

value = instance.Name

C#

public string Name { get;
 }

C++

public:
property String^ Name {
    String^ get ();
}

J#

/** @property */
public String get_Name ()

JScript

public function get Name
 () : String

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

解説

ControlParameter オブジェクトが PropertyName プロパティを設定せずに定義されている場合、実行時に ControlParameter オブジェクトにバインドされる既定のプロパティは Name プロパティを使用して決定します。

使用例

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

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 名前空間
ControlParameter
ControlValuePropertyAttribute.DefaultValue プロパティ