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 imageCopy Code
                                  public sealed class EnvViperModule
Visual Basic (Declaration) Copy imageCopy Code
                                  Public NotInheritable Class EnvViperModule

The type exposes the following methods.

Public Methods

  Name Description
Public method Static member About
Gets the system information.
Public method Static member AboutCompany
Gets the iXperion runtime assembly company name from system information.
Public method Static member AboutCopyright
Gets the iXperion runtime assembly copyright notice from system information.
Public method Static member AboutDate
Gets the iXperion runtime assembly date from system information.
Public method Static member AboutDescription
Gets the iXperion runtime assembly description from system information.
Public method AddAIMRelation
Adds an item to the AIM relations collection.
(Inherited from Module.)
Public method ApplyProperties
Applies the properties from the SXML processing environment into the current module.
(Inherited from BaseModule.)
Public method BeginExecute
Override this to execute code before Execute() is fired.
Last point to add data to the Cache Signature.
(Inherited from Module.)
Public method Capture
Passes an SXML subtree to the current module.
(Inherited from BaseModule.)
Public method CheckTimeout
Checks whether execution has timed out, given the setting of TimeoutMilliseconds()()()().
(Inherited from BaseModule.)
Public method ClearForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method Static member DefaultServerAddress
Returns the default server address of the site.
Public method Dispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from BaseModule.)
Public method DoPreparse
Check whether to preparse data in the given property.
(Inherited from BaseModule.)
Public method DoRecurseTag
Determines whether to recurse on a given tag
Public method EndExecute
Override this to execute code after Execute() is fired.
(Inherited from Module.)
Public method Equals (Inherited from Object.)
Public method EvaluatePropertyExpression
Evaluates an expression in a property with Expression Syntax
(Inherited from Module.)
Public method Execute
Execute the macro. Should be overridden by inherited class.
(Inherited from Module.)
Public method ExecuteRawParameter
Executes the data of a raw parameter.
(Inherited from Module.)
Public method ExistsBuffer
Checks whether a local buffer exists.
(Inherited from BaseModule.)
Public method Find
Finds the specified child module.
(Inherited from BaseModule.)
Public method FindExtension
Finds an extension macro.
(Inherited from BaseModule.)
Public method GetAIMRelations
Gets a list of all outgoing AIM relations created by the macro.
(Inherited from BaseModule.)
Public method GetBuffer
Gets a local buffer.
(Inherited from BaseModule.)
Public method Static member GetCMSAddress Overloaded.
Public method Static member GetCurrentExecutable
Gets the executing assembly.
Public method GetException
Returns the text message of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetExceptionSmartsiteCode
Returns the Smartsite Error code of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetExceptionString
Returns the full information of the exception that has occurred, including the stack trace.
(Inherited from BaseModule.)
Public method GetExceptionType
Returns the full Type name of the exception that has occurred.
(Inherited from BaseModule.)
Public method Static member GetExecutingAssembly
Gets the executing assembly.
Public method GetForcedResult
Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult().
(Inherited from Module.)
Public method GetHashCode (Inherited from Object.)
Public method Static member GetHostValue
Gets a value from the host of the ASP.NET process (such as the TestSuite), if any.
Public method GetInnerException
Returns the text message of the inner exception of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetInnerExceptionSmartsiteCode
Returns Smartsite error code of the inner exception of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetInnerExceptionString
Returns the full information of the inner exception of the exception that has occurred, including the stack trace.
(Inherited from BaseModule.)
Public method GetInnerExceptionType
Returns the full Type name of the inner exception of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetParameter
Gets the value of the given parameter/property.
(Inherited from BaseModule.)
Public method GetParameter
Gets the value of the given parameter/property.
(Inherited from BaseModule.)
Public method GetParent
Gets the parent Module of this module.
(Inherited from BaseModule.)
Public method GetParent
Gets the parent Module of this module, optionally crossing RenderContext boundaries if allowed so by embeds (Sandboxing off).
(Inherited from BaseModule.)
Public method GetRenderTime
Returns the render time of the macro in milliseconds.
(Inherited from Module.)
Public method GetResult
Returns the result of the macro.
Typically used in the ResultFormat property, to format, convert or encode the result.
(Inherited from BaseModule.)
Public method GetResult
Returns the result of the macro.
Typically used in the ResultFormat property, to format, convert or encode the result.
(Inherited from BaseModule.)
Public method GetType (Inherited from Object.)
Public method Static member HostHeaders
Gets a datatable containing the hostheader definitions.
Public method Static member Identity
Returns the identity Smartsite runs under.
Public method Initialize
Called to initialize this Module
(Inherited from BaseModule.)
Public method Static member Is32BitProcessOn64Bit
Returns a boolean indicating whether it's a 32-bit process on a 64-bit OS.
Public method Static member Is64Bit
Returns a boolean indicating whether the OS is 64-bit.
Public method IsChildOf
Determines whether the module is a descendant of the given parent
(Inherited from BaseModule.)
Public method Static member IsHostConnected
Returns true if the ASP.NET process is hosted by an application such as the TestSuite.
Public method Static member IsInteractive
Gets a value indicating whether the current process is running in user interactive mode.
Public method Static member MemoryUsage
Returns the current (private) memory usage (in bytes).
Public method Static member PageCacheInfo
Provides information about the status of the server page cache.
Public method ParameterExists
Checks whether the given parameter/property is set.
(Inherited from BaseModule.)
Public method PreInitialize
Called just before initialization of the module
(Inherited from Module.)
Public method Static member ProcessId
Returns the current process id.
Public method Static member ProductBuild
Gets the value of the build component of the iXperion product version.
Public method Static member ProductFullName
Gets the full name of the iXperion product including version information (eg. Smartsite iXperion RC2 1.0.7.0 (build 2).
Public method Static member ProductFullReleaseName
Gets the full release name of the iXperion product (eg. Smartsite iXperion RC2).
Public method Static member ProductMajorVersion
Gets the value of the major component of the iXperion product version.
Public method Static member ProductMinorVersion
Gets the value of the minor component of the iXperion product version.
Public method Static member ProductName
Gets the iXperion product name (eg. Smartsite iXperion).
Public method Static member ProductReleaseBuildNumber
Gets the build number of the current iXperion release.
Public method Static member ProductReleaseName
Gets the iXperion product release name (eg. RC2).
Public method Static member ProductRevision
Gets the value of the revision component of the iXperion product version.
Public method Static member ProductVersion
Gets the iXperion product version.
Public method ReadyExecuting
Method that is called after the module has executed.
(Inherited from Module.)
Public method ScopeTerminated
Executed when the module is about to get out of scope.
(Inherited from BaseModule.)
Public method Static member ServerAddress
Returns the current server address of the site.
Public method Static member ServerName
Returns the name of the server Smartsite runs on.
Public method Static member ServicesInfo
Returns information about the WCF services running and on which endpoints these services are available.
Public method SetBuffer
Sets a local buffer.
(Inherited from BaseModule.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method TestCondition
Tests whether execution should take place based on the expression in the condition property
(Inherited from Module.)
Public method TestPropertyExpression
Tests whether an expression in a property with Expression Syntax evaluates to true.
(Inherited from Module.)
Public method ThrowCurrentException
Makes Smartsite throw the current exception.
(Inherited from BaseModule.)
Public method ThrowInnerException
Makes Smartsite throw the inner exception.
(Inherited from BaseModule.)
Public method ToString
Returns a string that represents the current macro.
(Inherited from Module.)
Public method ToString
Returns a String that represents the current Object.
(Inherited from Module.)
Public method Static member VerifyMinimalVersion
Verifies whether the current running iXperion release has a version equal or higher than specified version.

Protected Methods

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

Explicit Interface Implementations

  Name Description
Explicit interface implemetation Private method IModuleExec..::..Cancel (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..FinishExecute (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..Initialize (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..SetChildException (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..SetInitialized
Triggers the Initialized status in the module.
(Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..SetProperty (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..SetProperty (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..StartExecute (Inherited from BaseModule.)

See Also

Advanced