RenameModule

 

The Construct method tells Voxler which command to create. The Construct method is accessed from the CommandApi object. The RenameModule type allows the Voxler program to assign a new name to an existing module. This is similar to the Edit | Rename command.

 

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(“RenameModule”)

 

Construct Type

RenameModule

 

Parameter

Type

Description

Module

String

Name of the module to be renamed

ModuleID

Unsigned

Numeric ID of the module to be renamed

Name

String

New name of the module

 

Example

This example opens the Helens (ContourMap) example file. It then renames the HeightField module.

 

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\Helens (ContourMap).voxb")

  CommandApi.DoOnce()

 

'Rename the HeightField Module

  CommandApi.Construct("RenameModule")

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

  CommandApi.Option ("Name", "New HeightField Name")

  CommandApi.Do()

 

End Sub

 

Used by: CommandApi object

 

 

See Also

Automation Model

Construct Method