INavigationElement Interface

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: 10.3.169

Syntax

C++

Copy

public interface INavigationElement : IElement

Public Interface INavigationElement
	Inherits IElement

public interface class INavigationElement : IElement

type INavigationElement =  
    interface
        interface IElement
    end

The INavigationElement type exposes the following members.

Properties

	Name	Description
	Expanded	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.)
	Hidden	Gets and sets the Element as hidden on the Edit Form. (Inherited from IElement.)
	Indexable	Gets and sets the field's ability to be indexed for in site search. (Inherited from IElement.)
	IsXpower	Gets if the Element is a Xpower element, a special Ingeniux CMS Element that executes at runtime (or fully expanded publishing). (Inherited from IElement.)
	Label	Gets and sets the label (friendly name) of the Element. (Inherited from IElement.)
	LocalExports	Gets the element's local exports.
	Name	Gets and sets the name of Element. (Inherited from IElement.)
	Readonly	Gets and sets the Element as read-only on the Edit Form. (Inherited from IElement.)
	Required	Gets sets the Element's value as required. Pages containing required Elements with empty values cannot be checked in. (Inherited from IElement.)
	Type	Gets the type of Element. (Inherited from IElement.)
	UniqueID	Gets the unique ID of the Element. (Inherited from IElement.)
	Value	Gets and sets the value of the Element. (Inherited from IElement.)

Top

Methods

	Name	Description
	Clone	Clones the current element and returns a new element. The cloned element usesthe name provided. (Inherited from IElement.)

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:

XML

Copy

<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" />

Reference

Ingeniux.CMS Namespace

Ingeniux.CMSIExportsElement