Breyta

Deila með


PasswordRecovery Class

Definition

Provides user interface (UI) elements that enable a user to recover or reset a lost password and receive it in email.

public ref class PasswordRecovery : System::Web::UI::WebControls::CompositeControl
[System.ComponentModel.Bindable(false)]
public class PasswordRecovery : System.Web.UI.WebControls.CompositeControl
[<System.ComponentModel.Bindable(false)>]
type PasswordRecovery = class
    inherit CompositeControl
Public Class PasswordRecovery
Inherits CompositeControl
Inheritance
Attributes

Examples

The following code example demonstrates using the PasswordRecovery control.

<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
    
    // Set the field label background color if the user name is not found.
    void PasswordRecovery1_UserLookupError(object sender, System.EventArgs e)
    {
        PasswordRecovery1.LabelStyle.ForeColor = System.Drawing.Color.Red;
    }
    
    // Reset the field label background color.
    void PasswordRecovery1_Load(object sender, System.EventArgs e)
    {
        PasswordRecovery1.LabelStyle.ForeColor = System.Drawing.Color.Black;
    }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
    <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
        <form id="form1" runat="server">
            <asp:PasswordRecovery id="PasswordRecovery1" runat="server" BorderStyle="Solid" BorderWidth="1px" BackColor="#F7F7DE"
                Font-Size="10pt" Font-Names="Verdana" BorderColor="#CCCC99" HelpPageText="Need help?" HelpPageUrl="recoveryHelp.aspx" onuserlookuperror="PasswordRecovery1_UserLookupError" onload="PasswordRecovery1_Load" >
                <successtemplate>
                    <table border="0" style="font-size:10pt;">
                        <tr>
                            <td>Your password has been sent to you.</td>
                        </tr>
                    </table>
                </successtemplate>
                <titletextstyle font-bold="True" forecolor="White" backcolor="#6B696B">
                </titletextstyle>
            </asp:PasswordRecovery>

        </form>
    </body>
</html>
<%@ Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
    
    ' Set the field label background color if the user name is not found.
    Sub PasswordRecovery1_UserLookupError(ByVal sender As Object, ByVal e As System.EventArgs)
        PasswordRecovery1.LabelStyle.ForeColor = System.Drawing.Color.Red
    End Sub
    
    ' Reset the field label background color.
    Sub PasswordRecovery1_Load(ByVal sender As Object, ByVal e As System.EventArgs)
        PasswordRecovery1.LabelStyle.ForeColor = System.Drawing.Color.Black
    End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
    <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
        <form id="form1" runat="server">
            <asp:PasswordRecovery id="PasswordRecovery1" runat="server" BorderStyle="Solid" BorderWidth="1px" BackColor="#F7F7DE"
                Font-Size="10pt" Font-Names="Verdana" BorderColor="#CCCC99" HelpPageText="Need help?" HelpPageUrl="recoveryHelp.aspx" onuserlookuperror="PasswordRecovery1_UserLookupError" onload="PasswordRecovery1_Load" >
                <successtemplate>
                    <table border="0" style="font-size:10pt;">
                        <tr>
                            <td>Your password has been sent to you.</td>
                        </tr>
                    </table>
                </successtemplate>
                <titletextstyle font-bold="True" forecolor="White" backcolor="#6B696B">
                </titletextstyle>
            </asp:PasswordRecovery>

        </form>
    </body>
</html>

Remarks

In this topic:

Introduction

The PasswordRecovery control assists users who have forgotten their passwords. It enables a user to request an email message containing either a new password or the password already associated with their user name.

Note

The PasswordRecovery Web control uses Internet email services to send recovered or new passwords to users. There are inherent security risks with sending passwords in email. You should determine whether these security risks are acceptable to your site.

Note

If you are not familiar with the set of login controls available in ASP.NET, see ASP.NET Login Controls Overview before continuing. For a list of other topics related to login controls and membership, see Managing Users by Using Membership.

Users can recover passwords only when the membership provider defined in the MembershipProvider property supports clear text or encrypted passwords. Because hashed passwords cannot be recovered, users at sites that use hashed passwords can only reset their passwords.

