Cadcorp SIS API Methods

SetStr Method

Description

Sets the value of a string property.

Syntax

Visual Basic
Public Function SetStr( _ ByVal objectType As Integer, _ ByVal nObject As Long, _ ByVal propertyName As String, _ ByVal value As String _ ) As Integer

Parameters

objectType

`SIS_OT_COMMAND`	Changes the properties/mode of the current command.
SIS_OT_CURITEM	The current open Item.
`SIS_OT_DEFITEM`	The default Item.
`SIS_OT_DATASET`	Datasets.
`SIS_OT_OVERLAY`	Overlays.
`SIS_OT_WINDOW`	The window.
`SIS_OT_NOL`	Named Object Libraries.
`SIS_OT_FTABLE`	The current Feature Table.
`SIS_OT_SCHEMA`	The current Schema.
`SIS_OT_SCHEMACOLUMN`	A column in the current Schema.
`SIS_OT_THEME`	The current Theme.
`SIS_OT_THEMECOMPONENT`	A component in the current Theme.
`SIS_OT_PRINTER`	Printer.
`SIS_OT_SYSTEM`	System variables.
`SIS_OT_OPTION`	System wide Boolean options.

nObject

The index of the object type.

propertyName

The name of the property. All string properties end in '$'.

value

The new string value of the property.

Remarks

When using the objectType SIS_OT_CURITEM, if no property exists of the name propertyName, and propertyName does not start with the "_" character (underscore) then a user-defined attribute will be created, with the name propertyName$, and the value value.

Available: GEO MM ME MD OD OM OV SISpy

Group:

Property Methods

Example

sis.SetStr (SIS_OT_CURITEM, 0, "TYP$", "Conservation Area" )

Send comments on this topic.

Click to return to www.cadcorp.com