SignInControl Members

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Base class for SignIn control

The following tables list the members exposed by the SignInControl type.

Protected Constructors

  Name Description
  SignInControl Base constructor for the T:Microsoft.IdentityModel.Web.Controls.SignInControl class.


Public Properties

(see also Protected Properties)

  Name Description
public property AccessKey  (Inherited from WebControl)
public property AppRelativeTemplateSourceDirectory  (Inherited from Control)
public property Attributes  (Inherited from WebControl)
public property AutoSignIn Gets or sets whether automatic sign-in is enabled.
public property BackColor  (Inherited from WebControl)
public property BindingContainer  (Inherited from Control)
public property BorderColor  (Inherited from WebControl)
public property BorderPadding Control border padding size.
public property BorderStyle  (Inherited from WebControl)
public property BorderWidth  (Inherited from WebControl)
public property CheckBoxStyle Gets the style of the checkbox.
public property ClientID  (Inherited from Control)
public property ClientSideSignInFunction Script function name to initiate signin.
public property Controls  Overridden. (Inherited from Control)
public property ControlStyle  (Inherited from WebControl)
public property ControlStyleCreated  (Inherited from WebControl)
public property CssClass  (Inherited from WebControl)
public property DestinationPageUrl Gets or sets the URL to which the user is redirected after signing in.
public property DisplayRememberMe Gets or sets whether to display the “Remember Me” checkbox.
public property Enabled  (Inherited from WebControl)
public property EnableTheming  Overridden. (Inherited from Control)
public property EnableViewState  (Inherited from Control)
public property ErrorAction Gets or sets a LoginFailureAction that takes place if the user signs in incorrectly.
public property ErrorText Gets or sets the text to display if the user signs in incorrectly.
public property ErrorTextStyle Gets the style of the text to display if the user signs in incorrectly.
public property Font  (Inherited from WebControl)
public property ForeColor  (Inherited from WebControl)
public property HasAttributes  (Inherited from WebControl)
public property Height  (Inherited from WebControl)
public property ID  (Inherited from Control)
public property NamingContainer  (Inherited from Control)
public property Orientation Control UI orientation.
public property Page  (Inherited from Control)
public property Parent  (Inherited from Control)
public property RememberMeSet Gets or sets whether the “Remember Me” checkbox is checked.
public property RememberMeText Gets or sets the text of the “Remember Me” checkbox.
public property RequireHttps Gets or sets a value that specifies whether endpoints used by the control must be HTTPS.
public property ServiceConfiguration The ServiceConfiguration used to process security tokens.
public property ShowButtonImage Gets or sets whether to show the sign-in button image.
public property SignInButtonStyle Gets the style of the sign-in button.
public property SignInButtonType Gets or sets the ButtonType of the sign-in button.
public property SignInContext An application context to be passed back during the sign-in process.
public property SignInImageUrl Gets or sets the URL of the sign-in button image.
public property SignInMode Gets or sets the SignInMode with which the user signs in. The two possible values are Session (the default) and Single. Sessions are persisted using a cookie. Single is appropriate for a scenario such as validating a user’s credit card.
public property SignInText Gets or sets the text of the sign-in button.
public property Site  (Inherited from Control)
public property SkinID  Overridden. (Inherited from Control)
public property Style  (Inherited from WebControl)
public property TabIndex  (Inherited from WebControl)
public property TemplateControl  (Inherited from Control)
public property TemplateSourceDirectory  (Inherited from Control)
public property TitleText Gets or sets the title text of the control.
public property TitleTextStyle Title text style.
public property ToolTip  (Inherited from WebControl)
public property UniqueID  (Inherited from Control)
public property Visible  (Inherited from Control)
public property VisibleWhenSignedIn Gets or sets whether the control is visible when the user is already signed in.
public property Width  (Inherited from WebControl)


Protected Properties

  Name Description
protected property ActiveButton ActiveButton from Template Container.
protected property Adapter  (Inherited from Control)
protected property ButtonClientId Button client id.
protected property ChildControlsCreated  (Inherited from Control)
protected property ClientIDSeparator  (Inherited from Control)
protected property Events  (Inherited from Control)
protected property HasChildViewState  (Inherited from Control)
protected property IdSeparator  (Inherited from Control)
protected property IsPersistentCookie Whether or not to write persistent cookie.
protected property IsTrackingViewState  (Inherited from Control)
protected property LoadViewStateByID  (Inherited from Control)
protected property RememberMeClientId RememberMeCheckBox client id.
protected property SignInButton Gets or sets the IButtonControl that will initiate sign in when clicked.
protected property TagKey  (Inherited from WebControl)
protected property TagName  (Inherited from WebControl)
protected property ViewState  (Inherited from Control)
protected property ViewStateIgnoresCase  (Inherited from Control)


Public Methods

(see also Protected Methods)

  Name Description
public method ApplyStyle  (Inherited from WebControl)
public method ApplyStyleSheetSkin  (Inherited from Control)
public method CopyBaseAttributes  (Inherited from WebControl)
public method DataBind  Overridden. (Inherited from Control)
public method Dispose  (Inherited from Control)
public method Equals  (Inherited from Object)
public method FindControl  (Inherited from Control)
public method Focus  (Inherited from Control)
public method GetHashCode  (Inherited from Object)
public method GetType  (Inherited from Object)
public method HasControls  (Inherited from Control)
public method MergeStyle  (Inherited from WebControl)
public method RenderBeginTag  (Inherited from WebControl)
public method RenderControl  (Inherited from Control)
public method RenderEndTag  (Inherited from WebControl)
public method ResolveClientUrl  (Inherited from Control)
public method ResolveUrl  (Inherited from Control)
public method SetRenderMethodDelegate  (Inherited from Control)
public method ToString  (Inherited from Object)


Protected Methods

  Name Description
protected method AddAttributesToRender  (Inherited from WebControl)
protected method AddParsedSubObject  (Inherited from Control)
protected method BuildProfileTree  (Inherited from Control)
protected method ClearChildControlState  (Inherited from Control)
protected method ClearChildState  (Inherited from Control)
protected method ClearChildViewState  (Inherited from Control)
protected method CreateChildControls Overridden. Creates all the child controls that may be rendered.
protected method CreateControlCollection  (Inherited from Control)
protected method CreateControlStyle  (Inherited from WebControl)
protected method DataBind  (Inherited from Control)
protected method DataBindChildren  (Inherited from Control)
protected method EnsureChildControls  (Inherited from Control)
protected method EnsureID  (Inherited from Control)
protected method Finalize  (Inherited from Object)
protected method FindControl  (Inherited from Control)
protected method GetAutoSignInScript  
protected method GetClientScript Return client script containing signin functionality.
protected method GetDesignModeState  (Inherited from Control)
protected method GetReturnUrl Return url to redirect after the signin.
protected method GetSessionTokenContext Ticket context to be persisted with cookie.
protected method HasEvents  (Inherited from Control)
protected method IsLiteralContent  (Inherited from Control)
protected method LoadViewState Overridden. Load view states.
protected method MemberwiseClone  (Inherited from Object)
protected method OnBubbleEvent  (Inherited from Control)
protected method OnDataBinding  (Inherited from Control)
protected method OnInit Overridden. Init the control.
protected method OnPreRender Overridden. Override OnPreRender process.
protected method OnRedirectingToIdentityProvider Raises the redirecting to identity provider event.
protected method OnSecurityTokenReceived Raises the security token received event.
protected method OnSecurityTokenValidated Raises the security token validated event.
protected method OnSessionSecurityTokenCreated Raises the security token validated event.
protected method OnSignedIn Raises after the user is signed in.
protected method OnSignInError Raises when signin error occurred.
protected method RaiseBubbleEvent  (Inherited from Control)
protected method RecreateChildControls  (Inherited from CompositeControl)
protected method Render Overridden. Override Render process.
protected method RenderControl  (Inherited from Control)
protected method ResolveAdapter  (Inherited from Control)
protected method SaveViewState Overridden. Save view states.
protected method SetDesignModeState Overridden. Designer mode state.
protected method SignIn Handle the specifics of a protocol signin.
protected method TrackViewState Overridden. Track view states.


Public Events

(see also Protected Events)

  Name Description
public event DataBinding  (Inherited from Control)
public event Disposed  (Inherited from Control)
public event Init  (Inherited from Control)
public event Load  (Inherited from Control)
public event PreRender  (Inherited from Control)
public event RedirectingToIdentityProvider Event raised before redirecting to an identity provider.
public event SecurityTokenReceived This event fires when the security token is received from the STS.
public event SecurityTokenValidated This event fires when the security token received from the STS is validated.
public event SessionSecurityTokenCreated Event raised after the issued token is validated.
public event SignedIn This event fires when the user has been successfully signed in.
public event SignInError This event fires when there is an error in signing the user in.
public event Unload  (Inherited from Control)


Protected Events

  Name Description
protected event Click Gets or sets the EventHandler invoked when the sign in button is clicked.


See Also


SignInControl Class
Microsoft.IdentityModel.Web.Controls Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.