Important

Accepting user input is a potential security threat. Malicious users can send data that is intended to expose vulnerabilities or run programs that try generated passwords. To improve security when working with user input, you should use the validation features of your control and secure any data providers that are configured for your control. For more information, see Securing Login Controls, Basic Security Practices for Web Applications, and Securing Membership.

Note

The PasswordRecovery control can be used when a membership user has not been approved (MembershipUser.IsApproved is set to false), but it cannot be used when a membership user has been locked out (MembershipUser.IsLockedOut is set to true).

The email message is sent using the MailDefinition class. To be able to send email to users, you must configure a mail server in your application's Web.config file. You can change the content of the email sent to users by setting a custom message in the MailDefinition property.

Note

It is not possible to guarantee that a user will receive or view an email message. To verify that a user has received a notification by email, consider providing a confirmation link in the message, allowing the user to confirm that the notification was received.

Views

The PasswordRecovery control has three states, or views:

  • UserName view -- Asks the user for their registered user name.

  • Question view -- Requires the user to provide the answer to a stored question to reset the password.

  • Success view -- Tells the user whether the password recovery or reset was successful.

The PasswordRecovery control displays the Question view only when the membership provider defined in the MembershipProvider property supports password question and answer.

The following table lists each style property of the PasswordRecovery control and indicates which view it affects.

Property UserName view Question view Success view
SubmitButtonStyle Yes Yes Yes
FailureTextStyle Yes Yes No
HyperLinkStyle Yes Yes No
InstructionTextStyle Yes Yes No
LabelStyle Yes Yes No
SuccessTextStyle No No Yes
TextBoxStyle Yes Yes No
TitleTextStyle Yes Yes Yes

Styles and Templates

You can use an extensive set of style properties to customize the appearance of the PasswordRecovery control. Alternatively, you can apply custom templates to the three views if you need complete control over the appearance of the control. You can use the QuestionTemplate, SuccessTemplate and UserNameTemplate properties to create templates for these views. If you define a template for a view, the style properties of PasswordRecovery have no effect.

The following table lists the PasswordRecovery control style properties and explains which UI element each style property affects. For a list of which properties each style applies to, see the documentation for the individual style properties.

Style property UI element affected
SubmitButtonStyle Submit buttons on all views.
FailureTextStyle Error text displayed to the user.
HyperLinkStyle Links to other pages.
InstructionTextStyle Instructional text on the page that tells users how to use the control.
LabelStyle Labels for all input fields, such as text boxes.
TextBoxStyle Text entry input fields.
TitleTextStyle Title text for each view.
SuccessTextStyle Text displayed to the user when the password recovery or reset attempt is successful.

The following table lists which template properties apply to each view in the PasswordRecovery control. For a list of the controls that you must set in each template, see the documentation for the individual template properties.

View Template property
UserName UserNameTemplate
Question QuestionTemplate
Success SuccessTemplate

When the PasswordRecovery control is not customized with templates, the AccessKey property of the PasswordRecovery control applies to the first text box in the control and the TabIndex property, which is applied to all text boxes of the control. If the PasswordRecovery control is customized with templates, then the AccessKey property and the TabIndex property are ignored. In this case, set the AccessKey property and the TabIndex property of each template child control directly.

PasswordRecovery control properties represented by text boxes, such as Answer and Question, are accessible during all phases of the page life cycle. The control will pick up any changes made by the end user by means of the TextChanged event triggered by the textboxes.

Validation Groupings

The PasswordRecovery control creates a validation group for all required field validators in the control so that other input controls on the page are not affected by validating the PasswordRecovery control. By default, the ID property of the PasswordRecovery control is used as the name of the validation group. For example, a PasswordRecovery control with the ID "PasswordRecovery1" will use a validation group name of "PasswordRecovery1". If you want the PasswordRecovery control to participate in another validation group, you must template the control.

Applying CSS Styles

