All Cadcorp SIS API Methods

CopyListItems Method

The Named List whose Items are to be copied.

Description

Copies the Items in a Named List to the default overlay.

Syntax

Public Function CopyListItems( _
   ByVal list As String _
) As Integer

Parameters

Remarks

Available: GEO D OD OM SISpy

Note: If you create an item in an internal overlay, add it to an empty list and use the CopyListItems method to copy it to a new overlay, the original item in the internal overlay will not be deleted from the internal overlay.

The following example code shows how to use the CopyListItems method to create a temporary list followed by the Delete method which will delete the original item from the internal overlay.

# Current overlay is a temporary internal overlay
.CreateRectangle()
.AddToList(“CurrItemList”)
.AddToList(“TempList”) # Creates a temporary list
.SetInt(SIS_OT_OVERLAY, FDBOverlay, “_status&”, 3)
.SetInt(SIS_OT_WINDOW, 0, “_nDefaultOverlay&”, FDBOverlay)
.CopyListItems(“CurrItemList”)
.Delete(“TempList”) # Deletes the original rectangle from internal overlay

Groups:

• Named List Methods

Example

sis.CopyListItems ("List1")