ModifyModule

The Construct method tells Voxler which command to create. The Construct method is accessed from the CommandApi object. The ModifyModule type changes the properties of a module in the Network Manager.

The Construct method must be used in combination with the Option method and the Do or DoOnce method to create an object.

Syntax

object.Construct(“ModifyModule”)

Construct Type

ModifyModule

Parameter	Type	Description
Module	string	Name of the module to be moved
ModuleID	unsigned	Numeric ID of the module to be moved
Property	string	Name of the property to be modified.
PropertyID	unsigned	Numeric ID of the property to be modified.
PropertyValue	string	A target property value encoded as a string.

The Property, PropertyId, and PropertyValue are dependent on the Module or ModuleId selected. See module pages for specific properties.

Example

This example opens the Gold (ScatterPlot) example file. It then changes the scatter plot color map to “Rainbow”.

Sub Main

'Declares VoxlerApp as an object

Dim VoxlerApp As Object

'Creates an instance of the Voxler application object

'and assigns it to the variable named "VoxlerApp"

Set VoxlerApp = CreateObject("Voxler.Application")

'Make Voxler visible

VoxlerApp.Visible = True

'Access CommandApi

Set CommandApi = VoxlerApp.CommandApi

'Open an existing file

CommandApi.Construct ("Open")

CommandApi.Option ("Path", VoxlerApp.Path+"\Samples\Gold (ScatterPlot).voxb")

CommandApi.DoOnce()

'Change color of scatter plot symbols

CommandApi.Construct ("ModifyModule")

CommandApi.Option ("Module", "ScatterPlot")

CommandApi.Option ("ScatterPlotColormap","Rainbow")

CommandApi.Do()

End Sub