Represents an element field on a CMS Page. Its parent can be a Page or an Element.
It is a collection of Attributes, plus field name and value, that can be serialized to an XElement.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)
Syntax
The IElement type exposes the following members.
Properties
Name | Description | |
---|---|---|
ContentUnitTemplateName |
Gets and sets the template name this field uses. Only fields generated via ContentUnit placement have this value.
(Inherited from IContentCollection.) | |
Expanded |
Gets and sets the Element's field on Edit Form as showing its full details. This value only applies to the Edit Form.
| |
Hidden |
Gets and sets the Element as hidden on the Edit Form.
| |
IsXpower |
Gets if the Element is a Xpower element, a special Ingeniux CMS Element that executes at runtime (or fully expanded publishing).
| |
Label |
Gets and sets the label (friendly name) of the Element.
| |
Name |
Gets and sets the name of Element.
| |
Readonly |
Gets and sets the Element as read-only on the Edit Form.
| |
Required |
Gets sets the Element's value as required. Pages containing required Elements with empty values cannot be checked in.
| |
Type |
Gets the type of Element.
| |
UniqueID |
Gets the unique ID of the Element.
| |
Value |
Gets and sets the value of the Element.
|
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.) | |
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.) | |
Clone |
Clones the current element and returns a new element. The cloned element usesthe name provided.
| |
RemoveAttribute |
Removes an Attribute from the collection.
(Inherited from IContentCollection.) | |
SetAttributeValue |
Sets an Attribute's value. If the Attribute with the given name doesn't exist, this method creates it.
(Inherited from IContentCollection.) |
Remarks
See Also