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