Smartsite Documentatie > Advanced > Developer > Class Library Reference > Smartsite.Scf Namespace > Smartlet Class > Smartlet Methods
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 class Smartlet
Visual Basic (Declaration) Copy imageCopy Code 
                                  Public Class Smartlet

The type exposes the following methods.

Public Methods

  Name Description
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.
(Overrides BaseModule..::ApplyProperties(IDictionary<(Of <<'(String, ModulePropertyValue>)>>)).)
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 CurrentSmartletAddValue
Adds a value to the Smartlet property.
Public method Static member CurrentSmartletAttachBehavior Overloaded.
Public method Static member CurrentSmartletCreateLink Overloaded.
Public method Static member CurrentSmartletExistsEvent Overloaded.
Public method Static member CurrentSmartletGetDefault Overloaded.
Public method Static member CurrentSmartletGetEventData Overloaded.
Public method Static member CurrentSmartletGetEventSingleProperty
Gets a single value from the event data sent earlier.
Public method Static member CurrentSmartletGetInstanceLocation Overloaded.
Public method Static member CurrentSmartletGetName Overloaded.
Public method Static member CurrentSmartletGetNamedParam
Gets a named parameter from the current smartlet
Public method Static member CurrentSmartletGetNumber
Get the item number of the smartlet.
Public method Static member CurrentSmartletGetOrigin
Gets the origin of a property.
Public method Static member CurrentSmartletGetResource Overloaded.
Public method Static member CurrentSmartletGetRootFolder
Get the root folder of the smartlet.
Public method Static member CurrentSmartletGetTitle Overloaded.
Public method Static member CurrentSmartletGetValue Overloaded.
Public method Static member CurrentSmartletIsInitialRendering
Determines whether one or more property values come from client data (ajax request, form posting, querystring).
Public method Static member CurrentSmartletMapEventData Overloaded.
Public method Static member CurrentSmartletNoInstance
Specifies that the current execution is not an instance of the Smartlet.
Public method Static member CurrentSmartletReturn Overloaded.
Public method Static member CurrentSmartletSetAjaxError Overloaded.
Public method Static member CurrentSmartletSetResult
Sets the result of the current Smartlet.
Public method Static member CurrentSmartletSetValue
Sets a value in the current smartlet's JSon object to return, when mode=Ajax.
Public method Static member CurrentSmartletTestProperties Overloaded.
Public method Static member CurrentSmartletTriggerEvent
Triggers an event with the given event data.
Public method Static member CurrentSmartletTriggerEventSimple
Triggers an event with the given event data.
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
Code executed after Execute() is fired.
(Overrides Module..::EndExecute()()()().)
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.
(Overrides ContainerModule..::Execute()()()().)
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 GetCurrent Overloaded.
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 Static member GetIdSelector Overloaded.
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 Static member GetNameSelector Overloaded.
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 Static member GetSmartletIcon Overloaded.
Public method Static member GetSmartletId Overloaded.
Public method Static member GetSmartletLocation Overloaded.
Public method GetType (Inherited from Object.)
Public method Initialize Overloaded.
Public method Static member IsAjaxCallback
Determines whether we are in an ajax callback.
Public method IsChildOf
Determines whether the module is a descendant of the given parent
(Inherited from BaseModule.)
Public method Static member IsPreview
Returns true if the Current Smartlet is being rendered in the Preview frame of the Smartlet Editor.
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 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 SetAppId
Sets the unique instance id of this Smartlet. Used for personalization storage.
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 TestAccess
Tests if the current user has at least the given level of content access for the Smartlet.
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.)

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