LSCleanupFormContext Class

Article
10/10/2016

Provides the information necessary for a Web form to perform state cleanup.

Namespace: System.Web.Security.SingleSignOn
Assembly: System.Web.Security.SingleSignOn (in System.Web.Security.SingleSignOn.dll)

Inheritance Hierarchy

System.Object
System.Web.Security.SingleSignOn.LSFormContext
System.Web.Security.SingleSignOn.LSCleanupFormContext

Syntax

public sealed class LSCleanupFormContext : LSFormContext

public ref class LSCleanupFormContext sealed : LSFormContext

[<Sealed>]
type LSCleanupFormContext = 
    class
        inherit LSFormContext
    end

Public NotInheritable Class LSCleanupFormContext
    Inherits LSFormContext

Properties

	Name	Description
	Applications	Gets a DataTable that contains data about the applications used to connect to the Web form. This property is used as the src attribute of an HTML <img> tag.
	CurrentAction	Gets an LSFormAction for casting an LSFormContext object to a more specific context type.(Inherited from LSFormContext.)
	ForeignRealms	A DataTable object that contains the URL of foreign realms that can connect to the Web form. Use the URLs in the ForeignRealms table as the src attribute of an iframe element.
	IsClientNonInteractive	Indicates whether the client is unable to respond to an interactive Web UI.(Inherited from LSFormContext.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Fields

	Name	Description
	DisplayNameColumn	A column in a data table that contains the display name for the logon server to clean up.
	UrlColumn	A column in a data table that contains the URL for a discoverable realm.

Remarks

The Applications and ForeignRealms properties are DataTable objects that are suitable for data binding to an <asp:repeater/> server side ASP.NET control, for example. Each DataTable object has two columns, named DisplayNameColumn and UrlColumn, that gives the information necessary to cleanup.

For LSCleanupFormContext, CurrentAction will be CleanupTopLevel or CleanupNested.

Examples

The URLs in the Applications collection should typically be used as the src attribute of an HTML img tag, and the URLs in the ForeignRealms table should be used as the src attribute of an iframe, as shown in the following example:

    <asp:repeater runat="server" id="ApplicationRepeater">
     <ItemTemplate>
     <img src="<%# DataBinder.Eval(Container.DataItem, 
     LSCleanupFormContext.UrlColumn) %> />
     <%# DataBinder.Eval(Container.DataItem, 
     LSCleanupFormContext.DisplayNameColumn %>
     </ItemTemplate>
    </asp:repeater>
    <asp:repeater runat="server" id="ForeignRealmRepeater">
     <ItemTemplate>Signing out of 
     <%# DataBinder.Eval(Container.DataItem, 
     LSCleanupFormContext.DisplayNameColumn %>
     iframe src="<%# DataBinder.Eval(Container.DataItem, 
     LSCleanupFormContext.UrlColumn %>"/>
     </ItemTemplate>
    </asp:repeater>
     ...
     LSCleanupFormContext ctx = 
    (LSCleanupFormContext)LSAuthenticationObject.Current.FormContext;
     ApplicationRepeater.DataSource = ctx.Applications;
     ApplicationRepeater.DataBind();
     ForeignRealmRepeater.DataSource = ctx.ForeignRealms;
     ForeignRealmRepeater.DataBind();

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.