ArcPad Scripting Object Model
Properties Property
See Also  Send comments on this topic.
Property
Required. A String that specifies the property name.
Map Object : Properties Property

Glossary Item Box

Description

Returns or sets the specified property for the map.

Property type

Read-write property

Syntax

object.Properties ( Property ) = [ value ]

Parameters

Property
Required. A String that specifies the property name.

Return Type

Variant

Remarks

The Properties property is used to get or set the value of properties that need to be accessed less often. The following properties are supported: 
Name Description Return Type Read-only or read/write
AreaDisplayNumericScale The number of decimal places displayed for area calculations. This setting affects the Measurement Information dialog box. Default is 2. Long Read/write
AutoRotation Determines whether the map automatically rotates when the GPS is active such that the map is always "course up". Default is False. Boolean Read/write
AutoRotationAverageWindow The number of successive GPS fixes that are averaged to calculate the average course over ground (ArcPad uses a moving average). If AutoRotationAverageWindow is 1, then the instantaneous course is used (which can cause excessive rotation). This only applies when AutoRotation is active. Default is 5. Long Read/write
AutoRotationCourseThreshold The course deviation threshold angle. The map does not automatically rotate unless you exceed the current rotation angle by the course threshold angle. This only applies when AutoRotation is active. Default is 5 °. Long Read/write
AutoRotationSpeedThreshold The minimum speed at which you must be traveling before the map automatically rotates. This only applies when AutoRotation is active. Default is 2 KPH. Double Read/write
AutoRotationStep The step angle when rotating the map. For example, an AutoRotationStep of 5 ° would round the course off to the nearest multiple of 5 ° when rotating the map. This only applies when AutoRotation is active. Default is 1 °. Long Read/write
AutoRotationTimeInterval The time interval between checks for automatic rotation. In the mean time ArcPad is still averaging the direction of travel as per the other AutoRotation parameters. This only applies when AutoRotation is active. Default is 10000 ms. Long Read/write
BackgroundColor The map's background color. Default is white (apWhite). OLE_COLOR Read/write
CoordinatesDisplayNumericScale The number of decimal places displayed for projected coordinates. This setting affects the Status Bar, GPS Position Window, and Measurement Information dialog box. Default is 1. Long Read/write
Crosshairs Determines whether the aiming Cross Hairs in ArcPad are enabled. Default is True. Boolean Read/write
DistanceDisplayNumericScale The number of decimal places displayed for distance calculations. This setting affects the Measurement Information dialog box. Default is 1. Long Read/write
Modified Sets ArcPad's modified flag which triggers the "Save Changes" dialog when closing the map or exiting ArcPad. Boolean Read/write
NorthArrowFillColor1 The fill color for the left portion of the north arrow. Default is black (apBlack). OLE_COLOR Read/write
NorthArrowFillColor2 The fill color for the right portion of the north arrow. Default is white (apWhite). OLE_COLOR Read/write
NorthArrowOutlineColor The outline color for the north arrow. Default is black (apBlack). OLE_COLOR Read/write
NorthArrowPosition The position of the north arrow on the screen, based on the following matrix: . Default is 3 (upper right portion of the screen). Long Read/write
NorthArrowRadius The radius of the north arrow (in pixels). Default is 15. Long Read/write
NorthArrowVisible Determines whether the north arrow is displayed in the map view. Default is False. Boolean Read/write
PanFrameVisible Determines whether the Panning Frame is displayed in the map view. Default is False. Boolean Read/write
ScalebarDisplayNumericScale Determines the number of decimal places displayed in the scale bar. Default is 0, which uses ArcPad's default behavior. Long Read/write
ScaleBarVisible Determines whether the Scale Bar is displayed in the map view. Default is True. Boolean Read/write
SelectionColor The color of the selection box around a selected feature. Default is black (apBlack). OLE_COLOR Read/write
SuspendDraw Determines whether map redrawing is disabled or enabled. This allows developers to suspend drawing before starting an editing operating; new feature capture; or other action that would ordinarily trigger a refresh, and then restore drawing. For example, it supports a scenario where the user makes multiple edits with only a single redraw occurring at the end. When set to True, the user interface continues to work but the map view is no longer refreshed. When set to False, the map is refreshed and drawing is restored. Default is True. Boolean Read/write

Here's an example of setting the Properties property:

Map.Properties ("BackgroundColor") = apYellow

See Also

© 2013 All Rights Reserved.