AddProcessDataResx

Description: Adds resource paths to the process data for later use by resource key tokens. Can include portal-specific, app-theme-specific, and optionally the core API resx paths.

Signature

public IEncodedString AddProcessDataResx(AppThemeLimpet appTheme, bool includeAPIresx = false)

Example

@AddProcessDataResx(appTheme, includeAPIresx)

ButtonIcon

Description: Renders a button with only an icon, using the button text as the title attribute for accessibility.

Signature

public IEncodedString ButtonIcon(ButtonTypes buttontype, String lang = "")

Example

@ButtonIcon(buttontype, lang)

ButtonIconText

Description: Renders a button with an icon followed by text, based on a button type.

Signature

public IEncodedString ButtonIconText(ButtonTypes buttontype, String lang = "")

Example

@ButtonIconText(buttontype, lang)

ButtonText

Description: Renders a button with an icon followed by text.

Signature

public IEncodedString ButtonText(ButtonTypes buttontype, String lang = "")

Example

@ButtonText(buttontype, lang)

ButtonTextIcon

Description: Renders a button with text followed by an icon, based on a button type.

Signature

public IEncodedString ButtonTextIcon(ButtonTypes buttontype, String lang = "")

Example

@ButtonTextIcon(buttontype, lang)

CheckBoxRowECOMode

Description: Creates a checkbox for ECOMode in the settings of a module. Creates a checkbox for ECOMode in the settings of a module.

Signature

public IEncodedString CheckBoxRowECOMode(SimplisityInfo rowData, bool defaultValue = true)

Example

@CheckBoxRowECOMode(rowData, defaultValue)

CKEditor4legacy

Description: Legacy CKEditor 4 implementation. Consider using @Editor() instead. Legacy CKEditor 4 implementation. Consider using @Editor() instead.

Signature

public IEncodedString CKEditor4legacy(SimplisityInfo info, string xpath, bool localized = false, int row = 0, string listname = "", string langauge = "", bool coded = false, string filename = "ckeditor4startup1.js")

Example

@CKEditor4legacy(info, xpath, localized, row, listname, langauge, coded, filename)

DataSourceList

Description: Renders a dropdown list of data sources (MODULEPARAMS) for a given system key.

Signature

public IEncodedString DataSourceList(SimplisityInfo info, int systemkey, string xpath, string attributes = "", bool allowEmpty = true, bool localized = false)

Example

@DataSourceList(info, systemkey, xpath, attributes, allowEmpty, localized)

DisplayEngineFlag

Description: Displays a flag image from a remote engine URL for a given culture code.

Signature

public IEncodedString DisplayEngineFlag(string engineUrl, string cultureCode, string classvalues = "")

Example

@DisplayEngineFlag(engineUrl, cultureCode, classvalues)

DisplayFlag

Description: Displays a flag image for a given culture code, if the image file exists.

Signature

public IEncodedString DisplayFlag(string cultureCode, string classvalues = "")

Example

@DisplayFlag(cultureCode, classvalues)

DropDownCountryCodeList

Description: Renders a dropdown list of country codes.

Signature

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

Example

@DropDownCountryCodeList(info, xpath, attributes, defaultValue, localized, row, listname)

DropDownCultureCodeList

Description: Renders a dropdown list of culture codes for the portal.

Signature

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

Example

@DropDownCultureCodeList(info, xpath, attributes, defaultValue, localized, row, listname)

DropDownCurrencyList

Description: Renders a dropdown list of available currencies.

Signature

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

Example

@DropDownCurrencyList(info, xpath, attributes, defaultValue, localized, row, listname)

DropDownLanguageList

Description: Renders a dropdown list of enabled languages for the portal, with flags.

Signature

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

Example

@DropDownLanguageList(info, xpath, attributes, defaultValue, localized, row, listname)

DropDownSystemKeyList

Description: Renders a dropdown list of active system keys.

Signature

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

Example

@DropDownSystemKeyList(info, xpath, attributes, defaultValue, localized, row, listname)

EditFlag

Description: Displays the flag image for the current editing culture code from session parameters.

Signature

