|
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 PagingModule
|
|
| Visual Basic (Declaration) |
Copy Code
|
|---|---|
Public Class PagingModule
|
|
The type exposes the following methods.
Public Methods
| Name | Description | |
|---|---|---|
|
AddAIMRelation |
Adds an item to the AIM relations collection.
(Inherited from Module.) |
|
|
ApplyProperties |
Applies the properties to this module.
(Overrides BaseModule..::ApplyProperties(IDictionary<(Of <<'(String, ModulePropertyValue>)>>)).) |
|
|
BeginExecute |
Override this to execute code before Execute() is fired. (Inherited from Module.)Last point to add data to the Cache Signature. |
|
|
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. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
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.) |
|
|
Find |
Finds the specified child module.
(Inherited from BaseModule.) |
|
|
FindExtension |
Finds an extension macro.
(Inherited from BaseModule.) |
|
|
GetActionLink | 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.) |
|
|
GetFirstResult |
Gets the index of the first result on the current page.
|
|
|
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.) |
|
|
GetLastResult |
Gets the index of the last result on the current page.
|
|
|
GetPageLocation | Overloaded. |
|
|
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. (Inherited from BaseModule.)Typically used in the ResultFormat property, to format, convert or encode the result. |
|
|
GetResult |
Returns the result of the macro. (Inherited from BaseModule.)Typically used in the ResultFormat property, to format, convert or encode the result. |
|
|
GetType | (Inherited from Object.) |
|
|
Initialize |
Called to initialize this Module
(Inherited from BaseModule.) |
|
|
Initialized |
Gets a value whether the paging state has been initialized with data.
Use this method to see whether there are no records or the totalcount has not been set (in both situations, GetTotalCount() returns 0). |
|
|
IsChildOf |
Determines whether the module is a descendant of the given parent
(Inherited from BaseModule.) |
|
|
ParameterExists |
Checks whether the given parameter/property is set.
(Inherited from BaseModule.) |
|
|
PreInitialize |
Called just before initialization of the module
(Overrides Module..::PreInitialize(IContext, IProcessingContext).) |
|
|
ReadyExecuting |
Method that is called after the module has executed.
(Inherited from Module.) |
|
|
ScopeTerminated |
Executed when the module is about to get out of scope.
(Inherited from BaseModule.) |
|
|
SetBuffer |
Sets a local buffer.
(Inherited from BaseModule.) |
|
|
SetCurrentPage | Overloaded. |
|
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
|
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.) |
|
|
ToString |
Returns a string that represents the current macro.
(Inherited from Module.) |
|
|
ToString | (Inherited from Module.) |
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.) |
See Also
Smartsite.Runtime.Modules Namespace