Field-Map Scripting
1. Field-Map Scripting
2. About Field-Map Scripting
2.1 What is a Field-Map script
2.2 Why use Field-Map scripts
2.3 How to create a Field-Map script
2.4 Some Field-Map scripting key terms
2.5 Field-Map script types
2.5.1 Field-Map script types overview
2.5.2 On-Validate scripts
2.5.3 On-Change scripts
2.5.4 On-Demand scripts
2.5.5 Layer scripts
2.5.5.1 List of layer events
2.5.6 Global scripts
2.5.6.1 List of global events
2.6 Writing scripts in Field-Map
2.6.1 Writing On-Validate / On-Change scripts in Field-Map Project Manager
2.6.2 Writing On-Demand scripts in Field-Map Project Manager
2.6.3 Writing Layer scripts in Field-Map Project Manager
2.6.4 Writing scripts in Field-Map Data Collector
2.6.5 Hot keys
3. About Field-Map Object Pascal
3.1 What is Field-Map Object Pascal
3.2 Borland Object Pascal features supported in Field-Map Object Pascal
3.3 Format strings
3.4 Field-Map Object Pascal specifics
3.4.1 Accessing Field-Map data within a script
3.4.2 Using Field-Map predefined variables
3.4.3 Using Field-Map global variables
3.4.4 Disabling events
3.4.4.1 DisableScripts
3.4.4.2 EnableScripts
3.4.4.3 ScriptsEnabled
3.4.5 Referencing scripts
3.4.5.1 PerformLayerScript
3.4.5.2 PerformOnChangeScript
3.4.5.3 PerformOnChangeScriptForAllRecords
4. Functions, procedures and properties
4.1 General
4.1.1 Screen
4.1.1.1 Message boxes
4.1.1.1.1 ShowMessage
4.1.1.1.2 ShowMsg
4.1.1.1.3 ShowInformation
4.1.1.1.4 ShowWarning
4.1.1.1.5 ShowError
4.1.1.1.6 YesNoQuestion
4.1.1.1.7 BlinkingMessage
4.1.1.1.8 OpenWebPage
4.1.1.2 Input from user interface
4.1.1.2.1 InputInteger
4.1.1.2.2 InputIntegerWithCounter
4.1.1.2.3 InputFloat
4.1.1.2.4 InputString
4.1.1.2.5 InputText
4.1.1.2.6 InputOption
4.1.1.2.7 InputOptionWithStartingValue
4.1.1.2.8 InputFromList
4.1.1.2.9 InputFromListWithStartingValue
4.1.1.2.10 InputFromCheckListTab
4.1.1.2.11 InputFromListTab
4.1.1.3 Logs
4.1.1.3.1 OpenLog
4.1.1.3.2 IsLogOpen
4.1.1.3.3 HideLog
4.1.1.3.4 ShowLog
4.1.1.3.5 LogWindowStayOnTop
4.1.1.3.6 MakeLogWindowStayOnTop
4.1.1.3.7 CloseLog
4.1.1.3.8 CloseLogWithDelay
4.1.1.3.9 Log
4.1.1.3.10 LogExt
4.1.1.3.11 LogTabStops
4.1.1.4 Progress bar
4.1.1.4.1 PrepareProgressBar
4.1.1.4.2 StartProgressBarCycle
4.1.1.4.3 StepProgressBar
4.1.1.4.4 ResetProgressBar
4.1.1.4.5 PerformOneStepCycle
4.1.1.4.6 SetProgressBarMin
4.1.1.4.7 SetProgressBarMax
4.1.1.4.8 SetProgressBarPosition
4.1.1.4.9 SetProgressBarStep
4.1.1.4.10 Example
4.1.1.5 Navigator
4.1.1.5.1 OpenNavigator
4.1.1.5.2 OpenNavigatorFromFile
4.1.1.5.3 CloseNavigator
4.1.1.5.4 ShowNavigator
4.1.1.5.5 ClearNavigator
4.1.1.6 Button management
4.1.1.6.1 HideButton
4.1.1.6.2 ShowButton
4.1.1.6.3 SetFieldMapButtonLabel
4.1.1.6.4 GetFingerControl
4.1.1.6.5 GetButtonExpansionPercentage
4.1.1.6.6 GetFontExpansionPercentage
4.1.1.6.7 List of button names
4.1.1.7 Data Collector options item
4.1.1.7.1 HideDataCollectorOptionsItem
4.1.1.7.2 ShowDataCollectorOptionsItem
4.1.1.8 Screen resolution
4.1.1.8.1 PixelsPerInch
4.1.1.8.2 MainFormWidth
4.1.1.8.3 MainFormHeight
4.1.1.9 Colors
4.1.1.9.1 RGB
4.1.1.9.2 Color2RGB
4.1.1.9.3 Colors list
4.1.1.10 ComboPanel
4.1.1.10.1 ComboPanelCollapse
4.1.1.10.2 ComboPanelExpand
4.1.1.10.3 CollapseAllComboPanels
4.1.1.10.4 ExpandAllComboPanels
4.1.1.10.5 AllComboPanelsCollapsed
4.1.2 Strings
4.1.2.1 Format
4.1.2.2 LZero
4.1.2.3 Delete
4.1.2.4 Trim
4.1.2.5 TrimLeft
4.1.2.6 TrimRight
4.1.2.7 SameText
4.1.2.8 StringReplace
4.1.2.9 DeFormat1-10
4.1.2.10 GetFieldCountFromString
4.1.2.11 GetFieldFromString
4.1.2.12 IndexOfField
4.1.2.13 SortNumericSequence
4.1.3 Math & Statistics
4.1.3.1 Mathematical functions and procedures
4.1.3.1.1 Power
4.1.3.1.2 Round
4.1.3.1.3 RoundTo
4.1.3.1.4 Round2int
4.1.3.1.5 RoundVariant
4.1.3.1.6 Cos
4.1.3.1.7 ArcCos
4.1.3.1.8 ArcCosH
4.1.3.1.9 Sin
4.1.3.1.10 ArcSin
4.1.3.1.11 ArcSinH
4.1.3.1.12 ArcTan
4.1.3.1.13 ArcTan2
4.1.3.1.14 ArcTanH
4.1.3.1.15 CosH
4.1.3.1.16 SinH
4.1.3.1.17 Tan
4.1.3.1.18 TanH
4.1.3.1.19 Random
4.1.3.1.20 RandomRange
4.1.3.1.21 Randomize
4.1.3.1.22 Floor
4.1.3.1.23 Ceil
4.1.3.1.24 Int
4.1.3.1.25 Frac
4.1.3.1.26 Log10
4.1.3.1.27 Ln
4.1.3.1.28 Exp
4.1.3.1.29 Abs
4.1.3.1.30 Min
4.1.3.1.31 Max
4.1.3.1.32 Odd
4.1.3.1.33 SecondsBetween
4.1.3.1.34 CompareValue
4.1.3.1.35 SameValue
4.1.3.1.36 Trunc
4.1.3.1.37 Example
4.1.3.2 Statistical functions and procedures
4.1.3.2.1 Mean
4.1.3.2.2 QuadraticMean
4.1.3.2.3 WeightedMean
4.1.3.2.4 Median
4.1.3.2.5 SampleVariance
4.1.3.2.6 StandardDeviation
4.1.3.2.7 StandardError
4.1.3.2.8 MeanError
4.1.3.2.9 VarianceOfMean
4.1.3.2.10 WeightedSampleVariance
4.1.3.2.11 WeightedStandardDeviation
4.1.3.2.12 WeightedVarianceOfMean
4.1.3.2.13 ConfidenceIntervalOfMean
4.1.3.2.14 VarianceOfTotal
4.1.3.2.15 ConfidenceIntervalOfTotal
4.1.3.2.16 StratifiedConfidenceIntervalOfTotal
4.1.3.2.17 SampleSize
4.1.3.2.18 ShowDistributionChart
4.1.3.2.19 ParameterizeRegressionModel
4.1.3.2.20 CalculateModelValue
4.1.3.2.21 Example
4.1.4 Text file
4.1.4.1 AssignFile
4.1.4.2 Reset
4.1.4.3 Rewrite
4.1.4.4 Append
4.1.4.5 WriteLn
4.1.4.6 ReadLn
4.1.4.7 EOF
4.1.4.8 CloseFile
4.1.4.9 DeleteFile
4.1.4.10 SaveStringToFile
4.1.4.11 SaveStringToFileAsUTF8
4.1.5 Registry
4.1.5.1 SaveValueToRegistry
4.1.5.2 LoadValueFromRegistry
4.1.6 System
4.1.6.1 Predefined variables
4.1.6.2 Sound
4.1.6.2.1 Beep
4.1.6.2.2 PlaySoundFromFile
4.1.6.2.3 PlaySoundFromLibrary
4.1.6.2.4 ReleaseSound
4.1.6.2.5 SwitchSoundsOff
4.1.6.2.6 SwitchSoundsOn
4.1.6.2.7 Speak
4.1.6.3 Decimal
4.1.6.3.1 DecimalSeparator
4.1.6.3.2 SetDecimalPoint
4.1.6.3.3 SetDecimalComma
4.1.6.3.4 ResetDecimalSeparator
4.1.6.4 Others functions and procedures
4.1.6.4.1 CloseFieldMap
4.1.6.4.2 Abort
4.1.6.4.3 ProcessMessages
4.1.6.4.4 Sleep
4.1.6.4.5 SoftwareKey
4.1.6.4.6 GetTickCount
4.1.6.4.7 CreateGUID
4.1.6.4.8 HourGlassCursor
4.1.6.4.9 DefaultCursor
4.1.6.4.10 DisableFieldMapWindow
4.1.6.4.11 EnableFieldMapWindow
4.1.6.4.12 SetRightTitleBarCaption
4.1.6.4.13 RunFieldMapExtension
4.1.6.4.14 VarIsNull
4.1.7 Conversions
4.1.7.1 String2Float
4.1.7.2 Variant2Float
4.1.7.3 Variant2Integer
4.1.7.4 Variant2String
4.1.7.5 String2Variant
4.1.7.6 Boolean2Integer
4.1.7.7 Date2Integer
4.1.7.8 Integer2Date
4.1.7.9 Int2Hex
4.1.7.10 IntToHex
4.1.7.11 GetBitFromLastThreeDigits
4.1.7.12 SetBitOfDouble
4.1.7.13 GetBitOfDouble
4.1.7.14 SetBitOfInteger
4.1.7.15 GetBitOfInteger
4.1.7.16 SetBitOfBigInt
4.1.7.17 GetBitOfBigInt
4.1.8 Global variables
4.1.8.1 SetGlobalVariable
4.1.8.2 GetGlobalVariable
4.1.8.3 GlobalVariableExists
4.1.8.4 RemoveGlobalVariable
4.1.8.5 RemoveGlobalVariables
4.1.8.6 Value
4.1.8.7 Example
4.1.9 Database
4.1.9.1 OpenTable
4.1.9.2 LoadSimpleXML
4.1.9.3 OpenParadoxTable
4.1.9.4 CreateMemTableFromDefs
4.1.9.5 CloseAndFreeTable
4.1.9.6 Constants
4.1.9.7 AddintegerAttribute
4.1.9.8 AddFloatAttribute
4.1.9.9 AddbooleanAttribute
4.1.9.10 AddStringAttribute
4.1.9.11 AttributeExists
4.1.9.12 DefaultValue
4.1.9.13 DefaultValueEnabled
4.1.9.14 GetAttributesWithDefaultValue
4.1.9.15 NumberOfAttributesWithDefaultValue
4.1.10 Array
4.1.10.1 SetArrayLength
4.1.10.2 GetArrayLength
4.1.10.3 VarArrayOf
4.1.10.4 VarArrayCreate
4.1.10.5 VarArrayDimCount
4.1.10.6 VarArrayLowBound
4.1.10.7 VarArrayHighBound
4.1.10.8 VarType
4.1.10.9 VarIsArray
4.1.10.10 VarIsNumeric
4.1.10.11 SetVarArrayValue
4.1.10.12 GetVarArrayValue
4.1.11 XML
4.1.11.1 TScriptXMLDocument members
4.1.11.1.1 OpenXMLDocument
4.1.11.1.2 OpenLockedXMLDocument
4.1.11.1.3 OpenXMLDocumentExt
4.1.11.1.4 OpenXMLDocumentFromString
4.1.11.1.5 OpenXMLDocumentFromStringExt
4.1.11.1.6 FreeXMLDocument
4.1.11.1.7 GetAttributeValueFromXMLDocument
4.1.11.1.8 Example
4.1.11.2 TScriptXMLElement members
4.1.11.2.1 GetRootElement
4.1.11.2.2 GetElementName
4.1.11.2.3 GetChildElements
4.1.11.2.4 GetFirstChildElement
4.1.11.2.5 GetElementText
4.1.11.2.6 GetElementInteger
4.1.11.2.7 GetElementDouble
4.1.11.2.8 GetElementBoolean
4.1.11.2.9 GetElementCDATA
4.1.11.2.10 HasAttribute
4.1.11.2.11 HasNoNullAttribute
4.1.11.2.12 GetStringAttribute
4.1.11.2.13 GetStringAttributeAsString
4.1.11.2.14 GetStringAttributeAsDateTime
4.1.11.2.15 GetIntegerAttribute
4.1.11.2.16 GetIntegerAttributeAsInteger
4.1.11.2.17 GetFloatAttribute
4.1.11.2.18 GetFloatAttributeAsVariant
4.1.11.2.19 GetFloatAttributeAsFloat
4.1.11.2.20 GetBooleanAttribute
4.1.11.2.21 GetFirstChildElementStringAttribute
4.1.11.2.22 GetFirstChildElementStringAttributeAsString
4.1.11.2.23 GetFirstChildElementIntegerAttribute
4.1.11.2.24 GetFirstChildElementIntegerAttributeAsInteger
4.1.11.2.25 GetFirstChildElementFloatAttribute
4.1.11.2.26 GetFirstChildElementFloatAttributeAsVariant
4.1.11.2.27 GetFirstChildElementFloatAttributeAsFloat
4.1.11.2.28 GetFirstChildElementBooleanAttribute
4.1.11.2.29 Name
4.1.11.2.30 FreeXMLElement
4.1.11.2.31 SaveValuesToTable
4.1.11.2.32 GetRootElementName
4.1.11.2.33 GetFirstChildElementText
4.1.11.2.34 GetFirstChildElementinteger
4.1.11.2.35 GetFirstChildElementDouble
4.1.11.2.36 GetFirstChildElementboolean
4.1.11.3 TScriptXMLElementList members
4.1.11.3.1 GetCount
4.1.11.3.2 GetElement
4.1.11.3.3 FreeXMLElementList
4.1.11.3.4 Example
4.1.11.4 TXMLOutputWrapper members
4.1.11.4.1 CreateXMLOutput
4.1.11.4.2 WriteComment
4.1.11.4.3 WriteString
4.1.11.4.4 WriteInteger
4.1.11.4.5 WriteVariant
4.1.11.4.6 WriteFloat
4.1.11.4.7 WriteBoolean
4.1.11.4.8 WriteDate
4.1.11.4.9 WriteDateTime
4.1.11.4.10 WriteDateTimeAsInt64
4.1.11.4.11 WriteDateTimeAsInt64WithMiliseconds
4.1.11.4.12 AddTableData
4.1.11.4.13 AddLayerData
4.1.11.4.14 BeginDocumentAttrs
4.1.11.4.15 BeginElementAttrs
4.1.11.4.16 EndAttrs
4.1.11.4.17 EndElement
4.1.11.4.18 EndDocument
4.1.11.4.19 FreeXMLOutput
4.1.11.4.20 CreateXMLOutputFile
4.1.11.4.21 Example
4.1.12 Date
4.1.12.1 Day
4.1.12.2 Month
4.1.12.3 Year
4.1.12.4 DecodeDate
4.1.12.5 DecodeDateExt
4.1.12.6 DecodeDateTimeExt
4.1.12.7 YearOf
4.1.12.8 MonthOf
4.1.12.9 DayOf
4.1.12.10 DaysInAMonth
4.1.12.11 StrToDateTime
4.1.12.12 DateToStr
4.1.12.13 DateTimeAsString
4.1.12.14 FormatElapsedTime
4.1.12.15 Date
4.1.12.16 Now
4.1.12.17 IncMonth
4.1.12.18 IncDay
4.1.13 Measurement (support of devices)
4.1.13.1 CancelMeasurement
4.1.13.2 MeasureHorizDist
4.1.13.3 MeasureInclination
4.1.13.4 MeasureHorizDistAndInclination
4.1.13.5 MeasureRemoteDiameter
4.1.13.6 MeasureStemProfile
4.1.13.7 GetContinuousGpsCoordinates
4.1.13.8 GetCurrentPosition
4.1.13.9 SetCurrentPosition
4.1.13.10 ResetOnlineCalliper
4.1.13.11 SendMessageToNonSpecificEquipment
4.1.13.12 ManageNonSpecificEquipment
4.1.13.13 NonSpecificEquipmentActive
4.1.13.14 DendroscopeSerialNumber
4.1.13.15 GetFieldMapVersion
4.1.13.16 CalcVerticalDistance
4.1.13.17 VerticalDistance
4.1.13.18 CalcInclination
4.1.13.19 CheckSum
4.1.13.20 CheckSumOK
4.1.13.21 GetBearingAngle_deg
4.1.13.22 GetBearingAzimuth_deg
4.1.13.23 GetLaserEquipmentHeight_cm
4.1.13.24 GetAzimuthFixOffset_deg
4.1.13.25 GetAzimuthUnits
4.1.13.26 GetMagneticDeclination_deg
4.1.13.27 GetMainPoleLength_cm
4.1.13.28 GetMainPoleLengthCorrection_cm
4.1.13.29 GetMainPoleOffsetForTreeMeasurement_cm
4.1.13.30 GetMainPoleReflectorOffset_cm
4.1.13.31 GetOffsetOfCylReflector_cm
4.1.13.32 GetGPSAntennaHeight_cm
4.1.13.33 GetPolePositionMode
4.1.13.34 SetPromptBeforeChangeTreePositionOfPreviousMeasurement
4.1.13.35 StartGNSSLog
4.1.14 GIS
4.1.14.1 ExtendLine
4.1.14.2 CombinePolygons
4.1.14.3 IntersectPolygons
4.1.14.4 FindLineIntersects
4.1.14.5 Distance
4.1.14.6 PolarToXY
4.1.14.7 Polar2XY
4.1.14.8 XYtoPolar
4.1.14.9 XY2polar
4.1.15 Lists
4.1.15.1 Creating list members
4.1.15.1.1 CreateStringList
4.1.15.1.2 CreateIntegerList
4.1.15.1.3 CreateVariantList
4.1.15.1.4 CreateMultiVariantList
4.1.15.1.5 CreateVarVariantList
4.1.15.2 Free list members
4.1.15.2.1 FreeStringList
4.1.15.2.2 FreeIntegerList
4.1.15.2.3 FreeVariantList
4.1.15.2.4 FreeMultiVariantList
4.1.15.2.5 FreeVarVariantList
4.1.16 ScriptOrganizer
4.1.16.1 Create
4.1.16.2 Free
4.1.16.3 Caption
4.1.16.4 Header
4.1.16.5 AddGroup
4.1.16.6 AddSubGroup
4.1.16.7 AddAttributeScript
4.1.16.8 AddOnDemandScript
4.1.16.9 AddGlobalVariable
4.1.16.10 Show
4.1.16.11 RegistryNameForLastPositionStyle
4.1.17 Stem profile
4.1.17.1 CreateStemProfile
4.1.17.2 FreeStemProfile
4.1.18 Species groups
4.1.18.1 CreateSpeciesGroups
4.1.18.2 FreeSpeciesGroups
4.2 LayerWrapper
4.2.1 Basic
4.2.1.1 Name
4.2.1.2 Free
4.2.1.3 ParentName
4.2.1.4 LayerType
4.2.1.5 LayerLevel
4.2.1.6 LayerLabel
4.2.1.7 AutoTimeStampEnabled
4.2.1.8 PerformOnChangeScript
4.2.1.9 PerformOnChangeScriptForAllRecords
4.2.1.10 PerformLayerScript
4.2.1.11 OnLineCalliper_AddAttribute
4.2.1.12 OnLineCalliper_RemoveAttribute
4.2.1.13 OnLineCalliper_ClearAttributes
4.2.1.14 OnLineCalliper_GotoAttribute
4.2.1.15 OnLineCalliper_AddRecordUponReceipt
4.2.1.16 GetCrownProfileVolumeAndSurface
4.2.1.17 GetCrownProjectionAsLine
4.2.1.18 GetCrownProjectionAsPolygon
4.2.1.19 OpenExternalForm
4.2.1.20 Filename
4.2.1.21 AssignAttribute
4.2.1.22 ImportOnlyCentroids
4.2.1.23 Execute
4.2.1.24 IsValidParentLayer
4.2.1.25 RelationType
4.2.1.26
4.2.2 Screen
4.2.2.1 RefreshAttributeLayout
4.2.2.2 TabStop
4.2.2.3 Enabled
4.2.2.4 EnableAttributes
4.2.2.5 DisableAttributes
4.2.2.6 Visible
4.2.2.7 ShowAttributes
4.2.2.8 HideAttributes
4.2.2.9 AlignAttribute
4.2.2.10 AlignAttributes
4.2.2.11 AlignOverviewGridTitles
4.2.2.12 OverviewGridAttributeTitle
4.2.2.13 ClickToAttributeControl
4.2.2.14 UseKeyboard4ComboBox
4.2.2.15 OverviewGridAttributeVisible
4.2.2.16 ShowOverviewGridAttribute
4.2.2.17 HideOverviewGridAttribute
4.2.2.18 Color
4.2.2.19 ResetColor
4.2.2.20 SetParentColor
4.2.2.21 SetColorOfAttributes
4.2.2.22 ResetColorOfAttributes
4.2.2.23 SetParentColorOfAttributes
4.2.2.24 EnableControls
4.2.2.25 DisableControls
4.2.2.26 ControlsDisabled
4.2.2.27 EnableScreenControls
4.2.2.28 DisableScreenControls
4.2.2.29 ScreenControlsDisabled
4.2.2.30 SetFocus
4.2.2.31 DisplayFormat
4.2.2.32 AttributeHint
4.2.2.33 ResetAttributeHint
4.2.2.34 AttributeLabel
4.2.2.35 PlacerStrategy
4.2.2.36 MaxSpaceForControlsPerc
4.2.2.37 GoToLayerPage
4.2.2.38 GoToMapPage
4.2.2.39 IsLayerPageOnTop
4.2.2.40 TabVisible
4.2.2.41 LayerPageVisible
4.2.2.42 StemProfilePageVisible
4.2.2.43 ShowInSeparateWindow
4.2.2.44 ShowThumbnailPreview
4.2.2.45 LayerVisible
4.2.2.46 LabelsVisible
4.2.2.47 AlwaysColored
4.2.2.48 SaveMiscTreeDataToXML
4.2.2.49 ShowVirtualKeyboard
4.2.2.50
4.2.2.51
4.2.2.52
4.2.2.53
4.2.2.54
4.2.2.55
4.2.2.56
4.2.2.57
4.2.2.58
4.2.2.59
4.2.2.60
4.2.2.61
4.2.2.62
4.2.2.63
4.2.2.64
4.2.2.65
4.2.2.66
4.2.2.67
4.2.3 Database
4.2.3.1 Value
4.2.3.2 ValueAsString
4.2.3.3 ValueAsinteger
4.2.3.4 ValueAsFloat
4.2.3.5 ValueAsboolean
4.2.3.6 OldValue
4.2.3.7 PreviousValue
4.2.3.8 BOF
4.2.3.9 EOF
4.2.3.10 RecordCount
4.2.3.11 State
4.2.3.12 SetValues
4.2.3.13 SetValuesFromXML
4.2.3.14 CrownProjection
4.2.3.15 CrownProfile
4.2.3.16 CrownProfilePoints
4.2.3.17 StemProfile
4.2.3.18 OldLayer
4.2.3.19 SavePosition
4.2.3.20 RestorePosition
4.2.3.21 SaveState
4.2.3.22 RestoreState
4.2.3.23 SavePositionAndState
4.2.3.24 RestorePositionAndState
4.2.3.25 Open
4.2.3.26 Close
4.2.3.27 First
4.2.3.28 Last
4.2.3.29 Next
4.2.3.30 Prior
4.2.3.31 Edit
4.2.3.32 Post
4.2.3.33 Append
4.2.3.34 Delete
4.2.3.35 Cancel
4.2.3.36 Refresh
4.2.3.37 Locate
4.2.3.38 ClearTable
4.2.3.39 Filter
4.2.3.40 Filtered
4.2.3.41 CheckFilter
4.2.3.42 SetFilterExt
4.2.3.43 ClearFilterForChildLayers
4.2.3.44 DeepFilter
4.2.3.45 EnableCachedUpdates
4.2.3.46 ApplyUpdates
4.2.3.47 GetAttributeValue
4.2.3.48 GetQueryResult
4.2.3.49 DeleteFrom
4.2.3.50 Update
4.2.3.51 CreateMemTable
4.2.3.52 SaveToDBF
4.2.3.53 SaveToExcel
4.2.3.54 GetMinOfAttributeValues
4.2.3.55 GetMaxOfAttributeValues
4.2.3.56 GetMeanOfAttributeValues
4.2.3.57 GetSumOfAttributeValues
4.2.3.58 GetRecordCount
4.2.3.59 GetLookupTable
4.2.3.60 GetLookupListValue
4.2.3.61 GetLookupListAttributeValue
4.2.3.62 GetID
4.2.3.63 GetIdAttributeName
4.2.3.64 GetIdSQL
4.2.3.65 SaveTimeStamp
4.2.3.66 File2Blob
4.2.3.67 Blob2Folder
4.2.3.68 String2Blob
4.2.3.69 Blob2String
4.2.3.70 FillAttributeValues
4.2.3.71 MarkValuesAsConditional
4.2.3.72 RoundAttributeValues
4.2.3.73 GetPercentageOfFilledAttributes4Table
4.2.3.74 GetPercentageOfFilledAttributes4Record
4.2.3.75 GetListOfChildLayers
4.2.4 XML
4.2.4.1 AddDataToXML
4.2.4.2 GetRecordAsXML
4.2.4.3 GetRecordsAsXML
4.2.4.4 GetLookupListContentAsXML
4.2.4.5 GetLookupListsContentAsXML
4.2.5 GIS
4.2.5.1 GisLayerReference
4.2.5.2 ShapeRecordCount
4.2.5.3 GetParentPolygonArea_m2
4.2.5.4 FindIntersectingPolygons
4.2.5.5 GetIntersectingPolygonAreas
4.2.5.6 FindContainedPointsOrCentroids
4.2.5.7 FindLinesIntersectingPolygon
4.2.5.8 FindLinesContainedInExpandedPolygon
4.2.5.9 FindClosestLine
4.2.5.10 FindPolygonContainingPoint
4.2.5.11 FindPolygonContainingPointByCoords
4.2.5.12 AddPoint
4.2.5.13 AddLine
4.2.5.14 AddPolygon
4.2.5.15 AddCentroid
4.2.5.16 AddPolygonWithCentroid
4.2.5.17 AddCircularPolygonWithCentroid
4.2.5.18 SplitMultiPolygon
4.2.5.19 DeletePoint
4.2.5.20 DeleteLine
4.2.5.21 DeletePolygon
4.2.5.22 DeletePolygonsKeepCentroidsAndAttributes
4.2.5.23 SaveShapesToBlobs
4.2.5.24 UpdateSymbolAndLabelInShapefiles
4.2.5.25 CreatePointsAlongLine
4.2.5.26 RefreshMap
4.2.5.27 RefreshMapRectangle
4.2.5.28 ZoomAndSelect
4.2.5.29 ZoomAndSelectEntity
4.2.5.30 SelectEntities
4.2.5.31 ZoomToLayerExtent
4.2.5.32 MeasureLineLength_m
4.2.5.33 MeasurePolygonArea_m2
4.2.5.34 GetLineCoordinates
4.2.5.35 GetPolygonCoordinates
4.2.5.36 GisEntityExists
4.2.5.37 GetCombinedPolygonsCoordinates
4.2.5.38 SelectLine
4.2.6 Navigator & DQT
4.2.6.1 AddItemToNavigatorXML
4.2.6.2 DBNavigatorVisible
4.2.6.3 DBNavigatorConfirmDelete
4.2.6.4 QueryBuilderEnabled
4.2.6.5 EnableQueryBuilder
4.2.6.6 DisableQueryBuilder
4.3 TableWrapper
4.3.1 Shared Layer members
4.3.2 Unique Table members
4.3.2.1 FieldExists
4.3.2.2 RecNo
4.3.2.3 IsTableOpen
4.3.2.4 AsXML
4.3.2.5 SaveToDbfExt
4.3.2.6 AlterTable
4.3.2.7 DisplayLabel
4.3.2.8 BlobAsString
4.4 Project
4.4.1 Basic
4.4.1.1 Name
4.4.1.2 DatabaseType
4.4.1.3 Version
4.4.1.4 UserLoginFullName
4.4.1.5 UserLoginName
4.4.1.6 UserGroupName
4.4.1.7 LayerCount
4.4.1.8 Layer
4.4.1.9 GetMapLayerListAsXML
4.4.1.10 ActiveLayer
4.4.1.11 ActiveLayerName
4.4.1.12 LayerAtIndex
4.4.1.13 SysTab_LayerList
4.4.1.14 SysTab_AttributeList
4.4.1.15 GetMapLayerListAsXML
4.4.1.16 ApplyMapLayerList
4.4.1.17 LoadMapLayerListFromXML
4.4.1.18 SaveMapLayerListToXML
4.4.1.19 MapLayerListVisible
4.4.1.20 SendDataToAnotherRunningProject
4.4.1.21 GetResourceString
4.4.1.22 AnotherProjectIsRunning
4.4.1.23 OpenAnotherProject
4.4.1.24 BringProjectToFront
4.4.1.25 SendDataToAnotherRunningProject
4.4.1.26 OpenInactiveLayers
4.4.1.27 CloseInactiveLayers
4.4.1.28 OpenPlot
4.4.1.29 OpenPlotUsingDataCollector
4.4.1.30 RunPolyshape
4.4.1.31 AddLayerWrapper
4.4.1.32 ScriptsEnabled
4.4.1.33 OnValidateScriptsEnabled
4.4.1.34 OnChangeScriptsEnabled
4.4.1.35 OnChangeTimeStampEnabled
4.4.1.36 DisableScripts
4.4.1.37 EnableScripts
4.4.1.38 RunSynchronization
4.4.1.39 RunSynchronizationExt
4.4.1.40 AdjustOnLineCalliperConnection
4.4.1.41 Example
4.4.2 Screen
4.4.2.1 GoToLayerPage
4.4.2.2 IsLayerPageVisible
4.4.3 Files
4.4.3.1 DeleteFile
4.4.3.2 CreateDir
4.4.3.3 DeleteDir
4.4.3.4 GetFilesOfDir
4.4.3.5 OpenFileByWindowsAssociation
4.4.3.6 SaveStringToIniFile
4.4.3.7 SaveIntegerToIniFile
4.4.3.8 SaveDoubleToIniFile
4.4.3.9 SaveBooleanToIniFile
4.4.3.10 LoadStringFromIniFile
4.4.3.11 LoadIntegerFromIniFile
4.4.3.12 LoadDoubleFromIniFile
4.4.3.13 LoadBooleanFromIniFile
4.4.3.14 ExtractFilename
4.4.3.15 ExtractFilePath
4.4.3.16 ExtractFileExt
4.4.3.17 FileExists
4.4.3.18 DirectoryExists
4.4.4 Database
4.4.4.1 Refresh
4.4.4.2 EnableCachedUpdates
4.4.4.3 ApplyUpdates
4.4.4.4 StartTransaction
4.4.4.5 Commit
4.4.4.6 CommitRetaining
4.4.4.7 Rollback
4.4.4.8 RollbackRetaining
4.4.4.9 ClearAllFilters
4.4.4.10 GetQueryResult
4.4.4.11 PerformQuery
4.4.4.12 OpenTable
4.4.4.13 SaveRecordToDeletedLog
4.4.4.14 SaveRecordsToDeletedLog
4.4.4.15 BackupDatabase
4.4.4.16 PostAllData
4.4.4.17 ReloadLookupLists
4.4.4.18 PostProjectAndLookupTablesToSynchroJournal
4.4.4.19 PostLookupTablesToSynchroJournal
4.4.4.20 PostSelectedLookupTablesToSynchroJournal
4.4.4.21 PostFileToSynchroJournal
4.4.4.22 ChangedAfterLastSynchronization
4.4.5 Navigator & DQT & Extensions
4.4.5.1 RunFieldMapExtension
4.4.5.2 HideExtensionMenu
4.4.5.3 ShowExtensionMenu
4.4.5.4 RunDatabaseQueryTool
4.4.5.5 ShowExcelPreview
4.4.5.6 AddItemToNavigatorXML
4.4.5.7 DBNavigatorVisible
4.4.5.8 DBNavigatorConfirmDelete
4.4.5.9 GetSpeciesGroupID
4.4.6 GIS
4.4.6.1 GetPolygonIntersectArea_m2
4.4.6.2 OverlayPolygonLayers
4.4.6.3 TransferAttributeValuesFromPolygonsToPointsOrCentroids
4.4.6.4 GetPoint
4.4.6.5 GetCentroids
4.4.6.6 DrawText
4.4.6.7 DrawPoint
4.4.6.8 DrawLine
4.4.6.9 DrawPolygon
4.4.6.10 DrawCircle
4.4.6.11 DrawRectangle
4.4.6.12 FlashPolygon
4.4.6.13 FlashLine
4.4.6.14 FlashPoint
4.4.6.15 SelectedPointCount
4.4.6.16 SelectedPointID
4.4.6.17 SelectedLineCount
4.4.6.18 SelectedLineID
4.4.6.19 GetCurrentPosition
4.4.6.20 SetCurrentPosition
4.4.6.21 SetBasicExtent
4.4.6.22 GetMapExtent
4.4.6.23 GetMapFullExtent
4.4.6.24 GetBasicExtent
4.4.6.25 ZoomToPolygon
4.4.6.26 ZoomToLine
4.4.6.27 MapExtentAsVariant
4.4.6.28 AddReferencePoint
4.4.6.29 InvertColors
4.4.6.30 FindTargetHeight
4.4.6.31 SetCircularPlotBoundary
4.4.6.32 TrimLineByPlotBoundary
4.4.6.33 RefreshMap
4.4.6.34 RefreshMapRectangle
4.4.6.35 RefreshTrackingLayer
4.4.6.36 RefreshTrackingLayerRectangle
4.4.6.37 ScreenMilimeters2MapDistance_m
4.4.6.38 MapToScreen
4.4.6.39 SaveShapesToBlobs
4.4.6.40 SaveShapesOfCurrentPlotToBlobs
4.4.6.41 SaveShapesOfAllPlotsToBlobs
4.4.6.42 ProjectionToWGS84
4.4.6.43 WGS84ToProjection
4.4.6.44 AdjustLineIntersectCoordinates
4.4.7 Extras
4.4.7.1 EditSpeciesGroups
4.4.7.2 EditSpeciesGroupsUsingDesigner
4.4.7.3 ShowHeightCandidates
4.4.8 Stem profile
4.4.8.1 LoadGlobalStemProfileModels
4.4.8.2 LoadGlobalStemProfileModelsForRegion
4.4.8.3 GlobalStemProfileModelsFilename
4.4.8.4 FreeGlobalStemProfileModels
4.5 Lists
4.5.1 StringList
4.5.1.1 Free
4.5.1.2 Duplicates
4.5.1.3 Sorted
4.5.1.4 CaseSensitive
4.5.1.5 BeginUpdate
4.5.1.6 EndUpdate
4.5.1.7 Add
4.5.1.8 AddStrings
4.5.1.9 Assign
4.5.1.10 Clear
4.5.1.11 Delete
4.5.1.12 Count
4.5.1.13 Exchange
4.5.1.14 Move
4.5.1.15 Find
4.5.1.16 IndexOf
4.5.1.17 Insert
4.5.1.18 Sort
4.5.1.19 LoadFromFile
4.5.1.20 SaveToFile
4.5.1.21 Strings
4.5.1.22 Text
4.5.1.23 Delimiter
4.5.1.24 DelimitedText
4.5.1.25 NameValueSeparator
4.5.1.26 IndexOfName
4.5.1.27 Name
4.5.1.28 Value
4.5.1.29 AsVarArray
4.5.2 IntegerList
4.5.2.1 Free
4.5.2.2 Add
4.5.2.3 Clear
4.5.2.4 Assign
4.5.2.5 Delete
4.5.2.6 Count
4.5.2.7 IndexOf
4.5.2.8 SortAscending
4.5.2.9 SortDescending
4.5.2.10 SortAscendingAndRemoveDuplicates
4.5.2.11 Value
4.5.2.12 Delimiter
4.5.2.13 DelimitedText
4.5.2.14 AsVarArray
4.5.3 VariantList
4.5.3.1 Free
4.5.3.2 Add
4.5.3.3 Clear
4.5.3.4 Assign
4.5.3.5 Delete
4.5.3.6 Count
4.5.3.7 IndexOf
4.5.3.8 Value
4.5.3.9 ValueAsFloat
4.5.3.10 ValueAsInteger
4.5.3.11 ValueAsString
4.5.3.12 AsVarArray
4.5.3.13 SortAscendingAndRemoveDuplicates
4.5.3.14 Delimiter
4.5.3.15 DelimitedText
4.5.4 MultiVariantList
4.5.4.1 Free
4.5.4.2 Add
4.5.4.3 Clear
4.5.4.4 Assign
4.5.4.5 Delete
4.5.4.6 Count
4.5.4.7 NumberOfVariantsPerItem
4.5.4.8 AsText
4.5.4.9 Value
4.5.4.10 ValueAsFloat
4.5.4.11 ValueAsInteger
4.5.4.12 ValueAsString
4.5.4.13 SortAscending
4.5.4.14 SortDescending
4.5.4.15 SortMultiAscending
4.5.4.16 SortMultiDescending
4.5.4.17 IndexOf
4.5.4.18 IndexOfMulti
4.5.5 VarVariantList
4.5.5.1 Free
4.5.5.2 ListCount
4.5.5.3 ValueCount
4.5.5.4 AddList
4.5.5.5 Clear
4.5.5.6 Assign
4.5.5.7 List
4.5.5.8 Value
4.5.5.9 ValueAsFloat
4.5.5.10 ValueAsInteger
4.5.5.11 ValueAsString
4.5.6 ObjectList
4.5.6.1 Free
4.5.6.2 Clear
4.5.6.3 OwnsObjects
4.5.6.4 Count
4.5.6.5 Add
4.5.6.6 Item
4.6 ExcelWrapper
4.6.1 Managing files
4.6.1.1 CreateFile
4.6.1.2 OpenFile
4.6.1.3 FileName
4.6.1.4 CloseAndSave
4.6.1.5 Save
4.6.1.6 OpenInExcel
4.6.1.7 ShowExcelPreview
4.6.2 Setting / getting cell values
4.6.2.1 SetValue
4.6.2.2 SetValueAndMerge
4.6.2.3 SetFormula
4.6.2.4 GetCellValue
4.6.2.5 AddImage
4.6.2.6 AddImageExt
4.6.2.7 SetHTML
4.6.2.8 SetHTMLAndMerge
4.6.3 Formatting cells
4.6.3.1 FillColor
4.6.3.2 MergeCells
4.6.3.3 SetTextOrientation
4.6.3.4 Align
4.6.3.5 DrawBorders
4.6.3.6 FormatCells
4.6.3.7 AddUserFormat
4.6.3.8 AutofitCol
4.6.3.9 AutofitRow
4.6.3.10 SetOptimalColWidth
4.6.3.11 SetColWidth
4.6.3.12 SetDefaultColWidth
4.6.3.13 SetRowHeight
4.6.3.14 SetDefaultRowHeight
4.6.3.15 SetColWidth_mm
4.6.3.16 SetRowHeight_mm
4.6.3.17 GetTextWidth
4.6.3.18 GetTextHeight
4.6.3.19 GetCellWidth
4.6.4 Managing page layout
4.6.4.1 Landscape
4.6.4.2 SetPaperSize
4.6.4.3 SetPrintArea
4.6.4.4 SetPrintMargins
4.6.4.5 SetHeader
4.6.4.6 SetFooter
4.6.4.7 SetHeaderAndFooter
4.6.4.8 SetFirstHeaderAndFooter
4.6.4.9 SetTitleRows
4.6.4.10 SetTitleRowsAndCols
4.6.4.11 InsertHPageBreak
4.6.4.12 InsertVPageBreak
4.6.4.13 CreateHeaderOfTableContent
4.6.4.14 CreateTableOfContent
4.6.4.15 AddBackToTableOfContent
4.6.4.16 RowCount
4.6.4.17 ColCount
4.6.4.18 Header and footer codes
4.6.4.19 Predefined paper sizes
4.6.4.20 HeaderAndFooterExample
4.6.4.21 KeepColsTogether
4.6.4.22 KeepRowsTogether
4.6.4.23 AutoPageBreaks
4.6.4.24 PrintNumberOfHorizontalPages
4.6.4.25 PrintNumberOfVerticalPages
4.6.4.26 PrintToFit
4.6.5 Managing worksheets
4.6.5.1 AddSheet
4.6.5.2 MakeSheetActive
4.6.5.3 ClearSheet
4.6.6 ExcelWrapperExample
4.7 PointWrapper
4.7.1 Create
4.7.2 Free
4.7.3 ID
4.7.4 X
4.7.5 Y
4.7.6 ShiftAndRotate
4.8 PointsWrapper
4.8.1 AddPoint
4.8.2 PointCount
4.8.3 Point
4.8.4 ClearPoints
4.9 LineWrapper
4.9.1 Create
4.9.2 Free
4.9.3 ID
4.9.4 AddPoint
4.9.5 AddPoint3D
4.9.6 ClearPoints
4.9.7 PointX
4.9.8 PointY
4.9.9 PointZ
4.9.10 Length
4.9.11 GetParallelLine
4.9.12 LoadFromPolygon
4.9.13 CreatePointsAlongLine
4.9.14 PointCount
4.9.15 FindClosestPoint
4.9.16 FindPointsWithinDistance
4.9.17 CloseLine
4.10 PolygonWrapper
4.10.1 Create
4.10.2 Free
4.10.3 ID
4.10.4 AddRing
4.10.5 AddPointToRing
4.10.6 LoadFromVarArray
4.10.7 AddPolygon
4.10.8 Ring
4.10.9 RingRotation
4.10.10 RingCount
4.10.11 MainRingCount
4.10.12 PointCount
4.10.13 TotalPointCount
4.10.14 PointX
4.10.15 PointY
4.10.16 Area
4.10.17 AreaOfSimplePolygons
4.10.18 PointInPolygon
4.10.19 CreateCircle
4.10.20 CoordinatesAsText
4.10.21 CreateSamplePoints
4.10.22 CreateCentroids
4.11 SpeciesGroups
4.11.1 Create
4.11.2 Free
4.11.3 Assign
4.11.4 SpeciesLookupTableName
4.11.5 LoadFromTable
4.11.6 SaveToTable
4.11.7 LoadFromXML
4.11.8 SaveToXML
4.11.9 GetSpeciesCompositionInfo
4.11.10 UpdateSpeciesGroupsLookupList
4.11.11 PublishClassificationToMemTable
4.11.12 EditClassification
4.11.13 ID
4.11.14 Name
4.11.15 FullName
4.11.16 SpecGroupsCount
4.11.17 SpecGroupName
4.11.18 SpecGroupFullName
4.11.19 SpeciesListForGroup
4.11.20 SpecGroupID
4.11.21 SpecGroupIDForSpecies
4.11.22 ClassifyTable
4.11.23 ClassifyLayerUsingSQL
4.11.24 UngroupedSpeciesCount
4.12 StemProfile
4.12.1 Free
4.12.2 Assign
4.12.3 ClearContent
4.12.4 ResetData
4.12.5 ID
4.12.6 SpeciesCode
4.12.7 SpeciesName
4.12.8 DBH_mm
4.12.9 TreeHeight_m
4.12.10 AddPoint
4.12.11 DeletePointAtHeight
4.12.12 DeletePointsBelowHeight
4.12.13 AddTop
4.12.14 ResetStemBaseAndTop
4.12.15 Count
4.12.16 SortByHeight
4.12.17 Diameter_mm
4.12.18 Height_m
4.12.19 Diameter2_mm
4.12.20 SD_m
4.12.21 Ticks
4.12.22 LoadBarkThicknessXML
4.12.23 LoadParametersFromStandModelXML
4.12.24 CalcD03FromStandModelXML
4.12.25 GetModelTypeFromStandModelXML
4.12.26 LoadDataFromXML
4.12.27 ExportStemPointsToXML
4.12.28 ApplyGlobalModel
4.12.29 DiamForHeightByModel_mm
4.12.30 HeightForDiamByModel_m
4.12.31 RoughBarkHeight_m
4.12.32 DoubleBarkThickness_mm
4.12.33 RoughBarkSmoothTransition
4.12.34 StumpDiameter_mm
4.12.35 StumpHeightCalcMethod
4.12.36 StumpHeight_m
4.12.37 AddDiameterReduction
4.12.38 ResetDiameterReductions
4.12.39 SaveDiameterReductions
4.12.40 RestoreDiameterReductions
4.12.41 CumulativeDiameterReduction
4.12.42 ExpandStemDataByDiameterReductions
4.12.43 Volume_m3
4.12.44 TotalVolume_m3
4.12.45 StemVolume_m3
4.12.46 MerchantableVolume_m3
4.12.47 ParametrizeModel
4.12.48 ModelAvailable
4.12.49 Param
4.12.50 AdjustForKnownVolume
4.12.51 AdjustForKnownMerchantableVolume
4.12.52 ShowStemProfile
4.12.53 ShowStemProfileComaprison
4.12.54 ShowStemProfileWithPoints
4.12.55 ShowStemProfileExt
4.12.56 RecalcDiametersUsingCurrentDendroscope
4.13 VolumeModelsWrapper
4.13.1 Create
4.13.2 Free
4.13.3 LoadFromXML
4.13.4 UseSpeciesGroups
4.13.5 Volume_m3
4.14 AttribDefsWrapper
4.14.1 Create
4.14.2 Free
4.14.3 AddAttributeDefAndValueFromFieldMapAttribute
4.14.4 AddAttributeDefAndValueFromFieldMapAttributeExt
4.14.5 AddAttributeByValue
4.14.6 AttributeLabel
4.14.7 AttributeType
4.14.8 AttributeRequired
4.14.9 AttributeVisible
4.14.10 AttributeValue
4.14.11 AttributeDefaultValue
4.14.12 AttributeExists
4.14.13 PrintAttributes
4.14.14 PrintAttributesCount
4.14.15 PrintAttribute
4.14.16 LoadFromXML
4.14.17 AsXML
4.14.18 ValuesHaveChanged
4.14.19 RenameAttribute
4.15 ValueDialogWrapper
4.15.1 Create
4.15.2 Free
4.15.3 AddHeader
4.15.4 AddInteger
4.15.5 AddFloat
4.15.6 AddString
4.15.7 AddLookupList
4.15.8 AddDate
4.15.9 InputValues
4.15.10 Value
4.15.11 ValueByLabel
4.16 ReclassificationWrapper
4.16.1 Create
4.16.2 Free
4.16.3 LoadClassification
4.16.4 RaiseExceptionOnMissingClass
4.16.5 ReclassifiedValue
4.16.6 ReclassifyTable
5. Data types
5.1 Basic data types
5.2 Structured data types
5.3 Variant types constants
6. Tutorial
6.1 Working with Field-Map data – scan and locate table records
6.2 Handling exceptions
6.3 Working with Field-Map data – using SQL queries
6.4 Parameterize regression models
6.5 Show diameter distribution
6.6 Grouping species
6.7 Working with Log window
6.8 Management of screen interface
About
About Field-Map script
Blob
Button
Calliper
Database
MyTest2
DisableEvents variable
GIS
Global scripts
Hot keys
Layer scripts
Log
Measurement
MyTest1
On-Change scripts
On-Demand scripts
On-Validate scripts
Project variable
ProjectDir variable
ProjectName variable
Query
Record
Script
ScriptResult variable
Species
Stem
TAttribDefsWrapper
TExcelWrapper
TIntegerListWrapper
TLayerWrapper
TLineWrapper
TMultiVariantListWrapper
TObjectListWrapper
TPointWrapper
TPolygonWrapper
TProjectWrapper
TScriptOrganizer
TSpeciesGroupsWrapper
TStemProfileWrapper
TStringListWrapper
TTableWrapper
TVariantListWrapper
TVarVariantListWrapper
TVolumeModelsWrapper
TXMLOutputWrapper
ValidationFailedMessageText variable
Writing scripts
Functions, procedures and properties
>
General
>
Screen
>
Colors
4.1.1.9 Colors
Colors
In this chapter:
RGB
Color2RGB
Colors list