Skip to content

CreateScriptResource.md

Latest commit

 

History

History
60 lines (50 loc) · 1.67 KB

CreateScriptResource.md

File metadata and controls

60 lines (50 loc) · 1.67 KB
Raw

CreateScriptResource

Description

Create a document script resource.

FUNCTION CreateScriptResource(
				scriptName  : STRING;
				paletteName : STRING;
				paletteOpen : BOOLEAN;
				script      : DYNARRAY[] of CHAR;
				python      : BOOLEAN): BOOLEAN;
def vs.CreateScriptResource(scriptName, paletteName, paletteOpen, script, python):
    return BOOLEAN

Parameters

Name Type Description
scriptName STRING A unique name for the new document script.
paletteName STRING A name of the script palette that will contain the new script. If the script palette doesn't exist, it will be created.
paletteOpen BOOLEAN Pass in TRUE if the script palette should be opened when created, and FALSE if it should be closed. If the palette exist, this parameter has no effect.
script DYNARRAY[] of CHAR The script text.
python BOOLEAN Pass TRUE if the script text contains python script. Otherwise it will be considered VectorScript.

Examples

resultOK := CreateScriptResource('Example', 'Example', TRUE, script, FALSE);
import vs

# Create a document script resource.
scriptName = 'Example'
paletteName = 'Example'
paletteOpen = True
script = 'Example'
python = True

ok = vs.CreateScriptResource(scriptName, paletteName, paletteOpen, script, python)
if ok:
    vs.Message('CreateScriptResource succeeded')
else:
    vs.Message('CreateScriptResource failed')

See Also

VS Functions: GetScriptResource | SetScriptResource | OpenScriptResPal

Version

Availability: from Vectorworks 2014

Category