Click or drag to resize

IGroupElement Interface


Represents a Group element on a page.

A Group element contains child elements of any type, except another group element.


Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
Syntax
public interface IGroupElement : IElement

The IGroupElement type exposes the following members.

Properties
 NameDescription
Public propertyAllowEnclosureChange Gets whether changing the Enclosed property is allowed on the element.
Public propertyClosed Gets whether the group is closed. You cannot add child elements to a closed group.
Public propertyCode exampleEnclosed Gets and sets whether the rendering of the group element at runtime or preview will be wrapped 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 propertyIndexable Gets and sets the field's ability to be indexed for in site search.
(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 propertyOpenByDefault Indicates to client that this element should display all information on initial get
(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 methodAddChildItem Adds a new child element.
Public methodChildItems Retrieves this group's child elements collection.
Public methodChildItemsCount Gets the count of child elements.
Public methodClone Clones the current element and returns a new element. The cloned element usesthe name provided.
(Inherited from IElement)
Public methodClose Closes the group element, preventing the addition of child elements.
Top
Remarks

In a schema, a group element consists of two pieces: GroupStart and GroupEnd. The children of Group element on a page are the elements between the GroupStart and GroupEnd tags.

See Also