AddProcessData

Description: Adds metadata to the current rendering process. This data can be used by other tokens or within the same template. Returns an empty string.

Signature

public IEncodedString AddProcessData(String metaType, String metaValue)

Example

@AddProcessData("mykey", "myvalue")

AddPreProcessData

Description: Adds metadata to a specific cache list before the Razor template is rendered. This allows module code to use this data (e.g., for database queries) before rendering. It requires a unique template name and module ID to create a specific cache key.

Signature

public IEncodedString AddPreProcessData(String metaKey, String metaValue, String templateFullName, String moduleId)

Example

@AddPreProcessData("sortfield", "name", "MyTheme.list.cshtml", "123")

AddCssLinkHeader

Description: Generates a <link> tag to include a CSS file in the HTML header.

Signature

public IEncodedString AddCssLinkHeader(string cssRelPath)

Example

@AddCssLinkHeader("/DesktopModules/MyModule/style.css")

AddJsScriptHeader

Description: Generates a <script> tag to include a JavaScript file in the HTML header.

Signature

public IEncodedString AddJsScriptHeader(string jsRelPath)

Example

@AddJsScriptHeader("/DesktopModules/MyModule/script.js")

HiddenField

Description: Renders a hidden input field bound to a SimplisityInfo data model.

Signature

public IEncodedString HiddenField(SimplisityInfo info, String xpath, String attributes = "", String defaultValue = "", bool localized = false, int row = 0, string listname = "")

Example

@HiddenField(Model.Info, "genxml/hidden/mydata")

TextBox

Description: Renders a text input field bound to a SimplisityInfo data model.

Signature

public IEncodedString TextBox(SimplisityInfo info, String xpath, String attributes = "", String defaultValue = "", bool localized = false, int row = 0, string listname = "", string type = "text")

Example

@TextBox(Model.Info, "genxml/textbox/firstname")

TextBoxDate

Description: Renders a date input field (type='date') bound to a SimplisityInfo data model. The value is formatted as 'yyyy-MM-dd'.

Signature

public IEncodedString TextBoxDate(SimplisityInfo info, String xpath, String attributes = "", String defaultValue = "", bool localized = false, int row = 0, string listname = "")

Example

@TextBoxDate(Model.Info, "genxml/date/startdate")

TextArea

Description: Renders a textarea field bound to a SimplisityInfo data model.

Signature

public IEncodedString TextArea(SimplisityInfo info, String xpath, String attributes = "", String defaultValue = "", bool localized = false, int row = 0, string listname = "")

Example

@TextArea(Model.Info, "genxml/textbox/description")

CheckBox

Description: Renders a single checkbox with a label, bound to a boolean value in a SimplisityInfo data model.

Signature

public IEncodedString CheckBox(SimplisityInfo info, String xpath, String text, String attributes = "", Boolean defaultValue = false, bool localized = false, int row = 0, string listname = "")

Example

@CheckBox(Model.Info, "genxml/checkbox/isactive", "Is Active")

CheckBoxList

Description: Renders a list of checkboxes from a dictionary or comma-separated strings. Each checkbox corresponds to a sub-node in the SimplisityInfo data model.

Signature

public IEncodedString CheckBoxList(SimplisityInfo info, string xpath, Dictionary<string, string> dataDictionary, string attributes = "", bool defaultValue = false, bool localized = false, int row = 0, string listname = "")

Example

@CheckBoxList(Model.Info, "genxml/checkboxlist/options", myDictionary)

RadioButtonList

Description: Renders a list of radio buttons from a dictionary or comma-separated strings, bound to a single field in the SimplisityInfo data model.

Signature

public IEncodedString RadioButtonList(SimplisityInfo info, string xpath, Dictionary<string, string> dataDictionary, string attributes = "", string defaultValue = "", string labelattributes = "", bool localized = false, int row = 0, string listname = "", string inputclass = "")

Example

@RadioButtonList(Model.Info, "genxml/radio/selection", myDictionary)

DropDownList

Description: Renders a dropdown list (select) from a dictionary or comma-separated strings, bound to a single field in the SimplisityInfo data model.

Signature

public IEncodedString DropDownList(SimplisityInfo info, String xpath, Dictionary<string, string> dataDictionary, String attributes = "", String defaultValue = "", bool localized = false, int row = 0, string listname = "")

Example

@DropDownList(Model.Info, "genxml/dropdown/category", myDictionary)

SortableListIndex

Description: Outputs hidden fields required for a sortable list to correctly process the sort order. This includes a unique item reference and the current row index.

Signature

public IEncodedString SortableListIndex(SimplisityInfo info, int row)

Example

@SortableListIndex(Model.Info, i)

EmailOf

Description: Formats an email address from the data model as a 'mailto:' link.

Signature

public IEncodedString EmailOf(SimplisityInfo info, String xpath, string subject = "", string visibleText = "")

Example

@EmailOf(Model.Info, "genxml/textbox/email", "Inquiry")

HtmlOf

Description: HTML-decodes a string from the data model or a direct string, rendering it as raw HTML.

Signature

public IEncodedString HtmlOf(SimplisityInfo info, String xpath)

Example

@HtmlOf(Model.Info, "genxml/richtext/content")

DateOf

Description: Formats a date from the data model or a DateTime object into a string using a specific culture and format.

Signature

public IEncodedString DateOf(SimplisityInfo info, String xpath, String cultureCode, String format = "d")

Example

@DateOf(Model.Info, "genxml/date/publishdate", "en-GB", "D")

Succinct

Description: Shortens a string to a specified length and appends '...' if it was truncated.

Signature

public IEncodedString Succinct(string value, int size, bool showdots = true)

Example

@Succinct(Model.Get("summary"), 100)

BreakOf

Description: Converts newline characters in a string to <br/> tags and HTML-encodes the content.

Signature

public IEncodedString BreakOf(SimplisityInfo info, String xpath)

Example

@BreakOf(Model.Info, "genxml/textbox/multilinetext")

CheckBoxListOf

Description: Displays a formatted list (ul/li) of the selected items from a checkbox list.

Signature

public IEncodedString CheckBoxListOf(SimplisityInfo info, String xpath, String datavalue, String datatext, String attributes = "")

Example

@CheckBoxListOf(Model.Info, "genxml/checkboxlist/options", "1,2,3", "Option 1,Option 2,Option 3")

FileSelectList

Description: Renders a dropdown list of files from a specified directory.

Signature

public IEncodedString FileSelectList(SimplisityInfo info, String xpath, String mappathRootFolder, String attributes = "", Boolean allowEmpty = true, bool localized = false)

Example

@FileSelectList(Model.Info, "genxml/dropdown/templatefile", Server.MapPath("~/MyTemplates"))

FolderSelectList

Description: Renders a dropdown list of subdirectories from a specified directory.

Signature

public IEncodedString FolderSelectList(SimplisityInfo info, String xpath, String mappathRootFolder, String attributes = "", Boolean allowEmpty = true, bool localized = false)

Example

@FolderSelectList(Model.Info, "genxml/dropdown/themefolder", Server.MapPath("~/MyThemes"))

SFields

Description: Generates a 's-fields' HTML attribute containing a JSON object from a series of key-value pairs. This is used for client-side scripting with Simplisity.

Signature

public IEncodedString SFields(params string[] sFields)

Example

@SFields("key1", "value1", "key2", "value2")

SecuritySiteKey

Description: Renders a hidden element containing the current session's site key. This can be used for security validation in client-side calls.

Signature

public IEncodedString SecuritySiteKey(SessionParams sessionParams)

Example

@SecuritySiteKey(Model.SessionParams)