Skip to content

DeleteStoryLayerTemplate.md

Latest commit

 

History

History
57 lines (43 loc) · 1.13 KB

DeleteStoryLayerTemplate.md

File metadata and controls

57 lines (43 loc) · 1.13 KB
Raw

DeleteStoryLayerTemplate

Description

Deletes the nth Story Layer Template from the current file. For example, if 3 is passed in, it will delete the 3rd Story Layer Template in the file.

FUNCTION DeleteStoryLayerTemplate(index : INTEGER): BOOLEAN;
def vs.DeleteStoryLayerTemplate(index):
    return BOOLEAN

Parameters

Name Type Description
index INTEGER Index of the Story Layer Template to delete.

Examples

VAR

success:BOOLEAN;

BEGIN

success := DeleteStoryTemplate(3);
resultOK := DeleteStoryLayerTemplate(1);
import vs

# Deletes the nth Story Layer Template from the current file.
index = 1

ok = vs.DeleteStoryLayerTemplate(index)
if ok:
    vs.Message('DeleteStoryLayerTemplate succeeded')
else:
    vs.Message('DeleteStoryLayerTemplate failed')

See Also

VS Functions: GetNumStoryLayerTemplates | GetStoryLayerTemplateName | CreateStoryLayerTemplate

Version

Availability: from Vectorworks 2012

Category