Skip to content

SetDefStoryLayerName.md

Latest commit

 

History

History
60 lines (46 loc) · 1.24 KB

SetDefStoryLayerName.md

File metadata and controls

60 lines (46 loc) · 1.24 KB
Raw

SetDefStoryLayerName

Description

Sets the name of the nth Default Story Layer in the file. For example, if 3 is passed in, it will set the name of the 3rd Default Story Layer in the file.

FUNCTION SetDefStoryLayerName(
				index : INTEGER;
				name  : STRING): BOOLEAN;
def vs.SetDefStoryLayerName(index, name):
    return BOOLEAN

Parameters

Name Type Description
index INTEGER The index of the default story layer whose name should be set.
name STRING The name that the indicated default story layer should be set to.

Examples

VAR

result : BOOLEAN;

BEGIN

result := SetStoryLayerTemplateName(2, "Subfloor");
resultOK := SetDefStoryLayerName(1, 'Example');
import vs

# Sets the name of the nth Default Story Layer in the file.
index = 1
name = 'Example'

ok = vs.SetDefStoryLayerName(index, name)
if ok:
    vs.Message('SetDefStoryLayerName succeeded')
else:
    vs.Message('SetDefStoryLayerName failed')

See Also

VS Functions: GetNumStoryLayerTemplates | GetStoryLayerTemplateName

Version

Availability: from Vectorworks 2013

Category