Template kind reference

Build 1501 on 14/Nov/2017  This topic last edited on: 21/Mar/2016, at 19:00

Member name

Description

Access

Attribute types supported: Access.

Template options supported: createObjectUI, DataTemplate, searchObjectUI and Sort.

Access template

Audio

Attribute types supported: DataContent.

Audio Player

AutoComplete

Attribute types supported: MultiCategory, MultiReference, Reference and SingleCategory.

Template options supported: autoCompleteMinChars, createObjectUI, searchAttributes and startsWith.

A text box with auto-complete listbox

Calendar

Attribute types supported: Date, DateTime.

Template options supported: format.

Calendar template

CalendarTime

Attribute types supported: DateTime.

Template options supported: format, timeZone.

Combination of calendar and time

CheckBox

Attribute types supported: Boolean.

CheckBox template

CheckBoxes

Attribute types supported: EnumSet.

Template options supported: sorted (when being used for editing EnumSet).

List of check-boxes

Color

Attribute types supported: RgbColor.

Color template

CompactList

 

DropDown

Attribute types supported: Boolean, Enum, Int (and descendants), ObjectTypeRef, Reference, RgbColor and SingleCategory.

Template options supported: createObjectUI (when being used for editing Reference), sorted and nameExtra (when being used for editing Reference and SingleCategory).

DropDown template

ExaleadSuggest

A text box with a list box from which it is possible to select keywords suggested by Exalead (people, location, organization, etc.).

Warning: ExaleadSuggest can be used only in editing forms, not in creation forms.

Attribute types supported: Keywords.

Template options supported:

autoCompleteMinChars: indicates the minimum number of characters to be entered before the query used to fill the suggestions list is fired. Default is 3.

startsWith: indicates whether the keywords to be suggested must start with the characters entered in the text box or if the position of the characters entered does not matter. Default is true.

exaleadCategories: indicates the exalead category types to be suggested.

separators: indicates the characters to be considered as separators. By default, no character is recognized as separator, and so the suggestions list shows only for the first word written in textbox. Note that for Keywords attributes, this parameter is added too with the deafult separator of the comma.

Note: since build 2711, all ExaleadXXX templates are renamed to FullTextXXX, and the ExaleadFullText became FullText.

ExpandedTree

 

Grid

Attribute types supported: List and MultiReference.

Template options supported: createObjectUI, DataTemplate (when being used for editing MultiReference), nameExtra (when being used for editing Reference), searchObjectUI (when being used for editing MultiReference) and Sort (when being used for editing MultiReference).

Multi columns grid that supports adding new rows, editing or removing existing rows and re-ordering rows if supported by the underlying attribute type.

GridAutoComplete

Attribute types supported: MultiReference.

Template options supported: autoCompleteMinChars, searchAttributes and startsWith.

Multi columns grid that supports adding new rows with auto complete, editing or removing existing rows and re-ordering rows if supported by the underlying attribute type.

HtmlEditor

Attribute types supported: DataContent, String, and Xml.

Template options supported: format (when being used for editing String), rightToLeft, showReadingTime, useSpellChecker and useWordCount.

Html Editor

Image

Attribute types supported: DataContent.

An image

Map

Attribute types supported: Position,

Template options supported: language.

A map from which select a geographical position.

MultiLineString

Attribute types supported: DataContent, String, and Xml.

Template options supported: format, rightToLeft (when being used for editing String), showReadingTime, useSpellChecker and useWordCount.

Multi-line string editing

MultiReference

Attribute types supported: MultiReference

!!! Not supported in GNPortal !!!

Template options supported: editScript newScript addScript multipleSelection

Multi Reference

ParamsGrid

Attribute types supported: List, when they are defined in the schema as attributes of the complex type tParams.

Template options supported: paramsDefPath.

Two columns grid that supports adding, editing or removing existing parameters. If the paramsDefPath template option is specified, then the parsDef of the associated template is used to assist the editing and validate the values edited.

Password

Attribute types

Template options supported:

Password

askForOldPassword.

Password entry: masked double string editing (main and confirmation)

Radio

List of radio buttons Template options supported: sorted.

Search

Attribute types supported: Reference.

Template options supported: createObjectUI, DataTemplate, searchObjectUI and Sort.

A search form to select a new value

SimpleList

Attribute types supported: Children, EnumSet and MultiReference.

Template options supported: DataTemplate (when being used for editing MultiReference), searchObjectUI (when being used for editing MultiReference), Sort (when being used for editing MultiReference) and sorted (when being used for editing EnumSet).

Table that supports adding new elements selected from a pop-up dialog, removing elements and re-ordering elements if supported by the underlying attribute type.

SimpleString

Attribute types supported: Date, DateTime, Id, Numeric (and descendants), RgbColor, String, Time.

