Entities - Revision history

80.229.4.125: /* Field Attributes */

2024-02-05T15:38:12Z

Field Attributes

← Older revision		Revision as of 15:38, 5 February 2024
Line 147:		Line 147:
	* [Module("Admin/ModuleName")] - This attribute tells the admin panel to render your field with the given module. The module will receive everything that UI/Input would have, so that's props like label, name and value.		* [Module("Admin/ModuleName")] - This attribute tells the admin panel to render your field with the given module. The module will receive everything that UI/Input would have, so that's props like label, name and value.

	* [Module(~~false~~)] - This attribute tells the admin panel to hide your field with the given module.		* [Module(true)] - This attribute tells the admin panel to hide your field with the given module.

	* [Data("propName", "propValue")] - This attribute passes additional props to the admin panel rendering of your component. Works best with custom modules, but can also be used to override certain default behaviours.		* [Data("propName", "propValue")] - This attribute passes additional props to the admin panel rendering of your component. Works best with custom modules, but can also be used to override certain default behaviours.

80.229.4.125: /* Field Attributes */

2024-02-05T15:22:03Z

Field Attributes

← Older revision		Revision as of 15:22, 5 February 2024
Line 146:		Line 146:

	* [Module("Admin/ModuleName")] - This attribute tells the admin panel to render your field with the given module. The module will receive everything that UI/Input would have, so that's props like label, name and value.		* [Module("Admin/ModuleName")] - This attribute tells the admin panel to render your field with the given module. The module will receive everything that UI/Input would have, so that's props like label, name and value.

			* [Module(false)] - This attribute tells the admin panel to hide your field with the given module.

	* [Data("propName", "propValue")] - This attribute passes additional props to the admin panel rendering of your component. Works best with custom modules, but can also be used to override certain default behaviours.		* [Data("propName", "propValue")] - This attribute passes additional props to the admin panel rendering of your component. Works best with custom modules, but can also be used to override certain default behaviours.

Luke at 17:16, 9 December 2022

2022-12-09T17:16:08Z

← Older revision		Revision as of 17:16, 9 December 2022
Line 150:		Line 150:

	* [Localized] - Often used on names and descriptions, this attribute indicates that the field varies by locale. Works with any field type meaning it can also be used to make, for example, a price vary by locale too. When you use localized fields and there are more than one locale on your site, you'll get a dropdown on the admin panel to switch between editing different locales.		* [Localized] - Often used on names and descriptions, this attribute indicates that the field varies by locale. Works with any field type meaning it can also be used to make, for example, a price vary by locale too. When you use localized fields and there are more than one locale on your site, you'll get a dropdown on the admin panel to switch between editing different locales.

			* [Meta("metaFieldName")] - Marks this field as the source of a given named [[Content Type Meta Fields\|meta field]].

Luke: /* Search mode for large sets */

2022-11-18T16:42:20Z

Search mode for large sets

← Older revision		Revision as of 16:42, 18 November 2022
Line 132:		Line 132:
	</syntaxhighlight>		</syntaxhighlight>

	This search Data attribute ~~can be added~~ is a prop recognised by the Admin/ContentSelect component, so you can turn it on wherever you're using that component. The attributes value is the name of the field that is used during the search - in this case, we're searching pages based on if the search term matches anything in the page title.		This search Data attribute is a prop recognised by the Admin/ContentSelect component, so you can turn it on wherever you're using that component. The attributes value is the name of the field that is used during the search - in this case, we're searching pages based on if the search term matches anything in the page title.

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">

Luke: /* Search mode for large sets */

2022-11-18T16:41:51Z

Search mode for large sets

← Older revision		Revision as of 16:41, 18 November 2022
Line 124:		Line 124:
	=== Search mode for large sets ===		=== Search mode for large sets ===

	Because this is a generic content selector component, it makes some best guesses about what field to use as the display text in the dropdown. If you have a very large amount of content, a dropdown would be inappropriate and should ~~instead~~ display a searchable set instead to avoid listing thousands of things on an awkward dropdown. It has a search mode to help with this:		Because this is a generic content selector component, it makes some best guesses about what field to use as the display text in the dropdown. If you have a very large amount of content, a dropdown would be inappropriate and should display a searchable set instead to avoid listing thousands of things on an awkward dropdown. It has a search mode to help with this:

Luke: /* Field names */

2022-11-18T16:37:17Z

