Smartsite Documentatie > Advanced > Developer > Class Library Reference > Smartsite.Runtime.Modules Namespace
This document is provided on an "AS IS" basis without warranties of any kind. Smartsite iXperion class libraries may change in future releases.
Smartsite SXML modules.

Syntax

C# Copy imageCopy Code 
                          namespace Smartsite.Runtime.Modules
Visual Basic (Declaration) Copy imageCopy Code 
                          Namespace Smartsite.Runtime.Modules

Classes

  Class Description
Public class AddFileProperties
Adds custom properties to a file on disk
Public class AIMReferencesModule
Renders items in order to collect AIM references.
Public class AIMRendertemplateModule
AIM Rendering macro
Public class AIMScanModule
AIM scanning macro. Scans itemdata for references
Public class AspNetAppModule
Asp.Net application macro. Used to incorporate ASP.NET applications.
Public class AuditViperModule
Supports to write audit trail information and to format/present audit information.
Public class BinaryBase
Provides base functionality for modules outputting binary data.
Public class BinaryDataModule
Returns binary data from images or word documents.
Public class BufferModule
Macro used to store or retrieve buffers.
Public class CacheBase
Cache macro. Used to cache blocks of SXML.
The cache key is auto-generated based on the SXML in the Xml (default) parameter.
Public class CachedData
Cache macro. Used to cache blocks of SXML.
The cache key is auto-generated based on the SXML in the Xml (default) parameter.
Public class CacheFile
Implements file based caching on the given page output.
Public class ChannelViperModule
Viper module for representing Channel state
Public class ChartModule
Creates a chart using the data given by the inputdata parameter and the defined formatting rules.
Public class CharViperMethodsModule
String library functions for Viper
Public class CmsAddItem
Adds a new allocated item to the specified parent, optionally using the specified XmlData, and returns the item number.
Public class CmsItemDataModule
Library methods for retrieving the current Cms item's properties.
Public class CmsLoadData
Loads data based on the specified metatype xml.
Public class CmsLoadItem
Loads an Cms Item and returns it as Xml.
Public class CmsNewDataModule
Provides access to the necessary data to help creating a new item or another new CMS metalayer document.
Public class CmsSaveData
Saves the data based on the specified metatype xml.
Public class CmsSaveItem
Saves an Cms item. Returns true when the item has been saved successfully.
Public class CmsSaveModule
Saves items into to the CMS.
Public class CmsServer
Public class CmsSettings
This macro can be used to construct a settings object for various other cms-related macros, such as se:cmssaveitem and se:cmsloaditem. The result of this macro is XmlData (serialized version of the settings object), and this result should be passed to the settings parameter of the appropriate macro.
Public class CmsViperModule
Viper library functions
Public class CodeModule
Represents source code that will be compiled and executed using the CodeDom. The first class deriving from Module.
Public class ColorModule
Viper methods operating on color values.
Public class ContentAccessViperModule
Viper methods concerning ContentAccess
Public class ContentTypeViperModule
Viper module for representing Channel state
Public class ConvertViperModule
Contains system viper methods
Public class CssModule
Converts LESS CSS to CSS.
Public class DatabaseViperModule
Contains database viper methods
Public class DataTableViperModule
Contains DataTable viper methods
Public class DateTimeViperMethods
Class with DateTime Viper methods.
Public class DebugViperModule
Contains system viper methods
Public class DoWhileModule
Executes statements while the given expression evaluates to true.
The expression is tested at the end of each loop.
Public class DoWhileModulebase
Executes statements while the given expression evaluates to true.
This is an abstract class that provides the base implementation for the DoWhile and While macros.
Public class Embed
Renders items and includes the result data.
Public class EmbedBase
Embeds data from other internet locations, either in the current site or externally.
Public class EmbedPreview
Preview existing items.
Public class EmbedUri
Retrieves data from internet locations.
Public class EnvViperModule
Library functions for Viper
Public class ExpressionModule
Returns the result of the given expression.
Public class FileSystemViperModule
Static Viper methods pertaining to the file system
Public class FilterByHierarchyModule
Filters content by using the Cms hierarchy.
Public class FilteringModule
Filters and sorts records from the InputData reader.
Public class FlexLayoutModule
The flexlayout macro.
Public class FlexLayoutModule..::..FlexReader
A fast, lightweight and non-destructive xml reader
Public class FlexLayoutModule..::..FlexReader..::..FlexReaderAttributes
Public class ForLoopModule
Executes statements a given number of times.
Public class FormatModule
Formats the given datatable.
Public class Hidden
Executes statements but suppresses any direct output.
Used to contain bulk statements that create or manipulate state or otherwise don't return any string results.
Public class HtmlPageModule
Html container macro that helps you setting the doctype and the encoding of the document.
Public class HtmlViperModule
Holds static Viper methods for Html string building.
Public class IfElseModule
Forks the execution to one of 2 child nodes.
Public class ImageFromHtml
Creates an image from the specified web page.
Public class ImpersonateModule
Impersonation macro. Executes the embedded Sxml under the credentials of the specified user.
Public class InstanceCreator
Helper class to increase performance by avoiding reflection.
Public class ItemDataModule
Library methods for retrieving the current Cms item's properties.
Public class JoinModule
Joins two DataTables into one.
Public class JsonModule
The JSON macro can parse a JSON string. It exposes properties to query the resulting object and methods to modify it.
Public class LicenseViperModule
Library functions for Viper
Public class LinkModule
Creates a link to an item if it exists, or just returns the text of the link if the item does not exist.
Public class LocaleModule
Class with Localization Viper methods.
Public class LoggingModule
Contains logging
Public class LoginModule
Secure login to the Membership Provider.
Public class LoremModule
Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Public class MathViperModule
Viper Math library
Public class Metadata
Provides metadata that can be included in an HTML page and forwarded to external components such as the PDF generator and Image Processor.
Public class MetaDirModule
Returns the directory listing of a specified path.
Public class NoAIMModule
Provides a way to skip AIM scanning for anything contained within this macro.
Public class PageTranslationsModule
Facilitates the creation of page-local translations that expose functionality during the rendering of a page.
Public class PagingModule
Paging macro. Holds state for paging through large datasets.
Can be used in combination with existing datatables to page through large datasets.
Use in combination with macros/vipers that return datatables.
Public class ParentsModule
Shows links to parent pages.
Public class PdfModule
Creates PDF documents from HTML sources.
Public class PersonalizationModule
Personalization class.
Public class PlaceHolder
Represents a datatable that can be accessed from other elements while in scope, then formatted and rendered when going out of scope.
Public class PlaceholderData
Represents data to add to a given placeholder.
Public class Product
ShoppingCart Product
Public class PublicationViperModule
Publications viper class
Public class RegionModule
The region macro declares a scope for SXML execution and allows for external rendering in ASP.NET.
Public class RemarkModule
Serverside comment module. All data within rem tags is ignored by the parser, and removed from the output.
Public class RenderTemplateModule
Contains DataTable viper methods
Public class Replace
Replaces strings in the contained data.
Public class RequestViperModule
Request class
Public class ResponseViperModule
Request class
Public class RSS
Creates an RSS feed based on the items under the given parent.
Public class ScheduledJobModule
Starts a ScheduledJob.
Public class SendMailModule
Sends SMTP mail messages.
Public class SessionModule
Global Viper methods for session state.
Public class ShoppingCart
ShoppingCart class.
Public class ShoppingCartModule
Shopping Cart Macro.
Public class SiblingsModule
Siblings module allows navigating through a data set by displaying links to first, previous, next and last records.
Public class SiteMapModule
Displays the site hierarchy inside a specified folder.
Public class SiteViperModule
Represents Viper methods to access Site properties
Public class SmartWebservice
Executes a webservice request using WCF.
Public class SortModule
Sorts the output of the given data.
Public class SpiceViperModule
Provides vipers to manage commands for the Smartsite Pipeline-Integrated Command Executor (Spice)
Public class SqlQueryModule
Executes sql queries/statements and shows the results.
Public class Statistics
The Statistics class can be used to retrieve page request information for the given items and displays it.
Public class StorageModule
Provides access to global dynamic storage.
Public class StringViperModule
String library functions for Viper
Public class SwitchCaseModule
Forks the execution to one or more matching cases.
Public class SXMLModule
Groups SXML methods
Public class SystemViperModule
Contains system viper methods
Public class TextModule
Acts as container. Used to conditionally execute statements (using [P:Condition]) or to buffer data for later use.

