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
SyntaxThe ICMSElement type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AuthenticationInformation |
Gets the authentication information of current Http Request. Only Page that requires authentication will carry this information, when authenticated.
(Inherited from ICMSPage.) |
| BaseURL |
Gets the absolute base URL of the Web Application.
(Inherited from ICMSEnvironment.) |
| BrowserCapabilities |
Gets the browser capabilities of the current Http Request.
(Inherited from ICMSPage.) |
| Content |
Gets content for XElement/XAttribute.
(Inherited from ICMSObjectT.) |
| Cookies |
Gets the Cookies collection.
(Inherited from ICMSEnvironment.) |
| CurrentPublishingTargetID |
Gets the current Publishing Target Id, design-time only.
(Inherited from ICMSEnvironment.) |
| EditMode |
Applies to design-time only. Gets whether the Http Request is for Previewing a Page
in In-Context-Edit mode..
(Inherited from ICMSEnvironment.) |
| Exists |
Gets whether the Page or Route exists within published content, for the given request.
(Inherited from ICMSRequest.) |
| Factory |
Gets the page factory used to retrieve pages
(Inherited from ICMSEnvironment.) |
| Form |
Gets the Form Posts collection.
(Inherited from ICMSEnvironment.) |
| ID |
Gets the Page or Component ID.
(Inherited from ICMSPage.) |
| IncludeAllPages |
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.) |
| IsPreview |
Checks whether the Http Request is for Page Preview from CMS Design-time site.
(Inherited from ICMSEnvironment.) |
| MobileDeviceInformation |
Get the mobile device information, if the Http Request was from browser on a mobile device; Otherwise, returns null.
(Inherited from ICMSPage.) |
| Page |
Gets the CMS Page to which this element belongs.
(Inherited from ICMSPage.) |
| Parent | |
| PhysicallyCacheLinks | (Inherited from ICMSEnvironment.) |
| 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.
(Inherited from ICMSPage.) |
| QueryString |
Gets QueryStrings collection.
(Inherited from ICMSEnvironment.) |
| RequestPath |
Gets the relative path of the Http Request.
(Inherited from ICMSEnvironment.) |
| RestrictedAccess |
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.) |
| RootElementName |
Gets the name the underlying XElement.
|
| ServerVariables |
Gets the Server Variables collection, specified by the CMS settings.
(Inherited from ICMSEnvironment.) |
| Site |
Gets the Site branding of the Request.
(Inherited from ICMSEnvironment.) |
| StructuredURL |
Gets the canonical structured URL of this Page.
(Inherited from ICMSEnvironment.) |
| Tag |
Gets/sets the extra information to be included in the model. Can be any type.
(Inherited from ICMSPage.) |
| TransformOption |
Gets the what type of Page content the Request wants: Final Markup, Expanded XML, or Raw XML.
(Inherited from ICMSEnvironment.) |
| Type | |
 | UID |
Gets the unique ID of the element. It is in the form of GUID.
|
| URL |
Gets the absolute URL of the Http Request.
(Inherited from ICMSEnvironment.) |
| UserAgent |
Gets the UserAgent branding of the Request
(Inherited from ICMSEnvironment.) |
| Value |
Gets the value of the Element.
|
| 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.
(Inherited from ICMSEnvironment.) |
| ViewName |
Gets the name of the MVC View of this Page. By default, is it is the root Element name.
(Inherited from ICMSPage.) |
Methods| Name | Description | |
|---|---|---|
 | Ancestors |
Gets ancestors of the Element.
|
| Ancestors(XName) |
Gets ancestors of the Element with the given name.
|
| AncestorsAndSelf |
Gets the ancestors of the Element, including the Element itself.
|
| AncestorsAndSelf(XName) |
Gets the ancestors of the Element with the given name, including the Element itself and any name matches.
|
| Attribute |
Gets an Attribute by its name.
(Inherited from ICMSPage.) |
| Attributes |
Gets all Attributes of the Element.
(Inherited from ICMSPage.) |
| Children | |
| Children(XName) | |
| Descendants |
Gets the descendant Elements.
(Inherited from ICMSPage.) |
| Descendants(XName, String) |
Gets the descendant Elements that have the specific element name.
(Inherited from ICMSPage.) |
| DescendantsAndSelf |
Gets the descendant Elements, including this Element/Page Root Element itself.
(Inherited from ICMSPage.) |
| DescendantsAndSelf(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.) |
| Element |
Gets the first child Element with the given name.
(Inherited from ICMSPage.) |
| Elements |
Gets the child Elements (Inherited from ICMSPage.) |
| Elements(XName, String) |
Gets the child Elements by given name.
(Inherited from ICMSPage.) |
| ElementsAfterSelf |
Gets sibling elements after this Element.
|
| ElementsAfterSelf(XName) |
Gets sibling Elements after this Element, using a given name.
|
| ElementsBeforeSelf |
Gets sibling Elements after this Element.
|
| ElementsBeforeSelf(XName) |
Gets sibling Elements before this Element, using a given name.
|
| GetAssetNavigationItems |
Gets Link items from a Navigation Element.
(Inherited from ICMSPage.) |
| GetAttributeValue |
Gets the value of an Attribute, if the attribute exists.
(Inherited from ICMSPage.) |
| GetComponentTemplate |
Gets the presentation fragment template for a particular component id.
If the component doesn't have presentation fragment, returns null.
(Inherited from ICMSPage.) |
| GetElementValue |
Gets the value of the first Element matching the given name.
(Inherited from ICMSPage.) |
| GetLinkItem |
Retrieves one Link item with the given name.
(Inherited from ICMSPage.) |
| GetLinkItems |
Gets Link items with the given name.
(Inherited from ICMSPage.) |
| GetNavigation |
Gets a Navigation Element.
(Inherited from ICMSPage.) |
| GetNavigationItems |
Gets Link items from a Navigation Element.
(Inherited from ICMSPage.) |
| GetTaxonomyNavigation |
Gets a Taxonomy Navigation Element.
(Inherited from ICMSPage.) |
| XPathSelectElement |
Uses an XPath query to select a single Element.
(Inherited from ICMSPage.) |
| XPathSelectElements |
Uses an XPath query to select a list of Elements.
(Inherited from ICMSPage.) |
See Also