Property DisplayText
DisplayText
Gets the formatted and rounded distance, ready for displaying.
Declaration
public string DisplayText { get; }
Property Value
| Type | Description |
|---|---|
| System.String | Formatted and rounded distance, ready for displaying. |
Remarks
Use this property to have consistent distances/units with voice guidance. The distance is converted to units of DisplayTextUnits. The following rules are used for rounding and formatting:
Imperial Units:
| term | description |
|---|---|
| 0 -> 50' | Round to increments of 10' (e.g. "10", "20", "30", "40") |
| 50' -> 0.1 mi (528') | Round to increments of 50' (e.g. "50", "100", "150", etc.) |
| 0.1 -> 1.0 mi | Round to decimal mile (e.g "0.1", "0.2", "0.3", etc.) |
| 1.0 mi -> 10 mi | Round to half mile (e.g. "1.0", "1.5", "2.0", etc.) |
| 10+ mi | Round to mile (e.g. "10", "11", "12", etc.) |
Metric Units:
| term | description |
|---|---|
| 0 -> 50 m | Round to increments of 10 m (e.g. "10", "20", "30", "40") |
| 50 m -> 500 m | Round to increments of 50 m (e.g. "50", "100", "150", etc.) |
| 500 m -> 10 km | Round to half km (e.g. "1.0", "1.5", "2.0", etc.) |
| 10+ km | Round to whole km (e.g. "10", "11", "12", etc.) |
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.6 - 100.15 |
| .NET 6.0 | 100.13 - 100.15 |
| .NET 6.0 Windows | 100.13 - 100.15 |
| .NET Framework | 100.6 - 100.15 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Xamarin.Android | 100.6 - 100.15 |
| Xamarin.iOS | 100.6 - 100.15 |
| UWP | 100.6 - 100.15 |
Relevant samples
Navigate route: Use a routing service to navigate between points.