Cadcorp SIS API Methods

GetImplicitNolObject Method

Description

Gets the implicit equivalent of an object in a Named Object Library.

The implicit string can be used in DefineNolObject to create a new named object.

Syntax

Visual Basic
Public Function GetImplicitNolObject( _ ByVal aclass As String, _ ByVal aname As String _ ) As String

Parameters

aclass

The class of named object to be queried. Valid classes are:

`ABrush`	Brush
`AColourset`	Colour-set
`APen`	Pen
`APrj`	Coordinate Reference System
AFtable	Feature Table
ATheme	Theme
AProcess	Returns a JSON string of a saved Process object

aname

The named object whose equivalent implicit string is to be queried.

The following parameters may be appended, separated from the aclass string by a ? character:

type=json
type=xml
type=v6
implicitstyles=true
implicitstyles=false

Return Type

An implicit string equivalent of a named object, e.g. P_SOLID_255:0:0_0R_0 for the standard Pen "Red".

Remarks

Named Pens and Brushes have "alpha" values to control transparency. "Implicit" strings can be specified and queried in a variety of formats: Version 6 (for backwards compatibility, but losing "alpha" values); JSON (see http://json.org) or XML. GetImplicitNolObject aclass parameter supports the optional type=[V6|JSON|XML] parameter to control this, with Version 6 as the default, for backwards compatibility.

GetImplicitNolObject supports implicit feature table strings, in JSON and XML formats.

GetImplicitNolObject can be used to convert implicit strings in any supported format to implicit strings in any other supported format.

aname parameters:

type=v6 only supports brush, colourset, pen
implicitstyles is only used by brush and ftable

To get a SIS v6 style brush (for example named "WhiteMask") the code would be:

GetImplicitNolObject ("ABrush?type=V6", "WhiteMask")

Available: GEO MM ME MD OD OM SISpy

Group:

Named Object Library Methods

Example

sis.GisGetImplicitNolObject("AFtable?type=xml","OS MasterMap.Topographic","implicitstyles=true")

sis.GisGetImplicitNolObject("APen?type=xml","Black")

sis.GisGetImplicitNolObject("ABrush?type=json","Invisible")

sis.GetImplicitNolObject(“AProcess”,”MyDefinedProcess”)

* Where “MyDefinedProcess” is a previously saved Process from a Named Object Library .

Send comments on this topic.

Click to return to www.cadcorp.com