The PasswordRecovery control lets you specify CSS style rules in markup. If you use templates to customize the appearance of the PasswordRecovery control, you can specify CSS styles in the markup in the templates. In that case, no extra outer table is required. You can prevent the table from being rendered by setting the RenderOuterTable property to false.

Accessibility

For information about how to configure this control so that it generates markup that conforms to accessibility standards, see Accessibility in Visual Studio and ASP.NET and ASP.NET Controls and Accessibility.

Declarative Syntax

<asp:PasswordRecovery
    AccessKey="string"
    AnswerLabelText="string"
    AnswerRequiredErrorMessage="string"
    BackColor="color name|#dddddd"
    BorderColor="color name|#dddddd"
    BorderPadding="integer"
    BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
        Inset|Outset"
    BorderWidth="size"
    CssClass="string"
    Enabled="True|False"
    EnableTheming="True|False"
    EnableViewState="True|False"
    Font-Bold="True|False"
    Font-Italic="True|False"
    Font-Names="string"
    Font-Overline="True|False"
    Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|Medium|
        Large|X-Large|XX-Large"
    Font-Strikeout="True|False"
    Font-Underline="True|False"
    ForeColor="color name|#dddddd"
    GeneralFailureText="string"
    Height="size"
    HelpPageIconUrl="uri"
    HelpPageText="string"
    HelpPageUrl="uri"
    ID="string"
    MailDefinition-BodyFileName="uri"
    MailDefinition-CC="string"
    MailDefinition-From="string"
    MailDefinition-IsBodyHtml="True|False"
    MailDefinition-Priority="Normal|Low|High"
    MailDefinition-Subject="string"
    MembershipProvider="string"
    OnAnswerLookupError="AnswerLookupError event handler"
    OnDataBinding="DataBinding event handler"
    OnDisposed="Disposed event handler"
    OnInit="Init event handler"
    OnLoad="Load event handler"
    OnPreRender="PreRender event handler"
    OnSendingMail="SendingMail event handler"
    OnSendMailError="SendMailError event handler"
    OnUnload="Unload event handler"
    OnUserLookupError="UserLookupError event handler"
    OnVerifyingAnswer="VerifyingAnswer event handler"
    OnVerifyingUser="VerifyingUser event handler"
    QuestionFailureText="string"
    QuestionInstructionText="string"
    QuestionLabelText="string"
    QuestionTitleText="string"
    runat="server"
    SkinID="string"
    Style="string"
    SubmitButtonImageUrl="uri"
    SubmitButtonText="string"
    SubmitButtonType="Button|Image|Link"
    SuccessPageUrl="uri"
    SuccessText="string"
    TabIndex="integer"
    TextLayout="TextOnLeft|TextOnTop"
    ToolTip="string"
    UserName="string"
    UserNameFailureText="string"
    UserNameInstructionText="string"
    UserNameLabelText="string"
    UserNameRequiredErrorMessage="string"
    UserNameTitleText="string"
    Visible="True|False"
    Width="size"
>
        <FailureTextStyle />
        <HyperLinkStyle />
        <InstructionTextStyle />
        <LabelStyle />
        <MailDefinition
            BodyFileName="uri"
            CC="string"
            From="string"
            IsBodyHtml="True|False"
            Priority="Normal|Low|High"
            Subject="string"
>
                <EmbeddedObjects>
                        <asp:EmbeddedMailObject
                            Name="string"
                            Path="uri"
                        />
                </EmbeddedObjects>
        </MailDefinition>
        <QuestionTemplate>
            <!-- child controls -->
        </QuestionTemplate>
        <SubmitButtonStyle />
        <SuccessTemplate>
            <!-- child controls -->
        </SuccessTemplate>
        <SuccessTextStyle />
        <TextBoxStyle />
        <TitleTextStyle />
        <UserNameTemplate>
            <!-- child controls -->
        </UserNameTemplate>
        <ValidatorTextStyle />
</asp:PasswordRecovery>

Constructors

PasswordRecovery()

Initializes a new instance of the PasswordRecovery class.

Fields

SubmitButtonCommandName

Represents the command to perform when the Submit button is clicked.

Properties

AccessKey

