dundas.controls.Parameter Class

Inheritance Hierarchy

Constructors

	Name	Description
	init	Initializes the control. Called during construction.

Properties

	Name	Description
	background	Gets or sets the brush used to fill the background of the control.
	border	Gets or sets the border in the control.
	includeAttributeTokens	Gets or sets a value indicating whether or not attribute tokens should be included in the call for tokens. Normally this is not desired.
	isContextMenuHidden	Gets or sets a value indicating whether or not the context menu should be hidden.
	isInvertHidden	Gets or sets a value indicating whether or not the inversion context menu option context menu and token menu option should be hidden.
	isParameterTypeIconHidden	Gets or sets a value indicating whether or not the parameter type icon will be shown.
	isTokenMenuHidden	Gets or sets a value indicating whether or not the token menu should be hidden. This property is a shortcut to setting tokenMenuVisibility directly. It will return true if tokenMenuVisibility is NONE; otherwise false.
	isUnresolvedTokenCaptionShown	Gets or sets a value indicating whether or not the unresolved token caption should be used instead of the resolved one. For example, by default the 'current month' would show the resolved month such as 'January 1, 2017', however in unresolved mode it will display 'Current Month'.
	isVertical	Gets or sets a value indicating whether this control should be laid out vertically.
	labelPosition	Gets or sets the label position in the control.
	parameterValue	Gets or sets the parameter value this control will update.
	shownTokens	Gets or sets a list of token IDs indicating which tokens will be shown. This can be null if no filter is desired.
	tokenMenuVisibility	Gets or sets a value indicating where the token menu is visible.
	tooltipDelay	Gets or sets the delay in milliseconds after hovering over this control with a mouse before its tooltip is displayed.

Methods

	Name	Description
	CreateParameterControl	Factory method to create a type of parameter control from the given parameter value.
	fromJObject	Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
	getContainer	Retrieves the container DOM.
	getContextMenuCommands	Gets the context menu commands for the parameter control.
	getHierarchyInfo	Gets the hierarchy information if this control supports a hierarchy. If it does not, null is returned.
	getTokenCompatibleDataTypes	Gets the compatible data types for the parameter token call.
	getTokenDisplayTypes	Gets the display types for the parameter token call.
	setControlLabelText	Attempts to set the control's label text. If the control is a range input, only the start label is set, and the end label is set to blank.
	setControlTooltipText	Attempts to set the control's tooltip text. If the control is a range input, only the start tooltip is set.
	toJSON	Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.