IListElement Interface

Represents a List element. List elements can have child elements of the same type. It must have at least one child element, but there is no upper limit on how many child elements it can have. The child element type can be any type, excluding Group and List elements.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308

Syntax

C++

Copy

public interface IListElement : IElement

Public Interface IListElement
	Inherits IElement

public interface class IListElement : IElement

type IListElement =  
    interface
        interface IElement
    end

The IListElement type exposes the following members.

Properties

	Name	Description
	AllowEnclosureChange	Gets whether the element's Enclosed property is allowed to be changed.
	ChildElementLabel	Gets the child element's label. A child element's label is determined by its page's schema and cannot be changed.
	ChildElementName	Gets the child element's name. A child element's name is determined by its page's schema and cannot be changed.
	ChildElementType	Gets the child element's type. A child element's type is determined by its page's schema and cannot be changed.
	Enclosed	Gets and sets whether the rendering of the List element at runtime or preview will be contained in a wrapper element.
	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.)
	MaxItems	Gets and sets the maximum amount of list items allowed for this list element. List element is only validated against this property when adding new list items
	Name	Gets and sets the name of Element. (Inherited from IElement.)
	OpenByDefault	Indicates to client that this element should display all information on initial get (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
	AddListItem	Creates a new child element and adds it to the collection. The new child element has its type and name decided, but nothing else.
	ClearListItems	Removes the child element's collection, leaving only the very first child element.
	Clone	Clones the current element and returns a new element. The cloned element usesthe name provided. (Inherited from IElement.)
	ListItem(Int32)	Retrieves a child element by its position in the collection.
	ListItem(String)	Retrieves a child element by its unique ID.
	ListItems	Retrieves all child elements.
	ListItemsCount	Gets the count of child elements.
	RemoveListItem	Removes a child element.

Top

Reference

Ingeniux.CMS Namespace

Ingeniux.CMSIPage