See also IfElseModule, SwitchCaseModule modules.
Public class TextPageModule
Simple text-based render template
Public class TranslationContextModule
Sets a context for translations to execute in.
Public class UrlViperModule
Viper methods for url manipulation.
Public class UserModule
User class.
Public class ViewHierarchyModule
Displays a hierarchy based on a data table.
Public class ViewSourceModule
Outputs encoded SXML Source.
When recurse is set to false, the input data is shown. Otherwise, the result is encoded.
Public class Webservice
Macro to execute a webservice request and embed the result in a page.
Note that this macro will by default return an XmlReader object as result.
Public class WebserviceMethodArguments
Represents webservice method arguments
Public class WebserviceParameters
Represents the basic webservice parameters: method name, SoapAction HTTP header, namespace-uri and -prefix.
Public class WhileModule
Executes statements while the given expression evaluates to true.
The expression is tested at the beginning of each loop.
Public class XHtmlPageModule
Xhtml container macro that helps you setting the doctype, the xml declaration and the encoding of the document.
Public class XLinksModule
Shows links to other pages in the site.
Public class XmlDataTable
Module that creates a DataTable from an xml document
Public class XmlProcessorModule
Native Xml data Macro.
Public class XmlProcessorViperModule
Native Xml Vipers.
Public class XsltModule
Module that performs xslt transformation on xml input.

