Syntax

C#	Copy Code
public class LoginModule

Visual Basic (Declaration)	Copy Code
Public Class LoginModule

The type exposes the following methods.

Public Methods

	Name	Description
	AddAIMRelation	Adds an item to the AIM relations collection. (Inherited from Module.)
	Alert	Shows a dialog to inform the user that log on has failed and reloads the current page to retry logging in. Depends on the 'javascript'- and 'javascriptonload' placeholders. Note: optionally, the 'noscript' placeholder is used to output the error string for scriptless environments.
	ApplyProperties	Applies the properties from the SXML processing environment into the current module. (Inherited from BaseModule.)
	BeginExecute	Begin execute (Overrides Module..::BeginExecute()()()().)
	Capture	Passes an SXML subtree to the current module. (Inherited from BaseModule.)
	CheckTimeout	Checks whether execution has timed out, given the setting of TimeoutMilliseconds()()()(). (Inherited from BaseModule.)
	ClearForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from BaseModule.)
	DoPreparse	Check whether to preparse data in the given property. (Inherited from BaseModule.)
	DoRecurseTag	Determines whether to recurse on a given tag
	EndExecute	Executed after normal execution. (Overrides Module..::EndExecute()()()().)
	Equals	(Inherited from Object.)
	EvaluatePropertyExpression	Evaluates an expression in a property with Expression Syntax (Inherited from Module.)
	Execute	Adds the login scripting and logs a user in. (Overrides Module..::Execute()()()().)
	ExecuteRawParameter	Executes the data of a raw parameter. (Inherited from Module.)
	ExistsBuffer	Checks whether a local buffer exists. (Inherited from BaseModule.)
	Find	Finds the specified child module. (Inherited from BaseModule.)
	FindExtension	Finds an extension macro. (Inherited from BaseModule.)
	GetAIMRelations	Gets a list of all outgoing AIM relations created by the macro. (Inherited from BaseModule.)
	GetBuffer	Gets a local buffer. (Inherited from BaseModule.)
	GetCurrentChallenge	Gets the current password challenge.
	GetException	Returns the text message of the exception that has occurred. (Inherited from BaseModule.)
	GetExceptionSmartsiteCode	Returns the Smartsite Error code of the exception that has occurred. (Inherited from BaseModule.)
	GetExceptionString	Returns the full information of the exception that has occurred, including the stack trace. (Inherited from BaseModule.)
	GetExceptionType	Returns the full Type name of the exception that has occurred. (Inherited from BaseModule.)
	GetForcedResult	Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult(). (Inherited from Module.)
	GetHashCode	(Inherited from Object.)
	GetInnerException	Returns the text message of the inner exception of the exception that has occurred. (Inherited from BaseModule.)
	GetInnerExceptionSmartsiteCode	Returns Smartsite error code of the inner exception of the exception that has occurred. (Inherited from BaseModule.)
	GetInnerExceptionString	Returns the full information of the inner exception of the exception that has occurred, including the stack trace. (Inherited from BaseModule.)
	GetInnerExceptionType	Returns the full Type name of the inner exception of the exception that has occurred. (Inherited from BaseModule.)
	GetParameter	Gets the value of the given parameter/property. (Inherited from BaseModule.)
	GetParameter	Gets the value of the given parameter/property. (Inherited from BaseModule.)
	GetParent	Gets the parent Module of this module. (Inherited from BaseModule.)
	GetParent	Gets the parent Module of this module, optionally crossing RenderContext boundaries if allowed so by embeds (Sandboxing off). (Inherited from BaseModule.)
	GetPreviousChallenge	Gets the previous password challenge.
	GetRenderTime	Returns the render time of the macro in milliseconds. (Inherited from Module.)
	GetResult	Returns the result of the macro. Typically used in the ResultFormat property, to format, convert or encode the result. (Inherited from BaseModule.)
	GetResult	Returns the result of the macro. Typically used in the ResultFormat property, to format, convert or encode the result. (Inherited from BaseModule.)
	GetReturnUrl	Encapsulates all logic to determine the Url to return to when login.return() (the default resultformat) is called. Rules: - cookie returnUrl, or querystring variable returnurl, returnUrl, or ReturnUrl are tested. - if returnUrl is outside site hostheaders, it is ignored, and returnUrl is set to current channel root. - if no returnUrl is set, returnUrl is set to the current page.
	GetType	(Inherited from Object.)
	Initialize	Overloaded.
	IsChildOf	Determines whether the module is a descendant of the given parent (Inherited from BaseModule.)
	ParameterExists	Checks whether the given parameter/property is set. (Inherited from BaseModule.)
	PreInitialize	Called just before initialization of the module (Inherited from Module.)
	ReadyExecuting	Method that is called after the module has executed. (Inherited from Module.)
	RedirectToReturnPage	Used to make the page redirect to the Url that the user
	ScopeTerminated	Executed when the module is about to get out of scope. (Inherited from BaseModule.)
	SetBuffer	Sets a local buffer. (Inherited from BaseModule.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	TestCondition	Tests whether execution should take place based on the expression in the condition property (Inherited from Module.)
	TestPropertyExpression	Tests whether an expression in a property with Expression Syntax evaluates to true. (Inherited from Module.)
	ThrowCurrentException	Makes Smartsite throw the current exception. (Inherited from BaseModule.)
	ThrowInnerException	Makes Smartsite throw the inner exception. (Inherited from BaseModule.)
	ToString	Returns a string that represents the current macro. (Inherited from Module.)
	ToString	Returns a String that represents the current Object. (Inherited from Module.)
	TryLogin	Tries to perform a forms-based login. If logon fails, a SecurityException error is thrown.
	Undo	Overloaded.

Protected Methods

	Name	Description
	Finalize	(Inherited from Object.)
	IsBufferName	Determines whether the data is a buffer name. (Inherited from Module.)
	IsSingleSaveBuffername	Determines whether a single save buffername is used. (Inherited from Module.)
	MemberwiseClone	(Inherited from Object.)
	SetCurrentProperty	Sets the current property. (Inherited from BaseModule.)

Explicit Interface Implementations

	Name	Description
	IModuleExec..::..Cancel	(Inherited from BaseModule.)
	IModuleExec..::..FinishExecute	(Inherited from BaseModule.)
	IModuleExec..::..SetChildException	(Inherited from BaseModule.)
	IModuleExec..::..SetInitialized	Triggers the Initialized status in the module. (Inherited from BaseModule.)
	IModuleExec..::..SetProperty	(Inherited from BaseModule.)
	IModuleExec..::..SetProperty	(Inherited from BaseModule.)
	IModuleExec..::..StartExecute	(Inherited from BaseModule.)

See Also