Field names

← Older revision		Revision as of 16:37, 18 November 2022
Line 17:		Line 17:
	Some field names are treated specially for convenience. This is the list of all current patterns checked for by AutoFormService.		Some field names are treated specially for convenience. This is the list of all current patterns checked for by AutoFormService.

	* string {Name}Ref - A string field ending with '''Ref''' indicates a file. You'll get a file selector in the admin panel for these. They should be given to the getRef function at UI/Functions/GetRef to either obtain a url or display it directly.		== Refs ==

			'''string {Name}Ref''' - A string field ending with '''Ref''' indicates a file. You'll get a file selector in the admin panel for these. They should be given to the getRef function at UI/Functions/GetRef to either obtain a url or display it directly.

	Whilst it's always recommended to end a field with ref so it's clear what data people are working with, you can get the same file selector on a field that doesn't end in ref by setting the type to image or file:		Whilst it's always recommended to end a field with ref so it's clear what data people are working with, you can get the same file selector on a field that doesn't end in ref by setting the type to image or file:
Line 26:		Line 28:
	</syntaxhighlight>		</syntaxhighlight>

	* DateTime {Name}, DateTime? {Name} - You should always postfix your date fields with '''Utc''' to make it obvious what the fields intended timezone is, however, any DateTime or DateTime? field will display a date selector. This is the same as setting the type to datetime:		If you don't want this behaviour on a field that fits this pattern, override it by setting the type to something else (default: text).

			== Dates ==

			'''DateTime {Name}, DateTime? {Name}''' - You should always postfix your date fields with '''Utc''' to make it obvious what the fields intended timezone is, however, any DateTime or DateTime? field will display a date selector. This is the same as setting the type to datetime:

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
Line 33:		Line 39:
	</syntaxhighlight>		</syntaxhighlight>

	* bool {Name}, bool? {Name} - Displays a checkbox on any bool field. This is the same as setting the type to checkbox:		If you don't want this behaviour on a field that fits this pattern, override it by setting the type to something else (default: text).

			== Booleans ==

			'''bool {Name}, bool? {Name}''' - Displays a checkbox on any bool field. This is the same as setting the type to checkbox:

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
Line 40:		Line 50:
	</syntaxhighlight>		</syntaxhighlight>

	* string {Name}Json - A string field ending with '''Json''' indicates canvas JSON by default. You'll get a wysiwig editor. If you want a regular Json editor instead, use a data attribute, like this:		If you don't want this behaviour on a field that fits this pattern, override it by setting the type to something else (default: text).

			== Canvas editors ==

			'''string {Name}Json''' - A string field ending with '''Json''' indicates canvas JSON by default. You'll get a wysiwig editor. If you want a regular Json editor instead, use a data attribute, like this:

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
Line 54:		Line 68:
	</syntaxhighlight>		</syntaxhighlight>

	* string {Name}Color, string {Name}Colour - Displays a colour picker. To get a colour picker on any other field, set the type to color:		If you don't want this behaviour on a field that fits this pattern, override it by setting the type to something else (default: text).

			== Colour pickers ==

			'''string {Name}Color, string {Name}Colour''' - Displays a colour picker. To get a colour picker on any other field, set the type to color:

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
Line 61:		Line 79:
	</syntaxhighlight>		</syntaxhighlight>

	* uint {Name}UserId - Displays a user selector. To display the same user selector on some other field, set the module like so:		If you don't want this behaviour on a field that fits this pattern, override it by setting the type to something else (default: text).

			== User selectors ==

			'''uint {Name}UserId''', '''int {Name}UserId''' - Displays a user selector. To display the same user selector on some other field, set the module like so:

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
Line 68:		Line 90:
	</syntaxhighlight>		</syntaxhighlight>

	* uint {EntityName}Id - a uint field ending with '''Id''' will be checked to see if you have an entity with the same name. If one exists, a selector for that entity will be used on the admin panel. ~~For example:~~		If you don't want this behaviour on a field that fits this pattern, override it by telling it to render with a regular UI/Input:

			<syntaxhighlight lang="csharp">
			[Module("UI/Input")]
			public uint ModeratedByUserId;
			</syntaxhighlight>

			== Entity selectors ==

			'''uint {EntityName}Id''' - a uint field ending with '''Id''' will be checked to see if you have an entity, i.e. any content type on your site, with the same name. If one exists, a selector for that entity will be used on the admin panel.

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
	public uint PageId;		public uint PageId; // Will display a dropdown of Page entries.
	</syntaxhighlight>		</syntaxhighlight>

	~~Will display a selector for~~ a ~~page. Override~~ this ~~behaviour~~ by telling it to render with a regular UI/Input:		If you don't want this behaviour on a field that fits this pattern, override it by telling it to render with a regular UI/Input:

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
Line 90:		Line 121:

	As with all Data attributes, contentType here is just a prop of the Admin/ContentSelect component. I.e. we're telling the form system to use a specific component to render this field and giving it some additional props to use as well.		As with all Data attributes, contentType here is just a prop of the Admin/ContentSelect component. I.e. we're telling the form system to use a specific component to render this field and giving it some additional props to use as well.

			=== Search mode for large sets ===

			Because this is a generic content selector component, it makes some best guesses about what field to use as the display text in the dropdown. If you have a very large amount of content, a dropdown would be inappropriate and should instead display a searchable set instead to avoid listing thousands of things on an awkward dropdown. It has a search mode to help with this:


			<syntaxhighlight lang="csharp">
			[Data("search", "title")]
			public uint PageId;
			</syntaxhighlight>

			This search Data attribute can be added is a prop recognised by the Admin/ContentSelect component, so you can turn it on wherever you're using that component. The attributes value is the name of the field that is used during the search - in this case, we're searching pages based on if the search term matches anything in the page title.

			<syntaxhighlight lang="csharp">
			[Module("Admin/ContentSelect")]
			[Data("search", "title")]
			[Data("contentType", "page")]
			public uint ParentPageId;
			</syntaxhighlight>

	=Field Attributes=		=Field Attributes=