public IEncodedString EditFlag(SessionParams sessionParams, string classvalues = "")

Example

@EditFlag(sessionParams, classvalues)

Editor

Description: Renders a rich text editor (defaulting to Jodit). The specific editor template can be configured in the portal settings or specified directly.

Signature

public IEncodedString Editor(SimplisityInfo info, string xpath, SimplisityRazor model, int row = 0, string listname = "", string editorRazorTemplate = "EditorJoditDefault.cshtml")

Example

@Editor(info, xpath, model, row, listname, editorRazorTemplate)

GetTabUrlByGuid

Description: Gets the URL for a tab by its unique GUID.

Signature

public IEncodedString GetTabUrlByGuid(String tabguid)

Example

@GetTabUrlByGuid(tabguid)

Signature

public IEncodedString GetTabUrlByGuid(SimplisityInfo info, String xpath)

Example

@GetTabUrlByGuid(info, xpath)

GetTreeTabList

Description: Generates a tree-structured HTML list of portal tabs with checkboxes for selection.

Signature

public IEncodedString GetTreeTabList(int portalId, List<int> selectedTabIdList, string treeviewId, string lang = "", string attributes = "", bool showAllTabs = false)

Example

@GetTreeTabList(portalId, selectedTabIdList, treeviewId, lang, attributes, showAllTabs)

ImageUrl

Description: Display Thumbnail Image - DEFAULT RULE: PNG will always output as PNG all other supported image formats will output as WEBP. note: The default rule can be overwritten is the "imgtype" is passed. default rule set by FMC on 9/1/2024 - IMPORTANT: If you need to delete the image file you MUST remove the cache first. The cache holds a link to the locked image file and must be disposed. use: DNNrocketUtils.ClearThumbnailLock(); Display Thumbnail Image. Creates and returns a URL for a resized version of an image. Supports various output formats and cropping. By default, PNGs remain PNGs, and other formats are converted to WEBP. The cache holds a lock on the image file, so use DNNrocketUtils.ClearThumbnailLock() before deleting the original image.

Signature

public IEncodedString ImageUrl(string url, int width = 0, int height = 0)

Example

@ImageUrl(url, width, height)

Signature

public IEncodedString ImageUrl(string url, int width = 0, int height = 0, string imgType = "")

Example

@ImageUrl(url, width, height, imgType)

Signature

public IEncodedString ImageUrl(string url, int width = 0, int height = 0, string imgType = "", bool cropCenter = true)

Example

@ImageUrl(url, width, height, imgType, cropCenter)

Signature

public IEncodedString ImageUrl(string engineUrl, string imgRelPath, int width, int height, string imgType, bool cropCenter)

Example

@ImageUrl(engineUrl, imgRelPath, width, height, imgType, cropCenter)

InjectHiddenFieldData

