BalloonPushPin Class

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

A PushPin with an informational balloon. The balloon may be hidden if required.

Inheritance Hierarchy

SystemObject
  Telogis.GeoBasePushPin
    Telogis.GeoBaseDirectionalPushPin
      Telogis.GeoBaseBalloonPushPin

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

Syntax

Copy

[SerializableAttribute]
public class BalloonPushPin : DirectionalPushPin, 
	IMapMouseHandler

<SerializableAttribute>
Public Class BalloonPushPin
	Inherits DirectionalPushPin
	Implements IMapMouseHandler

The BalloonPushPin type exposes the following members.

Constructors

	Name	Description
	BalloonPushPin(LatLon)	Create a new pushpin anchored at the given location. The informational balloon will contain information about the street address.
	BalloonPushPin(LatLon, Boolean)	Create a new pushpin anchored at the given location. The informational balloon will contain information about the street address.
	BalloonPushPin(String, GeocodeAddress)	Construct a new BalloonPushPin with a given name, placed at the given GeocodeAddress and displaying information about that address.
	BalloonPushPin(String, ISearchSuggestion)	Construct a new BalloonPushPin with a given name, placed at the given ISearchSuggestion and displaying information about that address.
	BalloonPushPin(String, LatLon)	Construct a new BalloonPushPin with a given name, to be placed at the given LatLon. The informational balloon will contain information about the street address and will be displayed by default.

Top

Properties

	Name	Description
	Address	Gets the Address this push pin is located at.
	AlwaysOnTop	Controls whether labels are always shown above other map elements. (Inherited from PushPin.)
	AnchorPoint	Gets the XY coordinates of the balloon's anchor point on the map.
	AutoAbbreviate	Gets or sets a boolean specifying whether to automatically hide the Information portion of the balloon when there is insufficient space to display it without collision.
	BorderColor	Changes the color of the border line.
	DetectBalloonClick	Gets or sets whether clicks are registered on both the balloon and the pin, or just the pin.
	DisplayLocation	Gets the BalloonLocation for the balloon.
	Heading	Gets or sets the heading (in degrees) of this DirectionalPushPin. (Inherited from DirectionalPushPin.)
	Icon	Gets or sets the Icon number. See IconCache for details. (Inherited from PushPin.)
	InformationBackgroundColor	Changes the background color of the information block.
	Location	Gets or sets the location (as a LatLon) of the push pin. (Inherited from PushPin.)
	MapMouseEventsHandler	Gets the MapMouseEventsHandler associated with this object.
	Name	Gets or sets the name of the balloon, which will appear as its title.
	RenderFont	Changes the font used to display the text in the informational balloon. Default is 8pt Arial.
	RequiredRendermodes	Gets the RenderMode required by this BalloonPushPin. (Overrides PushPinRequiredRendermodes.)
	ShowBalloon	Gets or sets whether the balloon will be hidden or shown. True (shown) by default.
	ShowInformation	Gets or sets whether the balloon will display its information. True (shown) by default.
	TextColor	Changes the color of the information text.
	TitleBackgroundColor	Changes the background color of the title block.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HitTest	On a given map, check whether the rectangular area occupied by this BalloonPushPin lies underneath the given x and y coordinates.
	Render	Render push pins with the given RenderContext. See also IMapRenderer. (Overrides DirectionalPushPinRender(Graphics, RenderContext).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	Information	Text to be displayed below the balloon name.
	PreferredLocation	A field representing the preferred location at which the balloon will be rendered. Default is NorthEast.
	Tag	A user object containing data to associate with this PushPin. (Inherited from PushPin.)

Top

Remarks

A BalloonPushPin appears as an information balloon anchored to a point on a map. The balloon can be given a name (such as "Some Company Ltd", the default is "PushPin") below which additional information can be displayed, such as a street address.

Both the balloon and its information (if any) are displayed by default. Use ShowBalloon and ShowInformation to modify this behavior.

When an address is known, it is strongly recommended to use BalloonPushPin(String, GeocodeAddress) to avoid a performance hit from the Reverse Geocoding, and ensure that the correct (or desired) address is used in labeling the balloon.

Examples

Copy

// new balloonpushpin, centered on Telogis HQ
BalloonPushPin b = new BalloonPushPin(new LatLon(33.584086,-117.731900));

// name the balloonpushpin
b.Name = "Telogis HQ";

// if you comment this line out, the address of the balloonpushpin will instead be displayed
b.Information = "GeoBase is designed for a rapid development cycle and low deployment cost.";

// if you uncomment this line, the Information (set above) will be hidden
//b.ShowInformation = false;

Reference

Telogis.GeoBase Namespace