Managing page layers in scripting

Build 1501 on 14/Nov/2017  This topic last edited on: 29/Aug/2014, at 13:57

Click to toggle expandHow many layers are on the current page?

Use the following command:

msgbox (Page.GetLayersCount)

Example: if the page has 4 layers, it will return the number 4.
Click to toggle expandMake a layer as current

Use the following command to make the first layer as current:

Page.LayerSelect(0)

Use the following command to make the last layer as current:

Page.LayerSelect(CShort(Page.GetLayersCount - 1))

Use the following command to make the second layer as current:

Page.LayerSelect(1)

Use the following script to make the layer named "XYZ" as current:

Page.LayerSelectIdName (0, "XYZ")

If the layer XYZ is found, it becomes the current. The method returns False if the layer was successfully selected, or True if it couldn't be found.
Click to toggle expandHide a layer

Use the following command to hide the first layer:

    Dim curlay As Short = Page.GetCurLayer

    FredApp.DisableDraw = True

    Page.LayerSelect(0)

    Page.LayerToggleVisible(0)

    Page.LayerSelect(curlay)

    FredApp.DisableDraw = False

The original layer is reselected at the end. The screen flickering is suppressed (by FredApp.DisableDraw).

Use the following command to hide the last layer:

    Dim curlay As Short = Page.GetCurLayer

    FredApp.DisableDraw = True

    Page.LayerSelect(CShort(Page.GetLayersCount - 1))

    Page.LayerToggleVisible(0)

    Page.LayerSelect(curlay)

    FredApp.DisableDraw = False

The original layer is reselected at the end. The screen flickering is suppressed (by FredApp.DisableDraw).

Use the following command to hide the second layer:

    Dim curlay As Short = Page.GetCurLayer

    FredApp.DisableDraw = True

    Page.LayerSelect(1)

    Page.LayerToggleVisible(0)

    Page.LayerSelect(curlay)

    FredApp.DisableDraw = False

The original layer is reselected at the end. The screen flickering is suppressed (by FredApp.DisableDraw).

Use the following script to hide the layer named "NotForEPaper":

    Dim curlay As Short = Page.GetCurLayer

    Dim notforepaperlay As Short = 0

    Dim i As Integer

    Dim bFailed As Boolean = Page.LayerSelectIdName(0, "NotForEPaper")

    If bFailed Then

      'MsgBox("Layer with the name 'NotForEPaper' not found!")

      Page.LayerSelect(curlay)

    Else

      notforepaperlay = page.getcurlayer

      Page.LayerToggleVisible(0)

      Page.LayerSelect(curlay)

    End If

If the layer NotForEPaper is found, it is hidden and after that, the original layer is reselected. Otherwise, nothing changes. Alternatively, if you want an error message to be displayed, then uncomment the MsgBox line..

Use the following script to hide all layers but the current one:

    Dim curlay As Short = Page.GetCurLayer

    Dim i As Integer

    FredApp.DisableDraw = True

    For i = 0 To Page.GetLayersCount - 1

      Page.LayerSelect(CShort(i))

      If i <> curlay Then

        Page.LayerToggleVisible(0)

      Else

        Page.LayerToggleVisible(1)

      End If

    Next

    Page.LayerSelect(curlay)

    FredApp.DisableDraw = False

If the current layer was hidden, it is displayed. The original layer is reselected at the end. The screen flickering is suppressed (by FredApp.DisableDraw).

Use the following script to show all layers:

Dim curlay As Short = Page.GetCurLayer

    Dim i As Integer

    FredApp.DisableDraw = True

    For i = 0 To Page.GetLayersCount - 1

      Page.LayerSelect(CShort(i))

      Page.LayerToggleVisible(1)

    Next

    Page.LayerSelect(curlay)

    FredApp.DisableDraw = False

The original layer is reselected at the end. The screen flickering is suppressed (by FredApp.DisableDraw).
Click to toggle expandCount objects on all layers

Use the following script to count objects on all layers:

    Dim curlay As Short = Page.GetCurLayer

    Dim i As Integer

    Dim oCount As Integer = 0

    FredApp.DisableDraw = True

    For i = 0 To Page.GetLayersCount - 1

      Page.LayerSelect(CShort(i))

      oCount += Page.GetObjCount

    Next

    Page.LayerSelect(curlay)

    FredApp.DisableDraw = False

The total number of all items is returned in the variable oCount. The original layer has been reselected (by Page.LayerSelect(curlay)). The screen flickering is suppressed (by FredApp.DisableDraw).
Click to toggle expandChange the layers order

Use the following script to move the current layer down in the list:

LayerToFront

Use the following script to move the current layer down in the list:

LayerToBack

Use the following script to make the current layer as the first one:

    Dim bWasListChecked As Boolean = Page.IsLayerListChecked

    If Not bWasListChecked Then Page.LayerListToggleCheck(1)

    If Page.IsLayerListChecked Then

      FredApp.DisableDraw = True

      Dim i As Integer

      Dim curlay As Short = Page.GetCurLayer

      For i = curlay To 0 Step -1

        Page.LayerToBack(CShort(i))

      Next

      If Not bWasListChecked Then Page.LayerListToggleCheck(0)

      FredApp.DisableDraw = True

    Else

      MsgBox("Layer list cannot be checked-out!")

    End If

The screen flickering is suppressed (by FredApp.DisableDraw).

Use the following script to make the current layer as the first one:

    Dim bWasListChecked As Boolean = Page.IsLayerListChecked

    If Not bWasListChecked Then Page.LayerListToggleCheck(1)

    If Page.IsLayerListChecked Then

      FredApp.DisableDraw = True

      Dim i As Integer

      Dim curlay As Short = Page.GetCurLayer

      For i = curlay To Page.GetLayersCount - 1

        Page.LayerToFront(CShort(i))

      Next

      If Not bWasListChecked Then Page.LayerListToggleCheck(0)

      FredApp.DisableDraw = True

    Else

      MsgBox("Layer list cannot be checked-out!")

    End If

The screen flickering is suppressed (by FredApp.DisableDraw).