This document is provided on an "AS IS" basis without warranties of any kind. Smartsite iXperion class libraries may change in future releases.

Syntax

C#	Copy Code
public sealed class RequestViperModule

Visual Basic (Declaration)	Copy Code
Public NotInheritable Class RequestViperModule

The type exposes the following methods.

Public Methods

	Name	Description
	AddAIMRelation	Adds an item to the AIM relations collection. (Inherited from Module.)
	ApplyProperties	Applies the properties from the SXML processing environment into the current module. (Inherited from BaseModule.)
	BeginExecute	Override this to execute code before Execute() is fired. Last point to add data to the Cache Signature. (Inherited from Module.)
	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.)
	ClientIP	Returns the current client's IP-address.
	Data	Overloaded.
	DataExists	Returns true if the given value exists in the data passed to the request. In a Web environment, this will be the posted form data.
	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	Override this to execute code after Execute() is fired. (Inherited from Module.)
	Equals	(Inherited from Object.)
	EvaluatePropertyExpression	Evaluates an expression in a property with Expression Syntax (Inherited from Module.)
	Execute	Execute the macro. Should be overridden by inherited class. (Inherited from Module.)
	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.)
	GetBody	Returns the http request body as a string
	GetBuffer	Gets a local buffer. (Inherited from BaseModule.)
	GetCookie	Gets a cookie.
	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.)
	GetFileData	Gets a datatable with all data of an uploaded file. Fields: Key, FileName, ContentType, ContentLength, Bytes.
	GetFiles	Gets a datatable with information about the uploaded files. Fields: Key, FileName, ContentType, ContentLength.
	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.)
	GetMetaData	Gets meta data added to the request. In Http traffic, reflects the HTTP headers added to the request.
	GetMimeType	Returns the MIME type of the request.
	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.)
	GetPostPersistanceId	Gets the post persistance id, auto-generated and used to uniquely identify the Post Persistance data.
	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.)
	GetState	Returns the value of the given State variable. Note: Request.State is a wrapper around the HttpContext.Items collection.
	GetTimeout	Gets the current ASP.NET Request timeout.
	GetType	(Inherited from Object.)
	Initialize	Called to initialize this Module (Inherited from BaseModule.)
	IsAimRequest	Gets a value indicating whether the request is an AIM request.
	IsChildOf	Determines whether the module is a descendant of the given parent (Inherited from BaseModule.)
	IsInternal	Gets a value indicating whether this request is done internally.
	IsJson	Gets a value indicating whether this request is a json request.
	IsLocal	Returns true if this client is from the localhost.
	IsPersistedPost	Determines whether a Post request was transferred and persistance data is available.
	IsPostback	Gets a value indicating whether the request is a postback from the same page.
	IsPosted	Gets a value indicating whether the request is posted.
	IsPreview	Returns true if this request is rendered in preview mode.
	IsReferrerCms	Returns true if the current request's referrer is the Cms.
	IsVirtualCmsFile	Gets a value indicating whether this request is done by the Smartsite Virtual Path Provider.
	Location	Gets the current Url.
	MapUrlParameters	Overloaded.
	Method	Gets the request method used in the current request.
	ParameterExists	Checks whether the given parameter/property is set. (Inherited from BaseModule.)
	PersistPostAndTransfer	Overloaded.
	PreInitialize	Called just before initialization of the module (Inherited from Module.)
	Query	Overloaded.
	QueryExists	Returns true if the given Querystring variable exists.
	ReadyExecuting	Method that is called after the module has executed. (Inherited from Module.)
	Referrer	Returns the current request's referrer address.
	SaveFile	Saves an uploaded file to disk.
	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.)
	SetState	Sets the value of the given State variable. Note: Request.State is a wrapper around the HttpContext.Items collection.
	SetTimeout	Sets the current ASP.NET Request timeout. This overrules the executionTimeout setting of the web.config for the current request. Also sets the default execution timeout for macros on the current page.
	StateVariableExists	Returns true if the given State variable exists. Note: Request.State is a wrapper around the HttpContext.Items collection.
	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.)
	Transfer	Overloaded.
	UserAgent	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..::..Initialize	(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.)

Syntax

Public Methods

Protected Methods

Explicit Interface Implementations

See Also