Luke: /* Field names */

2022-11-18T16:23:50Z

Field names

← Older revision		Revision as of 16:23, 18 November 2022
Line 15:		Line 15:
	=Field names=		=Field names=

	Some field names are treated specially for convenience.		Some field names are treated specially for convenience. This is the list of all current patterns checked for by AutoFormService.

	* string {Name}Ref - A string field ending with '''Ref''' indicates a file. You'll get a file selector in the admin panel for these. They should be given to the getRef function at UI/Functions/GetRef to either obtain a url or display it directly.		* string {Name}Ref - A string field ending with '''Ref''' indicates a file. You'll get a file selector in the admin panel for these. They should be given to the getRef function at UI/Functions/GetRef to either obtain a url or display it directly.

	* DateTime {Name}~~Utc~~ - You should always postfix your date fields with Utc, to make it obvious what the fields intended timezone is.		Whilst it's always recommended to end a field with ref so it's clear what data people are working with, you can get the same file selector on a field that doesn't end in ref by setting the type to image or file:

			<syntaxhighlight lang="csharp">
			[Data("type", "file")]
			public string MyFileSelector;
			</syntaxhighlight>

			* DateTime {Name}, DateTime? {Name} - You should always postfix your date fields with '''Utc''' to make it obvious what the fields intended timezone is, however, any DateTime or DateTime? field will display a date selector. This is the same as setting the type to datetime:

			<syntaxhighlight lang="csharp">
			[Data("type", "datetime")]
			public DateTime MyDateSelector;
			</syntaxhighlight>

			* bool {Name}, bool? {Name} - Displays a checkbox on any bool field. This is the same as setting the type to checkbox:

			<syntaxhighlight lang="csharp">
			[Data("type", "checkbox")]
			public int ZeroOrOne;
			</syntaxhighlight>

	* string {Name}Json - A string field ending with '''Json''' indicates canvas JSON by default. You'll get a wysiwig editor. If you want a regular Json editor instead, use a data attribute, like this:		* string {Name}Json - A string field ending with '''Json''' indicates canvas JSON by default. You'll get a wysiwig editor. If you want a regular Json editor instead, use a data attribute, like this:
Line 26:		Line 45:
	[Data("contentType", "application/json")]		[Data("contentType", "application/json")]
	public string ConfigurationJson;		public string ConfigurationJson;
			</syntaxhighlight>

			To get a canvas editor on a field that does not end in Json, set the type to canvas:

			<syntaxhighlight lang="csharp">
			[Data("type", "canvas")]
			public string Configuration;
			</syntaxhighlight>

			* string {Name}Color, string {Name}Colour - Displays a colour picker. To get a colour picker on any other field, set the type to color:

			<syntaxhighlight lang="csharp">
			[Data("type", "color")]
			public string Background;
			</syntaxhighlight>

			* uint {Name}UserId - Displays a user selector. To display the same user selector on some other field, set the module like so:

			<syntaxhighlight lang="csharp">
			[Module("Admin/User/Select")]
			public uint ModeratedBy;
	</syntaxhighlight>		</syntaxhighlight>

Line 40:		Line 80:
	public uint PageId;		public uint PageId;
	</syntaxhighlight>		</syntaxhighlight>

			If you would like the same content selector on a field which does not match this pattern, set the module and contentType like so:

			<syntaxhighlight lang="csharp">
			[Module("Admin/ContentSelect")]
			[Data("contentType", "page")]
			public uint ParentPageId;
			</syntaxhighlight>

			As with all Data attributes, contentType here is just a prop of the Admin/ContentSelect component. I.e. we're telling the form system to use a specific component to render this field and giving it some additional props to use as well.

	=Field Attributes=		=Field Attributes=

Luke: /* Field Attributes */

2022-03-24T17:39:58Z

Field Attributes

← Older revision		Revision as of 17:39, 24 March 2022
Line 48:		Line 48:

	* [Data("propName", "propValue")] - This attribute passes additional props to the admin panel rendering of your component. Works best with custom modules, but can also be used to override certain default behaviours.		* [Data("propName", "propValue")] - This attribute passes additional props to the admin panel rendering of your component. Works best with custom modules, but can also be used to override certain default behaviours.

			* [Localized] - Often used on names and descriptions, this attribute indicates that the field varies by locale. Works with any field type meaning it can also be used to make, for example, a price vary by locale too. When you use localized fields and there are more than one locale on your site, you'll get a dropdown on the admin panel to switch between editing different locales.

Luke: /* Field names */

2022-03-24T17:36:30Z

Field names

← Older revision		Revision as of 17:36, 24 March 2022
Line 17:		Line 17:
	Some field names are treated specially for convenience.		Some field names are treated specially for convenience.

	* string {Name}Ref - A string field ending with Ref indicates a file. You'll get a file selector in the admin panel for these. They should be given to the getRef function at UI/Functions/GetRef to either obtain a url or display it directly.		* string {Name}Ref - A string field ending with '''Ref''' indicates a file. You'll get a file selector in the admin panel for these. They should be given to the getRef function at UI/Functions/GetRef to either obtain a url or display it directly.

	* DateTime {Name}Utc - You should always postfix your date fields with Utc, to make it obvious what the fields intended timezone is.		* DateTime {Name}Utc - You should always postfix your date fields with Utc, to make it obvious what the fields intended timezone is.

	* string {Name}Json - A string field ending with Json indicates canvas JSON by default. You'll get a wysiwig editor. If you want a regular Json editor instead, use a data attribute, like this:		* string {Name}Json - A string field ending with '''Json''' indicates canvas JSON by default. You'll get a wysiwig editor. If you want a regular Json editor instead, use a data attribute, like this:

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
Line 28:		Line 28:
	</syntaxhighlight>		</syntaxhighlight>

	* uint {EntityName}Id - a uint field ending with Id will be checked to see if you have an entity with the same name. If one exists, a selector for that entity will be used on the admin panel. For example:		* uint {EntityName}Id - a uint field ending with '''Id''' will be checked to see if you have an entity with the same name. If one exists, a selector for that entity will be used on the admin panel. For example:

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
Line 40:		Line 40:
	public uint PageId;		public uint PageId;
	</syntaxhighlight>		</syntaxhighlight>


	=Field Attributes=		=Field Attributes=

Luke at 17:36, 24 March 2022

2022-03-24T17:36:08Z

← Older revision		Revision as of 17:36, 24 March 2022
Line 7:		Line 7:
	</syntaxhighlight>		</syntaxhighlight>

	Use a plural name here, otherwise you'll be asked if you wanted to make a simple service instead. This is to avoid class naming collisions, i.e. the above ultimately creates an entity class called ""Api.TodoItems.TodoItem"".		Use a plural name here, otherwise you'll be asked if you wanted to make a simple service instead. This is to avoid class naming collisions, i.e. the above ultimately creates an entity class called '''Api.TodoItems.TodoItem'''.

	=Fields=		=Fields=