All Cadcorp SIS API Methods

CreateIndexOverlay Method

Description

Creates an Index Dataset overlay, optionally creating outlines and labels for each tile found.

Syntax

Visual Basic 
Public Function CreateIndexOverlay( _
   ByVal pos As Integer, _
   ByVal tilename As String, _
   ByVal namer As String, _
   ByVal flags As Integer _
) As Integer

Parameters

pos

The position in the overlays list at which to insert the overlay. If this argument specifies a position in the existing overlays then the new overlay will not replace the existing overlay at the given position, but will shuffle any other overlays down the list.

 
tilename

The path name of one of the tiles being indexed.

 
namer

The tile naming convention to use. This parameter is only needed if the tilename is not sufficient for Cadcorp SIS to unambiguously determine the tile's naming convention. See Index Dataset Naming Conventions for the available options.

flags
SIS_INDEX_OUTLINES    Draw the outline of each tile found
SIS_INDEX_LABELS    Label each tile found with the tile name
SIS_INDEX_PYRAMID    Make the naming convention find related tiles in a pyramid

You can add SIS_INDEX_OUTLINES, SIS_INDEX_LABELS and SIS_INDEX_PYRAMID together.

Remarks

Available: GEO D OM OD OV SISpy

Group:

Example

sis.CreateIndexOverlay(1, "c:\data\tfSS7887SW.ntf", "ANtfNamer", _
 SIS_INDEX_PYRAMID + SIS_INDEX_OUTLINES + SIS_INDEX_LABELS)

Inserts a pyramid indexed overlay, in position 1, displaying gateways and labels