Please help us by completing this survey

Go to survey
Documentation

Docs / Development / Reference Field

Reference Field

The Reference Field is used for defining references to other content. When a content holds references pointing to other content (for example a group references users in its Members field) it is done using a Reference Field.

The following apply to the behavior of the Field:

Field handler

Usage in CTD:

<Field name="Manager" type="Reference">
   ...
</Field>

Supported Field Controls

Configuration

The following properties can be set in the Field’s Field Setting configuration:

For a complete list of common Field Setting configuration properties see CTD Field definition.

For developers

Please check the Node for developers article for advices on how can you work with reference properties in code.

Examples/Tutorials

Fully featured example:

<Field name="MyReferenceField" type="Reference">
	<DisplayName>My reference field</DisplayName>
	<Description>Referenced content</Description>
	<Configuration>
		<AllowMultiple>true</AllowMultiple>
		<AllowedTypes>
			<Type>Folder</Type>
			<Type>File</Type>
		</AllowedTypes>
		<SelectionRoot>
			<Path>/Root/System</Path>
			<Path>/Root/Sites</Path>
		</SelectionRoot>
		<DefaultValue>/Root/System/SystemPlugins,/Root/System/Schema</DefaultValue>
	</Configuration>
</Field>

The above example configures the Reference Field so that:

Is something missing? See something that needs fixing? Propose a change here.