Click or drag to resize

ICMSElement Interface

Represents an Element on a CMS Page. It provides the means to traverse an Elements's content through unique Ingeniux CMS types, and carries the necessary Http Request information.

Namespace:  Ingeniux.Runtime
Assembly:  IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 10.3.169
Syntax
public interface ICMSElement : ICMSPage, 
	ICMSObject<XElement>, ICMSRequest, ICMSEnvironment

The ICMSElement type exposes the following members.

Properties
  NameDescription
Public propertyAuthenticationInformation
Gets the authentication information of current Http Request. Only Page that requires authentication will carry this information, when authenticated.
(Inherited from ICMSPage.)
Public propertyBaseURL
Gets the absolute base URL of the Web Application.
(Inherited from ICMSEnvironment.)
Public propertyBrowserCapabilities
Gets the browser capabilities of the current Http Request.
(Inherited from ICMSPage.)
Public propertyContent
Gets content for XElement/XAttribute.
(Inherited from ICMSObjectT.)
Public propertyCookies
Gets the Cookies collection.
(Inherited from ICMSEnvironment.)
Public propertyCurrentPublishingTargetID
Gets the current Publishing Target Id, design-time only.
(Inherited from ICMSEnvironment.)
Public propertyEditMode
Applies to design-time only. Gets whether the Http Request is for Previewing a Page in In-Context-Edit mode..
(Inherited from ICMSEnvironment.)
Public propertyExists
Gets whether the Page or Route exists within published content, for the given request.
(Inherited from ICMSRequest.)
Public propertyFactory
Gets the page factory used to retrieve pages
(Inherited from ICMSEnvironment.)
Public propertyForm
Gets the Form Posts collection.
(Inherited from ICMSEnvironment.)
Public propertyID
Gets the Page or Component ID.
(Inherited from ICMSPage.)
Public propertyIncludeAllPages
Gets whether all Pages are included when building Component and Navigation references. Only applies to CMS design-time. Default value is false.
(Inherited from ICMSEnvironment.)
Public propertyIsPreview
Checks whether the Http Request is for Page Preview from CMS Design-time site.
(Inherited from ICMSEnvironment.)
Public propertyMobileDeviceInformation
Get the mobile device information, if the Http Request was from browser on a mobile device; Otherwise, returns null.
(Inherited from ICMSPage.)
Public propertyPage
Gets the CMS Page to which this element belongs.
(Inherited from ICMSPage.)
Public propertyParent
Public propertyPhysicallyCacheLinks (Inherited from ICMSEnvironment.)
Public propertyPresentationInformation
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.
(Inherited from ICMSPage.)
Public propertyQueryString
Gets QueryStrings collection.
(Inherited from ICMSEnvironment.)
Public propertyRequestPath
Gets the relative path of the Http Request.
(Inherited from ICMSEnvironment.)
Public propertyRestrictedAccess
Gets whether this Page is protected by the Ingeniux Runtime Authentication system. IF Runtime Authentication is disabled, this property will always return false.
(Inherited from ICMSPage.)
Public propertyRootElementName
Gets the name the underlying XElement.
Public propertyServerVariables
Gets the Server Variables collection, specified by the CMS settings.
(Inherited from ICMSEnvironment.)
Public propertySite
Gets the Site branding of the Request.
(Inherited from ICMSEnvironment.)
Public propertyStructuredURL
Gets the canonical structured URL of this Page.
(Inherited from ICMSEnvironment.)
Public propertyTag
Gets/sets the extra information to be included in the model. Can be any type.
(Inherited from ICMSPage.)
Public propertyTransformOption
Gets the what type of Page content the Request wants: Final Markup, Expanded XML, or Raw XML.
(Inherited from ICMSEnvironment.)
Public propertyType
Gets the type of the Element. It returns the value of "Type" or "type" Attribute. If the Attribute doesn't exist, returns empty string.
Public propertyCode exampleUID
Gets the unique ID of the element. It is in the form of GUID.
Public propertyURL
Gets the absolute URL of the Http Request.
(Inherited from ICMSEnvironment.)
Public propertyUserAgent
Gets the UserAgent branding of the Request
(Inherited from ICMSEnvironment.)
Public propertyValue
Gets the value of the Element.
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.
(Inherited from ICMSEnvironment.)
Public propertyViewName
Gets the name of the MVC View of this Page. By default, is it is the root Element name.
(Inherited from ICMSPage.)
Top
Methods
  NameDescription
Public methodAncestors
Gets ancestors of the Element.
Public methodAncestors(XName)
Gets ancestors of the Element with the given name.
Public methodAncestorsAndSelf
Gets the ancestors of the Element, including the Element itself.
Public methodAncestorsAndSelf(XName)
Gets the ancestors of the Element with the given name, including the Element itself and any name matches.
Public methodAttribute
Gets an Attribute by its name.
(Inherited from ICMSPage.)
Public methodAttributes
Gets all Attributes of the Element.
(Inherited from ICMSPage.)
Public methodChildren
Public methodChildren(XName)
Public methodDescendants
Gets the descendant Elements.
(Inherited from ICMSPage.)
Public methodDescendants(XName, String)
Gets the descendant Elements that have the specific element name.
(Inherited from ICMSPage.)
Public methodDescendantsAndSelf
Gets the descendant Elements, including this Element/Page Root Element itself.
(Inherited from ICMSPage.)
Public methodDescendantsAndSelf(XName)
Gets the descendant Elements by element name; including this Element/Page Root Element itself, if its name matches the given name.
(Inherited from ICMSPage.)
Public methodElement
Gets the first child Element with the given name.
(Inherited from ICMSPage.)
Public methodElements
Gets the child Elements
(Inherited from ICMSPage.)
Public methodElements(XName, String)
Gets the child Elements by given name.
(Inherited from ICMSPage.)
Public methodElementsAfterSelf
Gets sibling elements after this Element.
Public methodElementsAfterSelf(XName)
Gets sibling Elements after this Element, using a given name.
Public methodElementsBeforeSelf
Gets sibling Elements after this Element.
Public methodElementsBeforeSelf(XName)
Gets sibling Elements before this Element, using a given name.
Public methodGetAssetNavigationItems (Inherited from ICMSPage.)
Public methodGetAttributeValue
Gets the value of an Attribute, if the attribute exists.
(Inherited from ICMSPage.)
Public methodGetComponentTemplate
Gets the presentation fragment template for a particular component id. If the component doesn't have presentation fragment, returns null.
(Inherited from ICMSPage.)
Public methodGetElementValue
Gets the value of the first Element matching the given name.
(Inherited from ICMSPage.)
Public methodGetLinkItem
Retrieves one Link item with the given name.
(Inherited from ICMSPage.)
Public methodGetLinkItems
Gets Link items with the given name.
(Inherited from ICMSPage.)
Public methodGetNavigation (Inherited from ICMSPage.)
Public methodGetNavigationItems (Inherited from ICMSPage.)
Public methodGetTaxonomyNavigation (Inherited from ICMSPage.)
Public methodXPathSelectElement
Uses an XPath query to select a single Element.
(Inherited from ICMSPage.)
Public methodXPathSelectElements
Uses an XPath query to select a list of Elements.
(Inherited from ICMSPage.)
Top
See Also