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 class UrlViperModule

Visual Basic (Declaration)	Copy Code
Public Class UrlViperModule

The type exposes the following methods.

Public Methods

	Name	Description
	AddAIMRelation	Adds an item to the AIM relations collection. (Inherited from Module.)
	AddParameter	Overloaded.
	AddParameters	Overloaded.
	AddRequestCommand	Overloaded.
	AddRequestCommands	Adds the given request commands to the location.
	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.)
	Create	Overloaded.
	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.)
	ExistsRequestCommands	Checks whether the given command identifier is present on the given location.
	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.)
	GetBaseUrl	Gets the host name used in the given location.
	GetBookmark	Gets the bookmark specified in the location.
	GetBuffer	Gets a local buffer. (Inherited from BaseModule.)
	GetChannel	Returns the channel the given location maps to, if any.
	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.)
	GetHost	Gets the host name used in the given location.
	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.)
	GetItemCode	Returns the item code the given location maps to, if any.
	GetItemNumber	Returns the item number the given location maps to, if any.
	GetMappedParameterName	Gets the name of a mapped URL parameter at the given index.
	GetParameter	Overloaded.
	GetParameters	Gets a datatable containing all the keys and values from the querystring.
	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.)
	GetPath	Gets the path of the given location.
	GetPathSegments	Gets the segments of the path of the given location.
	GetPort	Gets the port used in the given location.
	GetQuery	Gets the query string of the given location.
	GetRenderTime	Returns the render time of the macro in milliseconds. (Inherited from Module.)
	GetRequestCommand	Gets the given request command parameter from a location.
	GetRequestCommandCount	Gets then number of request command parameters from a location.
	GetRequestCommands	Gets a list of request command parameters from a location.
	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.)
	GetType	(Inherited from Object.)
	Initialize	Called to initialize this Module (Inherited from BaseModule.)
	IsBaseOf	Checks whether the first location is a base of the second location.
	IsChildOf	Determines whether the module is a descendant of the given parent (Inherited from BaseModule.)
	IsLocalFile	Checks whether the given location url maps to a local file.
	MapToFriendlyUrl	Maps the given url to a friendly url.
	MapToNormalUrl	Maps the given friendly url to a normal url.
	MapUrlParameter	Maps the URL parameter at the given position, to enable manipulation of the parameter using normal querystring methods.
	MapUrlParameters	Overloaded.
	Munge	Munges the specified parameters onto the given location.
	ParameterExists	Overloaded.
	PreInitialize	Called just before initialization of the module (Inherited from Module.)
	ReadyExecuting	Method that is called after the module has executed. (Inherited from Module.)
	RemoveAllParameters	Overloaded.
	RemoveBookmark	Gets the value of the given query parameter.
	RemoveParameter	Removes a querystring parameter.
	RemoveParameters	Removes multiple querystring parameters.
	RemoveRequestCommand	Overloaded.
	ScopeTerminated	Executed when the module is about to get out of scope. (Inherited from BaseModule.)
	SetAbsolute	Makes a locator absolute.
	SetBookmark	Sets a bookmark on the given location url.
	SetBuffer	Sets a local buffer. (Inherited from BaseModule.)
	SetChannel	Changes the channel of the given location to the new channel.
	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.)
	SetItemNumber	Changes the item number of the given location to the new item number.
	SetParameter	Overloaded.
	SetParameters	Overloaded.
	SetRelative	Makes a locator relative.
	SetUriEscaping	Sets the URI escaping.
	SetUrlParams	Sets all given parameters as URL Parameters on the given url and returns the location.
	SetXmlEncoding	Sets XML encoding for ampersands.
	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.)
	ToCompactString	Generates a compact string for the location (number or friendly code for CMS items, url for files).
	ToString	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