context_v2_themeBody Script API

Ben Tiedt — Wed, 20 Nov 2019 14:53:25 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:53:25

This extension is only available when rendering the body of a theme. Is is not generally available for use by widgets or automations.

RenderFooter
RenderHeader
RenderPage

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
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	`Int32`	Depth of parent themes from which to load content fragments.	Optional	10
InheritContentFromParentDepth	`Int32`	Depth of parent themes from which to load locked content.	Optional	10
LayoutReflowMinWidth	`Int32`	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

String

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
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	`Int32`	Depth of parent themes from which to load content fragments.	Optional	10
InheritContentFromParentDepth	`Int32`	Depth of parent themes from which to load locked content.	Optional	10
LayoutReflowMinWidth	`Int32`	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

String

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, TabsLeaderHtml = $tabsLeaderHtmlArg, TabsTrailerHtml = $tabsTrailerHtmlArg, 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, TabsLeaderHtml: tabsLeaderHtmlArg, TabsTrailerHtml: tabsTrailerHtmlArg, WrappingFormats: wrappingFormatsArg });

Parameters

Name	Type	Description	Required	Default
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	`Int32`	Depth of parent themes from which to load content fragments.	Optional	10
LayoutReflowMinWidth	`Int32`	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
TabsLeaderHtml	`String`	HTML to render before all tabs.	Optional
TabsTrailerHtml	`String`	HTML to render after all tabs.	Optional
WrappingFormats	`ArrayList`	List of dictionaries with Name, CssClass, and IncludeHeader	Optional

Returns

String