Smartsite Documentatie > Advanced > Developer > Class Library Reference > Smartsite.Runtime.Modules Namespace > StringViperModule Class > StringViperModule Members
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 StringViperModule
Visual Basic (Declaration) Copy imageCopy Code 
                                  Public NotInheritable Class StringViperModule

The type exposes the following members.

Public Methods

  Name Description
Public method Static member Abstract
Creates a (plain text) abstract of the specified text, including the specified word(s).
Public method AddAIMRelation
Adds an item to the AIM relations collection.
(Inherited from Module.)
Public method Static member AppendIfMissing
Appends the second string to the first if the first one doesn't end with the second one.
Public method Static member AppendIfMissingAny
Appends a string if the source doesn't end with any of the characters specified in anyChars.
Public method ApplyProperties
Applies the properties from the SXML processing environment into the current module.
(Inherited from BaseModule.)
Public method Static member BBDecode
Decodes a string containing BBCode formatting tags to the equivalent XHTML-formatted string representation.
Public method Static member BBEncode
Encodes a string containing XHTML formatting tags to the equivalent BBCode-formatted string representation.
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 Static member Capitalize
Returns a capitalized string.
Public method Capture
Passes an SXML subtree to the current module.
(Inherited from BaseModule.)
Public method Static member CheckSum
Creates a checksum for the given input.
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 Concat Overloaded.
Public method Static member Contains Overloaded.
Public method Static member DecodeAmpersand
Decodes AMP XML entities in the given string.
Public method Static member DecodeCharEntities
Decodes the HTML character entity references in given string.
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 Static member Enclose Overloaded.
Public method Static member EncodeAmpersand
Encodes ampersand characters to AMP XML entities in the given string.
Public method Static member EncodeAttribute Overloaded.
Public method Static member 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.
Public method EndExecute
Override this to execute code after Execute() is fired.
(Inherited from Module.)
Public method Static member EndsWith Overloaded.
Public method Static member Equals Overloaded.
Public method Static member Eval
Evaluates the given string as a Viper expression.
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 Static member Format
Formats the specified string/number into the specified format. This method always uses the invariant culture.
Public method Static member FormatSize Overloaded.
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 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 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 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 HtmlDecode Overloaded.
Public method Static member HtmlEncode Overloaded.
Public method Static member IfEmpty
Returns the value if it is not empty, the defaultValue otherwise.
Public method Static member Indent Overloaded.
Public method Static member IndexOf Overloaded.
Public method Initialize
Called to initialize this Module
(Inherited from BaseModule.)
Public method IsChildOf
Determines whether the module is a descendant of the given parent
(Inherited from BaseModule.)
Public method Static member IsEmpty Overloaded.
Public method Static member IsMatch Overloaded.
Public method Static member IsNumeric
Checks whether the given object can be cast to an integer.
Public method Static member JsDecode
Unescapes all Javascript escaped characters such that it becomes a normal string.
Public method Static member 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.
Public method Static member LastIndexOf Overloaded.
Public method Static member Length
Returns the length of the given string.
Public method Static member Literal
Returns a literal string.
Public method Static member NormalizeLineEndings
Normalizes the line endings to use CrLf characters.
Public method Static member NormalizeWhitespace
Normalizes the whitespace.
Public method Static member Pad Overloaded.
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 Quote Overloaded.
Public method ReadyExecuting
Method that is called after the module has executed.
(Inherited from Module.)
Public method Static member RemoveTags Overloaded.
Public method Static member RemoveVipers Overloaded.
Public method Static member RemoveWhitespace
Removes all whitespace.
Public method Static member Repeat
Repeats the given string.
Public method ScopeTerminated
Executed when the module is about to get out of scope.
(Inherited from BaseModule.)
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 Static member Split Overloaded.
Public method Static member StartsWith Overloaded.
Public method Static member Substring Overloaded.
Public method Static member SXMLDecode Overloaded.
Public method Static member SXMLEncode Overloaded.
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 Static member ToHex
Returns the Hex representation of the given string.
Public method Static member ToLower
Returns a lower case version of the given string.
Public method Static member ToMD5
Returns the Md5 hash of the given string.
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 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.
Public method Static member ToUpper
Returns an upper case version of the given string.
Public method Static member TrimLeftRight Overloaded.
Public method Static member TrimString Overloaded.
Public method Static member Truncate Overloaded.
Public method Static member UrlDecode
Urldecodes the given string. (Converts a string that has been encoded for transmission in a URL into a decoded string.)
Public method Static member UrlEncode
Urlencodes the given string.
Public method Static member XmlDecode Overloaded.
Public method Static member XmlEncode Overloaded.

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.)

Protected Fields

  Name Description
