ControlValuePropertyAttribute.Name Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the default property for a control.

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)

public string Name { get; }

Property Value

Type: System.String

The default property for a control.

When a ControlParameter object is defined without its PropertyName property set, use the Name property to determine the default property that is bound to the ControlParameter object at run time.

The following code example demonstrates how to set the Name property by applying a ControlValuePropertyAttribute attribute to a custom control.


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
Available since 2.0
Return to top
Show: