SignInControl Members

Article
10/05/2012

[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.

Top

Public Properties

(see also Protected Properties)

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

Top

Protected Properties

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

Top

Public Methods

(see also Protected Methods)

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

Top

Protected Methods

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

Top

Public Events

(see also Protected Events)

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

Top

Protected Events

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

Top