Skip to content

GetStoryLayerTemplateName.md

Latest commit

 

History

History
53 lines (39 loc) · 1.07 KB

GetStoryLayerTemplateName.md

File metadata and controls

53 lines (39 loc) · 1.07 KB
Raw

GetStoryLayerTemplateName

Description

Returns the name of the nth Story Layer Template in the file. For example, if 3 is passed in, it will return the name of the 3rd Story Layer Template in the file.

FUNCTION GetStoryLayerTemplateName(index : INTEGER): STRING;
def vs.GetStoryLayerTemplateName(index):
    return STRING

Parameters

Name Type Description
index INTEGER The index of the Story Layer Template whose name is desired.

Examples

VAR

templateName:STRING;

BEGIN

templateName:=GetStoryLayerTemplateName(2);
resultStr := GetStoryLayerTemplateName(1);
import vs

# Returns the name of the nth Story Layer Template in the file.
index = 1

name = vs.GetStoryLayerTemplateName(index)
vs.Message('GetStoryLayerTemplateName returned: ' + str(name))

See Also

VS Functions: GetNumStoryLayerTemplates | CreateStoryLayerTemplate

Version

Availability: from Vectorworks 2012

Category