Gets or sets the access key that allows you to quickly navigate to the Web server control.

(Inherited from WebControl)
Adapter

Gets the browser-specific adapter for the control.

(Inherited from Control)
Answer

Gets the answer to the password recovery confirmation question entered by the user.

AnswerLabelText

Gets or sets the label text for the password confirmation answer text box.

AnswerRequiredErrorMessage

Gets or sets the error message displayed to the user when the Answer text box is blank.

AppRelativeTemplateSourceDirectory

Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.

(Inherited from Control)
Attributes

Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.

(Inherited from WebControl)
BackColor

Gets or sets the background color of the Web server control.

(Inherited from WebControl)
BindingContainer

Gets the control that contains this control's data binding.

(Inherited from Control)
BorderColor

Gets or sets the border color of the Web control.

(Inherited from WebControl)
BorderPadding

Gets or sets the amount of padding inside the borders of the PasswordRecovery control.

BorderStyle

Gets or sets the border style of the Web server control.

(Inherited from WebControl)
BorderWidth

Gets or sets the border width of the Web server control.

(Inherited from WebControl)
ChildControlsCreated

Gets a value that indicates whether the server control's child controls have been created.

(Inherited from Control)
ClientID

Gets the control ID for HTML markup that is generated by ASP.NET.

(Inherited from Control)
ClientIDMode

Gets or sets the algorithm that is used to generate the value of the ClientID property.

(Inherited from Control)
ClientIDSeparator

Gets a character value representing the separator character used in the ClientID property.

(Inherited from Control)
Context

Gets the HttpContext object associated with the server control for the current Web request.

(Inherited from Control)
Controls

Gets a ControlCollection object that represents the child controls in a CompositeControl.

(Inherited from CompositeControl)
ControlStyle

Gets the style of the Web server control. This property is used primarily by control developers.

(Inherited from WebControl)
ControlStyleCreated

Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.

(Inherited from WebControl)
CssClass

Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.

(Inherited from WebControl)
DataItemContainer

Gets a reference to the naming container if the naming container implements IDataItemContainer.

(Inherited from Control)
DataKeysContainer

Gets a reference to the naming container if the naming container implements IDataKeysControl.

(Inherited from Control)
DesignMode

Gets a value indicating whether a control is being used on a design surface.

(Inherited from Control)
Enabled

Gets or sets a value indicating whether the Web server control is enabled.

(Inherited from WebControl)
EnableTheming

Gets or sets a value indicating whether themes apply to this control.

(Inherited from WebControl)
EnableViewState

Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.

(Inherited from Control)
Events

Gets a list of event handler delegates for the control. This property is read-only.

(Inherited from Control)
FailureTextStyle

Gets a reference to a collection of properties that define the appearance of error text in the PasswordRecovery control.

Font

Gets the font properties associated with the Web server control.

(Inherited from WebControl)
ForeColor

Gets or sets the foreground color (typically the color of the text) of the Web server control.

(Inherited from WebControl)
GeneralFailureText

Gets or sets the error message to display when there is a problem with the membership provider for the PasswordRecovery control.

HasAttributes

Gets a value indicating whether the control has attributes set.

(Inherited from WebControl)
HasChildViewState

Gets a value indicating whether the current server control's child controls have any saved view-state settings.

(Inherited from Control)
Height

Gets or sets the height of the Web server control.

(Inherited from WebControl)
HelpPageIconUrl

Gets or sets the URL of an image to display next to the link to the Help page.

HelpPageText

Gets or sets the text of the link to the password recovery Help page.

HelpPageUrl

Gets or sets the URL of the password recovery Help page.

HyperLinkStyle

Gets a reference to a collection of properties that define the appearance of hyperlinks on the PasswordRecovery control.

ID

Gets or sets the programmatic identifier assigned to the server control.

(Inherited from Control)
IdSeparator

Gets the character used to separate control identifiers.

(Inherited from Control)
InstructionTextStyle

Gets a reference to a collection of style properties that define the appearance of explanatory text in the PasswordRecovery control.

IsChildControlStateCleared

