IUniqueSchemaUnit Interface Ingeniux CMS Content Store API

Presents a fully filled-out Schema Field. It is the construction unit of Schema Field Favorites. Normally, an instance of this type has all the necessary attributes and values filled in, so can be used directly when constructing a new Schema.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)
Syntax

public interface IUniqueSchemaUnit : ISchemaField

The IUniqueSchemaUnit type exposes the following members.

Properties

  NameDescription
Public propertyAdditionalProperties
Gets the additional Properties of this unit. This is where this field's values are stored.
Public propertyChildElementLabel
Gets and sets the child element label. Only applies to the List element field type.
(Inherited from ISchemaField.)
Public propertyChildElementName
Gets and sets the child element's name. Only applies to the List element field type.
(Inherited from ISchemaField.)
Public propertyChildElementType
Gets and sets the child element type. Only applies to the List element field type.
(Inherited from ISchemaField.)
Public propertyChildProperties
Gets the Properties of this field's child elements. Only applies to XPower elements.
Public propertyDefaultValue
Gets and sets the field's default value.
(Inherited from ISchemaField.)
Public propertyExports
Gets the field's collection of local exports. Local exports add additional attributes for Link and Navigation element XML output to global exports.
(Inherited from ISchemaField.)
Public propertyFieldType
Gets and sets the type of field.
(Inherited from ISchemaField.)
Public propertyHelpText
Gets and sets a field's help text. Help text, displayed on the Ingeniux CMS edit form, is information to help users complete the field.
(Inherited from ISchemaField.)
Public propertyHidden
Gets and sets whether the field is hidden for non-administrator users and users who don't have the View Hidden Elements permission on the CMS edit form.
(Inherited from ISchemaField.)
Public propertyID
Gets this unit's unique ID.
Public propertyLabel
Gets and sets the the field's label (friendly name).
(Inherited from ISchemaField.)
Public propertyName
Gets and sets the name of the field.
(Inherited from ISchemaField.)
Public propertyReadonly
Gets and sets whether the field is read-only for non-administrator users on the CMS edit form.
(Inherited from ISchemaField.)
Public propertyRequired
Gets and sets whether the field is required.
(Inherited from ISchemaField.)
Public propertyTypeName
Gets the name of the field type.
(Inherited from ISchemaField.)
Public propertyUniqueID
Gets and sets the unique ID of the Schema Field. Only effective in page creation for Element fields
(Inherited from ISchemaField.)
Top
Methods

  NameDescription
Public methodChildProperty
Gets a property of a child item of the field. Only applies to the List element field type.
(Inherited from ISchemaField.)
Public methodProperty
Gets a field property by its name. Each property corresponds to an attribute on a pageelement.
(Inherited from ISchemaField.)
Public methodRemoveExport
Removes a local exports entry if exists.
(Inherited from ISchemaField.)
Public methodSerialize
Serialize this field into Ingeniux CMS XML schema format.
(Inherited from ISchemaField.)
Public methodCode exampleSerializeToFavorite
Serializes the XML element as a favorite entry. The favorite-entry format is not the same as output elements for schemas.
Public methodSetChildProperty
Sets a property of child item of the field. Only applies to List Element field type. If child property with given name doesn't exist, will create a new child property.
(Inherited from ISchemaField.)
Public methodSetExport
Sets a local exports entry. If the entry exists, it updates its value. Otherwise, it creates a new entry.
(Inherited from ISchemaField.)
Public methodSetProperty
Sets a property of the field. If the property with the given name doesn't exist, creates a new property.
(Inherited from ISchemaField.)
Top
See Also

Reference