CreateStory.md

CreateStory

Description

Creates a Story. Stories are used to group layers and are shown on the Story pane of the Organization dialog.

FUNCTION CreateStory(
				name   : STRING;
				suffix : STRING): BOOLEAN;

def vs.CreateStory(name, suffix):
    return BOOLEAN

Parameters

Name	Type	Description
name	STRING	The name of the Story to create.
suffix	STRING	The suffix to be used at the end of the name of a Layer associated with the Story.

Examples

VAR

success:BOOLEAN

BEGIN

success := CreateStory('4th Floor', '4');

resultOK := CreateStory('Example', 'Example');

import vs

# Creates a Story.
name = 'Example'
suffix = 'Example'

ok = vs.CreateStory(name, suffix)
if ok:
    vs.Message('CreateStory succeeded')
else:
    vs.Message('CreateStory failed')

See Also

VS Functions: GetNumStories | GetStoryOfLayer | AssociateLayerWithStory

Version

Availability: from Vectorworks 2012

Category

• Layers