ThinkGeo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== ThinkGeo.MapSuite.MvcEdition.Popup ======
Serves as the base class that defines the methods and properties common to all types of popups.
===== Inheritance Hierarchy =====
  *System.Object
    ***ThinkGeo.MapSuite.MvcEdition.Popup**
      *[[ThinkGeo.MapSuite.MvcEdition.CloudPopup]]
      *[[ThinkGeo.MapSuite.MvcEdition.CustomPopup]]
===== Members Summary =====
==== Public Constructors ====
==== Protected Constructors ====
** {{wiki:ProtectedMethod.gif|}} Popup() **

Initialize an instance of the Popup class.
== Remarks ==
N/A
== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Popup(String) **

Initialize an instance of the Popup class with the identifier specified.
== Remarks ==
N/A
== Parameters ==
  * //id//
    * Type:String
    * Description:The identifier by which you can find the popup.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Popup(String,PointShape) **

Initialize an instance of the Popup class with the identifier and position specified.
== Remarks ==
N/A
== Parameters ==
  * //id//
    * Type:String
    * Description:The identifier by which you can find the popup.

  * //position//
    * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]
    * Description:A point shape in world coordinates that indicates the position of the popup.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Popup(String,PointShape,Int32,Int32) **

Initialize an instance of the Popup class with the identifier, position, width and height specified.
== Remarks ==
N/A
== Parameters ==
  * //id//
    * Type:String
    * Description:The identifier by which you can find the popup.

  * //position//
    * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]
    * Description:A point shape in world coordinates that indicates the position of the popup.

  * //width//
    * Type:Int32
    * Description:An int value that indicates the popup's width.

  * //height//
    * Type:Int32
    * Description:An int value that indicates the popup's height.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Popup(String,PointShape,Int32,Int32,Boolean) **

Initialize an instance of the CloundPopup class with an Id string, position, popup content, popup size and a boolean value that determines whether to pan the map if necessary to show the full popup.
== Remarks ==
N/A
== Parameters ==
  * //id//
    * Type:String
    * Description:The identifier by which you can find the popup.

  * //position//
    * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]
    * Description:A point shape in world coordinates that indicates the position of the popup.

  * //width//
    * Type:Int32
    * Description:An int value that indicates the popup's width.

  * //height//
    * Type:Int32
    * Description:An int value that indicates the popup's height.

  * //autoPan//
    * Type:Boolean
    * Description:A boolean value indicating whether to pan the map if necessary to show the full popup.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Popup(String,PointShape,Int32,Int32,Boolean,Boolean) **

Initialize an instance of the CloundPopup class with an Id string, position, popup's content, popup size, a boolean value for whether to pan the map to show the popup, and a boolean value for whether to have a close button on the popup.
== Remarks ==
N/A
== Parameters ==
  * //id//
    * Type:String
    * Description:The identifier by which you can find the popup.

  * //position//
    * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]
    * Description:A point shape in world coordinates that indicates the position of the popup.

  * //width//
    * Type:Int32
    * Description:An int value that indicates the popup's width.

  * //height//
    * Type:Int32
    * Description:An int value that indicates the popup's height.

  * //autoPan//
    * Type:Boolean
    * Description:A boolean value indicating whether to pan the map if necessary to show the full popup.

  * //hasCloseButton//
    * Type:Boolean
    * Description:A boolean value indicating whether the popup should have a close button.

<div newline></div>
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} CloneShallow() **

Creates a shallow copy of the current popup object.
== Remarks ==
N/A

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.MvcEdition.Popup|Popup]]
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} ToJson() **

Returns a JSON string which contains the popup's information and is used to create the popup at the client side.
== Remarks ==
N/A

== Return Value ==
  * Type:String
  * Description:A string that is used to create the popup at the client side.

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} FromJson(String) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //jsonString//
    * Type:String
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} ToString() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:String
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Equals(Object) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Boolean
  * Description:N/A

== Parameters ==
  * //obj//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHashCode() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Int32
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetType() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Type
  * Description:N/A

== Parameters ==
<div newline></div>
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} Finalize() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Object
  * Description:N/A

== Parameters ==
<div newline></div>
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} Id **

Gets the identifier by which you can find the popup.
== Remarks ==
N/A
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} Position **

Gets or sets a point shape in world coordinates that represents the position of the popup.
== Remarks ==
N/A
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]

** {{wiki:PublicProperty.gif|}} Width **

Gets or sets the width of the popup.
== Remarks ==
N/A
== Return Value ==
  * Type:Int32

** {{wiki:PublicProperty.gif|}} Height **

Gets or sets the height of the popup.
== Remarks ==
N/A
== Return Value ==
  * Type:Int32

** {{wiki:PublicProperty.gif|}} IsVisible **

Gets or sets a value that indicates whether the popup is visible on the map.
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} Opacity **

Gets or sets the opacity level of the popup.
== Remarks ==
The Opacity property enables you to specify a level of transparency for the popup. When this property is set to a value less than 100 percent (1.00), the entire popup (including its content) is made more transparent. The lower the value, the more transparent it is.  Setting this property to a value of 0 percent (0.00) makes the popup completely invisible.
== Return Value ==
  * Type:Single

** {{wiki:PublicProperty.gif|}} AutoSize **

Gets or sets a value that indicates whether the popup is automatically resized to fit its contents.
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} AutoPan **

Gets or sets a value that indicates whether to pan the map to display the entire popup if the popup is not fully displayed.
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} HasCloseButton **

Gets or sets a value that indicates whether the popup window has a close button in the upper right corner.
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} OffsetXInPixels **

Gets or sets the popup's pixel offset in X direction.
== Remarks ==
N/A
== Return Value ==
  * Type:Int32

** {{wiki:PublicProperty.gif|}} OffsetYInPixels **

Gets or sets the popup's pixel offset in Y direction.
== Remarks ==
N/A
== Return Value ==
  * Type:Int32

==== Protected Properties ====
** {{wiki:ProtectedProperty.gif|}} PopupType **

Gets a string that represents the type of the Popup object.
== Remarks ==
N/A
== Return Value ==
  * Type:String

==== Public Events ====
Map Suite UI Controls

MapSuite GIS Services

Free Tools

Professional Services

Support & Learning

About ThinkGeo

User Tools

Site Tools

Page Tools

Map Suite UI Controls

MapSuite GIS Services

Free Tools

Professional Services

Support & Learning

About ThinkGeo
