ICMSEnvironment


The ICMSEnvironment interface captures the HTTP and CMS variables processed in a request to the DSS. The interface allows for overriding of the HTTP variable, which is particularly useful in preview mode, where all HTTP variables are simulated. ICMSEnvironment exposes the following properties.

BaseURL
Gets the absolute base URL of the Web Application.
Cookies
Gets the Cookies collection.
CurrentPublishingTargetID
Gets the current Publishing Target Id, design-time only.
EditMode
Applies to design-time only. Gets whether the Http Request is for Previewing a Page in In-Context-Edit mode.
Factory
Gets the page factory used to retrieve pages.
Form
Gets the Form Posts collection.
IncludeAllPages
Gets whether all Pages are included when building Component and Navigation references. Only applies to CMS design-time. Default value is false.
IsPreview
Checks whether the Http Request is for Page Preview from CMS Design-time site.
PhysicallyCacheLinks
Applies navigation processors to cache link, linkset, assetlinkset, and ancestor/sibling/sequatial navigations.
QueryString
Gets QueryStrings collection.
RequestPath
Gets the relative path of the Http Request.
ServerVariables
Gets the Server Variables collection, specified by the CMS settings.
Site
Gets the Site branding of the Request.
StructuredURL
Gets the canonical structured URL of this Page.
TransformOption
Gets the what type of Page content the Request wants: Final Markup, Expanded XML, or Raw XML.
URL
Gets the absolute URL of the Http Request.
UserAgent
Gets the UserAgent branding of the Request
ViewMode
Gets the Mode of View. It is used to distinguish different View/XSLT template, when requesting the same Element. The value of this property is particularly important for In-Context-Edit markup update, especially for traditional XSLT implementations.