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
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 | |
| ContentUnitTemplateName |
Gets and sets the template name this field uses. Only fields generated via ContentUnit placement have this value.
(Inherited from IContentCollection.) |
 | 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.) |
| 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.) |
| 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.) |
Methods
| Name | Description | |
|---|---|---|
 | AddAttribute |
Adds one or more Attributes to the ContentCollection. This method accepts variable number of Attribute objects as parameters.
(Inherited from IContentCollection.) |
| AddAttributes |
Adds a collection of Attributes to the Content Collection.
(Inherited from IContentCollection.) |
| AddListItem | |
| Attribute |
Gets a specific Attribute by name
(Inherited from IContentCollection.) |
| Attributes | (Inherited from IContentCollection.) |
| AttributesCount |
Gets the count of Attributes in the ContentCollection.
(Inherited from IContentCollection.) |
| AttributeValue |
Gets the value of a specific Attribute by name.
(Inherited from IContentCollection.) |
| ClearAttributes |
Clears all Attributes from collection.
(Inherited from IContentCollection.) |
| 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.
|
| RemoveAttribute |
Removes an Attribute from the collection.
(Inherited from IContentCollection.) |
| RemoveListItem |
Removes a child element.
|
| SetAttributeValue |
Sets an Attribute's value. If the Attribute with the given name doesn't exist, this method creates it.
(Inherited from IContentCollection.) |
See Also