string Property Template

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

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

Enables rendering of string configuration properties

Supported Data Types

string

Scripted Extension Configuration XML

<property id="propertyId" labelResourceName="nameResource" descriptionResourceName="descriptionResource" dataType="string" template="string" rows="1" columns="40" obscure="false" syntax="" />

Plugin Configuration C#

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

Options

Name	Description	Default	Options
rows	The number of rows to show when editing. If set to 1 and a syntax is defined, 10 rows will be rendered.	1
columns	The number of columns to show when editing.	40
obscure	When set to 'true' (and rows is '1' and 'syntax' is not specified), the value is visually obscured.	false
syntax	An optional syntax to edit within. When specified, syntax highlighting will be used when editing.		actionscript, applescript, batchfile, clojure, cobol, coffee, coldfusion, csharp, css, curly, d, dart, diff, dockerfile, erlang, golang, html, java, javascript, json, jsp, latex, less, lisp, lua, makefile, markdown, nix, objectivec, ocaml, pascal, perl, pgsql, php, powershell, praat, python, rhtml, ruby, rust, sass, scala, sql, sqlserver, text, typescript, velocity, xml, xquery, yaml