|
<< Click to Display Table of Contents >> Navigation: »No topics above this level« TOC : Script API > JavaScript > JavaScript API > GeneralScript > Global > Method >_StartUpdateLocation |
Starts to update location information.
Prototype :
void _StartUpdateLocation
(
[ bool UpdateAddress ],
[ string LocationUpdateType ]
)
Arguments :
UpdateAddress |
Whether the update Address information with location information If not set, applies as true |
LocationUpdateType |
refer to LocationUpdateTypeConst If not set, applies as Once |
Reference :
This function works in the Android, iOS and WinUWP viewer.
In an unsupported environment if OnLocationUpdated event, Location and Address object return null.
When UpdateAddress argument be set to false, Address object of OnLocation Updated event return null
If LocationUpdateType argument be set to Once, OnLocationUpdated event is called once and then stop updating the location information.
When LocationUpdateType argument be set to Tracking, whenever location information changes LocationUpdateType event is called and if _StopUpdateLocation function is called it stops updating location information. But if the report is saved or printed when LocationUpdateType argument be set to Tracking, updating location information is stoped automatically.
Example :
//string
_StartUpdateLocation(true, "Tracking");
//constant
_StartUpdateLocation(true, LocationUpdateTypeConst.Tracking);
Available Events :
OnClick, OnExternalEvent, OnFocus, OnKillFocus, OnValueChanged
See also :
LocationUpdateTypeConst, OnLocationUpdated