Template options supported: format, rightToLeft (when being used for editing String), showReadingTime, units (when being used for editing Numeric, useSpellChecker and useWordCount.

Simple (single-line) string editing

StartCopyFlow

Attribute types supported: Only Reference attributes to objects of type 'folder' and 'calendar'. Moreover, StartCopyFlow can be used only in creation forms, not in edit forms.

Suggest

A text box with a list box from which it is possible to select keywords suggested.

Attribute types supported: String, Keywords.

Template options supported:

autoCompleteMinChars: indicates the minimum number of characters to be entered before the query used to fill the suggestions list is fired. Default is 3.

forceKeywords (only for String attributes): TODO Alberto: document here. Default is false.

keywordSetName (only for String attributes): indicates the keyword set from which the keywords to be suggested are taken. Note that for Keywords attributes, the keyword set is already associated in the schema definition of the attribute.

separators: indicates the characters to be considered as separators. By default, no character is recognized as separator, and so the suggestions list shows only for the first word written in textbox. Note that for Keywords attributes, this parameter is added too with the dafult separator of the comma.

startsWith: indicates whether the keywords to be suggested must start with the characters entered in the text box or if the position of the characters entered within the keywords does not matter. Default is true.

TextStatus

Attribute types supported: String

!!! Not supported in GNPortal !!!

Template options supported: sourceJustScope

Text Status

Time

Attribute types supported: Time.

Template options supported: format, timeZone.

Time template

Tree

Attribute types supported: MultiCategory, MultiReference, Reference and SingleCategory.

Template options supported: defaultWeight (when being used for editing MultiCategory), displayCompletePath, homeFolderOnly (when being used for editing Reference and MultiReference), root (when being used for editing Reference and MultiReference), showHomeFoldersOnTop (when being used for editing Reference and MultiReference), refAttributes (when being used for editing Reference and MultiReference) and showWeights (when being used for editing MultiCategory).

A tree.

TriCheckBoxes

Attribute types supported: TriStateSet.

List of three-state check-boxes

Upload

Attribute types supported: DataContent.

Template options supported: DataTemplate and parse.

Upload template

Video

Attribute types supported: DataContent.

Video Player

XmlCombo

Attribute types supported: String

!!! Not supported in GNPortal !!!

Template options supported: displayPath and sourcePath.

Xml ComboBox

XmlEditor

.

Attribute types supported: DataContent and Xml.

Template options supported: format (when being used for editing String) and useSpellChecker

Xml editor

 

 

When specifying fields for search panes, search dialogs and custom dialogs, the following template kind are available:

<template kind="Access" permissionsSet="Folders" xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd">

<template kind="Access" xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd">

<template kind="AutoComplete" autoCompleteMinChars="1"/>

<template kind="Calendar" opCodes="Today Tomorrow ThisYear ThisMonth ThisWeek NextYears NextMonths NextWeeks NextDays EqualDate" />

<template kind="Calendar" opCodes="Today Yesterday ThisYear ThisMonth ThisWeek EqualDate" />

<template kind="CheckBox" opMode="Hidden"/>

<template kind="CheckBoxList" />

<template kind="CheckBoxList" objectTypes="article audio document image img story video" opMode="Hidden"/>

<template kind="CheckBoxList" objectTypes="article img audio document image story video"/>

<template kind="CheckBoxList" objectTypes="article img"  opMode="Hidden"/>

<template kind="CheckBoxList" objectTypes="article img"/>

<template kind="CheckBoxList" objectTypes="article story image img audio video url" opMode="Hidden"/>

<template kind="CheckBoxList" objectTypes="audio document image story video" opMode="Hidden"/>

<template kind="CheckBoxList" objectTypes="audio document image story video"/>

<template kind="CheckBoxList" objectTypes="audio image story video" opMode="Hidden"/>

<template kind="CheckBoxList" objectTypes="audio image story video"/>

<template kind="CheckBoxList" objectTypes="image"/>

<template kind="CheckBoxList" objectTypes="story image video audio" opMode="Hidden"/>

<template kind="CheckBoxList" opMode="Hidden" />

<template kind="CompactList" opMode="Hidden" />

<template kind="CompactList" opMode="Hidden" objectTypes="audio document image package story video" />

<template kind="CompactList" opMode="Hidden" objectTypes="audio document image package story video" />

<template kind="DropDown" xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd">

<template kind="DropDown" xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd" sorted="true">

<template kind="ExpandedTree" refAttributes="pubDestParent" opMode="Hidden"/>

<template kind="Grid" xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd">

<template kind="ListBox" opMode="Hidden" />

<template kind="MultiLineString" useSpellChecker="yes" xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd">

<template kind="MultiLineString" xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd">

<template kind="MultiLineString"/>

<template kind="MultiReference"

<template kind="ParamsGrid" paramsDefPath="printQueueRef.parsDef" xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd" />

<template kind="ParamsGrid" paramsDefPath="templateRef.parsDef" xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd" />

<template kind="SimpleString" />

<template kind="SimpleString" useSpellChecker="yes" xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd" />

<template kind="SimpleString" xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd" />

<template kind="SimpleString">

<template kind="Single" />

<template kind="Single" objectTypes="security user group" opMode="Hidden"/>

<template kind="Single" opMode="Hidden" />

<template kind="Single"/>

<template kind="TextStatus"

<template kind="Tree"

<template kind="Tree" opMode="Hidden" />

<template kind="Tree" refAttributes="archiveParent"/>

<template kind="Tree" refAttributes="calendarParent" opMode="Hidden"/>

<template kind="Tree" refAttributes="folderParent" />

<template kind="Tree" refAttributes="pubDestParent" />

<template kind="Tree" refAttributes="titleRef" />

<template kind="Tree" root="/Wires" opMode="Hidden" />

<template kind="Tree"/>

<template kind="Upload" xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd">

<template kind="XmlCombo"