Gets a value indicating whether controls contained within this control have control state.

(Inherited from Control)
IsEnabled

Gets a value indicating whether the control is enabled.

(Inherited from WebControl)
IsTrackingViewState

Gets a value that indicates whether the server control is saving changes to its view state.

(Inherited from Control)
IsViewStateEnabled

Gets a value indicating whether view state is enabled for this control.

(Inherited from Control)
LabelStyle

Gets a reference to a collection of style properties that define the appearance of text box labels in the PasswordRecovery control.

LoadViewStateByID

Gets a value indicating whether the control participates in loading its view state by ID instead of index.

(Inherited from Control)
MailDefinition

Gets a reference to a collection of properties that define the characteristics of email messages used to send new or recovered passwords to users.

MembershipProvider

Gets or sets the membership provider used to look up user information.

NamingContainer

Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.

(Inherited from Control)
Page

Gets a reference to the Page instance that contains the server control.

(Inherited from Control)
Parent

Gets a reference to the server control's parent control in the page control hierarchy.

(Inherited from Control)
Question

Gets the password recovery confirmation question established by the user on the Web site.

QuestionFailureText

Gets or sets the text to display when the user's answer to the password recovery confirmation question does not match the answer stored in the Web site data store.

QuestionInstructionText

Gets or sets the text to display in the Question view to instruct the user to answer the password recovery confirmation question.

QuestionLabelText

Gets or sets the text of the label for the Question text box.

QuestionTemplate

Gets or sets the template used to display the Question view of the PasswordRecovery control.

QuestionTemplateContainer

Gets the container that a PasswordRecovery control used to create an instance of the QuestionTemplate template. This property provides programmatic access to child controls.

QuestionTitleText

Gets or sets the title for the Question view of the PasswordRecovery control.

RenderingCompatibility

Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.

(Inherited from Control)
RenderOuterTable

Gets or sets a value that indicates whether the control encloses rendered HTML in a table element in order to apply inline styles.

Site

Gets information about the container that hosts the current control when rendered on a design surface.

(Inherited from Control)
SkinID

Gets or sets the skin to apply to the control.

(Inherited from WebControl)
Style

Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.

(Inherited from WebControl)
SubmitButtonImageUrl

Gets or sets the URL of an image to use as the Submit button.

SubmitButtonStyle

Gets a reference to a collection of properties that define the appearance of Submit buttons in the PasswordRecovery control.

SubmitButtonText

Gets or sets the text of the button that submits the form.

SubmitButtonType

Gets or sets the type of Submit button to use when rendering the PasswordRecovery control.

SuccessPageUrl

Gets or sets the URL of the page to display after sending a password successfully.

SuccessTemplate

Gets or sets the template used to display the Success view of the PasswordRecovery control.

SuccessTemplateContainer

Gets the container that a PasswordRecovery control used to create an instance of the SuccessTemplate template. This property provides programmatic access to child controls.

SuccessText

Gets or sets the text to display after sending a password successfully.

SuccessTextStyle

Gets a reference to a collection of style properties that define the appearance of text displayed in the Success view of the PasswordRecovery control.

SupportsDisabledAttribute

Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false.

(Inherited from CompositeControl)
TabIndex

Gets or sets the tab index of the Web server control.

(Inherited from WebControl)
TagKey

Gets the HtmlTextWriterTag value that corresponds to a PasswordRecovery control.

TagName

Gets the name of the control tag. This property is used primarily by control developers.

(Inherited from WebControl)
TemplateControl

Gets or sets a reference to the template that contains this control.

(Inherited from Control)
TemplateSourceDirectory

Gets the virtual directory of the Page or UserControl that contains the current server control.

(Inherited from Control)
TextBoxStyle

Gets a reference to a collection of style properties that define the appearance of text boxes in the PasswordRecovery control.

TextLayout

Gets or sets a value that specifies whether to display the PasswordRecovery control in a horizontal or vertical layout.

TitleTextStyle

Gets a reference to a collection of style properties that define the appearance of title text that appears in the PasswordRecovery control.

ToolTip

