IEditableTextControl Interface

Reference

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a control that renders text that can be changed by the user.

public interface class IEditableTextControl : System::Web::UI::ITextControl

public interface IEditableTextControl : System.Web.UI.ITextControl

type IEditableTextControl = interface
    interface ITextControl

Public Interface IEditableTextControl
Implements ITextControl

Derived: System.Web.UI.WebControls.ListControl

System.Web.UI.WebControls.TextBox

Implements: ITextControl

Examples

The following code example shows an implementation of the TextChanged event.


public partial class customeditablebox : System.Web.UI.UserControl, IEditableTextControl
{
    private static readonly object EventCustomTextChanged = new Object();

    public event EventHandler TextChanged
    {
        add
        {
            Events.AddHandler(EventCustomTextChanged, value);
        }
        remove
        {
            Events.RemoveHandler(EventCustomTextChanged, value);
        }
    }

    public string Text
    {
        get
        {
            // Provide implementation.
            return String.Empty;
        }
        set
        {
            // Provide implementation.
        }
    }
}

Public Class customeditablebox
    Inherits System.Web.UI.UserControl
    Implements System.Web.UI.IEditableTextControl

    Private Shared ReadOnly EventCustomTextChanged As New Object

    Public Custom Event TextChanged As EventHandler _
      Implements System.Web.UI.IEditableTextControl.TextChanged
        AddHandler(ByVal value As EventHandler)
            Events.AddHandler(EventCustomTextChanged, value)
        End AddHandler

        RemoveHandler(ByVal value As EventHandler)
            Events.RemoveHandler(EventCustomTextChanged, value)
        End RemoveHandler

        RaiseEvent(ByVal sender As Object, ByVal e As EventArgs)

        End RaiseEvent
    End Event

    Public Property Text() As String _
      Implements System.Web.UI.IEditableTextControl.Text
        Get
            ' Provide implementation.
            Return String.Empty
        End Get
        Set(ByVal value As String)
            ' Provide implementation.
        End Set
    End Property
End Class

Remarks

Controls, such as TextBox and those that derive from ListControl, provide a text property that can be changed by a page user. When the text property is changed, an event is raised to notify handlers that the property has changed. Classes that implement IEditableTextControl must define the TextChanged event.

Although the IEditableTextControl interface contains only the TextChanged event, it inherits from the ITextControl interface, which defines a Text property. To implement the IEditableTextControl interface, a control must define the Text property and the TextChanged event that occurs when the Text property changes between posts to the server.

IEditableTextControl is implemented by TextBox and ListControl. In those classes, the event is raised through the ListControl.OnTextChanged or TextBox.OnTextChanged methods. A class that implements the IEditableTextControl interface could define a similar method for raising the event.

Properties

Text	Gets or sets the text content of a control. (Inherited from ITextControl)

Events

TextChanged

Occurs when the content of the text changes between posts to the server.

Applies to

Dela via