dundas.controls.ParameterCheckboxList Class

 

Inheritance Hierarchy

 
Class
   dundas.controls.Parameter
      dundas.controls.ParameterCheckboxList
 

Constructors

 
  Name Description
init Initializes the control. Called during construction. Inherited from dundas.controls.Parameter.
 
 

Properties

 
  Name Description
background Gets or sets the brush used to fill the background of the control. Inherited from dundas.controls.Parameter.
border Gets or sets the border in the control. Inherited from dundas.controls.Parameter.
hierarchy Gets or sets the hierarchy that should be used if this check box list is using a hierarchy.
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. Inherited from dundas.controls.Parameter.
isContextMenuHidden Gets or sets a value indicating whether or not the context menu should be hidden. Inherited from dundas.controls.Parameter.
isInvertHidden Gets or sets a value indicating whether or not the inversion context menu option context menu and token menu option should be hidden. Inherited from dundas.controls.Parameter.
isParameterTypeIconHidden Gets or sets a value indicating whether or not the parameter type icon will be shown. Inherited from dundas.controls.Parameter.
isRadioMode Gets or sets the radio mode of control. Only one checkbox can be checked when in radio mode.
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. Inherited from dundas.controls.Parameter.
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'. Inherited from dundas.controls.Parameter.
isVertical Gets or sets a value indicating whether this control should be laid out vertically. Inherited from dundas.controls.Parameter.
items Gets or sets the items displayed in the control.
itemsWordWrap Gets or sets the word wrap property of the item label texts in control.
labelPosition Gets or sets the label position in the control. Inherited from dundas.controls.Parameter.
labelText Gets or sets the text label displayed in the control.
labelTextWordWrap Gets or sets the word wrap property of the primary label text in control.
parameterValue Gets or sets the parameter value this control will update. Inherited from dundas.controls.Parameter.
parentEntityId Gets or sets the parent entity ID which will be used to resolve a parameter value's token. This is typically a metric set, but is optional and may not be set.
shownTokens Gets or sets a list of token IDs indicating which tokens will be shown. This can be null if no filter is desired. Inherited from dundas.controls.Parameter.
tokenMenuVisibility Gets or sets a value indicating where the token menu is visible. Inherited from dundas.controls.Parameter.
tooltipDelay Gets or sets the delay in milliseconds after hovering over this control with a mouse before its tooltip is displayed. Inherited from dundas.controls.Parameter.
tooltipText Gets or sets the text tooltip displayed in the control.
 
 

Methods

 
  Name Description
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. Inherited from dundas.controls.Parameter.
getContextMenuCommands Gets the context menu commands for the parameter control. Inherited from dundas.controls.Parameter.
getHierarchyInfo Gets the hierarchy information if this control supports a hierarchy. If it does not, null is returned. Inherited from dundas.controls.Parameter.
getTokenCompatibleDataTypes Gets the compatible data types for the parameter token call. Inherited from dundas.controls.Parameter.
getTokenDisplayTypes Gets the display types for the parameter token call. Inherited from dundas.controls.Parameter.
onItemsChanged Notify control that items have changed.
populateFromHierarchy This method, when called, will re-populate the items from the hierarchy.
populateFromParameter This method, when called, will re-populate the items from the valid values from the parameter.
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. Inherited from dundas.controls.Parameter.
setControlTooltipText Attempts to set the control's tooltip text. If the control is a range input, only the start tooltip is set. Inherited from dundas.controls.Parameter.
setCrossFilterValues Sets any cross filter values which should be passed along with any hierarchyService.getMembers(..) call done by this control. Setting this will cause a refresh.
setInheritedFilterValues Sets any inherited filter values which should be passed along with any hierarchyService.getMembers(..) call done by this control. Setting this will cause a refresh.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.