INavigationElement Interface Ingeniux CMS Content Store API

Represents the types of XPower elements that produce a collection of Navigation elements during runtime or publishing expansion. A Navigation element queries each page it covers and produces a Page element with a set of attributes that summarizes the page's content.

The highly organized and highly flexible Navigation elements are a central part of the Ingeniux CMS.

The amount of information to summarize from page content is decided by the combination of global exports and local exports. Local exports override global exports with same name. Therefore, all Navigation element types can have local exports.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)
Syntax

public interface INavigationElement : IElement, 
	IContentCollection

The INavigationElement type exposes the following members.

Properties

  NameDescription
Public propertyContentUnitTemplateName
Gets and sets the template name this field uses. Only fields generated via ContentUnit placement have this value.
(Inherited from IContentCollection.)
Public propertyExpanded
Gets and sets the Element's field on Edit Form as showing its full details. This value only applies to the Edit Form.
(Inherited from IElement.)
Public propertyHidden
Gets and sets the Element as hidden on the Edit Form.
(Inherited from IElement.)
Public propertyIsXpower
Gets if the Element is a Xpower element, a special Ingeniux CMS Element that executes at runtime (or fully expanded publishing).
(Inherited from IElement.)
Public propertyLabel
Gets and sets the label (friendly name) of the Element.
(Inherited from IElement.)
Public propertyLocalExports
Gets the element's local exports.
Public propertyName
Gets and sets the name of Element.
(Inherited from IElement.)
Public propertyReadonly
Gets and sets the Element as read-only on the Edit Form.
(Inherited from IElement.)
Public propertyRequired
Gets sets the Element's value as required. Pages containing required Elements with empty values cannot be checked in.
(Inherited from IElement.)
Public propertyType
Gets the type of Element.
(Inherited from IElement.)
Public propertyUniqueID
Gets the unique ID of the Element.
(Inherited from IElement.)
Public propertyValue
Gets and sets the value of the Element.
(Inherited from IElement.)
Top
Methods

  NameDescription
Public methodAddAttribute
Adds one or more Attributes to the ContentCollection. This method accepts variable number of Attribute objects as parameters.
(Inherited from IContentCollection.)
Public methodAddAttributes
Adds a collection of Attributes to the Content Collection.
(Inherited from IContentCollection.)
Public methodAttribute
Gets a specific Attribute by name
(Inherited from IContentCollection.)
Public methodAttributes (Inherited from IContentCollection.)
Public methodAttributesCount
Gets the count of Attributes in the ContentCollection.
(Inherited from IContentCollection.)
Public methodAttributeValue
Gets the value of a specific Attribute by name.
(Inherited from IContentCollection.)
Public methodClearAttributes
Clears all Attributes from collection.
(Inherited from IContentCollection.)
Public methodClone
Clones the current element and returns a new element. The cloned element usesthe name provided.
(Inherited from IElement.)
Public methodRemoveAttribute
Removes an Attribute from the collection.
(Inherited from IContentCollection.)
Public methodSetAttributeValue
Sets an Attribute's value. If the Attribute with the given name doesn't exist, this method creates it.
(Inherited from IContentCollection.)
Top
Remarks

It is highly recommended to use gloabal exports whenever possible, because using local exports is much slower. An exception is when override is desired on global export entries, or you are trying to query expanded Link elements.

Examples

Each Navigation element's page output will look something like the following example:

<Page ID="x454" URL="about-us/news-and-events/motorola-employees-credit-union-selects-ingeniux"
  Date="20040111T00:00:00" 
  Changed="20130515T20:47:10" 
  CategoryIds="133" 
  Locale="" 
  Schema="NewsDetail" 
  Name="Motorola Employees Credit Union Selects Ingeniux"
  Abstract="MECU Licenses Ingeniux CMS to Power Internet and Intranet sites" Title="Motorola Employees Credit Union Selects Ingeniux CMS" />
See Also

Reference