Share via


GuidanceRoute Class

Definition

Represents a route for which navigational guidance is provided.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

public ref class GuidanceRoute sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Services.Maps.GuidanceContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class GuidanceRoute final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Services.Maps.GuidanceContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class GuidanceRoute
Public NotInheritable Class GuidanceRoute
Inheritance
Object Platform::Object IInspectable GuidanceRoute
Attributes

Windows requirements

Device family
Windows Desktop Extension SDK (introduced in 10.0.10240.0)
Windows Mobile Extension SDK (introduced in 10.0.10240.0)
API contract
Windows.Services.Maps.GuidanceContract (introduced in v1.0)

Properties

BoundingBox

Gets the geographic area that contains the route.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

Distance

Gets the total distance of the route in meters.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

Duration

Gets the estimated travel time of the route.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

Maneuvers

Gets a list of maneuvers required to navigate the route.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

Path

Gets an ordered series of geographic points along the route.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

RoadSegments

Gets a list of road segments, ordered from start to finish, that make up the route.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

Methods

CanCreateFromMapRoute(MapRoute)

Checks if the specified MapRoute object can be converted to a GuidanceRoute object.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

ConvertToMapRoute()

Creates a MapRoute object that's based on the current GuidanceRoute.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

TryCreateFromMapRoute(MapRoute)

Creates a GuidanceRoute object that's based on the specified MapRoute.

Note

This API is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime. For more information about the Windows.Services.Maps.Guidance namespace, please work with your Microsoft Account Team representative.

Applies to