Directions Class

Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release

A driving route through a number of stops.

Inheritance Hierarchy

SystemObject
Telogis.GeoBase.RoutingDirections

Namespace: Telogis.GeoBase.Routing
Assembly: geobase.net (in geobase.net.dll) Version: 4.99.0.0

Syntax

Copy

public class Directions : IMapRenderer, IList, 
	ICollection, IEnumerable, IList<Direction>, ICollection<Direction>, 
	IEnumerable<Direction>

Public Class Directions
	Implements IMapRenderer, IList, ICollection, IEnumerable, 
	IList(Of Direction), ICollection(Of Direction), IEnumerable(Of Direction)

The Directions type exposes the following members.

Constructors

	Name	Description
	Directions	Initialize a new Directions object.
	Directions(MessagesBundle)	Initializes a new instance of the Directions class

Top

Properties

	Name	Description
	Count	Returns the number of Directions.
	IsFixedSize	Returns whether this collection is a fixed size. Always returns true.
	IsReadOnly	Gets whether this collection is read-only or not. Always true.
	IsSynchronized	Returns whether this collection is synchronized.
	Item	Gets the Direction for the specified index.
	MessagesBundle	Provides access to messages (for example strings and announcements) for a single culture.
	Points	Gets an array of LatLons representing the entire driving route. These points may differ from the concatenation of the points on individual direction objects.
	Remote	Whether these directions were generated by a GeoStream server.
	RenderArrowColor	Sets the color of the route arrow.
	RenderArrowLength	The pixel length of the arrows that appear on the route. Set to zero to disable arrows.
	RenderArrowSpacing	The minimum distance between route arrows in pixels.
	RenderArrowWidth	The width of the arrow in pixels.
	RenderColor	Sets the Color to render the route in.
	RenderPen	The Pen normally used to render the route.
	RenderPenSmall	The Pen used to render the route when the map is zoomed out
	RequiredRendermodes	Gets the RenderMode required by this Directions.
	Selected	Gets or sets the currently selected Direction. The current selection is the one that will be rendered on the map.
	SelectedIndex	Gets or sets the current Direction by its index value in the list. See remarks.
	SyncRoot	Gets an object that can be used to synchronize access to this object. See SyncRoot.
	Units	The UnitSystem that is to be used in these directions. The value is used by the read-only UnitsEffectiveValue. If Units is not set by the application, then UnitsEffectiveValue is taken from the global settings field Units. The global default is imperial yards.
	UnitsEffectiveValue	The UnitSystem used in these directions. If Units is not set in the application, then UnitsEffectiveValue is taken from the global settings field Units. The global default is imperial yards.
	Violations	Contains a list of all constraint violations in the directions.

Top

Methods

	Name	Description
	Add(Direction)	Not supported in this class.
	Add(Object)	Not supported in this class.
	AddTag	Insert a customized object somewhere along the route. For example a simple string comment could be added.
	Clear	Not supported in this class.
	Contains(Direction)	Gets whether or not these Directions contain the specified object.
	Contains(Object)	Gets whether or not these Directions contain the specified object.
	CopyTo(Array, Int32)	Copies the contents of this collection to an array. See CopyTo(Array).
	CopyTo(Direction, Int32)	Copies the contents of this collection to an array. See CopyTo(Array).
	Deserialize	Deserialize a Directions after it has previously been serialized using the Serialize method.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetDirectionLinks	Get the DirectionLinks held by this Directions object
	GetEnumerator	Returns an enumerator for this collection.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetStopToStopDistances	Gets the travel distances between each consecutive pair of stops.
	GetStopToStopTimes	Gets the travel times between each consecutive pair of stops.
	GetTotalDistance	Gets the total distance for this route in the specified DistanceUnit.
	GetTotalTime	Get the total time for this set of directions.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf(Direction)	Gets the index of the specified object.
	IndexOf(Object)	Gets the index of the specified object.
	Insert(Int32, Object)	Not supported in this class.
	Insert(Int32, Direction)	Not supported in this class.
	Remove(Direction)	Not supported in this class.
	Remove(Object)	Not supported in this class.
	RemoveAt	Not supported in this class.
	Render	IMapRenderer support - renders a route on the map.
	Serialize	Serialize the Directions to the supplied stream. The serialized Directions can be deserialized using the Deserialize method.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ZoomTo(IMap)	Zooms the given map to this driving route.
	ZoomTo(IMap, Int32)	Zooms the given map to this driving route, and ensures that there is a visible buffer of buffer pixels between the edge of the route and the edge of the map. For example, setting buffer to 10 results in a map where the edges of this driving route are 10 pixels in from the edge of the map.

Top

Remarks

Related articles: Routing Concept, Using Directions, Routing with Traffic.

Reference

Telogis.GeoBase.Routing Namespace