Gets or sets the text displayed when the mouse pointer hovers over the Web server control.

(Inherited from WebControl)
UniqueID

Gets the unique, hierarchically qualified identifier for the server control.

(Inherited from Control)
UserName

Gets or sets the text that appears in the User Name text box.

UserNameFailureText

Gets or sets the text displayed when the user name entered by the user is not a valid user name for the Web site.

UserNameInstructionText

Gets or sets the text to display in the UserName view of the PasswordRecovery control to instruct the user to enter a user name.

UserNameLabelText

Gets or sets the text of the label for the User Name text box.

UserNameRequiredErrorMessage

Gets or sets the error message displayed when a user leaves the User Name text box empty.

UserNameTemplate

Gets or sets the template used to display the UserName view of the PasswordRecovery control.

UserNameTemplateContainer

Gets the container that a PasswordRecovery control used to create an instance of the UserNameTemplate template. This property provides programmatic access to child controls.

UserNameTitleText

Gets or sets the title for the UserName view of the PasswordRecovery control.

ValidateRequestMode

Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.

(Inherited from Control)
ValidatorTextStyle

Gets a reference to a collection of Style properties that define the appearance of error messages that are associated with any input validation used by the PasswordRecovery control.

ViewState

Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.

(Inherited from Control)
ViewStateIgnoresCase

Gets a value that indicates whether the StateBag object is case-insensitive.

(Inherited from Control)
ViewStateMode

Gets or sets the view-state mode of this control.

(Inherited from Control)
Visible

Gets or sets a value that indicates whether a server control is rendered as UI on the page.

(Inherited from Control)
Width

Gets or sets the width of the Web server control.

(Inherited from WebControl)

Methods

AddAttributesToRender(HtmlTextWriter)

Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.

(Inherited from WebControl)
AddedControl(Control, Int32)

Called after a child control is added to the Controls collection of the Control object.

(Inherited from Control)
AddParsedSubObject(Object)

Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.

(Inherited from Control)
ApplyStyle(Style)

Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.

(Inherited from WebControl)
ApplyStyleSheetSkin(Page)

Applies the style properties defined in the page style sheet to the control.

(Inherited from Control)
BeginRenderTracing(TextWriter, Object)

Begins design-time tracing of rendering data.

(Inherited from Control)
BuildProfileTree(String, Boolean)

Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.

(Inherited from Control)
ClearCachedClientID()

Sets the cached ClientID value to null.

(Inherited from Control)
ClearChildControlState()

Deletes the control-state information for the server control's child controls.

(Inherited from Control)
ClearChildState()

Deletes the view-state and control-state information for all the server control's child controls.

(Inherited from Control)
ClearChildViewState()

Deletes the view-state information for all the server control's child controls.

(Inherited from Control)
ClearEffectiveClientIDMode()

Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.

(Inherited from Control)
CopyBaseAttributes(WebControl)

Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.

(Inherited from WebControl)
CreateChildControls()

Creates the individual controls that make up the PasswordRecovery control.

CreateControlCollection()

Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.

(Inherited from Control)
CreateControlStyle()

Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers.

(Inherited from WebControl)
DataBind()

Binds a data source to the CompositeControl and all its child controls.

(Inherited from CompositeControl)
DataBind(Boolean)

Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.

(Inherited from Control)
DataBindChildren()

Binds a data source to the server control's child controls.

(Inherited from Control)
Dispose()

Enables a server control to perform final clean up before it is released from memory.

(Inherited from Control)
EndRenderTracing(TextWriter, Object)

Ends design-time tracing of rendering data.

(Inherited from Control)
EnsureChildControls()

Determines whether the server control contains child controls. If it does not, it creates child controls.

(Inherited from Control)
EnsureID()

Creates an identifier for controls that do not have an identifier assigned.

(Inherited from Control)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
FindControl(String, Int32)

Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.

(Inherited from Control)
FindControl(String)

Searches the current naming container for a server control with the specified id parameter.

(Inherited from Control)
Focus()

Sets input focus to a control.

(Inherited from Control)
GetDesignModeState()

Gets design-time data for a control.

