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.308
SyntaxThe IGroupElement type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AllowEnclosureChange |
Gets whether changing the Enclosed property is allowed on the element.
|
| Closed |
Gets whether the group is closed. You cannot add child elements to a closed group.
|
 | Enclosed |
Gets and sets whether the rendering of the group element at runtime or preview will be wrapped 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.) |
| 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.) |
Methods| Name | Description | |
|---|---|---|
 | AddChildItem |
Adds a new child element.
|
| ChildItems |
Retrieves this group's child elements collection.
|
| ChildItemsCount |
Gets the count of child elements.
|
| Clone |
Clones the current element and returns a new element. The cloned element usesthe name provided.
(Inherited from IElement.) |
| Close |
Closes the group element, preventing the addition of child elements.
|
RemarksIn 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