Login
Home CMS Documentation Home CMS 10 Development Building an MVC Website Working with the DSS API ICMSPage

ICMSPage

The ICMSPage interface represents an actual request to a CMS page. The interface contains request information and is traversable. It exposes the following methods.

  • Attribute - Gets an Attribute by its name.
  • Attributes - Gets all Attributes of the Element.Descendants() - Gets the descendant Elements.
  • Descendants(XName, String) - Gets the descendant Elements that have the specific element name.
  • DescendantsAndSelf - Gets the descendant Elements, including this Element/Page Root Element itself.
  • DescendantsAndSelf(XName) - Gets the descendant Elements by element name; including this Element/Page Root Element itself, if its name matches the given name.
  • Element - Gets the first child Element with the given name.
  • Elements - Gets the child Elements.
  • Elements(XName, String) - Gets the child Elements by given name.
  • GetAssetNavigationItems - Gets Link items from a Navigation Element.
  • GetAttributeValue - Gets the value of an Attribute, if the attribute exists.
  • GetComponentTemplate - Gets the presentation fragment template for a particular component id. If the component doesn't have presentation fragment, returns null.
  • GetElementValue - Gets the value of the first Element matching the given name.
  • GetLinkItem - Retrieves one Link item with the given name.
  • GetLinkItems - Gets Link items with the given name.
  • GetNavigation - Gets a Navigation Element.
  • GetNavigationItems - Gets Link items from a Navigation Element.
  • GetTaxonomyNavigation - Gets a Taxonomy Navigation Element.
  • XPathSelectElement - Uses an XPath query to select a single Element.
  • PathSelectElements - Uses an XPath query to select a list of Elements.

The ICMSPage interface inherits a number of properties from ICMSEnvironment. In addition, ICMSPage exposes the following properties.

  • AuthenticationInformation - Gets the authentication information of the current request. Only a page that requires authentication will carry this info, when authenticated.
  • BrowserCapabilities - Gets the browser capabilities of the current request.
  • ID - Gets the Page or Component ID.
  • MobileDeviceInformation - Gets the mobile device information from a mobile client. If the client is not a mobile device, the value returns null.
  • Page - Gets the CMS page to which an element belongs.
  • PresentationInformation - Gets the information for the Presentation for the Page to which this Element belongs. Presentations are design customization on the Page that were built via Ingeniux CMS Page builder. This property returns null, if the Page this Element belongs to doesn't have Presentation, or this Element belongs to a Component.
  • RestrictedAccess - Gets whether this Page is protected by the Ingeniux Runtime Authentication system. IF Runtime Authentication is disabled, this property will always return false.
  • Tag - Extra information to be included in the model.
  • ViewName - Gets the view name of the page. By default it's the root element name.