Methods
RenderFooter
RenderFooter Overload 1
Renders the footer widgets in their configured layout.
Velocity
#set($stringResponse = $context_v2_themeBody.RenderFooter())
JavaScript
var stringResponse = context_v2_themeBody.RenderFooter();
RenderFooter Overload 2
Renders the footer widgets in their configured layout.
Velocity
#set($stringResponse = $context_v2_themeBody.RenderFooter("%{ ContentFragmentHeaderLeaderHtml = $contentFragmentHeaderLeaderHtmlArg, ContentFragmentHeaderTrailerHtml = $contentFragmentHeaderTrailerHtmlArg, ContentFragmentLeaderHtml = $contentFragmentLeaderHtmlArg, ContentFragmentTrailerHtml = $contentFragmentTrailerHtmlArg, DefaultWrappingFormatWithHeader = $defaultWrappingFormatWithHeaderArg, DefaultWrappingFormatWithoutHeader = $defaultWrappingFormatWithoutHeaderArg, InheritContentFragmentsFromParentDepth = $inheritContentFragmentsFromParentDepthArg, InheritContentFromParentDepth = $inheritContentFromParentDepthArg, LayoutReflowMinWidth = $layoutReflowMinWidthArg, LayoutRegionLeaderHtml = $layoutRegionLeaderHtmlArg, LayoutRegionTrailerHtml = $layoutRegionTrailerHtmlArg, WrappingFormats = $wrappingFormatsArg }"))JavaScript
var stringResponse = context_v2_themeBody.RenderFooter({ ContentFragmentHeaderLeaderHtml: contentFragmentHeaderLeaderHtmlArg, ContentFragmentHeaderTrailerHtml: contentFragmentHeaderTrailerHtmlArg, ContentFragmentLeaderHtml: contentFragmentLeaderHtmlArg, ContentFragmentTrailerHtml: contentFragmentTrailerHtmlArg, DefaultWrappingFormatWithHeader: defaultWrappingFormatWithHeaderArg, DefaultWrappingFormatWithoutHeader: defaultWrappingFormatWithoutHeaderArg, InheritContentFragmentsFromParentDepth: inheritContentFragmentsFromParentDepthArg, InheritContentFromParentDepth: inheritContentFromParentDepthArg, LayoutReflowMinWidth: layoutReflowMinWidthArg, LayoutRegionLeaderHtml: layoutRegionLeaderHtmlArg, LayoutRegionTrailerHtml: layoutRegionTrailerHtmlArg, WrappingFormats: wrappingFormatsArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | Options | Set of optional parameters including: | Required | ||
| ContentFragmentHeaderLeaderHtml | String | HTML to render before each content fragment header. | Optional | ||
| ContentFragmentHeaderTrailerHtml | String | HTML to render after each content fragment header. | Optional | ||
| ContentFragmentLeaderHtml | String | HTML to render before each content fragment. | Optional | ||
| ContentFragmentTrailerHtml | String | HTML to rneder after each content fragment. | Optional | ||
| DefaultWrappingFormatWithHeader | String | The CssClass of the default wrapping format to use when a header is included | Optional | ||
| DefaultWrappingFormatWithoutHeader | String | The CssClass of the default wrapping format to use when a header is not included | Optional | ||
| InheritContentFragmentsFromParentDepth | Number | Depth of parent themes from which to load content fragments. | Optional | 10 | |
| InheritContentFromParentDepth | Number | Depth of parent themes from which to load locked content. | Optional | 10 | |
| LayoutReflowMinWidth | Number | The minimum width at which the layout reflows to single column mode. | Optional | ||
| LayoutRegionLeaderHtml | String | HTML to render before each layout region. | Optional | ||
| LayoutRegionTrailerHtml | String | HTML to render after each layout region. | Optional | ||
| WrappingFormats | ArrayList | List of dictionaries with Name, CssClass, and IncludeHeader | Optional |
Returns
RenderHeader
RenderHeader Overload 1
Renders header widgets in their configured layout.
Velocity
#set($stringResponse = $context_v2_themeBody.RenderHeader())
JavaScript
var stringResponse = context_v2_themeBody.RenderHeader();
RenderHeader Overload 2
Renders header widgets in their configured layout.
Velocity
#set($stringResponse = $context_v2_themeBody.RenderHeader("%{ ContentFragmentHeaderLeaderHtml = $contentFragmentHeaderLeaderHtmlArg, ContentFragmentHeaderTrailerHtml = $contentFragmentHeaderTrailerHtmlArg, ContentFragmentLeaderHtml = $contentFragmentLeaderHtmlArg, ContentFragmentTrailerHtml = $contentFragmentTrailerHtmlArg, DefaultWrappingFormatWithHeader = $defaultWrappingFormatWithHeaderArg, DefaultWrappingFormatWithoutHeader = $defaultWrappingFormatWithoutHeaderArg, InheritContentFragmentsFromParentDepth = $inheritContentFragmentsFromParentDepthArg, InheritContentFromParentDepth = $inheritContentFromParentDepthArg, LayoutReflowMinWidth = $layoutReflowMinWidthArg, LayoutRegionLeaderHtml = $layoutRegionLeaderHtmlArg, LayoutRegionTrailerHtml = $layoutRegionTrailerHtmlArg, WrappingFormats = $wrappingFormatsArg }"))JavaScript
var stringResponse = context_v2_themeBody.RenderHeader({ ContentFragmentHeaderLeaderHtml: contentFragmentHeaderLeaderHtmlArg, ContentFragmentHeaderTrailerHtml: contentFragmentHeaderTrailerHtmlArg, ContentFragmentLeaderHtml: contentFragmentLeaderHtmlArg, ContentFragmentTrailerHtml: contentFragmentTrailerHtmlArg, DefaultWrappingFormatWithHeader: defaultWrappingFormatWithHeaderArg, DefaultWrappingFormatWithoutHeader: defaultWrappingFormatWithoutHeaderArg, InheritContentFragmentsFromParentDepth: inheritContentFragmentsFromParentDepthArg, InheritContentFromParentDepth: inheritContentFromParentDepthArg, LayoutReflowMinWidth: layoutReflowMinWidthArg, LayoutRegionLeaderHtml: layoutRegionLeaderHtmlArg, LayoutRegionTrailerHtml: layoutRegionTrailerHtmlArg, WrappingFormats: wrappingFormatsArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | Options | Set of optional parameters including: | Required | ||
| ContentFragmentHeaderLeaderHtml | String | HTML to render before each content fragment header. | Optional | ||
| ContentFragmentHeaderTrailerHtml | String | HTML to render after each content fragment header. | Optional | ||
| ContentFragmentLeaderHtml | String | HTML to render before each content fragment. | Optional | ||
| ContentFragmentTrailerHtml | String | HTML to rneder after each content fragment. | Optional | ||
| DefaultWrappingFormatWithHeader | String | The CssClass of the default wrapping format to use when a header is included | Optional | ||
| DefaultWrappingFormatWithoutHeader | String | The CssClass of the default wrapping format to use when a header is not included | Optional | ||
| InheritContentFragmentsFromParentDepth | Number | Depth of parent themes from which to load content fragments. | Optional | 10 | |
| InheritContentFromParentDepth | Number | Depth of parent themes from which to load locked content. | Optional | 10 | |
| LayoutReflowMinWidth | Number | The minimum width at which the layout reflows to single column mode. | Optional | ||
| LayoutRegionLeaderHtml | String | HTML to render before each layout region. | Optional | ||
| LayoutRegionTrailerHtml | String | HTML to render after each layout region. | Optional | ||
| WrappingFormats | ArrayList | List of dictionaries with Name, CssClass, and IncludeHeader | Optional |
Returns
RenderPage
RenderPage Overload 1
Renders the page body widgets in their configured layout.
Velocity
#set($stringResponse = $context_v2_themeBody.RenderPage())
JavaScript
var stringResponse = context_v2_themeBody.RenderPage();
RenderPage Overload 2
Renders the page body widgets in their configured layout.
Velocity
#set($stringResponse = $context_v2_themeBody.RenderPage("%{ ContentFragmentHeaderLeaderHtml = $contentFragmentHeaderLeaderHtmlArg, ContentFragmentHeaderTrailerHtml = $contentFragmentHeaderTrailerHtmlArg, ContentFragmentLeaderHtml = $contentFragmentLeaderHtmlArg, ContentFragmentTrailerHtml = $contentFragmentTrailerHtmlArg, DefaultWrappingFormatWithHeader = $defaultWrappingFormatWithHeaderArg, DefaultWrappingFormatWithoutHeader = $defaultWrappingFormatWithoutHeaderArg, InheritContentFragmentsFromParentDepth = $inheritContentFragmentsFromParentDepthArg, LayoutReflowMinWidth = $layoutReflowMinWidthArg, LayoutRegionLeaderHtml = $layoutRegionLeaderHtmlArg, LayoutRegionTrailerHtml = $layoutRegionTrailerHtmlArg, WrappingFormats = $wrappingFormatsArg }"))JavaScript
var stringResponse = context_v2_themeBody.RenderPage({ ContentFragmentHeaderLeaderHtml: contentFragmentHeaderLeaderHtmlArg, ContentFragmentHeaderTrailerHtml: contentFragmentHeaderTrailerHtmlArg, ContentFragmentLeaderHtml: contentFragmentLeaderHtmlArg, ContentFragmentTrailerHtml: contentFragmentTrailerHtmlArg, DefaultWrappingFormatWithHeader: defaultWrappingFormatWithHeaderArg, DefaultWrappingFormatWithoutHeader: defaultWrappingFormatWithoutHeaderArg, InheritContentFragmentsFromParentDepth: inheritContentFragmentsFromParentDepthArg, LayoutReflowMinWidth: layoutReflowMinWidthArg, LayoutRegionLeaderHtml: layoutRegionLeaderHtmlArg, LayoutRegionTrailerHtml: layoutRegionTrailerHtmlArg, WrappingFormats: wrappingFormatsArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | Options | Set of optional parameters including: | Required | ||
| ContentFragmentHeaderLeaderHtml | String | HTML to render before each content fragment header. | Optional | ||
| ContentFragmentHeaderTrailerHtml | String | HTML to render after each content fragment header. | Optional | ||
| ContentFragmentLeaderHtml | String | HTML to render before each content fragment. | Optional | ||
| ContentFragmentTrailerHtml | String | HTML to rneder after each content fragment. | Optional | ||
| DefaultWrappingFormatWithHeader | String | The CssClass of the default wrapping format to use when a header is included | Optional | ||
| DefaultWrappingFormatWithoutHeader | String | The CssClass of the default wrapping format to use when a header is not included | Optional | ||
| InheritContentFragmentsFromParentDepth | Number | Depth of parent themes from which to load content fragments. | Optional | 10 | |
| LayoutReflowMinWidth | Number | The minimum width at which the layout reflows to single column mode. | Optional | ||
| LayoutRegionLeaderHtml | String | HTML to render before each layout region. | Optional | ||
| LayoutRegionTrailerHtml | String | HTML to render after each layout region. | Optional | ||
| WrappingFormats | ArrayList | List of dictionaries with Name, CssClass, and IncludeHeader | Optional |
Returns
ToString
Velocity
#set($stringResponse = $context_v2_themeBody.ToString())
JavaScript
var stringResponse = context_v2_themeBody.ToString();