IListElement Interface Ingeniux CMS Content Store API

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: 9.0.565.0 (9.0.565)
Syntax

public interface IListElement : IElement, 
	IContentCollection

The IListElement type exposes the following members.

Properties

  NameDescription
Public propertyAllowEnclosureChange
Gets whether the element's Enclosed property is allowed to be changed.
Public propertyChildElementLabel
Gets the child element's label. A child element's label is determined by its page's schema and cannot be changed.
Public propertyChildElementName
Gets the child element's name. A child element's name is determined by its page's schema and cannot be changed.
Public propertyChildElementType
Gets the child element's type. A child element's type is determined by its page's schema and cannot be changed.
Public propertyContentUnitTemplateName
Gets and sets the template name this field uses. Only fields generated via ContentUnit placement have this value.
(Inherited from IContentCollection.)
Public propertyCode exampleEnclosed
Gets and sets whether the rendering of the List element at runtime or preview will be contained in a wrapper element.
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 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 methodAddListItem
Creates a new child element and adds it to the collection. The new child element has its type and name decided, but nothing else.
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 methodClearListItems
Removes the child element's collection, leaving only the very first child element.
Public methodClone
Clones the current element and returns a new element. The cloned element usesthe name provided.
(Inherited from IElement.)
Public methodListItem(Int32)
Retrieves a child element by its position in the collection.
Public methodListItem(String)
Retrieves a child element by its unique ID.
Public methodListItems
Retrieves all child elements.
Public methodListItemsCount
Gets the count of child elements.
Public methodRemoveAttribute
Removes an Attribute from the collection.
(Inherited from IContentCollection.)
Public methodRemoveListItem
Removes a child element.
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
See Also

Reference