IElement Interface Ingeniux CMS Content Store API

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

public interface IElement : IContentCollection

The IElement type exposes the following members.

Properties

  NameDescription
Public propertyContentUnitTemplateName
Gets and sets the template name this field uses. Only fields generated via ContentUnit placement have this value.
(Inherited from IContentCollection.)
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.
Public propertyHidden
Gets and sets the Element as hidden on the Edit Form.
Public propertyIsXpower
Gets if the Element is a Xpower element, a special Ingeniux CMS Element that executes at runtime (or fully expanded publishing).
Public propertyLabel
Gets and sets the label (friendly name) of the Element.
Public propertyName
Gets and sets the name of Element.
Public propertyReadonly
Gets and sets the Element as read-only on the Edit Form.
Public propertyRequired
Gets sets the Element's value as required. Pages containing required Elements with empty values cannot be checked in.
Public propertyType
Gets the type of Element.
Public propertyUniqueID
Gets the unique ID of the Element.
Public propertyValue
Gets and sets the value of the Element.
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 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 methodClone
Clones the current element and returns a new element. The cloned element usesthe name provided.
Public methodRemoveAttribute
Removes an Attribute from the collection.
(Inherited from IContentCollection.)
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
Remarks

Each element has unique ID for easy identification.
See Also

Reference