displayLayoutNameInCreateArticle

Syntax

StudioPreference.displayLayoutNameInCreateArticle;

Access

read/write

Parameters

Return value boolean

true if the layout name is used as the default article name, false if it is not.

Description

The displayLayoutNameInCreateArticle property defines if the name of the layout should be used as the default name for an article that is created from a frame on the layout.

The default value is false.

Examples

Read the current preference

// Read whether the layout name is used as the default article name.
var pref = app.studioPreferences.displayLayoutNameInCreateArticle;
alert("Display layout name: " + pref);

Use the layout name as the default article name

// Pre-fill the article name with the layout name when creating an article.
app.studioPreferences.displayLayoutNameInCreateArticle = true;

Do not use the layout name as the default article name

// Leave the article name field empty when creating an article.
app.studioPreferences.displayLayoutNameInCreateArticle = false;

Supported versions