Description
Moves the specified layer back.
The function fails if the layer is already the bottom one. It requires that the list of layers is checked out. See LayerListToggleCheck Function.
Syntax
Page.LayerToBack (LayerN) |
LayerN
Position of the layer in the layers list, from 0 (the first one in the list of layers, and the first drawn, therefore below all other layers) to GetLayersCount (the last layer in the list, the last drawn, therefore on top of all other layers)
Remarks
Note: the layers are displayed on page in the same order as they are listed in the list of layers. Thus the first layer in the list, is displayed visually on the page below all other layers. Its index is 0. The last layer in the list is displayed on top of all other layers. It's index is GetLayersCount-1. See also GetCurLayer Function.
Return value
Returns an error code.
Examples
See Managing page layers in scripting.
Context
Page designer
All layers related commands
GetCurLayer, GetLayerId, GetLayerLockLevel, GetLayerName, GetLayersCount,GetLayerTypeId, GetLayerUserId, GetLayerUserName
IsLayerChecked, IsLayerFrozen, IsLayerListChecked, IsLayerLocked, IsLayerVisible
LayerAdd, LayerDelete, LayerEditDlg, LayerJumpTo, LayerListToggleCheck, LayerMerge, LayerNoJumpTo, LayerRecover, LayersCopyContent, LayerSelect, LayerSelectIdName, LayerTest, LayerToBack, LayerToFront, LayerToggleCheck, LayerToggleFreeze, LayerToggleLock, LayerToggleVisible