url Property Template

Ben Tiedt — Fri, 23 Apr 2021 19:58:06 GMT

Current Revision posted to API Documentation by Ben Tiedt on 04/23/2021 19:58:06

Enables rendering of URL configuration properties

Supported Data Types

url, string

Scripted Extension Configuration XML

<property id="propertyId" labelResourceName="nameResource" descriptionResourceName="descriptionResource" dataType="url" template="url" defaultProtocol="http://" allowedFileExtensions="" allowLocal="false" allowRemote="true" enablePreview="false" />

Plugin Configuration C#

var property = new Property
{
	Id = "propertyId",
	LabelResourceName = "nameResource",
	DescriptionResourceName = "descriptionResource",
	DataType = "url",
	Template = "url",
	Options = new NameValueCollection
	{
		{ "defaultProtocol", "http://" },
		{ "allowedFileExtensions", "" },
		{ "allowLocal", "false" },
		{ "allowRemote", "true" },
		{ "enablePreview", "false" }
	}
};

Options

Name	Description	Default	Options
defaultProtocol	The default protocol to show for remote URLs.	http://
allowedFileExtensions	Comma-separated list of allowed file extensions for local uploads.
allowLocal	When true and when the configuration supports file embedding, allows files to be uploaded. Local files will be stored using their local URL.	false	true, false
allowRemote	When true, allows remote URLs to be linked.	true	true, false
enablePreview	When true, a preview of the current URL will be shown.	false	true, false