admSetSpaceLayout

admSetSpaceLayout

Syntax

admSetSpaceLayout(spaceKey, layout)

Package

Alias

admSetSpaceLayout(decorator)

Pkg Usage

Description

Creates a decorator for the given spaceKey with the given name, and saves it. Will update an already existing decorator with the same (spaceKey, name) pair. Also updates the velocity cache.

Parameters

Parameter name

Type

Required

Description

spaceKey

String

Yes

The key of the Confluence space to which the syle should be applied.

layout

String

Yes

A String representing the css styles for the space

Or

Parameter name

Type

Required

Description

decorator

CLayout

Yes

Predefined structure that defines the new Layout

Return Type

Boolean (true/false)

Returns true if the layout was successfully applied

Examples

Example 1

return admSetSpaceLayout("MS", "layout");

Example 2

CLayout layout; layout.spaceKey = "MS"; layout.body = "hello"; admSetSpaceLayout("someSpaceKey", layout);

See also

Need support? Create a request with our support team.

Copyright © 2005 - 2025 Appfire | All rights reserved.