Enumerations

  Enumeration Description
Public enumeration BindingType
Enumeration which describes the type of WCF binding to be used.
Public enumeration ChangesetAction
Changeset Action enumeration.
Public enumeration ContentSource
Content source enumeration.
Public enumeration ContentStatus
Content Status enumeration.
Public enumeration ContentTypeFieldType
The field type of a ContenType field.
Public enumeration DeleteAttachmentAfterSend
Specifies if attachments on disk should be deleted after send.
Public enumeration DublinCoreElement
Defines the default set of dublin core elements
Public enumeration ExecutionStatus
Execution Status enumeration.
Public enumeration FlexLayoutModule..::..FlexReader..::..AppendMode
Public enumeration FlexLayoutModule..::..FlexReader..::..NodeAttrType
Public enumeration FlexLayoutModule..::..FlexReader..::..NodeType
Public enumeration FolderState
Folder state enumeration.
Public enumeration ImageFormat
Defines the available image formats.
Public enumeration LocaleModule..::..CalendarWeekRule
Defines different rules for determining the first week of the year.
Public enumeration LoremUnitType
Defines the Lorem unit types.
Public enumeration MailPriority
Specifies the priority of a mail message.
Public enumeration NoAIMScanMode
Mode for AIM suppressing.
Public enumeration PagingPosition
Location to move to when paging.
Public enumeration RegionRunMode
Determines the point in time at which SXML code should be executed.
Public enumeration SaveMode
Save mode enumeration.
Public enumeration ShoppingCartPrice
Public enumeration SqlParameterValidationMode
Defines how sql parameters are validated.
Public enumeration SqlQueryModuleExecuteMode
Represents the mode the SqlQueryModule uses to execute its query.
Advanced