Protected field DoExecute
Specifies whether to execute the module
(Inherited from BaseModule.)
Protected field InternalAIMMode
Cotnains the internal AIM mode.
(Inherited from Module.)
Protected field InternalCopyFormatting
The id of the macro to copy the formatting settings from.
(Inherited from Module.)
Protected field InternalFormatting
Formatting settings.
(Inherited from Module.)
Protected field ResolvingSaveBuffers
True when save buffers are evaluated.
(Inherited from BaseModule.)
Protected field savingUnformattedResult
True when save buffers are checked before formatting is applied, to facilitate unformated data to be saved.
(Inherited from BaseModule.)

Public Properties

  Name Description
Public property AcceptsInnerXml
Returns true if the module currently accepts string data within the macro tags.
(Inherited from BaseModule.)
Public property AccessDeniedReturnValue
Gets or sets the value that is returned when the site visitor has insufficient access.
(Inherited from Module.)
Public property AIMMode
Gets or sets the AIM scanning mode of the macro.
(Inherited from Module.)
Public property AIMOrigin
Returns the current AIM source. If AIMMode is Autonomous, the current instructionsource is used, otherwise the current item.
(Inherited from Module.)
Public property BufferNames
Gets or sets the buffer names.
(Inherited from Module.)
Public property Condition
Gets or sets the Viper expression to evaluate before actually executing the macro.
If the expression returns false, the execution of the module and its child modules is skipped.
(Inherited from Module.)
Public property ConditionMatched
Must return true if TestCondition() matched.
(Inherited from Module.)
Public property CurrentCacheModule
Returns a reference to the current cache module, if the current instruction is encapsulated by a cache block.
(Inherited from Module.)
Public property CurrentProperty
Gets the property currently being set on the module.
(Inherited from BaseModule.)
Public property DefaultValue
Gets or sets the default value that will be returned when the execution would otherwise return an empty string.
(Inherited from Module.)
Public property Formatting
Gets the formatting options.
(Inherited from Module.)
Public property HasParameterSection
Returns true if the macro currently uses an SXML parameters section
(Inherited from BaseModule.)
Public property Id
Gets or sets the unique id of the module instance during the current processing.
Modules with Id set will be kept alive during the complete rendering and can be accessed from other modules using the Find method.
(Inherited from BaseModule.)
Public property IsCancelled
Gets a value indicating whether the execution of the macro is cancelled.
(Inherited from BaseModule.)
Public property IsSelfClosing
Gets a value indicating whether this instance is self closing.
(Inherited from BaseModule.)
Public property LocalId
Gets or sets the local id of the macro in the current buffer scope.
(Inherited from Module.)
Public property MinimumAccessTypeLevel
Friendly name of the minimum access type level required by the site visitor to execute this macro.
(Inherited from Module.)
Public property ModuleInfo
Gets the module info.
(Inherited from BaseModule.)
Public property OnErrorReturnValue
Gets or sets the value to return in case on error occurs during execution.
The Viper expressions this.error(), this.error(full) and this.error(type) are available in this context.
(Inherited from Module.)
Public property Properties
Gets the full list of properties as set when executing the module.
(Inherited from BaseModule.)
Public property Remarks
Gets or sets the remarks. Remarks have no effect on the actual execution of the module.
They only improve the readability of the code.
(Inherited from BaseModule.)
Public property Result
Returns a reference to the module result
(Inherited from BaseModule.)
Public property ResultFormat
Gets or sets the resultformat.
(Inherited from Module.)
Public property ResultType
Gets or sets the type of the result.
(Inherited from BaseModule.)
Public property State
Gets a key/value collection that can be used to organize and share data during the lifecycle of a module.
(Inherited from BaseModule.)
Public property Status
Gets a value indicating the ModuleStatus of this module.
(Inherited from BaseModule.)
Public property SXMLPath
Gets the path to the macro in the current execution stack.
(Inherited from BaseModule.)
Public property TimeoutSeconds
Gets or sets the timeout in seconds. In the overriden Execute() method, you can call CheckTimeout() to check whether execution has timed out.
(Inherited from BaseModule.)
Public property Trim
Gets a value indicating how the whitespace is trimmed.
(Inherited from BaseModule.)
Public property TypeName
Gets the name of the Module type.
(Inherited from BaseModule.)
Public property UserSetPropertyList
Gets the user-set property list.
(Inherited from BaseModule.)
Public property Whitespace
Gets a value indicating whether to preserve whitespace.
(Inherited from BaseModule.)

Protected Properties

  Name Description
Protected property IContext
Gets a reference to the IContext interface.
(Inherited from BaseModule.)

Public Events

  Name Description
Public event SetProperty
Event fired just before setting a property on the Module instance from the SXML processor.
(Inherited from BaseModule.)
Public event StatusChange
Event raised when the execution status changes.
(Inherited from BaseModule.)

Explicit Interface Implementations

See Also

Advanced