Click or drag to resize

ControlPanel Properties

The ControlPanel type exposes the following members.

Properties
 NameDescription
Public propertyAggregateInterval Relative TimeSpan used when requesting an aggregate value. /// See documentation on Relative TimeSpans for more details. Default value is null.
Public propertyAggregateKind Name of aggregate to use when requesting an aggregate value. Default value is null.
Public propertyAggregateStartTime Relative DateTime used when requesting an aggregate value. See documentation on Relative DateTimes for more details. Default value is null.
Public propertyAssetBranchCount Number of branches to display in asset picker.
Public propertyAssetInstance Fully qualified asset instance of a control. Default value is null.
Public propertyAssetPickerInlineWidth Width of the asset picker in pixels when a control's PropertyAssetPickerMode property is set to Inline.
Public propertyAssetPickerMode Mode used by control to change an asset instance. See PropertyAssetPickerMode for mode descriptions. Default value is Modal
Public propertyCode exampleChildren Collection of child controls. Add, remove, index, iterate and more using the IControlChildren interface.
Public propertyColor Color of control. Default value is Color.Empty.
Public propertyHeight Height of control in pixels.
Public propertyIsAssetInstanceValid Validity of asset instance. Default value is null;
Public propertyIsBackgroundTransparent Background transparency. True if background is transparent. False if background is opaque. Default value is false.
Public propertyIsVisible Visibility of control. Default value is true.
Public propertyKind Kind of control.
(Inherited from ControlBase)
Public propertyLimitColor Current limit color. Default value is null.
Public propertyLimits Collection of limits. See PropertyLimit for limit color behavior.
Public propertyName Control name that is unique within the owning screen. Name of control must conform to the regex pattern [a-zA-Z0-9], as only letters and numbers are valid characters.
(Inherited from ControlBase)
Public propertyOnBeginAssetChange Name of a method defined in the screen script that will be invoked before the asset instance of a control is changed. Method must have same signature as EventDelegatesOnAssetChange. Default value is null.
Public propertyOnBeginValueChange Name of a method defined in the screen script that will be invoked before the value of a control is changed. Method must have same signature as EventDelegatesOnValueChange. Default value is null.
Public propertyOnClick Name of a method defined in the screen script that will be invoked when the client clicks on a control. Method must have same signature as EventDelegatesOnClick. Default value is null.
Public propertyOnEndAssetChange Name of a method defined in the screen script that will be invoked after the asset instance of a control is changed. Method must have same signature as EventDelegatesOnAssetChange. Default value is null.
Public propertyOnEndValueChange Name of a method defined in the screen script that will be invoked after the value of a control is changed. Method must have same signature as EventDelegatesOnValueChange. Default value is null.
Public propertyParent Parent of the control.
(Inherited from ControlBase)
Public propertyRefreshInterval Amount of delay between updates. Raw values are updated every second. Aggregated values are updated at slower rates based on the aggregate interval.
Public propertyScreen Screen the control resides in.
(Inherited from ControlBase)
Public propertySource Source of data used to display the current value. This can be either a source tag or a calculation based on other controls that implement the Source property.
Public propertySourceTag Deprecated. Use Source property.
Public propertyTemplateId Id used to find sibling controls within a template. All siblings will have the same id. Default value is null.
(Inherited from ControlBase)
Public propertyValue The last raw value, or an aggregate value when aggregate properties are set.
Public propertyValueState An enumeration that describes the current state of the value property.
Public propertyValueTransform An equation that can be used to perform simple conversions of the value. Example: "Value / 1000" will divide the current value by 1000. Default value is null.
Public propertyWidth Width of control in pixels.
Public propertyX X position of a control relative to its parent in pixels.
Public propertyY Y position of a control relative to its parent in pixels.
Top
See Also