Document Object Model - Variable

A variable field. Many properties only apply to certain dataTypes

Fields

Name	Type	Triggers	Description

Name	Type	Triggers	Description
customButtons	CustomButtons		Custom button collection
displayName	string	Triggered when the definition of a Variable is changed	Display name
displayFilter	string	Triggered when the definition of a Variable is changed	Display filter (used in combination with filter on VariableInput Panel)
dataType	string	Triggered when the definition of a Variable is changed	Variable data type
defaultValue	string	Triggered when the definition of a Variable is changed	Default variable value
notes	string		Administrative notes for Variable
imgXML	string	Triggered when the value of a Variable is changed	Loaded Image/Asset definition XML (as returned by for example ResourceItemGetDefinitionXML for Assets Resource)
displayValue	string		Display value (calculatedby combining value with prefix, suffix, ...)
required	bool	Triggered when the definition of a Variable is changed	Variable is required input for end users
visible	bool	Triggered when the visibility of a variable in the input for is changed	Variable is visible in input form?
info	string	Triggered when the definition of a Variable is changed	Variable info / help text
pushChangesToDataSource	bool		Variable is visible in input form?
showInfoInline	bool	Triggered when the definition of a Variable is changed	Show variable info inline in input form (rather than just as tooltip)
removeParagraphIfEmpty	bool	Triggered when the definition of a Variable is changed	Remove paragraphs where the variable is placed, if no value
prefix	string	Triggered when the definition of a Variable is changed	Prefix (prepended to displayValue if value is not empty)
suffix	string	Triggered when the definition of a Variable is changed	Suffix (apppended to displayValue if value is not empty)
checkedValue	string	Triggered when the definition of a Variable is changed	Checked value for checkboxes
unCheckedValue	string	Triggered when the definition of a Variable is changed	Uncheck value for checkboxes
itemFilter	string	Triggered when the definition of a Variable is changed	Item filter
allowEditStyle	bool	Triggered when the definition of a Variable is changed	Allow Formatted Text Styles
controlHeight	int	Triggered when the definition of a Variable is changed	Input control height (formatted text, multi-line text, ...)
maxLength	int	Triggered when the definition of a Variable is changed	Maximum text length during user input
dateDisplayFormat	string	Triggered when the definition of a Variable is changed	Date Settings
dateNumDaysBeforeToday	string	Triggered when the definition of a Variable is changed	Date Settings
dateNumDaysAfterToday	string	Triggered when the definition of a Variable is changed	Date Settings
dateFirstDayOfWeek	int	Triggered when the definition of a Variable is changed	Date Settings
dateRangeStart	string	Triggered when the definition of a Variable is changed	Date Settings
dateRangeEnd	string	Triggered when the definition of a Variable is changed	Date Settings
includeEmptyItem	bool	Triggered when the definition of a Variable is changed	Include empty item in list
multipleSelection	bool	Triggered when the definition of a Variable is changed	Allow multiple selection on lists
concatenationPrefix	string	Triggered when the definition of a Variable is changed	Concatenation prefix for list items (multiple selection)
concatenationSuffix	string	Triggered when the definition of a Variable is changed	Concatenation suffix for list items (multiple selection)
minimum	number	Triggered when the definition of a Variable is changed	Minimum numeric value
maximum	number	Triggered when the definition of a Variable is changed	Maximum numeric value
numberDecimalSeparator	string	Triggered when the definition of a Variable is changed	Numeric decimal separator
numberThousandsSeparator	string	Triggered when the definition of a Variable is changed	Numeric thousands separator
numberPrecision	int	Triggered when the definition of a Variable is changed	Numeric precision
numberRounding	NumberRounding	Triggered when the definition of a Variable is changed	Numeric rounding strategy
minimumUnit	unit	Triggered when the definition of a Variable is changed	Minimum unit value
maximumUnit	unit	Triggered when the definition of a Variable is changed	Maximum unit value
snapInterval	number	Triggered when the definition of a Variable is changed	Numeric snap interval
value	object	Triggered when the value of a Variable is changed	Variable value
stepSize	number	Triggered when the definition of a Variable is changed	Numeric step size
allowFont	bool	Triggered when the definition of a Variable is changed	Allow Formatted Text Font selection
allowFontSize	bool	Triggered when the definition of a Variable is changed	Allow Formatted Text font size input
allowFontStyle	bool	Triggered when the definition of a Variable is changed	Allow Formatted Text font style choice
allowFontUnderLine	bool	Triggered when the definition of a Variable is changed	Allow Formatted Text underline
allowFontAlign	bool	Triggered when the definition of a Variable is changed	Allow Formatted Text Font align selection
allowFontLineThrough	bool	Triggered when the definition of a Variable is changed	Allow Formatted Text linethrough
allowFontPosition	bool	Triggered when the definition of a Variable is changed	Allow Formatted Text font position
allowFontColor	bool	Triggered when the definition of a Variable is changed	Allow Formatted Text Font Color Selection
allowFontBulletLists	bool	Triggered when the definition of a Variable is changed	Allow Formatted Text Bulletlists
imageShowPreview	bool	Triggered when the definition of a Variable is changed	Show image previews
imageAllowUpload	bool	Triggered when the definition of a Variable is changed	Allow image upload
imageAllowCrop	bool	Triggered when the definition of a Variable is changed	Allow image cropping
imageFromPulldown	bool	Triggered when the definition of a Variable is changed	Images presented in pulldown
imagePulldownDirectory	string	Triggered when the definition of a Variable is changed	Image pulldown source directory (in CHILI DAM)
dateDisabledDays	string	Triggered when the definition of a Variable is changed	Date Settings
listItems	VariableListItems		List item configuration
tableSettings	VariableTableSettings		Table Configuration
tableRows	VariableTableRows		TableRow configuration
changeAction	VariableChangeAction		Variable change action
validationAction	VariableValidationAction		Variable validation action
visibilityAction	VariableVisibleAction		Visibility calculation action
valueAction	VariableValueAction		Value calculation action
imageUploadOnly	bool	Triggered when the definition of a Variable is changed	Only allow upload of new images (no selection of existing)
imageSource	VariableImageSource	Triggered when the definition of a Variable is changed	Image source type
imageSourcePanelProperties	string	Triggered when the definition of a Variable is changed	Image Panel Properties (when popup is used)
imageAllowCropManualCoordinates	bool	Triggered when the definition of a Variable is changed	If true, the crop popup in the variable input form includes the possibility for the user to manually enter the crop coordinates
imageCropAllInstances	bool	Triggered when the definition of a Variable is changed	If true, all instances of the variable (in any frame) are cropped at the same time
imagePulldownDirectoryVariable	Variable	Triggered when the definition of a Variable is changed	Bind pulldown directory to another variable
textDirection	VariableTextDirection	The Text Direction of a Variable was modified	Text direction
maxLengthShowInForm	bool	Triggered when the definition of a Variable is changed	Maximum length shown in the input form
applyToSnippets	bool	Triggered when the definition of a Variable is changed	If true, similarly named variables in placed snippets will also be updated
emptyItemIsSelected	bool	Triggered when the definition of a Variable is changed	Included empty item is selected in list
dynamicAssetProvider	string	Triggered when the definition of a Variable is changed
dynamicAssetProviderValue