Description: Add all genxml/hidden/* fields to the template. Renders all nodes under 'genxml/hidden/*' as hidden input fields in the HTML. This is useful for passing data from the model to client-side scripts.

Signature

public IEncodedString InjectHiddenFieldData(SimplisityInfo sInfo)

Example

@InjectHiddenFieldData(sInfo)

LinkInternalUrl

Description: Generates a URL for an internal DNN page (tab) with a specific culture code and optional extra parameters. Generates a URL for an internal DNN page (tab) with a specific culture code and optional extra parameters.

Signature

public IEncodedString LinkInternalUrl(int portalid, int tabid, string cultureCode, PortalSettings portalSettings = null, string[] extraparams = null)

Example

@LinkInternalUrl(portalid, tabid, cultureCode, portalSettings, extraparams)

LinkPageURL

Description: Creates an anchor tag linking to an internal DNN page. The tab ID is read from a SimplisityInfo field.

Signature

public IEncodedString LinkPageURL(SimplisityInfo info, string xpath, bool openInNewWindow = true, string text = "", string attributes = "")

Example

@LinkPageURL(info, xpath, openInNewWindow, text, attributes)

LinkURL

Description: Creates an anchor tag for a URL stored in a SimplisityInfo field. Automatically handles adding 'https://' if missing.

Signature

public IEncodedString LinkURL(SimplisityInfo info, string xpath, bool openInNewWindow = true, string text = "", string attributes = "")

Example

@LinkURL(info, xpath, openInNewWindow, text, attributes)

ModSelectList

Description: Renders a dropdown list of modules for a given portal, showing module references.

Signature

public IEncodedString ModSelectList(SimplisityInfo info, String xpath, int portalId, String attributes = "", bool addEmpty = true )

Example

@ModSelectList(info, xpath, portalId, attributes, addEmpty)

RenderDocumentSelect

Description: Renders a document selection interface.

Signature

public IEncodedString RenderDocumentSelect(string systemKey, string docFolderRel, bool singleselect = true, bool autoreturn = false)

Example

@RenderDocumentSelect(systemKey, docFolderRel, singleselect, autoreturn)

Signature

public IEncodedString RenderDocumentSelect(int portalId, int moduleid, string systemKey, bool singleselect = true, bool autoreturn = false)

Example

@RenderDocumentSelect(portalId, moduleid, systemKey, singleselect, autoreturn)

Signature

public IEncodedString RenderDocumentSelect(ModuleParams moduleParams, bool singleselect = true, bool autoreturn = false)

Example

@RenderDocumentSelect(moduleParams, singleselect, autoreturn)

RenderImageSelect

Description: Renders an image selection interface.

Signature

public IEncodedString RenderImageSelect(string systemKey, string imageFolderRel, bool singleselect = true, bool autoreturn = false)

Example

@RenderImageSelect(systemKey, imageFolderRel, singleselect, autoreturn)

Signature

public IEncodedString RenderImageSelect(int portalId, int moduleid, string systemKey, bool singleselect = true, bool autoreturn = false)

Example

@RenderImageSelect(portalId, moduleid, systemKey, singleselect, autoreturn)

Signature

public IEncodedString RenderImageSelect(ModuleParams moduleParams, bool singleselect = true, bool autoreturn = false)

Example

@RenderImageSelect(moduleParams, singleselect, autoreturn)

RenderLanguageSelector

Description: Renders a language selector component with a dictionary for selector fields.

Signature

public IEncodedString RenderLanguageSelector(string scmd, AppThemeSystemLimpet appThemeSystem, SimplisityRazor model)

Example

@RenderLanguageSelector(scmd, appThemeSystem, model)

Signature

public IEncodedString RenderLanguageSelector(string scmd, Dictionary<string,string> sfieldDict, AppThemeSystemLimpet appThemeSystem, SimplisityRazor model)

Example

@RenderLanguageSelector(scmd, sfieldDict, appThemeSystem, model)

RenderPlugin

Description: Renders a plugin based on its registered interface key. The 'systemdata' object must be available in the model.

Signature

public IEncodedString RenderPlugin(string interfaceKey, string cmd, SimplisityRazor model)

Example

@RenderPlugin(interfaceKey, cmd, model)

RenderRemoteLanguageSelector

Description: Renders a remote language selector component.

Signature

public IEncodedString RenderRemoteLanguageSelector(string scmd, string sfields, AppThemeSystemLimpet appThemeSystem, SimplisityRazor model)

Example

@RenderRemoteLanguageSelector(scmd, sfields, appThemeSystem, model)

Signature

public IEncodedString RenderRemoteLanguageSelector(string scmd, string sfields, AppThemeDNNrocketLimpet appThemeDNNrocket, SimplisityRazor model)

Example

@RenderRemoteLanguageSelector(scmd, sfields, appThemeDNNrocket, model)

RenderTemplate

Description: Renders a Razor template string with the given model. Renders a Razor template string with the given model.

Signature

public IEncodedString RenderTemplate(string razorTemplateName, AppThemeRocketApiLimpet appThemeSystem, SimplisityRazor model, bool cacheOff = false)

Example

@RenderTemplate(razorTemplateName, appThemeSystem, model, cacheOff)

Signature

public IEncodedString RenderTemplate(string razorTemplateName, AppThemeSystemLimpet appThemeSystem, SimplisityRazor model, bool cacheOff = false)

Example

@RenderTemplate(razorTemplateName, appThemeSystem, model, cacheOff)

Signature

public IEncodedString RenderTemplate(string razorTemplateName, AppThemeDNNrocketLimpet appThemeSystem, SimplisityRazor model, bool cacheOff = false)

Example

@RenderTemplate(razorTemplateName, appThemeSystem, model, cacheOff)

Signature

public IEncodedString RenderTemplate(string razorTemplateName, AppThemeLimpet appTheme, SimplisityRazor model, bool cacheOff = false)

Example

@RenderTemplate(razorTemplateName, appTheme, model, cacheOff)

Signature

public IEncodedString RenderTemplate(string razorTemplateName, string moduleRef, AppThemeLimpet appTheme, SimplisityRazor model, bool cacheOff = false)

Example

@RenderTemplate(razorTemplateName, moduleRef, appTheme, model, cacheOff)

Signature

public IEncodedString RenderTemplate(string razorTemplate, SimplisityRazor model, bool debugMode = false)

Example

@RenderTemplate(razorTemplate, model, debugMode)

RenderXml

Description: Renders a display of the XML model from a SimplisityInfo object for debugging purposes.

Signature

public IEncodedString RenderXml(SimplisityInfo info, string xmlidx = "")

Example

@RenderXml(info, xmlidx)

ResourceCSV

Description: Output CSV list of resx values. <br/> @ResourceCSV("Resx File Name", "csv list of resx file keys") Example:<br/> @ResourceCSV("RocketIntra", "test1,test2,test3") Output CSV list of resx values. Example: @ResourceCSV("RocketIntra", "test1,test2,test3")

Signature

public IEncodedString ResourceCSV(String resourceFileKey, string keyListCSV, string lang = "", string resourceExtension = "Text")

Example

@ResourceCSV(resourceFileKey, keyListCSV, lang, resourceExtension)

ResourceKey

Description: Gets a resource string from the resource paths previously added via AddProcessDataResx.

Signature

public IEncodedString ResourceKey(String resourceFileKey, String lang = "", String resourceExtension = "Text")

Example

@ResourceKey(resourceFileKey, lang, resourceExtension)

ResourceKeyJS

Description: Gets a resource string and escapes single quotes for safe use within JavaScript code.

Signature

public IEncodedString ResourceKeyJS(String resourceFileKey, String lang = "", String resourceExtension = "Text")

Example

@ResourceKeyJS(resourceFileKey, lang, resourceExtension)

ResourceKeyMod

Description: Gets a resource string, automatically prepending the key with a module reference and an underscore.

Signature

public IEncodedString ResourceKeyMod(String moduleRef, String resourceFileKey, String lang = "", String resourceExtension = "Text")

Example

@ResourceKeyMod(moduleRef, resourceFileKey, lang, resourceExtension)

TabSelectListOnTabId

Description: Renders a dropdown list of portal tabs (pages), structured as a tree. The value of each option is the TabId.

Signature

public IEncodedString TabSelectListOnTabId(SimplisityInfo info, String xpath, String attributes = "", Boolean allowEmpty = true, bool localized = false, int row = 0, string listname = "", bool showAllTabs = false)

Example

@TabSelectListOnTabId(info, xpath, attributes, allowEmpty, localized, row, listname, showAllTabs)

Translate

Description: Renders a translation icon that can be clicked to trigger a translation action for a specific field.

Signature

public IEncodedString Translate(SimplisityInfo info, string xpath, bool active = true, int row = 0)

Example

@Translate(info, xpath, active, row)

TranslationKeyUp

Description: Generates an 'onkeyup' HTML attribute. When the user types in a field, this script will automatically set the corresponding translation lock to 'locked'.

Signature

public IEncodedString TranslationKeyUp(string fieldId, bool active = true, int row = 0)

Example

@TranslationKeyUp(fieldId, active, row)

TranslationLock

Description: Renders a lock/unlock icon for managing the translation state of a field. It includes a hidden checkbox to store the state.

Signature

public IEncodedString TranslationLock(SimplisityInfo info, string xpath, bool active = true, int row = 0)

Example

@TranslationLock(info, xpath, active, row)