DataPA Enterprise Dashboard Controls API Reference

The ControlPanelObject type exposes the following members.

Constructors

Methods

  Name Description
Public method AddQueryRequiredField
Add's a required field reference to this control panel object.
Public method BuildDropDownData
Rebuilds the data for a drop down list
Public method CopyToClipboard
Copies this object to the clipboard.
Public method GenerateMinAndMax
Generates the min and max values for a slider
Public method GetObjectData(SerializationInfo)
Public method GetObjectData(SerializationInfo, StreamingContext)
Public method GetValueString
Returns the value as a string, using the ControlPanelObject numeric format settings where appropriate.
Public method ObjectIsDependant
Gets a value that indicates if the provided dashboard object is dependant on this filter condition object.
Public method RemoveQueryRequiredField
Removes a required field reference from this object.
Public method ResetDataProvider
Protected method SetObjectData

Fields

  Name Description
Public field Static member ClassId
Public field Static member EventsId
Public field Static member InterfaceId

Properties

  Name Description
Public property AllowAllInDropDownList
Gets and sets a value that indicates whether the drop down list filter condition will include the option ALL
Public property Clone
Gets cloned copy of this object (only the ID will be different).
Public property COMValue
Gets and sets the selected value that this control panel object returns. (String version for COM, which cannot expose object properties).
Public property DefaultRequiredField
Gets the default required field that this control panel object represents.
Public property DependandQueryIDs
Gets and sets a list of query IDs that represents which queries require this object to refresh when refreshed.
Public property DependantCalculatedColumns
Gets a list of calculated columns that are dependant on this filter parameter value
Public property DirectFilterDependantObjects
Gets a collection that contains all the DashboardObjects that are dependant on this filter condition, excluding those that are dependant on other dependants.
Public property DisplayColumn
Gets and sets the column that is used to populate the control panel object.
Public property DisplayColumnDateType
Gets and sets a value that determines how date and date/time values are treated in the display of a drop down list
Public property DisplayColumnIsDate
Gets and sets a value that indicates whether the drop down list display column is a date column.
Public property DisplayColumnIsDateTime
Gets and sets a value that indicates whether the drop down list display column is a DateTime column.
Public property DropDownList
Gets and sets an array that represents the manual list of values used to populate the drop down list.
Public property Enabled
Gets a value that indicates whether the ControlPanelObject is currently enabled.
Public property FilterControlType
Gets and sets the type of control used to render a filter control.
Public property FilterDependantControlPanelObjects
Gets a collection that contains all the ControlPanelObjects that are dependant on this filter condition.
Public property FilterDependantObjects
Gets a collection that contains all the DashboardObjects that are dependant on this filter condition.
Public property Font
Gets and sets the font used by this control panel object.
Public property FontColour
Gets and sets the colour of the font used by this panel object.
Public property forceTrailingZeros
Gets and sets a value that indicates whether all labels should have the number of decimal digits specified by numberDecimals, even if it requires trailing zeros.
Public property GUID
Gets a GUID that uniquely identifies this object.
Public property HAlign
Gets and sets a value that represents the horizontal alignment of the contents of this control object.
Public property ID
Gets a value that indicates the Unique ID of this object.
Public property IgnoreDuplicatesInDropDownList
Gets and sets a value that indicates whether the drop down list should include duplicate items.
Public property Image
Gets and sets an image this object will display.
Public property ImageDisplayType
Gets and sets a value that determines how the image is rendered.
Public property ListDataTable
Gets the data table that is used to populate a drop down list.
Public property ListDataTag
Gets and sets the identifier that indicates which dataset is used to populate a drop down list
Public property LookupObject
Gets the RunDataPA.Lookup object that this ControlPanelObject uses to populate the drop down list.
Public property ManualDataDefinition
Gets and sets a value that indicates whether the data for this object is populated manually.
Public property MaximumValue
Gets and sets the Maximum value on a ControlPanelObject with the FilterControlType of slider.
Public property MinimumValue
Gets and sets the minimum value on a ControlPanelObject with the FilterControlType of slider.
Public property numberDecimals
Gets and sets a value that indicates the number of decimal places that should be used for values represented on the ControlPanelObject.
Public property NumericGuiFormat
Gets a GUI format string for this Column
Public property numericPrefix
Gets and sets the numeric prefix (text before the data value) that will be used in labels on the ControlPanelObject.
Public property numericSuffix
Gets and sets the numeric suffix (text after the data value) that will be used in labels on the ControlPanelObject.
Public property ObjectType
Gets and sets the type of control panel object.
Public property Parent
Gets and sets the ControlPanelObjects object that is the parent of this object.
Public property QuarterStartMonth
Public property QueryRequiredFieldDeleted
Gets the a value that indicates whether all the required fields associated with this ControlPanelObject are missing.
Public property QueryRequiredFields
Gets a collection of the query required fields that this control panel object represents.
Public property Querys
Gets a collection of the DashboardQuery objects that this ControlPanelObject updates.
Public property RefreshQueriesOnChange
Gets a collection of queries that should be refreshed when the value of this query parameter is changed.
Public property scalingUnits
Gets and sets a string value that represents the scaling units used to represent the ControlPanelObject label values.
Public property scalingValues
Gets and sets a string value that represents the scaling values used to represent the ControlPanelObject label values.
Public property ShowLabels
Gets and sets a value that indicates whether value labels will be show on this ControlPanelObject
Public property ShowMajorTickMarks
Gets and sets a value that indicates whether major tick marks will be shown on this ControlPanelObject.
Public property ShowMinorTickMarks
Gets and sets a value that indicates whether minor tick marks will be shown on this ControlPanelObject.
Public property SortDropDownList
Gets and sets a value that indicates whether the drop down list should be sorted.
Public property SourceDataTable
Gets the source data table that is used to build a controls contents
Public property SourceDataTableFilter
Gets and sets a DashboardFilter object that defines the filter to be applied to the source data table for a drop down list.
Public property SuppressThousandSeparator
Gets and sets a property that indicates if numeric values should suppress the thousand separator.
Public property Text
Gets and sets a text value that will be displayed by this control panel object.
Public property UpdatingFilterObjects
Gets a list of ControlPanelObjects that filter this object
Public property VAlign
Gets and sets a value that represents the vertical alignment of the contents of this control object.
Public property Value
Gets and sets the selected value that this control panel object returns.
Public property ValueColumn
Gets and sets the column that is used derive the value of the control panel object.
Public property ValueColumnDateType
Gets and sets a value that determines how date and date/time values are treated in the Value of a drop down list
Public property ValueColumnIsDate
Gets and sets a value that indicates whether the drop down list Value column is a date column.
Public property ValueColumnIsDateTime
Gets and sets a value that indicates whether the drop down list Value column is a DateTime column.
Public property ValueColumnType
Gets the type of the value column for this object

See Also