LSCleanupFormContext Class

 

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)

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

public sealed class LSCleanupFormContext : LSFormContext

NameDescription
System_CAPS_pubpropertyApplications

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.

System_CAPS_pubpropertyCurrentAction

Gets an LSFormAction for casting an LSFormContext object to a more specific context type.(Inherited from LSFormContext.)

System_CAPS_pubpropertyForeignRealms

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.

System_CAPS_pubpropertyIsClientNonInteractive

Indicates whether the client is unable to respond to an interactive Web UI.(Inherited from LSFormContext.)

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticDisplayNameColumn

A column in a data table that contains the display name for the logon server to clean up.

System_CAPS_pubfieldSystem_CAPS_staticUrlColumn

A column in a data table that contains the URL for a discoverable realm.

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.

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();

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

Return to top

Community Additions

ADD
Show: