Click or drag to resize

ISchemaField Interface

Represents a field in schema. It corresponds to an element or attribute in a page.

A schema contains a flat list of multiple fields.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax
Copy
public interface ISchemaField

The ISchemaField type exposes the following members.

Properties
  NameDescription
Public propertyAIHelpText
Gets/sets a field's AI related help text. Fields with AI help text will be included the full content AI content generation, and the help text will be part of the prompt to confine the content generation context.
Public propertyChildElementLabel
Gets/sets the child element label. Only applies to the List element field type.
Public propertyChildElementName
Gets/sets the child element's name. Only applies to the List element field type.
Public propertyChildElementType
Gets/sets the child element type. Only applies to the List element field type.
Public propertyDefaultValue
Gets/sets the field's default value.
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.
Public propertyFieldType
Gets/sets the type of field.
Public propertyHelpText
Gets/sets a field's help text. Help text, displayed on the Ingeniux CMS edit form, is information to help users complete the field.
Public propertyHidden
Gets/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.
Public propertyIndexable
Gets/sets the field's ability to be indexed for in site search.
Public propertyLabel
Gets/sets the the field's label (friendly name).
Public propertyName
Gets/sets the name of the field.
Public propertyOpenByDefault
Gets/sets whether this field should display all information to the client on initial get.
Public propertyReadonly
Gets/sets whether the field is read-only for non-administrator users on the CMS edit form.
Public propertyRequired
Gets/sets whether the field is required.
Public propertyTypeName
Gets the name of the field type.
Public propertyUniqueID
Gets/sets the unique ID of the Schema Field. Only effective in page creation for Element fields.
Top
Methods
  NameDescription
Public methodChildProperty
Gets a property of a child item of the field. Only applies to the List element field type.
Public methodProperty
Gets a field property by its name. Each property corresponds to an attribute on a pageelement.
Public methodRemoveExport
Removes a local exports entry if exists.
Public methodSerialize
Serialize this field into Ingeniux CMS XML schema format.
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.
Public methodSetExport
Sets a local exports entry. If the entry exists, it updates its value. Otherwise, it creates a new entry.
Public methodSetProperty
Sets a property of the field. If the property with the given name doesn't exist, creates a new property.
Top
Remarks

Normally one schema field corresponds to one page field. However there are exceptions:

A Group element in the schema consists of two fields: GroupStart and GroupEnd.

A List element may have multiple child elements, but in the schema, the List element and its children's properties are defined in one field.

See Also