html Property Template

Ben Tiedt — Fri, 08 Mar 2024 17:22:41 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:22:41

Enables rendering of HTML configuration properties.

Supported Data Types

html

Scripted Extension Configuration XML

<property id="propertyId" labelResourceName="nameResource" descriptionResourceName="descriptionResource" dataType="html" template="html" enableRichEditing="false" rows="1" columns="40" contentTypeId="" />

Plugin Configuration C#

var property = new Property
{
	Id = "propertyId",
	LabelResourceName = "nameResource",
	DescriptionResourceName = "descriptionResource",
	DataType = "html",
	Template = "html",
	Options = new NameValueCollection
	{
		{ "enableRichEditing", "false" },
		{ "rows", "1" },
		{ "columns", "40" },
		{ "contentTypeId", "" }
	}
};

Options

Name	Description	Default	Options
enableRichEditing	If true, the rich editor will be used for WYSIWYG editing.	false	true, false
rows	The number of rows to show. If greater than 1, a source or rich editor will be used (dependent on the value of enableRichEditing).	1
columns	The number of columns to show.	40
contentTypeId	The content type being edited, if applicable. When enableRichEditing is enabled, this setting will be used to configure the rich text editor according to content filtering configuration for the provided content type.