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
The IUniqueSchemaUnit type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | AdditionalProperties |
Gets the additional Properties of this unit. This is where this field's values are stored.
|
| ChildElementLabel |
Gets and sets the child element label. Only applies to the List element field type.
(Inherited from ISchemaField.) |
| ChildElementName |
Gets and sets the child element's name. Only applies to the List element field type.
(Inherited from ISchemaField.) |
| ChildElementType |
Gets and sets the child element type. Only applies to the List element field type.
(Inherited from ISchemaField.) |
| ChildProperties |
Gets the Properties of this field's child elements. Only applies to XPower elements.
|
| DefaultValue |
Gets and sets the field's default value.
(Inherited from ISchemaField.) |
| Exports |
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.) |
| FieldType |
Gets and sets the type of field.
(Inherited from ISchemaField.) |
| HelpText |
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.) |
| Hidden |
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.) |
| ID |
Gets this unit's unique ID.
|
| Label |
Gets and sets the the field's label (friendly name).
(Inherited from ISchemaField.) |
| Name |
Gets and sets the name of the field.
(Inherited from ISchemaField.) |
| Readonly |
Gets and sets whether the field is read-only for non-administrator users on the CMS edit form.
(Inherited from ISchemaField.) |
| Required |
Gets and sets whether the field is required.
(Inherited from ISchemaField.) |
| TypeName |
Gets the name of the field type.
(Inherited from ISchemaField.) |
| UniqueID |
Gets and sets the unique ID of the Schema Field. Only effective in page creation for Element fields
(Inherited from ISchemaField.) |
Methods
| Name | Description | |
|---|---|---|
 | ChildProperty |
Gets a property of a child item of the field. Only applies to the List element field type.
(Inherited from ISchemaField.) |
| Property | (Inherited from ISchemaField.) |
| RemoveExport |
Removes a local exports entry if exists.
(Inherited from ISchemaField.) |
| Serialize |
Serialize this field into Ingeniux CMS XML schema format.
(Inherited from ISchemaField.) |
 | SerializeToFavorite |
Serializes the XML element as a favorite entry. The favorite-entry format is not the same as output elements for schemas.
|
| SetChildProperty |
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.) |
| SetExport |
Sets a local exports entry.
If the entry exists, it updates its value. Otherwise, it creates a new entry.
(Inherited from ISchemaField.) |
| SetProperty |
Sets a property of the field. If the property with the given name doesn't exist, creates a new property.
(Inherited from ISchemaField.) |
See Also