(Inherited from Control)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetRouteUrl(Object)

Gets the URL that corresponds to a set of route parameters.

(Inherited from Control)
GetRouteUrl(RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters.

(Inherited from Control)
GetRouteUrl(String, Object)

Gets the URL that corresponds to a set of route parameters and a route name.

(Inherited from Control)
GetRouteUrl(String, RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters and a route name.

(Inherited from Control)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetUniqueIDRelativeTo(Control)

Returns the prefixed portion of the UniqueID property of the specified control.

(Inherited from Control)
HasControls()

Determines if the server control contains any child controls.

(Inherited from Control)
HasEvents()

Returns a value indicating whether events are registered for the control or any child controls.

(Inherited from Control)
IsLiteralContent()

Determines if the server control holds only literal content.

(Inherited from Control)
LoadControlState(Object)

Implements the base LoadControlState(Object) method.

LoadViewState(Object)

Implements the base LoadViewState(Object) method.

MapPathSecure(String)

Retrieves the physical path that a virtual path, either absolute or relative, maps to.

(Inherited from Control)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
MergeStyle(Style)

Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.

(Inherited from WebControl)
OnAnswerLookupError(EventArgs)

Raises the AnswerLookupError event.

OnBubbleEvent(Object, EventArgs)

Determines whether the event for the server control is passed up the page's UI server control hierarchy.

OnDataBinding(EventArgs)

Raises the DataBinding event.

(Inherited from Control)
OnInit(EventArgs)

Implements the base OnInit(EventArgs) method.

OnLoad(EventArgs)

Raises the Load event.

(Inherited from Control)
OnPreRender(EventArgs)

Implements the base OnPreRender(EventArgs) method.

OnSendingMail(MailMessageEventArgs)

Raises the SendingMail event.

OnSendMailError(SendMailErrorEventArgs)

Raises the SendMailError event when an email message cannot be sent to the user.

OnUnload(EventArgs)

Raises the Unload event.

(Inherited from Control)
OnUserLookupError(EventArgs)

Raises the UserLookupError event.

OnVerifyingAnswer(LoginCancelEventArgs)

Raises the VerifyingAnswer event.

OnVerifyingUser(LoginCancelEventArgs)

Raises the VerifyingUser event.

OpenFile(String)

Gets a Stream used to read a file.

(Inherited from Control)
RaiseBubbleEvent(Object, EventArgs)

Assigns any sources of the event and its information to the control's parent.

(Inherited from Control)
RecreateChildControls()

Recreates the child controls in a control derived from CompositeControl.

(Inherited from CompositeControl)
RemovedControl(Control)

Called after a child control is removed from the Controls collection of the Control object.

(Inherited from Control)
Render(HtmlTextWriter)

Writes the CompositeControl content to the specified HtmlTextWriter object, for display on the client.

RenderBeginTag(HtmlTextWriter)

Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.

(Inherited from WebControl)
RenderChildren(HtmlTextWriter)

Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.

(Inherited from Control)
RenderContents(HtmlTextWriter)

Renders the contents of the control to the specified writer. This method is used primarily by control developers.

(Inherited from WebControl)
RenderControl(HtmlTextWriter, ControlAdapter)

Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.

(Inherited from Control)
RenderControl(HtmlTextWriter)

Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.

(Inherited from Control)
RenderEndTag(HtmlTextWriter)

Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.

(Inherited from WebControl)
ResolveAdapter()

Gets the control adapter responsible for rendering the specified control.

(Inherited from Control)
ResolveClientUrl(String)

Gets a URL that can be used by the browser.

(Inherited from Control)
ResolveUrl(String)

Converts a URL into one that is usable on the requesting client.

(Inherited from Control)
SaveControlState()

Saves any server control state changes that have occurred since the time the page was posted back to the server.

SaveViewState()

Saves any state that was modified after the TrackViewState() method was invoked.

SetDesignModeState(IDictionary)

Implements the base IControlDesignerAccessor.SetDesignModeState(IDictionary) method.

SetRenderMethodDelegate(RenderMethod)

Assigns an event handler delegate to render the server control and its content into its parent control.

(Inherited from Control)
SetTraceData(Object, Object, Object)

Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.

(Inherited from Control)
SetTraceData(Object, Object)

Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.

(Inherited from Control)
ToString()

Returns a string that represents the current object.

(Inherited from Object)
TrackViewState()

Implements the base TrackViewState() method.

Events

AnswerLookupError

Occurs when the user enters an incorrect answer to the password recovery confirmation question.

DataBinding

Occurs when the server control binds to a data source.

(Inherited from Control)
Disposed

Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.

(Inherited from Control)
Init

Occurs when the server control is initialized, which is the first step in its lifecycle.

(Inherited from Control)
Load

Occurs when the server control is loaded into the Page object.

(Inherited from Control)
PreRender

Occurs after the Control object is loaded but prior to rendering.

(Inherited from Control)
SendingMail

Occurs before the user is sent a password in email.

SendMailError

Occurs when the SMTP Mail system throws an error while attempting to send an email message.

Unload

Occurs when the server control is unloaded from memory.

(Inherited from Control)
UserLookupError

Occurs when the membership provider cannot find the user name entered by the user.

VerifyingAnswer

Occurs when the user has submitted an answer to the password recovery confirmation question.

VerifyingUser

Occurs before the user name is validated by the membership provider.

Explicit Interface Implementations

IAttributeAccessor.GetAttribute(String)

Gets an attribute of the Web control with the specified name.

(Inherited from WebControl)
IAttributeAccessor.SetAttribute(String, String)

Sets an attribute of the Web control to the specified name and value.

(Inherited from WebControl)
ICompositeControlDesignerAccessor.RecreateChildControls()

Enables a designer to recreate the composite control's collection of child controls in the design-time environment.

(Inherited from CompositeControl)
IControlBuilderAccessor.ControlBuilder

For a description of this member, see ControlBuilder.

(Inherited from Control)
IControlDesignerAccessor.GetDesignModeState()

For a description of this member, see GetDesignModeState().

(Inherited from Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary)

For a description of this member, see SetDesignModeState(IDictionary).

(Inherited from Control)
IControlDesignerAccessor.SetOwnerControl(Control)

For a description of this member, see SetOwnerControl(Control).

(Inherited from Control)
IControlDesignerAccessor.UserData

For a description of this member, see UserData.

(Inherited from Control)
IDataBindingsAccessor.DataBindings

For a description of this member, see DataBindings.

(Inherited from Control)
IDataBindingsAccessor.HasDataBindings

For a description of this member, see HasDataBindings.

(Inherited from Control)
IExpressionsAccessor.Expressions

For a description of this member, see Expressions.

(Inherited from Control)
IExpressionsAccessor.HasExpressions

For a description of this member, see HasExpressions.

(Inherited from Control)
IParserAccessor.AddParsedSubObject(Object)

For a description of this member, see AddParsedSubObject(Object).

(Inherited from Control)

Extension Methods

FindDataSourceControl(Control)

Returns the data source that is associated with the data control for the specified control.

FindFieldTemplate(Control, String)

Returns the field template for the specified column in the specified control's naming container.

FindMetaTable(Control)

Returns the metatable object for the containing data control.

GetDefaultValues(INamingContainer)

Gets the collection of the default values for the specified data control.

GetMetaTable(INamingContainer)

Gets the table metadata for the specified data control.

SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>)

Sets the table metadata and default value mapping for the specified data control.

SetMetaTable(INamingContainer, MetaTable, Object)

Sets the table metadata and default value mapping for the specified data control.

SetMetaTable(INamingContainer, MetaTable)

Sets the table metadata for the specified data control.

TryGetMetaTable(INamingContainer, MetaTable)

Determines whether table metadata is available.

EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>)

Enables Dynamic Data behavior for the specified data control.

EnableDynamicData(INamingContainer, Type, Object)

Enables Dynamic Data behavior for the specified data control.

EnableDynamicData(INamingContainer, Type)

Enables Dynamic Data behavior for the specified data control.

Applies to

See also