Click or drag to resize

ICMSEnvironment Interface

Represents the Http and CMS exclusive variables to be carried by a Http Request to a Dynamic Site Server Page. This interface allows for overriding of the Http variables, which is particularly useful in preview mode, where all Http variables are simulated.

Namespace:  Ingeniux.Runtime
Assembly:  IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.5.94
Syntax
public interface ICMSEnvironment

The ICMSEnvironment type exposes the following members.

Properties
  NameDescription
Public propertyBaseURL
Gets the absolute base URL of the Web Application.
Public propertyCookies
Gets the Cookies collection.
Public propertyCurrentPublishingTargetID
Gets the current Publishing Target Id, design-time only.
Public propertyEditMode
Applies to design-time only. Gets whether the Http Request is for Previewing a Page in In-Context-Edit mode..
Public propertyFactory
Gets the page factory used to retrieve pages
Public propertyForm
Gets the Form Posts collection.
Public propertyIncludeAllPages
Gets whether all Pages are included when building Component and Navigation references. Only applies to CMS design-time. Default value is false.
Public propertyIsPreview
Checks whether the Http Request is for Page Preview from CMS Design-time site.
Public propertyPhysicallyCacheLinks
Public propertyQueryString
Gets QueryStrings collection.
Public propertyRequestPath
Gets the relative path of the Http Request.
Public propertyServerVariables
Gets the Server Variables collection, specified by the CMS settings.
Public propertySite
Gets the Site branding of the Request.
Public propertyStructuredURL
Gets the canonical structured URL of this Page.
Public propertyTransformOption
Gets the what type of Page content the Request wants: Final Markup, Expanded XML, or Raw XML.
Public propertyURL
Gets the absolute URL of the Http Request.
Public propertyUserAgent
Gets the UserAgent branding of the Request
Public propertyViewMode
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.
Top
See Also