Widget and Node Group Members

Navigation:  Widget Designer > Script Language > Object and Member Notation (dot syntax) >

Widget and Node Group Members

 prev main next

Navigation:  Widget Designer > Script Language > Object and Member Notation (dot syntax) >

Widget and Node Group Members

 prev main next

Loading...

Show/Hide hidden text

This chapter gives an overview of the members available for Widget and Node Groups. Please read the chapter "Widget and Node Groups" if you would like to know how to add and use this device. As explained in the chapter "Object and Member Notation (dot syntax)", a variety 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.

With scripting a group, you can change all devices of the same type at the same time by using the following:

WidgetGroup1.CustomScript.SubMember

To talk to a single group member, use the following:

WidgetGroup1.CustomScript("CustomScript1").SubMember
or
WidgetGroup1.CustomScript(1).SubMember

 

hmtoggle_arrow1Project.WidgetGroup

Project.WidgetGroup(groupName).WidgetType.SubMember

Example:
WidgetGroup1 consists of 3 custom script buttons and 3 faders.

To change the label color for all buttons, use the following:

Project.WidgetGroup("WidgetGroup1").CustomScript.SetLabelColor(255,0,255)

Or fade down all faders simultaneously:

WidgetGroup1.Fader.FadeDown(2)

To edit all widgets of a type, use the corresponding SubMember of the corresponding type. See chapter "Object and Member Notation (dot syntax)".

In addition, the properties of the group can be scripted.
hmtoggle_arrow1WidgetGroup.FrameColor

WidgetGroup_Name.FrameColor

Example:
WidgetGroup1.FrameColor = "150,0,255".ToColor

Alternative Examples:
vxString = Project.WidgetGroup("WidgetGroup1").FrameColor.ToHex
Project.WidgetGroup("WidgetGroup1").FrameColor = "150,0,255".ToColor

This command gets or sets the frame color of the widget group "WidgetGroup1". The returned value is of type color. An alternative command is WidgetGroup.GetFrameColor or WidgetGroup.SetFrameColor.
hmtoggle_arrow1WidgetGroup.GetFrameColor

WidgetGroup_Name.GetFrameColor

Example:
vcolor = WidgetGroup1.GetFrameColor

Alternative Examples:
vcolor = Project.WidgetGroup("WidgetGroup1").GetFrameColor
vcolor = WDWidgetGroupGetFrameColor("WidgetGroup1")

This command gets the frame color of widget group "WidgetGroup1". The returned value is of type color.
hmtoggle_arrow1WidgetGroup.GetName

WidgetGroup_Name.GetName

Example:
vstring = WidgetGroup1.GetName

Alternative Examples:
vstring = Project.WidgetGroup("WidgetGroup1").GetName
vstring = WDWidgetGroupGetName("WidgetGroup1")

This command gets the name of widget group "WidgetGroup1". The returned value is of type string.
hmtoggle_arrow1WidgetGroup.GetTitleColor

WidgetGroup_Name.GetTitleColor

Example:
vcolor = WidgetGroup1.GetTitleColor

Alternative Examples:
vcolor = Project.WidgetGroup("WidgetGroup1").GetTitleColor
vcolor = WDWidgetGroupGetTitleColor("WidgetGroup1")

This command gets the frame color of widget group "WidgetGroup1". The returned value is of type color.
hmtoggle_arrow1WidgetGroup.GetWindowName

WidgetGroup_Name.GetWindowName

Example:
vstring = WidgetGroup1.GetWindowName

Alternative Examples:
vstring = Project.WidgetGroup("WidgetGroup1").GetWindowName
vstring = WDWidgetGroupGetWindowName("WidgetGroup1")

This command gets the name of the window to which the widget group "WidgetGroup1" belongs. The returned value is of type string.
hmtoggle_arrow1WidgetGroup.Name

WidgetGroup_Name.Name

Example:
WidgetGroup1.Name = "newName"

Alternative Examples:
vxString = Project.WidgetGroup("WidgetGroup1").Name
Project.WidgetGroup("WidgetGroup1").Name = "newName"

This command gets or sets the name of widget group "WidgetGroup1". The returned value is of type string. An alternative command is: WidgetGroup.GetName.
hmtoggle_arrow1WidgetGroup.SetFrameColor

WidgetGroup_Name.SetFrameColor

Example:
WidgetGroup1.SetFrameColor(150,0,255)

Alternative Examples:
Project.WidgetGroup("WidgetGroup1").SetFrameColor(150,0,255)
WDWidgetGroupSetFrameColor("WidgetGroup1",150,0,255)

This command sets the frame color of widget group "WidgetGroup1" to an intensive violet (Red=150, Green=0, Blue=255). You can change the color manually in the dialog "Widget Group Properties" (double click on the widget group header). An alternative command is WidgetGroup.FrameColor.
hmtoggle_arrow1WidgetGroup.SetTitleColor

WidgetGroup_Name.SetTitleColor

Example:
WidgetGroup1.SetTitleColor(150,0,255)

Alternative Examples:
Project.WidgetGroup("WidgetGroup1").SetTitleColor(150,0,255)
WDWidgetGroupSetTitleColor("WidgetGroup1",150,0,255)

This command sets the title color of widget group "WidgetGroup1" to an intensive violet (Red=150, Green=0, Blue=255). You can change the color manually in the dialog "Widget Group Properties" (double click on the widget group header). An alternative command is WidgetGroup.TitleFontColor.
hmtoggle_arrow1WidgetGroup.TitleFontColor

WidgetGroup_Name.TitleFontColor

Example:
WidgetGroup1.TitleFontColor(150,0,255)

Alternative Examples:
vstring = Project.WidgetGroup("WidgetGroup1").TitleFontColor.ToHex
Project.WidgetGroup("WidgetGroup1").TitleFontColor(150,0,255)

This command gets or sets the title color of widget group "WidgetGroup1" to an intensive violet (Red=150, Green=0, Blue=255). The returned value is of type color. You can change the color manually in the dialog "Widget Group Properties" (double click on the widget group header). An alternative command is WidgetGroup.SetTitleColor.