ICMSLinkElement Interface

Ingeniux DSS Library

Represents an expanded Link or Navigation entry, which is a summaried representation of another Page. Its XML element is always a "Page" element like the following:

Namespace: Ingeniux.Runtime
Assembly: IGXRuntimeAPI (in IGXRuntimeAPI.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public interface ICMSLinkElement : ICMSElement, 
	ICMSPage, ICMSRequest, ICMSEnvironment

Public Interface ICMSLinkElement
	Inherits ICMSElement, ICMSPage, ICMSRequest, ICMSEnvironment

public interface class ICMSLinkElement : ICMSElement, 
	ICMSPage, ICMSRequest, ICMSEnvironment

type ICMSLinkElement =  
    interface
        interface ICMSElement
        interface ICMSPage
        interface ICMSRequest
        interface ICMSEnvironment
    end

The ICMSLinkElement type exposes the following members.

Properties

	Name	Description
	Abstract	Gets the value of "Abstract" Attribute from this Element. The value of this Attribute is normally exported from the "Abstract" Element on the target Page.
	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.)
	CategoryIds	Get the ids of the Categories associated with the target Page
	Changed	Gets the time when the target Page was last changed at Ingeniux CMS design-time site instance.
	ChildLinks	Gets "Page" Elements that are the children of this Element. Only entries from transitional Navigation Element could contain child links. Link Element will return an empty collection on this property.
	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.)
	IsComponent
	IsPreview	Checks whether the Http Request is for Page Preview from CMS Design-time site. (Inherited from ICMSEnvironment.)
	LinkName	Gets the name of the Link. This property only has value, if it represents the expanded result of a Link Element. Navigation entries will return empty string on this property.
	Locale	Gets the region code of the language of target Page
	MobileDeviceInformation	Get the mobile device information, if the Http Request was from browser on a mobile device; Otherwise, returns null. (Inherited from ICMSPage.)
	Name	Gets the name of the target Page
	Page	Gets the CMS Page to which this element belongs. (Inherited from ICMSPage.)
	PresentationInformation	Gets the information for the Presentation for the Page to which this Element belongs. Presentations are design customization onthe 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. (Inherited from ICMSElement.)
	Schema	Gets the name of the root Element of target Page
	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.)
	TargetID	Gets the unique Id of the target Page, which is the value of "ID" Attribute.
	TargetWindow	Gets how the target url should be openned. It could return one of the following 3 possible values: _blank, _self, _parent
	Title	Gets the value of "Title" Attribute from this Element. The value of this Attribute is normally exported from the "Title" Element on the target Page.
	TransformOption	Gets the what type of Page content the Request wants: Final Markup, Expanded XML, or Raw XML. (Inherited from ICMSEnvironment.)
	Type	Gets the type of the Element. It returns the value of "Type" or "type" Attribute. If the Attribute doesn't exist, returns empty string. (Inherited from ICMSElement.)
	UID	Gets the unique ID of the element. It is in the form of GUID. (Inherited from ICMSElement.)
	URL	Gets the URL of the target Page.
	UserAgent	Gets the UserAgent branding of the Request (Inherited from ICMSEnvironment.)
	Value	Gets the value of the Element. (Inherited from ICMSElement.)
	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.)

Top

Methods

	Name	Description
	Ancestors	Gets ancestors of the Element. (Inherited from ICMSElement.)
	Ancestors(XName)	Gets ancestors of the Element with the given name. (Inherited from ICMSElement.)
	AncestorsAndSelf	Gets the ancestors of the Element, including the Element itself. (Inherited from ICMSElement.)
	AncestorsAndSelf(XName)	Gets the ancestors of the Element with the given name, including the Element itself and any name matches. (Inherited from ICMSElement.)
	Attribute	Gets an Attribute by its name. (Inherited from ICMSPage.)
	Attributes	Gets all Attributes of the Element. (Inherited from ICMSPage.)
	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. (Inherited from ICMSElement.)
	ElementsAfterSelf(XName)	Gets sibling Elements after this Element, using a given name. (Inherited from ICMSElement.)
	ElementsBeforeSelf	Gets sibling Elements after this Element. (Inherited from ICMSElement.)
	ElementsBeforeSelf(XName)	Gets sibling Elements before this Element, using a given name. (Inherited from ICMSElement.)
	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.)

Top

Remarks

Examples

Copy

<Page ID="x89" Name="FooterLink" Link="About Us" URL="history-of-quality" Schema="DocumentWithSideImage" Locale="" Changed="20140711T20:11:45" CategoryIds="" Title="History of Quality"/>

Reference

Ingeniux.Runtime Namespace