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 StringViperModule

Visual Basic (Declaration)	Copy Code
Public NotInheritable Class StringViperModule

The type exposes the following methods.

Public Methods

	Name	Description
	Abstract	Creates a (plain text) abstract of the specified text, including the specified word(s).
	AddAIMRelation	Adds an item to the AIM relations collection. (Inherited from Module.)
	AppendIfMissing	Appends the second string to the first if the first one doesn't end with the second one.
	AppendIfMissingAny	Appends a string if the source doesn't end with any of the characters specified in anyChars.
	ApplyProperties	Applies the properties from the SXML processing environment into the current module. (Inherited from BaseModule.)
	BBDecode	Decodes a string containing BBCode formatting tags to the equivalent XHTML-formatted string representation.
	BBEncode	Encodes a string containing XHTML formatting tags to the equivalent BBCode-formatted string representation.
	BeginExecute	Override this to execute code before Execute() is fired. Last point to add data to the Cache Signature. (Inherited from Module.)
	Capitalize	Returns a capitalized string.
	Capture	Passes an SXML subtree to the current module. (Inherited from BaseModule.)
	CheckSum	Creates a checksum for the given input.
	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.)
	Concat	Overloaded.
	Contains	Overloaded.
	DecodeAmpersand	Decodes AMP XML entities in the given string.
	DecodeCharEntities	Decodes the HTML character entity references in given string.
	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
	Enclose	Overloaded.
	EncodeAmpersand	Encodes ampersand characters to AMP XML entities in the given string.
	EncodeAttribute	Overloaded.
	EncodeQuotes	Encodes single and double quotes in the given string where single quotes are emitted as numeric entities. Double quote is encoded using AMP QUOT named entity.
	EndExecute	Override this to execute code after Execute() is fired. (Inherited from Module.)
	EndsWith	Overloaded.
	Equals	Overloaded.
	Eval	Evaluates the given string as a Viper expression.
	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.)
	Format	Formats the specified string/number into the specified format. This method always uses the invariant culture.
	FormatSize	Overloaded.
	GetAIMRelations	Gets a list of all outgoing AIM relations created by the macro. (Inherited from BaseModule.)
	GetBuffer	Gets a local buffer. (Inherited from BaseModule.)
	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.)
	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.)
	GetType	(Inherited from Object.)
	HtmlDecode	Overloaded.
	HtmlEncode	Overloaded.
	IfEmpty	Returns the value if it is not empty, the defaultValue otherwise.
	Indent	Overloaded.
	IndexOf	Overloaded.
	Initialize	Called to initialize this Module (Inherited from BaseModule.)
	IsChildOf	Determines whether the module is a descendant of the given parent (Inherited from BaseModule.)
	IsEmpty	Overloaded.
	IsMatch	Overloaded.
	IsNumeric	Checks whether the given object can be cast to an integer.
	JsDecode	Unescapes all Javascript escaped characters such that it becomes a normal string.
	JsEncode	Escapes all characters in the input string such that the output is a valid Javascript string. Escaped character are e.g. Carriage Return, Linefeed, Tab, single quote, double quote and backslash.
	LastIndexOf	Overloaded.
	Length	Returns the length of the given string.
	Literal	Returns a literal string.
	NormalizeLineEndings	Normalizes the line endings to use CrLf characters.
	NormalizeWhitespace	Normalizes the whitespace.
	Pad	Overloaded.
	ParameterExists	Checks whether the given parameter/property is set. (Inherited from BaseModule.)
	PreInitialize	Called just before initialization of the module (Inherited from Module.)
	Quote	Overloaded.
	ReadyExecuting	Method that is called after the module has executed. (Inherited from Module.)
	RemoveTags	Overloaded.
	RemoveVipers	Overloaded.
	RemoveWhitespace	Removes all whitespace.
	Repeat	Repeats the given string.
	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.)
	Split	Overloaded.
	StartsWith	Overloaded.
	Substring	Overloaded.
	SXMLDecode	Overloaded.
	SXMLEncode	Overloaded.
	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.)
	ToHex	Returns the Hex representation of the given string.
	ToLower	Returns a lower case version of the given string.
	ToMD5	Returns the Md5 hash of the given string.
	ToString	Returns a string that represents the current macro. (Inherited from Module.)
	ToString	Returns a String that represents the current Object. (Inherited from Module.)
	ToTitleCase	Returns a "titlecase" version of the given string. Generally, title casing converts the first character of each word to uppercase and the rest of the characters to lowercase. However, a word that is entirely uppercase, such as an acronym, is not converted.
	ToUpper	Returns an upper case version of the given string.
	TrimLeftRight	Overloaded.
	TrimString	Overloaded.
	Truncate	Overloaded.
	UrlDecode	Urldecodes the given string. (Converts a string that has been encoded for transmission in a URL into a decoded string.)
	UrlEncode	Urlencodes the given string.
	XmlDecode	Overloaded.
	XmlEncode	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