All Cadcorp SIS API Methods

SetCombinedFilterClause Method

Description

Adds a clause to a named Combined Class/Property filter.

Syntax

Visual Basic
Public Function SetCombinedFilterClause( _
   ByVal filter As String, _
   ByVal aclass As String, _
   ByVal flag As Integer, _
   ByVal clause As String _
) As Integer

Parameters

filter
The named Combined Class/Property filter to edit, previously created using CreateCombinedFilter.
 
aclass
The Item class which this clause will affect.
 
flag
SIS_CLASSEXCLUDE    Exclude from filter
SIS_CLASSINCLUDE    Include in filter

Each of these flags may have the modifier SIS_OPENBRANCH added to them in order to open a class tree branch in readiness for modifying the filter behaviour of a sub-class of the Item class specified in the aclass argument.
 
clause
The property clause, e.g. "_closed&=-1".

Remarks

The Item class name in the aclass argument (which reflects the Cadcorp SIS 9.0 C++ class name) is not necessarily the same that appears in the SIS user interface, which is translatable.

In particular the "Polygon" and "TopoLineString" item classes should be specified as "SeedArea" and "SeedChain" respectively. The class name to use in this method is stored in the Class name item property. The translatable class name is stored in the Item class property.

Available: GEO D OD OM SISpy

Group:

Example

sis.SetCombinedFilterClause "Polygons>50", "Area", SIS_CLASS_EXCLUDE, "_area#<50"

Excludes areas whose _area#< value is less than 50 from the filter Polygons>50.