articles_v1_articleCollectionLookup Property Template

Ben Tiedt — Fri, 23 Apr 2021 19:57:21 GMT

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

Enables articlecollection or group selection using type-ahead search. Represents selections as a querystring: when groups are selected the format is Group=ID&IncludeSubGroups=True, when articlecollections are selected the format is ArticleCollection=ID.

Supported Data Types

custom

Scripted Extension Configuration XML

<property id="propertyId" labelResourceName="nameResource" descriptionResourceName="descriptionResource" dataType="custom" template="articles_v1_articleCollectionLookup" enableCurrentArticleCollection="true" maxArticleCollectionSelections="1" maxGroupSelections="1" enableGroupSelection="true" enableCurrentGroup="false" parentGroupId="" format="query" />

Plugin Configuration C#

var property = new Property
{
	Id = "propertyId",
	LabelResourceName = "nameResource",
	DescriptionResourceName = "descriptionResource",
	DataType = "custom",
	Template = "articles_v1_articleCollectionLookup",
	Options = new NameValueCollection
	{
		{ "enableCurrentArticleCollection", "true" },
		{ "maxArticleCollectionSelections", "1" },
		{ "maxGroupSelections", "1" },
		{ "enableGroupSelection", "true" },
		{ "enableCurrentGroup", "false" },
		{ "parentGroupId", "" },
		{ "format", "query" }
	}
};

Options

Name	Description	Default	Options
enableCurrentArticleCollection	When true, enables current articlecollection selection (represented with an ID of 00000000-0000-0000-0000-000000000000).	true	true, false
maxArticleCollectionSelections	The number of articlecollections that can be selected.	1
maxGroupSelections	The number of groups that can be selected.	1
enableGroupSelection	When enabled, groups can be selected. Group selections will be in the format Group=ID where ID is the integer ID of the group.	true
enableCurrentGroup	When true, enables current group selection (represented with an ID of -1).	false
parentGroupId	When set to a group's integer identifier, only articlecollections and groups in the specified group can be selected.
format	When set to 'query', all selected groups/ articlecollections will be represented with their own query keys. When set to 'csv', all selected groups/articlecollections are comma-separated in a shared query key.	query	query, csv