Show/Hide hidden text
This chapter gives an overview of the members available per Widget. As explained in the topic"Object and Member Notation (dot syntax)", all kinds of objects can be addressed in the scripting language by using their members which set (or return if applicable) properties or methods of that object. Please refer to the chapter "Script Language" for more details about scripting in general.
Note that this is an overview of members that are only available using the dot syntax; the chapter "Command List" offers more commands that are available per widget.
The first four are common members shown for every widget (and node).
WidgetName.CustomClass
|
Example:
vstring = Label1.CustomClass
vstring = Node1.CustomClass
Alternative Example:
vstring = Project.Label(1).CustomClass
vstring = Project.Nodes.Mouse(1).CustomClass
|
This member exists for all widgets and nodes and returns the value of its property "CustomClass".
It can be either set in the widget's or node's "Item Properties dialog" (section UI Effects & Animation) or with below command:
Label1.CustomClass = "MyClass"
|
WidgetName.Fix
|
Example:
vbool = Label1.Fix
vbool = Node1.Fix
Alternative Example:
vbool = Project.Label(1).Fix
vbool = Project.Nodes.Mouse(1).Fix
|
This member exists for all widgets and nodes and returns the state of its property "Fix": "False" when it is deactivated (default value) and "True" when activated to be visible on any page.
It can be either set in the widget's or node's "Item Properties dialog" or with below command:
Label1.Fix = True
|
WidgetName.Notes
|
Example:
vstring = Label1.Notes
vstring = Node1.Notes
Alternative Example:
vstring = Project.Label(1).Notes
vstring = Project.Nodes.Mouse(1).Notes
|
This member exists for all widgets and nodes and returns the value of its property "Notes".
It can be either set in the widget's or node's "Item Properties dialog" or with below command:
Label1.Notes = "Room1"
|
WidgetName.Visible
|
Example:
vbool = Label1.Visible
vbool = Node1.Visible
Alternative Example:
vbool = Project.Label(1).Visible
vbool = Project.Nodes.Mouse(1).Visible
|
This member exists for all widgets and nodes and returns the state of its property "Visible": "True" when it is activated (default value) and "False" when not.
It can be either set in the widget's or node's "Item Properties dialog" or with below command:
Label1.Visible = False
|
AnalogClockName.UtcOffset
|
Example:
vdouble = AnalogClock1.UtcOffset
Alternative Example:
vdouble = Project.AnalogClock(1).UtcOffset
|
This refers to the AnalogClock widget and returns the value of its property "UTC Offset".
It can be either set in the widget's "Item Properties dialog" or with below command:
AnalogClock1.UtcOffset = 1.5
|
ArtNetRecorderName.NetBroadcasting
|
Example:
ArtNetRecorder1.NetBroadcasting.SubMember
Alternative Example:
Project.ArtNetRecorder(1).NetBroadcasting.SubMember
|
The "Network Broadcasting Service" (NBS) is currently not working.
|
ArtNetRecorderName.WebLink
|
Example:
vstring = ArtNetRecorder1.WebLink
Alternative Example:
vstring = Project.ArtNetRecorder(1).WebLink
|
This refers to the ArtNetRecorder widget and returns the value of its property "WebLink".
It can be either set in the widget's "Item Properties dialog" or with below command:
ArtNetRecorder1.WebLink = "https://www.christiepandorasbox.com"
|
ArtNetSnapshotName.FadeTime
|
Example:
vdouble = ArtNetSnapshot1.FadeTime
Alternative Example:
vdouble = Project.ArtNetSnapshot(1).FadeTime
|
This refers to the ArtNetSnapshot widget and returns the value of its property "FadeTime".
It can be either set in the widget's "Item Properties dialog" or with below command:
ArtNetSnapshot1.FadeTime = 1.5
|
ArtNetSnapshotName.NetBroadcasting
|
Example:
ArtNetSnapshot1.NetBroadcasting.SubMember
Alternative Example:
Project.ArtNetSnapshot(1).NetBroadcasting.SubMember
|
The "Network Broadcasting Service" (NBS) is currently not working.
|
ArtNetSnapshotName.WebLink
|
Example:
vstring = ArtNetSnapshot1.WebLink
Alternative Example:
vstring = Project.ArtNetSnapshot(1).WebLink
|
This refers to the ArtNetSnapshot widget and returns the value of its property "WebLink".
It can be either set in the widget's "Item Properties dialog" or with below command:
ArtNetSnapshot1.WebLink = "https://www.christiepandorasbox.com"
|
BarGraphName.BgColor
|
Example:
vcolor = BarGraph1.BgColor
Alternative Example:
vcolor = Project.BarGraph(1).BgColor
|
This refers to the BarGraph widget and returns the value of its property "Background Color".
It can be either set in the widget's "Item Properties dialog" or with below commands:
BarGraph1.BgColor = "#007DFF".ToColor
BarGraph1.BgColor.SetRGBA(0,125,255,125)
|
BarGraphName.CenterColor
|
Example:
vcolor = BarGraph1.CenterColor
Alternative Example:
vcolor = Project.BarGraph(1).CenterColor
|
This refers to the BarGraph widget and returns the value of its property "CenterColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
BarGraph1.CenterColor = "#007DFF".ToColor
BarGraph1.CenterColor.SetRGBA(0,125,255,125)
|
BarGraphName.Direction
|
Example:
vint = BarGraph1.Direction
Alternative Example:
vint = Project.BarGraph(1).Direction
|
This refers to the BarGraph widget and returns the value of its property "Direction".
It can be either set in the widget's "Item Properties dialog" or with below command:
BarGraph1.Direction = 180
90 = Up
180 = Left
270 = Down
360 = Right
|
BarGraphName.EdgeRadius
|
Example:
vdouble = BarGraph1.EdgeRadius
Alternative Example:
vdouble = Project.BarGraph(1).EdgeRadius
|
This refers to the BarGraph widget and returns the value of its property "EdgeRadius".
It can be either set in the widget's "Item Properties dialog" or with below command:
BarGraph1.EdgeRadius = 50
|
BarGraphName.HasGradient
|
Example:
vbool = BarGraph1.HasGradient
Alternative Example:
vbool = Project.BarGraph(1).HasGradient
|
This refers to the BarGraph widget and returns the state of its property "Gradient": "False" when it is not set (default value) and "True" when activated.
It can be either set in the widget's "Item Properties dialog" or with below command:
BarGraph1.HasGradient = True
|
BarGraphName.IsGlossy
|
Example:
vbool = BarGraph1.IsGlossy
Alternative Example:
vbool = Project.BarGraph(1).IsGlossy
|
This refers to the BarGraph widget and returns the state of its property "Glossy": "False" when it is not set (default value) and "True" when activated.
It can be either set in the widget's "Item Properties dialog" or with below command:
BarGraph1.IsGlossy = True
|
BarGraphName.MaxColor
|
Example:
vcolor = BarGraph1.MaxColor
Alternative Example:
vcolor = Project.BarGraph(1).MaxColor
|
This refers to the BarGraph widget and returns the value of its property "MaxColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
BarGraph1.MaxColor = "#007DFF".ToColor
BarGraph1.MaxColor.SetRGBA(0,125,255,125)
|
BarGraphName.MaxValue
|
Example:
vdouble = BarGraph1.MaxValue
Alternative Example:
vdouble = Project.BarGraph(1).MaxValue
|
This refers to the BarGraph widget and returns the value of its property "Max. Value".
It can be either set in the widget's "Item Properties dialog" or with below command:
BarGraph1.MaxValue = 200
|
BarGraphName.MinColor
|
Example:
vcolor = BarGraph1.MinColor
Alternative Example:
vcolor = Project.BarGraph(1).MinColor
|
This refers to the BarGraph widget and returns the value of its property "MinColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
BarGraph1.MinColor = "#007DFF".ToColor
BarGraph1.MinColor.SetRGBA(0,125,255,125)
|
BarGraphName.MinValue
|
Example:
vdouble = BarGraph1.MinValue
Alternative Example:
vdouble = Project.BarGraph(1).MinValue
|
This refers to the BarGraph widget and returns the value of its property "Min. Value".
It can be either set in the widget's "Item Properties dialog" or with below command:
BarGraph1.MinValue = -200
|
BarGraphName.Value
|
Example:
vdouble = BarGraph1.Value
Alternative Example:
vdouble = Project.BarGraph(1).Value
|
This refers to the BarGraph widget and returns the value of its property "Value".
It can be either changed manually in the GUI or scripted with below command:
BarGraph1.Value = 50
|
CheckBoxName.BackColor
|
Example:
vcolor = CheckBox1.BackColor
Alternative Example:
vcolor = Project.CheckBox(1).BackColor
|
This refers to the CheckBox widget and returns the value of its property "BackgroundColor".
It can be either set in the widget's "Item Properties dialog" or with below command:
CheckBox1.BackColor = "#007DFF".ToColor
CheckBox1.BackColor.SetRGBA(0,125,255,125)
Keep in mind to switch off the "Transparent" property in order to see the effect of the background color:
CheckBox1.Transparent = False
|
CheckBoxName.ForeColor
|
Example:
vcolor = CheckBox1.ForeColor
Alternative Example:
vcolor = Project.CheckBox(1).ForeColor
|
This refers to the CheckBox widget and returns the color value of its property "Font Color".
It can be either set in the widget's "Item Properties dialog" or with below command:
CheckBox1.ForeColor = "#007DFF".ToColor
CheckBox1.ForeColor.SetRGBA(0,125,255,125)
|
CheckBoxName.NetBroadcasting
|
Example:
CheckBox1.NetBroadcasting.SubMember
Alternative Example:
Project.CheckBox(1).NetBroadcasting.SubMember
|
The "Network Broadcasting Service" (NBS) is currently not working.
|
CheckBoxName.State
|
Example:
vint = CheckBox1.State
Alternative Example:
vint = Project.CheckBox(1).State
|
This refers to the CheckBox widget and returns the value of its property "State":
1 for "Checked"
0 for "Unchecked"
-1 for "Undetermined"
The CheckBox can also be set to a defined state, e.g. with these commands:
CustomScript1.State = 1
CustomScript1.SetState("Checked")
Overview of similar commands:
WDCheckBoxClick: state+script, always
WDCheckBoxForce(Un)Checked/-Undetermined: state+script, if in other mode
WDCheckBoxSetState: state without script
WDCheckBoxExecuteScript: script without state
|
CheckBoxName.Transparent
|
Example:
vbool = CheckBox1.Transparent
Alternative Example:
vbool = Project.CheckBox(1).Transparent
|
This refers to the CheckBox widget and returns the state of its property "Transparent": "True" when activated (default) and "False" when it is deactivated to see a background color.
It can be either set in the widget's "Item Properties dialog" or with below command:
CheckBox1.Transparent = True
|
ColorPickerName.SelectedColor
|
Example:
vcolor = ColorPicker1.SelectedColor
Alternative Example:
vcolor = Project.ColorPicker(1).SelectedColor
|
This refers to the ColorPicker widget and returns the value of its property "SelectedColor".
It can be either changed manually in the GUI or scripted with below commands:
ColorPicker1.SelectedColor = "#007DFF".ToColor
ColorPicker1.SelectedColor.SetRGBA(0,125,255,125)
|
CustomScriptName.NetBroadcasting
|
Example:
CustomScript1.NetBroadcasting.SubMember
Alternative Example:
Project.CustomScript(1).NetBroadcasting.SubMember
|
The "Network Broadcasting Service" (NBS) is currently not working.
|
CustomScriptName.State
|
Example:
vbool = CustomScript1.State
Alternative Example:
vbool = Project.CustomScript(1).State
|
This refers to the CustomScript widget and returns the value of its property "State": "True" when it is currently pressed in the GUI or "False" when being released.
CustomScript buttons with the type "Toggle" can also be set to a defined state, e.g. with these commands:
CustomScript1.State = True
CustomScript1.SetState("Released")
Overview of similar commands:
WDCustomScriptClick: state+script, always
WDCustomScriptForcePressed/-Released: state+script, if in other mode
WDCustomScriptSetState: state without script
WDCustomScriptExecuteScript: script without state
|
CustomScriptName.WebLink
|
Example:
vstring = CustomScript1.WebLink
Alternative Example:
vstring = Project.CustomScript(1).WebLink
|
This refers to the CustomScript widget and returns the value of its property "WebLink".
It can be either set in the widget's "Item Properties dialog" or with below command:
CustomScript1.WebLink = "https://www.christiepandorasbox.com"
|
DigitalClockName.UtcOffset
|
Example:
vdouble = DigitalClock1.UtcOffset
Alternative Example:
vdouble = Project.DigitalClock(1).UtcOffset
|
This refers to the DigitalClock widget and returns the value of its property "UTC Offset".
It can be either set in the widget's "Item Properties dialog" or with below command:
DigitalClock1.UtcOffset = 1.5
|
DigitalDisplayName.MaxValue
|
Example:
vdouble = DigitalDisplay1.MaxValue
Alternative Example:
vdouble = Project.DigitalDisplay(1).MaxValue
|
This refers to the DigitalDisplay widget and returns the value of its property "Max. Value".
It can be either set in the widget's "Item Properties dialog" or with below command:
DigitalDisplay1.MaxValue = 200
|
DigitalDisplayName.MinValue
|
Example:
vdouble = DigitalDisplay1.MinValue
Alternative Example:
vdouble = Project.DigitalDisplay(1).MinValue
|
This refers to the DigitalDisplay widget and returns the value of its property "Min. Value".
It can be either set in the widget's "Item Properties dialog" or with below command:
DigitalDisplay1.MinValue = -200
|
DigitalDisplayName.Value
|
Example:
vdouble = DigitalDisplay1.Value
Alternative Example:
vdouble = Project.DigitalDisplay(1).Value
|
This refers to the DigitalDisplay widget and returns the value of its property "Value".
It can be either changed manually in the GUI or scripted with below command:
DigitalDisplay1.Value = 50
|
DropDownListName.BackgroundColor
|
Example:
vcolor = DropDownList1.BackgroundColor
Alternative Example:
vcolor = Project.DropDownList(1).BackgroundColor
|
This refers to the DropDownList widget and returns the value of its property "BackgroundColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
DropDownList1.BackgroundColor = "#007DFF".ToColor
DropDownList1.BackgroundColor.SetRGBA(0,125,255,125)
|
DropDownListName.Index
|
Example:
vdouble = DropDownList1.Index
Alternative Example:
vdouble = Project.DropDownList(1).Index
|
This refers to the DropDownList widget and returns the value of its property "Index".
It depends on which item is selected in the GUI but can also be set with below command:
DropDownList1.Index = 2
DropDownList1.Index = -1 // or 0 to deselect
|
DropDownListName.ItemList
|
Example:
vstring = DropDownList1.ItemList
Alternative Example:
vstring = Project.DropDownList(1).ItemList
|
This refers to the DropDownList widget and returns the value of its property "Drop Down Items". All items are concatenated to a single string and linebreaks are returned as "\r\n". E.g. : "First\r\nSecond\r\nThird"
It can be either set in the widget's "Item Properties dialog" or with below commands:
DropDownList1.ItemList = "First\r\nSecond\r\nThird".Unescape
var list = VideoInputDisplay1.SourceList
DropDownList1.SetItemsFromArray("list")
|
DropDownListName.NetBroadcasting
|
Example:
DropDownList1.NetBroadcasting.SubMember
Alternative Example:
Project.DropDownList(1).NetBroadcasting.SubMember
|
The "Network Broadcasting Service" (NBS) is currently not working.
|
DropDownListName.Text
|
Example:
vstring = DropDownList1.Text
Alternative Example:
vstring = Project.DropDownList(1).Text
|
This refers to the DropDownList widget and returns the value of its property "Text".
It can be either entered in the GUI or set with below command using the index. 0 refers to the first entry of the "Drop Down Items" listed in the widget's "Item Properties dialog":
DropDownList1.Index = 0
|
DropDownListName.TextColor
|
Example:
vcolor = DropDownList1.TextColor
Alternative Example:
vcolor = Project.DropDownList(1).TextColor
|
This refers to the DropDownList widget and returns the value of its font property "TextColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
DropDownList1.TextColor = "#007DFF".ToColor
DropDownList1.TextColor.SetRGBA(0,125,255,125)
|
DropDownListName.Title
|
Example:
vstring = DropDownList1.Title
Alternative Example:
vstring = Project.DropDownList(1).Title
|
This refers to the DropDownList widget and returns the value of its property "Title".
It can be either set in the widget's "Item Properties dialog" or with below command:
DropDownList1.Title = "NewTitle"
To reset a DropDownList (so that it shows the title) use the following command:
DropDownList1.Index = -1
|
EncoderName.Max
|
Example:
vdouble = Encoder1.Max
Alternative Example:
vdouble = Project.Encoder(1).Max
|
This refers to the Encoder widget and returns the value of its property "Maximum Value".
It can be either set in the widget's "Item Properties dialog" or with below command:
Encoder1.Max = 100
|
EncoderName.Midi
|
Example:
Encoder1.Midi.SubMember
Alternative Example:
Project.Encoder(1).Midi.SubMember
|
This accesses all available Midi members; set a dot and choose one from the list.
|
EncoderName.Min
|
Example:
vdouble = Encoder1.Min
Alternative Example:
vdouble = Project.Encoder(1).Min
|
This refers to the Encoder widget and returns the value of its property "Minimum Value".
It can be either set in the widget's "Item Properties dialog" or with below command:
Encoder1.Min = -100
|
EncoderName.NetBroadcasting
|
Example:
Encoder1.NetBroadcasting.SubMember
Alternative Example:
Project.Encoder(1).NetBroadcasting.SubMember
|
The "Network Broadcasting Service" (NBS) is currently not working.
|
EncoderName.Value
|
Example:
vdouble = Encoder1.Value
Alternative Example:
vdouble = Project.Encoder(1).Value
|
This refers to the Encoder widget and returns the value of its property "Value".
It can be either changed manually in the GUI or scripted with below command:
Encoder1.Value = 50
|
FaderName.Max
|
Example:
vdouble = Fader1.Max
Alternative Example:
vdouble = Project.Fader(1).Max
|
This refers to the Fader widget and returns the value of its property "Maximum Value".
It can be either set in the widget's "Item Properties dialog" or with below command:
Fader1.Max = 100
|
FaderName.Midi
|
Example:
Fader1.Midi.SubMember
Alternative Example:
Project.Fader(1).Midi.SubMember
|
This accesses all available Midi members; set a dot and choose one from the list.
|
FaderName.Min
|
Example:
vdouble = Fader1.Min
Alternative Example:
vdouble = Project.Fader(1).Min
|
This refers to the Fader widget and returns the value of its property "Minimum Value".
It can be either set in the widget's "Item Properties dialog" or with below command:
Fader1.Min = -100
|
FaderName.NetBroadcasting
|
Example:
Fader1.NetBroadcasting.SubMember
Alternative Example:
Project.Fader(1).NetBroadcasting.SubMember
|
The "Network Broadcasting Service" (NBS) is currently not working.
|
FaderName.Value
|
Example:
vdouble = Fader1.Value
Alternative Example:
vdouble = Project.Fader(1).Value
|
This refers to the Fader widget and returns the value of its property "Value".
It can be either changed manually in the GUI or scripted with below command:
Fader1.Value = 50
|
FlipSwitchName.Value
|
Example:
vdouble = FlipSwitch1.Value
Alternative Example:
vdouble = Project.FlipSwitch(1).Value
|
This refers to the FlipSwitch widget and returns the value of its property "Value".
It can be either changed manually in the GUI or scripted with below command:
FlipSwitch1.Value = 50
|
GaugeName.MaxValue
|
Example:
vdouble = Gauge1.MaxValue
Alternative Example:
vdouble = Project.Gauge(1).MaxValue
|
This refers to the Gauge widget and returns the value of its property "Max. Value".
It can be either set in the widget's "Item Properties dialog" or with below command:
Gauge1.MaxValue = 200
|
GaugeName.MinValue
|
Example:
vdouble = Gauge1.MinValue
Alternative Example:
vdouble = Project.Gauge(1).MinValue
|
This refers to the Gauge widget and returns the value of its property "Min. Value".
It can be either set in the widget's "Item Properties dialog" or with below command:
Gauge1.MinValue = -200
|
GaugeName.Value
|
Example:
vdouble = Gauge1.Value
Alternative Example:
vdouble = Project.Gauge(1).Value
|
This refers to the Gauge widget and returns the value of its property "Value".
It can be either changed manually in the GUI or scripted with below command:
Gauge1.Value = 50
|
GraphDisplayName.AutoMinMax
|
Example:
vbool = GraphDisplay1.AutoMinMax
Alternative Example:
vbool = Project.GraphDisplay(1).AutoMinMax
|
This refers to the GraphDisplay widget and returns the value of its property "Automatic Min/Max".
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.AutoMinMax = False
|
GraphDisplayName.AxisColor
|
Example:
vcolor = GraphDisplay1.AxisColor
Alternative Example:
vcolor = Project.GraphDisplay(1).AxisColor
|
This refers to the GraphDisplay widget and returns the value of its property "AxisColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
GraphDisplay1.AxisColor = "#007DFF".ToColor
GraphDisplay1.AxisColor.SetRGBA(0,125,255,125)
|
GraphDisplayName.Color1
|
Example:
vcolor = GraphDisplay1.Color1
Alternative Example:
vcolor = Project.GraphDisplay(1).Color1
|
This refers to the GraphDisplay widget and returns the value of its property "Top Color".
It can be either set in the widget's "Item Properties dialog" or with below commands:
GraphDisplay1.Color1 = "#007DFF".ToColor
GraphDisplay1.Color1.SetRGBA(0,125,255,125)
|
GraphDisplayName.Color2
|
Example:
vcolor = GraphDisplay1.Color2
Alternative Example:
vcolor = Project.GraphDisplay(1).Color2
|
This refers to the GraphDisplay widget and returns the value of its property "Bottom Color".
It can be either set in the widget's "Item Properties dialog" or with below commands:
GraphDisplay1.Color2 = "#007DFF".ToColor
GraphDisplay1.Color2.SetRGBA(0,125,255,125)
|
GraphDisplayName.Decimals
|
Example:
vdouble = GraphDisplay1.Decimals
Alternative Example:
vdouble = Project.GraphDisplay(1).Decimals
|
This refers to the GraphDisplay widget and returns the value of its property "Decimals".
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.Decimals = 1
|
GraphDisplayName.Interval
|
Example:
vdouble = GraphDisplay1.Interval
Alternative Example:
vdouble = Project.GraphDisplay(1).Interval
|
This refers to the GraphDisplay widget and returns the value of its property "Interval (in ms)".
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.Interval = 500
|
GraphDisplayName.LabelColor
|
Example:
vcolor = GraphDisplay1.LabelColor
Alternative Example:
vcolor = Project.GraphDisplay(1).LabelColor
|
This refers to the GraphDisplay widget and returns the value of its property "Labels Color".
It can be either set in the widget's "Item Properties dialog" or with below commands:
GraphDisplay1.LabelColor = "#007DFF".ToColor
GraphDisplay1.LabelColor.SetRGBA(0,125,255,125)
|
GraphDisplayName.LineBlur
|
Example:
vdouble = GraphDisplay1.LineBlur
Alternative Example:
vdouble = Project.GraphDisplay(1).LineBlur
|
This refers to the GraphDisplay widget and returns the value of its property "Line Blur".
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.LineBlur = 1
|
GraphDisplayName.LineColor
|
Example:
vcolor = GraphDisplay1.LineColor
Alternative Example:
vcolor = Project.GraphDisplay(1).LineColor
|
This refers to the GraphDisplay widget and returns the value of its property "LineColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
GraphDisplay1.LineColor = "#007DFF".ToColor
GraphDisplay1.LineColor.SetRGBA(0,125,255,125)
|
GraphDisplayName.LineWidth
|
Example:
vdouble = GraphDisplay1.LineWidth
Alternative Example:
vdouble = Project.GraphDisplay(1).LineWidth
|
This refers to the GraphDisplay widget and returns the value of its property "Line Thickness".
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.LineWidth = 4
|
GraphDisplayName.Max
|
Example:
vdouble = GraphDisplay1.Max
Alternative Example:
vdouble = Project.GraphDisplay(1).Max
|
This refers to the GraphDisplay widget and returns the value of its property "Maximum Value".
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.Max = 100
|
GraphDisplayName.Min
|
Example:
vdouble = GraphDisplay1.Min
Alternative Example:
vdouble = Project.GraphDisplay(1).Min
|
This refers to the GraphDisplay widget and returns the value of its property "Minimum Value".
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.Min = -100
|
GraphDisplayName.Opacity
|
Example:
vdouble = GraphDisplay1.Opacity
Alternative Example:
vdouble = Project.GraphDisplay(1).Opacity
|
This refers to the GraphDisplay widget and returns the value of its property "Opacity".
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.Opacity = 125
The value "255" makes the widget fully opaque whilst "0" stands for full transparency.
|
GraphDisplayName.SetBGImage
|
Example:
GraphDisplay1.SetBGImage("C:\Christie\grid.png")
Alternative Example:
Project.GraphDisplay(1).SetBGImage("C:\Christie\background.jpg")
|
This loads the image "grid.png" from the specified path as a background image for the GraphDisplay widget. It is not scaled.
This property is not accessible through the Item Properties!
|
GraphDisplayName.ShowLabels
|
Example:
vbool = GraphDisplay1.ShowLabels
Alternative Example:
vbool = Project.GraphDisplay(1).ShowLabels
|
This refers to the GraphDisplay widget and returns the value of its property "ShowLabels".
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.ShowLabels = False
|
GraphDisplayName.ShowTitle
|
Example:
vbool = GraphDisplay1.ShowTitle
Alternative Example:
vbool = Project.GraphDisplay(1).ShowTitle
|
This refers to the GraphDisplay widget and returns the value of its property "Show Title": "True" when it is displayed and "False" when not.
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.ShowTitle = False
|
GraphDisplayName.Title
|
Example:
vstring = GraphDisplay1.Title
Alternative Example:
vstring = Project.GraphDisplay(1).Title
|
This refers to the GraphDisplay widget and returns the value of its property "Title".
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.Title = "NewTitle"
|
GraphDisplayName.UpdateAlways
|
Example:
vbool = GraphDisplay1.UpdateAlways
Alternative Example:
vbool = Project.GraphDisplay(1).UpdateAlways
|
This refers to the GraphDisplay widget and returns the value of its property "Update Always".
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.UpdateAlways = True
|
GraphDisplayName.Value
|
Example:
vdouble = GraphDisplay1.Value
Alternative Example:
vdouble = Project.GraphDisplay(1).Value
|
This refers to the GraphDisplay widget and returns the value of its property "Value".
It can be either changed manually in the GUI or scripted with below command:
GraphDisplay1.Value = 50
|
GraphDisplayName.XAxis
|
Example:
vdouble = GraphDisplay1.XAxis
Alternative Example:
vdouble = Project.GraphDisplay(1).XAxis
|
This refers to the GraphDisplay widget and returns the value of its property "X-Axis".
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.XAxis = 20
|
GraphDisplayName.XFactor
|
Example:
vdouble = GraphDisplay1.XFactor
Alternative Example:
vdouble = Project.GraphDisplay(1).XFactor
|
This refers to the GraphDisplay widget and returns the value of its property "X-Factor".
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.XFactor = 0.5
|
GraphDisplayName.YFactor
|
Example:
vdouble = GraphDisplay1.YFactor
Alternative Example:
vdouble = Project.GraphDisplay(1).YFactor
|
This refers to the GraphDisplay widget and returns the value of its property "Y-Factor".
It can be either set in the widget's "Item Properties dialog" or with below command:
GraphDisplay1.YFactor = 0.5
|
ImageLoaderName.NetBroadcasting
|
Example:
ImageLoader1.NetBroadcasting.SubMember
Alternative Example:
Project.ImageLoader(1).NetBroadcasting.SubMember
|
The "Network Broadcasting Service" (NBS) is currently not working.
|
ImageLoaderName.WebLink
|
Example:
vstring = ImageLoader1.WebLink
Alternative Example:
vstring = Project.ImageLoader(1).WebLink
|
This refers to the ImageLoader widget and returns the value of its property "WebLink".
It can be either set in the widget's "Item Properties dialog" or with below command:
ImageLoader1.WebLink = "https://www.christiepandorasbox.com"
|
InputBoxName.BackgroundColor
|
Example:
vcolor = InputBox1.BackgroundColor
Alternative Example:
vcolor = Project.InputBox(1).BackgroundColor
|
This refers to the InputBox widget and returns the value of its property "BackgroundColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
InputBox1.BackgroundColor = "#007DFF".ToColor
InputBox1.BackgroundColor.SetRGBA(0,125,255,125)
|
InputBoxName.ReadOnly
|
Example:
vbool = InputBox1.ReadOnly
Alternative Example:
vbool = Project.InputBox(1).ReadOnly
|
This refers to the InputBox widget and returns the value of its property "ReadOnly": "False" when it is not set (default behavior) and "True" when it is set in order to prevent the user to enter text in the GUI manually.
It can be either set in the widget's "Item Properties dialog" or with below command:
InputBox1.ReadOnly = True
|
InputBoxName.Text
|
Example:
vstring = InputBox1.Text
Alternative Example:
vstring = Project.InputBox(1).Text
|
This refers to the InputBox widget and returns the value of its property "Text".
It can be either entered in the GUI or set with below command:
InputBox1.Text = "SomeText"
|
InputBoxName.TextColor
|
Example:
vcolor = InputBox1.TextColor
Alternative Example:
vcolor = Project.InputBox(1).TextColor
|
This refers to the InputBox widget and returns the value of its font property "TextColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
InputBox1.TextColor = "#007DFF".ToColor
InputBox1.TextColor.SetRGBA(0,125,255,125)
|
LabelName.BackColor
|
Example:
vcolor = Label1.BackColor
Alternative Example:
vcolor = Project.Label(1).BackColor
|
This refers to the Label widget and returns the value of its property "Background Color".
It can be either set in the widget's "Item Properties dialog" or with below commands:
Label1.BackColor = "#007DFF".ToColor
Label1.BackColor.SetRGBA(0,125,255,125)
Keep in mind to switch off the "Transparent" property in order to see the effect of the background color:
Label1.Transparent = False
|
LabelName.ForeColor
|
Example:
vcolor = Label1.ForeColor
Alternative Example:
vcolor = Project.Label(1).ForeColor
|
This refers to the Label widget and returns the value of its property "Font Color".
It can be either set in the widget's "Item Properties dialog" or with below commands:
Label1.ForeColor = "#FF007D".ToColor
Label1.ForeColor.SetRGBA(255,0,125,125)
|
LabelName.NetBroadcasting
|
Example:
Label1.NetBroadcasting.SubMember
Alternative Example:
Project.Label(1).NetBroadcasting.SubMember
|
The "Network Broadcasting Service" (NBS) is currently not working.
|
LabelName.Text
|
Example:
vstring = Label1.Text
Alternative Example:
vstring = Project.Label(1).Text
|
This refers to the Label widget and returns the value of its property "Label / Text".
It can be either set in the widget's "Item Properties dialog" or with below command:
Label1.Text = "SomeText"
|
LabelName.Transparent
|
Example:
vbool = Label1.Transparent
Alternative Example:
vbool = Project.Label(1).Transparent
|
This refers to the Label widget and returns the state of its property "Transparent": "True" when activated (default) and "False" when it is deactivated to see a background color.
It can be either set in the widget's "Item Properties dialog" or with below command:
Label1.Transparent = True
|
LabelName.WebLink
|
Example:
vstring = Label1.WebLink
Alternative Example:
vstring = Project.Label(1).WebLink
|
This refers to the Label widget and returns the value of its property "WebLink".
It can be either set in the widget's "Item Properties dialog" or with below command:
Label1.WebLink = "https://www.christiepandorasbox.com"
|
ListViewName.ColEnd
|
Example:
vdouble = ListView1.ColEnd
Alternative Example:
vdouble = Project.ListView(1).ColEnd
|
This refers to the ListView widget and returns the value of its property "ColEnd".
It can be either set in the widget's "Item Properties dialog" or with below command:
ListView1.ColEnd = 5
|
ListViewName.ColStart
|
Example:
vdouble = ListView1.ColStart
Alternative Example:
vdouble = Project.ListView(1).ColStart
|
This refers to the ListView widget and returns the value of its property "ColStart".
It can be either set in the widget's "Item Properties dialog" or with below command:
ListView1.ColStart = 2
|
ListViewName.RowEnd
|
Example:
vdouble = ListView1.RowEnd
Alternative Example:
vdouble = Project.ListView(1).RowEnd
|
This refers to the ListView widget and returns the value of its property "RowEnd".
It can be either set in the widget's "Item Properties dialog" or with below command:
ListView1.RowEnd = 5
|
ListViewName.RowStart
|
Example:
vdouble = ListView1.RowStart
Alternative Example:
vdouble = Project.ListView(1).RowStart
|
This refers to the ListView widget and returns the value of its property "RowStart".
It can be either set in the widget's "Item Properties dialog" or with below command:
ListView1.RowStart = 2
|
ListViewName.SelectedRow
|
Example:
vdouble = ListView1.SelectedRow
Alternative Example:
vdouble = Project.ListView(1).SelectedRow
|
This refers to the ListView widget and returns the value of its property "Selected Row".
A row can be selected in the GUI or with below command:
ListView1.SelectedRow = 10
ListView1.SelectedRow = -1 // or 0 to deselect
|
MediaControlName.Columns
|
Example:
vint = MediaControl1.Columns
Alternative Example:
vint = Project.MediaControl(1).Columns
|
This refers to the MediaControl widget and returns the value of its property "Columns".
It can be either set in the widget's "Item Properties dialog" or with below command:
MediaControl1.Columns = 10
|
MediaControlName.FolderId
|
Example:
vdouble = MediaControl1.FolderId
Alternative Example:
vdouble = Project.MediaControl(1).FolderId
|
This refers to the MediaControl widget and returns the value of its property "Folder ID".
It can be either set in the widget's "Item Properties dialog" or with below command:
MediaControl1.FolderId = 2
|
MediaControlName.Rows
|
Example:
vint = MediaControl1.Rows
Alternative Example:
vint = Project.MediaControl(1).Rows
|
This refers to the MediaControl widget and returns the value of its property "Rows".
It can be either set in the widget's "Item Properties dialog" or with below command:
MediaControl1.Rows = 10
|
MediaControlName.Size
|
Example:
vdouble = MediaControl1.Size
Alternative Example:
vdouble = Project.MediaControl(1).Size
|
This refers to the MediaControl widget and returns the value of its property "Size".
It can be either set in the widget's "Item Properties dialog" or with below command:
MediaControl1.Size = 140
|
MediaControlName.StartIndex
|
Example:
vdouble = MediaControl1.StartIndex
Alternative Example:
vdouble = Project.MediaControl(1).StartIndex
|
This refers to the MediaControl widget and returns the value of its property "Index".
It can be either set in the widget's "Item Properties dialog" or with below command:
MediaControl1.StartIndex = 2
|
PictureBoxName.WebLink
|
Example:
vstring = PictureBox1.WebLink
Alternative Example:
vstring = Project.PictureBox(1).WebLink
|
This refers to the widget PictureBox and returns the value of its property "WebLink".
It can be either set in the widget's "Item Properties dialog" or with below command:
PictureBox1.WebLink = "https://www.christiepandorasbox.com"
|
PlaylistName.BackColor
|
Example:
vcolor = Playlist1.BackColor
Alternative Example:
vcolor = Project.Playlist(1).BackColor
|
This refers to the Playlist widget and returns the value of its property "Background Color".
It cannot be set in the widget's "Item Properties dialog" but with below commands:
Playlist1.BackColor = "#007DFF".ToColor
Playlist1.BackColor.SetRGBA(0,125,255,125)
|
PlaylistName.BackgroundId
|
Example:
vstring = Playlist1.BackgroundId
Alternative Example:
vstring = Project.Playlist(1).BackgroundId
|
This refers to the Playlist widget and returns the value of its property "Background" refering to a Site and Device ID in Pandoras Box.
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.BackgroundId = "2.10"
|
PlaylistName.CrossFade
|
Example:
vbool = Playlist1.CrossFade
Alternative Example:
vbool = Project.Playlist(1).CrossFade
|
This refers to the Playlist widget and returns the value of its property "CrossFade".
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.CrossFade = True
|
PlaylistName.CurrentCue
|
Example:
vdouble = Playlist1.CurrentCue
Alternative Example:
vdouble = Project.Playlist(1).CurrentCue
|
This refers to the Playlist widget and returns the value of its "CurrentCue".
It can be set in the GUI (green highlighted Cue).
|
PlaylistName.CurrentTime
|
Example:
vdouble = Playlist1.CurrentTime
Alternative Example:
vdouble = Project.Playlist(1).CurrentTime
|
This refers to the Playlist widget and returns the time in milliseconds displayed as "Playing Now".
It depends on the playing time of the current media. If the time displayed in the Widget is 1 minute and 1 second, the result would be "61000.0".
|
PlaylistName.DefaultDuration
|
Example:
vstring = Playlist1.DefaultDuration
Alternative Example:
vstring = Project.Playlist(1).DefaultDuration
|
Note: This is currently not working correctly.
|
PlaylistName.DefaultFadeTime
|
Example:
vdouble = Playlist1.DefaultFadeTime
Alternative Example:
vdouble = Project.Playlist(1).DefaultFadeTime
|
This refers to the Playlist widget and returns the value of its property "DefaultFadeTime".
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.DefaultFadeTime =
|
PlaylistName.DefaultLoopMode
|
Example:
vbool = Playlist1.DefaultLoopMode
Alternative Example:
vbool = Project.Playlist(1).DefaultLoopMode
|
This refers to the Playlist widget and returns the value of its property "Loop Media, Audio & Overlays".
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.DefaultLoopMode = False
|
PlaylistName.DefaultPlayMode
|
Example:
vint = Playlist1.DefaultPlayMode
Alternative Example:
vint = Project.Playlist(1).DefaultPlayMode
|
This refers to the Playlist widget and returns the value of its property "Default Mode".
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.DefaultPlayMode = 2
1 = "Continue"
2 = "Pause and hold"
3 = "Pause and fade"
|
PlaylistName.DefaultPrerollTime
|
Example:
vdouble = Playlist1.DefaultPrerollTime
Alternative Example:
vdouble = Project.Playlist(1).DefaultPrerollTime
|
This refers to the Playlist widget and returns the value of its property "Default Pre Roll Time".
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.DefaultPrerollTime = 0.2
|
PlaylistName.EditMode
|
Example:
vbool = Playlist1.EditMode
Alternative Example:
vbool = Project.Playlist(1).EditMode
|
This refers to the Playlist widget and returns the value of its property "Editing Mode": "True" when it is activated to allow users to edit the playlist items in the GUI, "False" when not.
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.EditMode = False
|
PlaylistName.Items
|
Example:
Playlist1.Items.SubMember
Alternative Example:
Project.Playlist(1).Items.SubMember
|
This accesses all available Item members; set a dot and choose one from the list.
|
PlaylistName.Items.Count
|
Example:
vint = Playlist1.Items.Count
Alternative Example:
vint = Project.Playlist(1).Items.Count
|
This refers to the Playlist widget and returns how many items the Playlist currently has.
|
PlaylistName.Items.Cue
|
Example:
Playlist1.Items.Cue(2).SubMember
Alternative Example:
Project.Playlist(1).Items.Cue(2).SubMember
|
This accesses all available Cue item members. Define the cue with the ID as displayed in the widget, e.g 2 or 2.001. Then set a dot and choose a sub member from the list.
The great majority of sub members refer to the properties that can be set in the "Playlist Item Property" dialog (right-click on cue > Edit Cue). Mostly, they return a value (type, e.g. string or Boolean, is displayed in Script Assist) and can be set as seen below.
Example 1:
vdouble = Playlist1.Items.Cue(2).Duration
=> if the duration is 10 seconds, vdouble shows 10000
Example 2:
Playlist1.Items.Cue(2).Duration = 20000
=> the duration of the second cue adopts to 20 seconds
Example 3:
Playlist1.Items.Cue(2.001).Duration = 20000
=> If you have sub cues in your Playlist, simply enter the ID as shown in WD
|
PlaylistName.Items.Item
|
Example:
Playlist1.Items.Item(2).SubMember
Alternative Example:
Project.Playlist(1).Items.Item(2).SubMember
|
This accesses all available Cue item members. Define the cue with the key ID as returned by the command Playlist1.Items.Keys, for example. Then set a dot and choose a sub member from the list.
The great majority of sub members refer to the properties that can be set in the "Playlist Item Property" dialog (right-click on cue > Edit Cue). Mostly, they return a value (type, e.g. string or Boolean, is displayed in Script Assist) and can be set as seen below.
Example 1:
vdouble = Playlist1.Items.Item(2).Duration
=> if the duration is 10 seconds, vdouble shows 10000
Example 2:
Playlist1.Items.Item(2).Duration = 20000
=> the duration of the second cue adopts to 20 seconds
|
PlaylistName.Items.Keys
|
Example:
vlist = Playlist1.Items.Keys
Alternative Example:
vlist = Project.Playlist(1).Items.Keys
|
This refers to the Playlist widget and returns all keys as a list value. The Key values are used internally and for the item members "Playlist1.Items.Item(...).SubMember".
|
PlaylistName.LayerAId
|
Example:
vstring = Playlist1.LayerAId
Alternative Example:
vstring = Project.Playlist(1).LayerAId
|
This refers to the Playlist widget and returns the value of its property "Layer A ID" refering to a Site and Device ID in Pandoras Box.
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.LayerAId = "2.1"
|
PlaylistName.LayerBId
|
Example:
vstring = Playlist1.LayerBId
Alternative Example:
vstring = Project.Playlist(1).LayerBId
|
This refers to the Playlist widget and returns the value of its property "Layer B ID" refering to a Site and Device ID in Pandoras Box.
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.LayerBId = "2.2"
|
PlaylistName.LoopCues
|
Example:
vbool = Playlist1.LoopCues
Alternative Example:
vbool = Project.Playlist(1).LoopCues
|
This refers to the Playlist widget and returns the value of its property "Loop Cue List".
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.LoopCues = False
|
PlaylistName.NextTime
|
Example:
vdouble = Playlist1.NextTime
Alternative Example:
vdouble = Project.Playlist(1).NextTime
|
This refers to the Playlist widget and returns the time in milliseconds displayed as "Playing Next".
It depends on the playing time of the current media and its total duration. If the time displayed in the Widget is 1 minute and 1 second, the result would be "61000.0".
|
PlaylistName.Overlay1AId
|
Example:
vstring = Playlist1.Overlay1AId
Alternative Example:
vstring = Project.Playlist(1).Overlay1AId
|
This refers to the Playlist widget and returns the value of its property "Overlay1 A ID" refering to a Site and Device ID in Pandoras Box.
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.Overlay1AId = "2.11"
|
PlaylistName.Overlay1BId
|
Example:
vstring = Playlist1.Overlay1BId
Alternative Example:
vstring = Project.Playlist(1).Overlay1BId
|
This refers to the Playlist widget and returns the value of its property "Overlay1 B ID" refering to a Site and Device ID in Pandoras Box.
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.Overlay1BId = "2.12"
|
PlaylistName.Overlay2AId
|
Example:
vstring = Playlist1.Overlay2AId
Alternative Example:
vstring = Project.Playlist(1).Overlay2AId
|
This refers to the Playlist widget and returns the value of its property "Overlay2 A ID" refering to a Site and Device ID in Pandoras Box.
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.Overlay2AId = "2.21
|
PlaylistName.Overlay2BId
|
Example:
vstring = Playlist1.Overlay2BId
Alternative Example:
vstring = Project.Playlist(1).Overlay2BId
|
This refers to the Playlist widget and returns the value of its property "Overlay2 B ID" refering to a Site and Device ID in Pandoras Box.
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.Overlay2BId = "2.22"
|
PlaylistName.PathFilter
|
Example:
vstring = Playlist1.PathFilter
Alternative Example:
vstring = Project.Playlist(1).PathFilter
|
This refers to the Playlist widget and returns the value of its property "Path Filter".
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.PathFilter = "PB Projectname\Testpattern"
|
PlaylistName.PlaybackState
|
Example:
vint = Playlist1.PlaybackState
Alternative Example:
vint = Project.Playlist(1).PlaybackState
|
This refers to the Playlist widget and returns its "Playback State" that can be changed with the playback buttons in the GUI.
0 = "Play"
1 = "Stop"
2 = "Pause"
|
PlaylistName.ShowButtons
|
Example:
vbool = Playlist1.ShowButtons
Alternative Example:
vbool = Project.Playlist(1).ShowButtons
|
This refers to the Playlist widget and returns the value of its property "ShowButtons".
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.ShowButtons = False
|
PlaylistName.ShowMenus
|
Example:
vbool = Playlist1.ShowMenus
Alternative Example:
vbool = Project.Playlist(1).ShowMenus
|
This refers to the Playlist widget and returns the value of its property "ShowMenus".
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.ShowMenus = False
|
PlaylistName.ShowProjectTree
|
Example:
vbool = Playlist1.ShowProjectTree
Alternative Example:
vbool = Project.Playlist(1).ShowProjectTree
|
This refers to the Playlist widget and returns the value of its property "ShowProjectTree".
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.ShowProjectTree = False
|
PlaylistName.ShowTitle
|
Example:
vbool = Playlist1.ShowTitle
Alternative Example:
vbool = Project.Playlist(1).ShowTitle
|
This refers to the Playlist widget and returns the value of its property "Show Title": "True" when it is displayed and "False" when not.
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.ShowTitle = False
|
PlaylistName.Shuffle
|
Example:
vbool = Playlist1.Shuffle
Alternative Example:
vbool = Project.Playlist(1).Shuffle
|
This refers to the Playlist widget and returns the value of its property "Shuffle".
It can be set with below command:
Playlist1.Shuffle = True
|
PlaylistName.Title
|
Example:
vstring = Playlist1.Title
Alternative Example:
vstring = Project.Playlist(1).Title
|
This refers to the Playlist widget and returns the value of its property "Title".
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.Title = "NewTitle"
|
PlaylistName.TrackAId
|
Example:
vstring = Playlist1.TrackAId
Alternative Example:
vstring = Project.Playlist(1).TrackAId
|
This refers to the Playlist widget and returns the value of its property "Track A ID" refering to a Site and Device ID in Pandoras Box.
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.TrackAId = "2.31"
|
PlaylistName.TrackBId
|
Example:
vstring = Playlist1.TrackBId
Alternative Example:
vstring = Project.Playlist(1).TrackBId
|
This refers to the Playlist widget and returns the value of its property "Track B ID" refering to a Site and Device ID in Pandoras Box.
It can be either set in the widget's "Item Properties dialog" or with below command:
Playlist1.TrackBId = "2.32"
|
PowerPointDisplayName.Device
|
Example:
vstring = PowerPointDisplay1.Device
Alternative Example:
vstring = Project.PowerPointDisplay(1).Device
|
This refers to the PowerPointDisplay widget and returns the value of its property "Device name".
It can be either set in the widget's "Item Properties dialog" or with below command:
PowerPointDisplay1.Device = "PPT1"
|
ScriptTimerName.ExecuteOnStart
|
Example:
vbool = ScriptTimer1.ExecuteOnStart
Alternative Example:
vbool = Project.ScriptTimer(1).ExecuteOnStart
|
This refers to the ScriptTimer widget and returns the state of its property "Execute On Start".
It can be either set in the widget's "Item Properties dialog" or with below command:
ScriptTimer1.ExecuteOnStart = True
|
ScriptTimerName.Interval
|
Example:
vdouble = ScriptTimer1.Interval
Alternative Example:
vdouble = Project.ScriptTimer(1).Interval
|
This refers to the ScriptTimer widget and returns the value of its property "Interval (in ms)".
It can be either set in the widget's "Item Properties dialog" or with below command:
ScriptTimer1.Interval = 500
|
ScriptTimerName.WebLink
|
Example:
vstring = ScriptTimer1.WebLink
Alternative Example:
vstring = Project.ScriptTimer(1).WebLink
|
This refers to the ScriptTimer widget and returns the value of its property "WebLink".
It can be either set in the widget's "Item Properties dialog" or with below command:
ScriptTimer1.WebLink = "https://www.christiepandorasbox.com"
|
ScrollerName.Devices
|
Example:
vlist = Scroller1.Devices
Alternative Example:
vlist = Project.Scroller(1).Devices
|
This refers to the Scroller widget and returns the value of its property "Devices".
Note: Currently, this is not working correctly.
|
ScrollerName.ItemOffset
|
Example:
vdouble = Scroller1.ItemOffset
Alternative Example:
vdouble = Project.Scroller(1).ItemOffset
|
This refers to the Scroller widget and returns the value of its property "Gap".
It can be either set in the widget's "Item Properties dialog" or with below command:
Scroller1.ItemOffset = 10
|
ScrollerName.ItemSize
|
Example:
vdouble = Scroller1.ItemSize
Alternative Example:
vdouble = Project.Scroller(1).ItemSize
|
This refers to the Scroller widget and returns the value of its property "Item Height".
It can be either set in the widget's "Item Properties dialog" or with below command:
Scroller1.ItemSize = 100
|
ScrollerName.SiteCount
|
Example:
vdouble = Scroller1.SiteCount
Alternative Example:
vdouble = Project.Scroller(1).SiteCount
|
This refers to the Scroller widget and returns the value of its property "Site Count".
It can be either set in the widget's "Item Properties dialog" or with below command:
Scroller1.SiteCount = 2
|
ScrollerName.SnapEnabled
|
Example:
vbool = Scroller1.SnapEnabled
Alternative Example:
vbool = Project.Scroller(1).SnapEnabled
|
This refers to the Scroller widget and returns the value of its property "Snap Mode": "False" when it is deactivated (default) and "True" when activated.
It can be either set in the widget's "Item Properties dialog" or with below command:
Scroller1.SnapEnabled = True
|
ScrollerName.WrapEnabled
|
Example:
vbool = Scroller1.WrapEnabled
Alternative Example:
vbool = Project.Scroller(1).WrapEnabled
|
This refers to the Scroller widget and returns the value of its property "Wrap Mode": "False" when it is deactivated (default) and "True" when activated
It can be either set in the widget's "Item Properties dialog" or with below command:
Scroller1.WrapEnabled = True
|
ShapeName.CornerSize
|
Example:
vdouble = Shape1.CornerSize
Alternative Example:
vdouble = Project.Shape(1).CornerSize
|
This refers to the Shape widget and returns the value of its property "CornerSize".
It can be either set in the widget's "Item Properties dialog" or with below command:
Shape1.CornerSize = 10
|
ShapeName.DrawFill
|
Example:
vbool = Shape1.DrawFill
Alternative Example:
vbool = Project.Shape(1).DrawFill
|
This refers to the Shape widget and returns the state of its property "Draw Fill Color".
It can be either set in the widget's "Item Properties dialog" or with below command:
Shape1.DrawFill = True
|
ShapeName.DrawLine
|
Example:
vbool = Shape1.DrawLine
Alternative Example:
vbool = Project.Shape(1).DrawLine
|
This refers to the Shape widget and returns the state of its property "Draw Line Color".
It can be either set in the widget's "Item Properties dialog" or with below command:
Shape1.DrawLine = False
|
ShapeName.FillColor
|
Example:
vcolor = Shape1.FillColor
Alternative Example:
vcolor = Project.Shape(1).FillColor
|
This refers to the Shape widget and returns the value of its property "Fill Color".
It can be either set in the widget's "Item Properties dialog" or with below commands:
Shape1.FillColor = "#007DFF".ToColor
Shape1.FillColor.SetRGBA(0,125,255,125)
|
ShapeName.LineColor
|
Example:
vcolor = Shape1.LineColor
Alternative Example:
vcolor = Project.Shape(1).LineColor
|
This refers to the Shape widget and returns the value of its property "LineColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
Shape1.LineColor = "#007DFF".ToColor
Shape1.LineColor.SetRGBA(0,125,255,125)
|
ShapeName.LineSize
|
Example:
vdouble = Shape1.LineSize
Alternative Example:
vdouble = Project.Shape(1).LineSize
|
This refers to the Shape widget and returns the value of its property "LineSize".
It can be either set in the widget's "Item Properties dialog" or with below command:
Shape1.LineSize = 4
|
ShapeName.Opacity
|
Example:
vdouble = Shape1.Opacity
Alternative Example:
vdouble = Project.Shape(1).Opacity
|
This refers to the Shape widget and returns the value of its property "Opacity".
It can be either set in the widget's "Item Properties dialog" or with below command:
Shape1.Opacity = 125
The value "255" makes the widget fully opaque whilst "0" stands for full transparency.
|
TerraDisplayArrayName.BackgroundFillColor
|
Example:
vcolor = TerraDisplayArray1.BackgroundFillColor
Alternative Example:
vcolor = Project.TerraDisplayArray(1).BackgroundFillColor
|
This refers to the TerraDisplayArray widget and returns the value of its property "BackgroundFillColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
TerraDisplayArray1.BackgroundFillColor = "#007DFF".ToColor
TerraDisplayArray1.BackgroundFillColor.SetRGBA(0,125,255,125)
|
TerraDisplayArrayName.Columns
|
Example:
vint = TerraDisplayArray1.Columns
Alternative Example:
vint = Project.TerraDisplayArray(1).Columns
|
This refers to the TerraDisplayArray widget and returns the value of its property "Columns" which depends on the applied Layout per DisplayArray.
|
TerraDisplayArrayName.Device
|
Example:
vstring = TerraDisplayArray1.Device
Alternative Example:
vstring = Project.TerraDisplayArray(1).Device
|
This refers to the TerraDisplayArray widget and returns the value of its property "Device name".
It can be either set in the widget's "Item Properties dialog" or with below command:
TerraDisplayArray1.Device = "Christie_Terra1"
|
TerraDisplayArrayName.DisplayArrayOutlineColor
|
Example:
vcolor = TerraDisplayArray1.DisplayArrayOutlineColor
Alternative Example:
vcolor = Project.TerraDisplayArray(1).DisplayArrayOutlineColor
|
This refers to the TerraDisplayArray widget and returns the value of its property "DisplayArrayOutlineColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
TerraDisplayArray1.DisplayArrayOutlineColor = "#007DFF".ToColor
TerraDisplayArray1.DisplayArrayOutlineColor.SetRGBA(0,125,255,125)
|
TerraDisplayArrayName.DisplayFillColor
|
Example:
vcolor = TerraDisplayArray1.DisplayFillColor
Alternative Example:
vcolor = Project.TerraDisplayArray(1).DisplayFillColor
|
This refers to the TerraDisplayArray widget and returns the value of its property "DisplayFillColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
TerraDisplayArray1.DisplayFillColor = "#007DFF".ToColor
TerraDisplayArray1.DisplayFillColor.SetRGBA(0,125,255,125)
|
TerraDisplayArrayName.DisplayOutlineColor
|
Example:
vcolor = TerraDisplayArray1.DisplayOutlineColor
Alternative Example:
vcolor = Project.TerraDisplayArray(1).DisplayOutlineColor
|
This refers to the TerraDisplayArray widget and returns the value of its property "DisplayOutlineColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
TerraDisplayArray1.DisplayOutlineColor = "#007DFF".ToColor
TerraDisplayArray1.DisplayOutlineColor.SetRGBA(0,125,255,125)
|
TerraDisplayArrayName.FontColor
|
Example:
vcolor = TerraDisplayArray1.FontColor
Alternative Example:
vcolor = Project.TerraDisplayArray(1).FontColor
|
This refers to the TerraDisplayArray widget and returns the value of its property "FontColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
TerraDisplayArray1.FontColor = "#007DFF".ToColor
TerraDisplayArray1.FontColor.SetRGBA(0,125,255,125)
|
TerraDisplayArrayName.Rows
|
Example:
vint = TerraDisplayArray1.Rows
Alternative Example:
vint = Project.TerraDisplayArray(1).Rows
|
This refers to the TerraDisplayArray widget and returns the value of its property "Rows" which depends on the applied Layout per DisplayArray.
|
TerraDisplayArrayName.ShowTitle
|
Example:
vbool = TerraDisplayArray1.ShowTitle
Alternative Example:
vbool = Project.TerraDisplayArray(1).ShowTitle
|
This refers to the TerraDisplayArray widget and returns the value of its property "Show Title": "True" when it is displayed and "False" when not.
It can be either set in the widget's "Item Properties dialog" or with below command:
TerraDisplayArray1.ShowTitle = False
|
TerraDisplayArrayName.Title
|
Example:
vstring = TerraDisplayArray1.Title
Alternative Example:
vstring = Project.TerraDisplayArray(1).Title
|
This refers to the TerraDisplayArray widget and returns the value of its property "Title".
It can be either set in the widget's "Item Properties dialog" or with below command:
TerraDisplayArray1.Title = "NewTitle"
|
TerraDisplayArrayName.WindowFillColor
|
Example:
vcolor = TerraDisplayArray1.WindowFillColor
Alternative Example:
vcolor = Project.TerraDisplayArray(1).WindowFillColor
|
This refers to the TerraDisplayArray widget and returns the value of its property "WindowFillColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
TerraDisplayArray1.WindowFillColor = "#007DFF".ToColor
TerraDisplayArray1.WindowFillColor.SetRGBA(0,125,255,125)
|
TerraDisplayArrayName.WindowOutlineColor
|
Example:
vcolor = TerraDisplayArray1.WindowOutlineColor
Alternative Example:
vcolor = Project.TerraDisplayArray(1).WindowOutlineColor
|
This refers to the TerraDisplayArray widget and returns the value of its property "WindowOutlineColor".
It can be either set in the widget's "Item Properties dialog" or with below commands:
TerraDisplayArray1.WindowOutlineColor = "#007DFF".ToColor
TerraDisplayArray1.WindowOutlineColor.SetRGBA(0,125,255,125)
|
TextBoxName.BackColor
|
Example:
vcolor = TextBox1.BackColor
Alternative Example:
vcolor = Project.TextBox(1).BackColor
|
This refers to the TextBox widget and returns the value of its property "Background Color".
It can be either set in the widget's "Item Properties dialog" or with below commands:
TextBox1.BackColor = "#007DFF".ToColor
TextBox1.BackColor.SetRGBA(0,125,255,125)
|
TextBoxName.ForeColor
|
Example:
vcolor = TextBox1.ForeColor
Alternative Example:
vcolor = Project.TextBox(1).ForeColor
|
This refers to the TextBox widget and returns the value of its property "Font Color".
It can be either set in the widget's "Item Properties dialog" or with below commands:
TextBox1.ForeColor = "#FF007D".ToColor
TextBox1.ForeColor.SetRGBA(255,0,125,125)
|
TextBoxName.ReadOnly
|
Example:
vbool = TextBox1.ReadOnly
Alternative Example:
vbool = Project.TextBox(1).ReadOnly
|
This refers to the TextBox widget and returns the value of its property "ReadOnly": "False" when it is not set (default behavior) and "True" when it is set in order to prevent the user to enter text in the GUI manually.
It can be either set in the widget's "Item Properties dialog" or with below command:
TextBox1.ReadOnly = True
|
TextBoxName.Text
|
Example:
vstring = TextBox1.Text
Alternative Example:
vstring = Project.TextBox(1).Text
|
This refers to the TextBox widget and returns the value of its property "Text".
It can be either entered in the GUI or set with below command:
TextBox1.Text = "SomeText"
|
TextBoxName.Title
|
Example:
vstring = TextBox1.Title
Alternative Example:
vstring = Project.TextBox(1).Title
|
This refers to the TextBox widget and returns the value of its property "Title".
It can be either set in the widget's "Item Properties dialog" or with below command:
TextBox1.Title = "NewTitle"
|
TextInputName.BackColor
|
Example:
vcolor = TextInput1.BackColor
Alternative Example:
vcolor = Project.TextInput(1).BackColor
|
This refers to the TextInput widget and returns the value of its property "Background Color".
It can be either set in the widget's "Item Properties dialog" or with below commands:
TextInput1.BackColor = "#007DFF".ToColor
TextInput1.BackColor.SetRGBA(0,125,255,125)
|
TextInputName.ForeColor
|
Example:
vcolor = TextInput1.ForeColor
Alternative Example:
vcolor = Project.TextInput(1).ForeColor
|
This refers to the TextInput widget and returns the value of its property "Font Color".
It can be either set in the widget's "Item Properties dialog" or with below commands:
TextInput1.ForeColor = "#FF007D".ToColor
TextInput1.ForeColor.SetRGBA(255,0,125,125)
|
TextInputName.ReadOnly
|
Example:
vbool = TextInput1.ReadOnly
Alternative Example:
vbool = Project.TextInput(1).ReadOnly
|
This refers to the TextInput widget and returns the value of its property "ReadOnly": "False" when it is not set (default behavior) and "True" when it is set in order to prevent the user to enter text in the GUI manually.
It can be either set in the widget's "Item Properties dialog" or with below command:
TextInput1.ReadOnly = True
|
TextInputName.Text
|
Example:
vstring = TextInput1.Text
Alternative Example:
vstring = Project.TextInput(1).Text
|
This refers to the TextInput widget and returns the value of its property "Text".
It can be either entered in the GUI or set with below command:
TextInput1.Text = "SomeText"
|
TextInputName.Title
|
Example:
vstring = TextInput1.Title
Alternative Example:
vstring = Project.TextInput(1).Title
|
This refers to the TextInput widget and returns the value of its property "Title".
It can be either set in the widget's "Item Properties dialog" or with below command:
TextInput1.Title = "NewTitle"
|
VideoInputDisplayName.Format
|
Example:
vstring = VideoInputDisplay1.Format
Alternative Example:
vstring = Project.VideoInputDisplay(1).Format
|
This refers to the VideoInputDisplay widget and returns the value of its property "Format".
It can be either set in the widget's "Item Properties dialog" or with below command:
VideoInputDisplay1.Format = "MJPG 1280x720@30.00p 16:9"
|
VideoInputDisplayName.FormatList
|
Example:
vlist = VideoInputDisplay1.FormatList
Alternative Example:
vlist = Project.VideoInputDisplay(1).FormatList
|
This refers to the VideoInputDisplay widget and returns all currently possible values of its property "Format" as a list.
You could populate a drop-down list with the list items as follows:
var list = VideoInputDisplay1.FormatList
DropDownList1.SetItemsFromArray("list")
|
VideoInputDisplayName.IsConnected
|
Example:
vbool = VideoInputDisplay1.IsConnected
Alternative Example:
vbool = Project.VideoInputDisplay(1).IsConnected
|
This refers to the VideoInputDisplay widget and returns the state of its property "IsConnected": "False" when it is not connected to a source and "True" when it is.
Note: Currently, this is not working correctly.
|
VideoInputDisplayName.Source
|
Example:
vstring = VideoInputDisplay1.Source
Alternative Example:
vstring = Project.VideoInputDisplay(1).Source
|
This refers to the VideoInputDisplay widget and returns the value of its property "Source".
It can be either set in the widget's "Item Properties dialog" or with below command:
VideoInputDisplay1.Source = "Integrated Webcam"
|
VideoInputDisplayName.SourceList
|
Example:
vlist = VideoInputDisplay1.SourceList
Alternative Example:
vlist = Project.VideoInputDisplay(1).SourceList
|
This refers to the VideoInputDisplay widget and returns all currently possible values of its property "Source" as a list.
You could populate a drop-down list with the list items as follows:
var list = VideoInputDisplay1.SourceList
DropDownList1.SetItemsFromArray("list")
|
VideoSnapshotName.NetBroadcasting
|
Example:
VideoSnapshot1.NetBroadcasting.SubMember
Alternative Example:
Project.VideoSnapshot(1).NetBroadcasting.SubMember
|
The "Network Broadcasting Service" (NBS) is currently not working.
|
VideoSnapshotName.WebLink
|
Example:
vstring = VideoSnapshot1.WebLink
Alternative Example:
vstring = Project.VideoSnapshot(1).WebLink
|
This refers to the VideoSnapshot widget and returns the value of its property "WebLink".
It can be either set in the widget's "Item Properties dialog" or with below command:
VideoSnapshot1.WebLink = "https://www.christiepandorasbox.com"
|
VncPanelName.Compression
|
Example:
vdouble = VncPanel1.Compression
Alternative Example:
vdouble = Project.VncPanel(1).Compression
|
This refers to the VncPanel widget and returns the value of its property "Compression".
It can be either set in the widget's "Item Properties dialog" or with below command:
VncPanel1.Compression = 3
|
VncPanelName.ForwardKeyboard
|
Example:
vbool = VncPanel1.ForwardKeyboard
Alternative Example:
vbool = Project.VncPanel(1).ForwardKeyboard
|
This refers to the VncPanel widget and returns the value of its property "Forward keyboard events": "False" when it is deactivated (default) and "True" when activated.
It can be either set in the widget's "Item Properties dialog" or with below command:
VncPanel1.ForwardKeyboard =
|
VncPanelName.ForwardMouse
|
Example:
vbool = VncPanel1.ForwardMouse
Alternative Example:
vbool = Project.VncPanel(1).ForwardMouse
|
This refers to the VncPanel widget and returns the value of its property "Forward mouse/touch events":: "False" when it is deactivated (default) and "True" when activated.
It can be either set in the widget's "Item Properties dialog" or with below command:
VncPanel1.ForwardMouse =
|
VncPanelName.IpAddress
|
Example:
vstring = VncPanel1.IpAddress
Alternative Example:
vstring = Project.VncPanel(1).IpAddress
|
This refers to the VncPanel widget and returns the value of its property "IP Address".
It can be either set in the widget's "Item Properties dialog" or with below command:
VncPanel1.IpAddress = "2.0.0.1"
|
VncPanelName.Password
|
Example:
vstring = VncPanel1.Password
Alternative Example:
vstring = Project.VncPanel(1).Password
|
This refers to the VncPanel widget and returns the value of its property "Password".
It can be either set in the widget's "Item Properties dialog" or with below command:
VncPanel1.Password = "PB"
|
VncPanelName.Port
|
Example:
vdouble = VncPanel1.Port
Alternative Example:
vdouble = Project.VncPanel(1).Port
|
This refers to the VncPanel widget and returns the value of its property "Port".
It can be either set in the widget's "Item Properties dialog" or with below command:
VncPanel1.Port = 5901
|
VncPanelName.Quality
|
Example:
vdouble = VncPanel1.Quality
Alternative Example:
vdouble = Project.VncPanel(1).Quality
|
This refers to the VncPanel widget and returns the value of its property "Quality".
It can be either set in the widget's "Item Properties dialog" or with below command:
VncPanel1.Quality = 3
|
VncPanelName.Throttle
|
Example:
vdouble = VncPanel1.Throttle
Alternative Example:
vdouble = Project.VncPanel(1).Throttle
|
This refers to the VncPanel widget and returns the value of its property "Throttle".
It can be either set in the widget's "Item Properties dialog" or with below command:
VncPanel1.Throttle = 250
|
WebBrowserName.Url
|
Example:
vstring = WebBrowser1.Url
Alternative Example:
vstring = Project.WebBrowser(1).Url
|
This refers to the WebBrowser widget and returns the value of its property "Url".
It can be either set in the widget's "Item Properties dialog" or with below command:
WebBrowser1.Url = "https://www.christiepandorasbox.com"
|
WheelName.Max
|
Example:
vdouble = Wheel1.Max
Alternative Example:
vdouble = Project.Wheel(1).Max
|
This refers to the Wheel widget and returns the value of its property "Maximum Value".
It can be either set in the widget's "Item Properties dialog" or with below command:
Wheel1.Max = 100
|
WheelName.Midi
|
Example:
Wheel1.Midi.SubMember
Alternative Example:
Project.Wheel(1).Midi.SubMember
|
This accesses all available Midi members; set a dot and choose one from the list.
|
WheelName.Min
|
Example:
vdouble = Wheel1.Min
Alternative Example:
vdouble = Project.Wheel(1).Min
|
This refers to the Wheel widget and returns the value of its property "Minimum Value".
It can be either set in the widget's "Item Properties dialog" or with below command:
Wheel1.Min = -100
|
WheelName.NetBroadcasting
|
Example:
Wheel1.NetBroadcasting.SubMember
Alternative Example:
Project.Wheel(1).NetBroadcasting.SubMember
|
The "Network Broadcasting Service" (NBS) is currently not working.
|
WheelName.Value
|
Example:
vdouble = Wheel1.Value
Alternative Example:
vdouble = Project.Wheel(1).Value
|
This refers to the Wheel widget and returns the value of its property "Value".
It can be either changed manually in the GUI or scripted with below command:
Wheel1.Value = 50
|
XyPanelName.Angle_Default
|
Example:
vdouble = XyPanel1.Angle_Default
Alternative Example:
vdouble = Project.XyPanel(1).Angle_Default
|
This refers to the XyPanel widget and returns the value of its property "Default Angle".
It can be either set in the widget's "Item Properties dialog" or with below command:
XyPanel1.Angle_Default = 10
|
XyPanelName.CurrentAngle
|
Example:
vdouble = XyPanel1.CurrentAngle
Alternative Example:
vdouble = Project.XyPanel(1).CurrentAngle
|
This refers to the XyPanel widget and returns the value of its property "Current Angle".
It is calculated by the input points in the GUI but can also be set with below command:
XyPanel1.CurrentAngle = 10
|
XyPanelName.CurrentDistance
|
Example:
vdouble = XyPanel1.CurrentDistance
Alternative Example:
vdouble = Project.XyPanel(1).CurrentDistance
|
This refers to the XyPanel widget and returns the value of its property "Current Distance".
It is calculated by the input points in the GUI but can also be set with below command:
XyPanel1.CurrentDistance = 10
|
XyPanelName.CurrentX
|
Example:
vdouble = XyPanel1.CurrentX
Alternative Example:
vdouble = Project.XyPanel(1).CurrentX
|
This refers to the XyPanel widget and returns the value of its property "Current X".
It is calculated by the input points in the GUI but can also be set with below command:
XyPanel1.CurrentX = 10
|
XyPanelName.CurrentY
|
Example:
vdouble = XyPanel1.CurrentY
Alternative Example:
vdouble = Project.XyPanel(1).CurrentY
|
This refers to the XyPanel widget and returns the value of its property "Current Y".
It is calculated by the input points in the GUI but can also be set with below command:
XyPanel1.CurrentY = 10
|
XyPanelName.Distance_Default
|
Example:
vdouble = XyPanel1.Distance_Default
Alternative Example:
vdouble = Project.XyPanel(1).Distance_Default
|
This refers to the XyPanel widget and returns the value of its property "Default Distance".
It can be either set in the widget's "Item Properties dialog" or with below command:
XyPanel1.Distance_Default = 10
|
XyPanelName.IsActive
|
Example:
vbool = XyPanel1.IsActive
Alternative Example:
vbool = Project.XyPanel(1).IsActive
|
This refers to the XyPanel widget and returns the state of its property "IsActive": "False" when no input is detected in the Panel and "True" when there is one.
|
XyPanelName.MouseX_Default
|
Example:
vdouble = XyPanel1.MouseX_Default
Alternative Example:
vdouble = Project.XyPanel(1).MouseX_Default
|
This refers to the XyPanel widget and returns the value of its property "Default Mouse X".
It can be either set in the widget's "Item Properties dialog" or with below command:
XyPanel1.MouseX_Default = 10
|
XyPanelName.MouseY_Default
|
Example:
vdouble = XyPanel1.MouseY_Default
Alternative Example:
vdouble = Project.XyPanel(1).MouseY_Default
|
This refers to the XyPanel widget and returns the value of its property "Default Mouse Y".
It can be either set in the widget's "Item Properties dialog" or with below command:
XyPanel1.MouseY_Default = 10
|