Products
Professional Services
Demos and Downloads
Help and Support
Sidebar
thinkgeo.mapsuite.webedition.popup
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.WebEdition.Popup
<!– Class –> Serves as the base class that defines the methods and properties common to all types of popups.
Remarks
A <strong>Popup</strong> is a special type of window overlaid on the map, which is typically used for dialog boxes, message boxes and other temporary windows.The <strong>Position</strong> property determines where the popup is. The <strong>Width</strong> and <strong>Height</strong> properties determine the popup's size.Set the <strong>Opacity</strong> property to a value between 0 and 1 to make the popup transparent. The smaller the value is, the more transparent the popup is. The <strong>Opacity</strong> is 1 (fully opaque) by default.Set the <strong>AutoSize</strong> to true to make the popup adjust its size automatically to fit its content.Set the <strong>AutoPan</strong> to true to always show the entire popup by automatically panning the map if the popup is only partially displayed.The <strong>HasCloseButton</strong> property indicates whether the popup has a close button in the upper right corner.The <strong>OffsetXInPixels</strong> and <strong>OffsetYInPixels</strong> properties determine the offset from its origin at which the popup will be displayed. Use these properties to move the popup if it is obscuring something beneath it.
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.WebEdition.Popup *ThinkGeo.MapSuite.WebEdition.CloudPopup ***ThinkGeo.MapSuite.WebEdition.CustomPopup
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Popup | Initialize an instance of the Popup class. | ||
| Popup | String | Initialize an instance of the Popup class with the identifier specified. | |
| Popup | String, PointShape | Initialize an instance of the Popup class with the identifier and position specified. | |
| Popup | String, PointShape, Int32, Int32 | Initialize an instance of the Popup class with the identifier, position, width and height specified. | |
| 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. | |
| 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. |
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 CloneShallow | Creates a shallow copy of the current popup object. | ||
| Equals | Object | Object | |
| GetHashCode | Object | ||
| GetType | Object | ||
| ToJson | Returns a JSON string which contains the popup's information and is used to create the popup at the client side. | ||
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| Finalize | Object | ||
| MemberwiseClone | Object |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 AutoPan | Boolean | Gets or sets a value that indicates whether to pan the map to display the entire popup if the popup is not fully displayed. | |
| AutoSize | Boolean | Gets or sets a value that indicates whether the popup is automatically resized to fit its contents. | |
| HasCloseButton | Boolean | Gets or sets a value that indicates whether the popup window has a close button in the upper right corner. | |
| Height | Int32 | Gets or sets the height of the popup. | |
| Id | String | Gets the identifier by which you can find the popup. | |
| IsVisible | Boolean | Gets or sets a value that indicates whether the popup is visible on the map. | |
| OffsetXInPixels | Int32 | Gets or sets the popup's pixel offset in X direction. | |
| OffsetYInPixels | Int32 | Gets or sets the popup's pixel offset in Y direction. | |
| Opacity | Single | Gets or sets the opacity level of the popup. | |
| Position | PointShape | Gets or sets a point shape in world coordinates that represents the position of the popup. | |
| Width | Int32 | Gets or sets the width of the popup. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 PopupType | String | Gets a string that represents the type of the Popup object. |
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|
Public Constructors
Protected Constructors
Popup()
Initialize an instance of the Popup class.
Overloads
Initialize an instance of the Popup class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28.29</a>
Parameters
| Name | Type | Description |
|---|
Popup(String)
Initialize an instance of the Popup class with the identifier specified.
Overloads
Initialize an instance of the Popup class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.29</a>
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | The identifier by which you can find the popup. |
Popup(String, PointShape)
Initialize an instance of the Popup class with the identifier and position specified.
Overloads
Initialize an instance of the Popup class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.2C_PointShape.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.2C_PointShape.29</a>
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | The identifier by which you can find the popup. |
| position | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | A point shape in world coordinates that indicates the position of the popup. |
Popup(String, PointShape, Int32, Int32)
Initialize an instance of the Popup class with the identifier, position, width and height specified.
Overloads
Initialize an instance of the Popup class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.2C_PointShape.2C_Int32.2C_Int32.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.2C_PointShape.2C_Int32.2C_Int32.29</a>
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | The identifier by which you can find the popup. |
| position | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | A point shape in world coordinates that indicates the position of the popup. |
| width | Int32<!– System.Int32 –> | An int value that indicates the popup's width. |
| height | Int32<!– System.Int32 –> | An int value that indicates the popup's height. |
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.
Overloads
Initialize an instance of the Popup class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.2C_PointShape.2C_Int32.2C_Int32.2C_Boolean.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.2C_PointShape.2C_Int32.2C_Int32.2C_Boolean.29</a>
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | The identifier by which you can find the popup. |
| position | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | A point shape in world coordinates that indicates the position of the popup. |
| width | Int32<!– System.Int32 –> | An int value that indicates the popup's width. |
| height | Int32<!– System.Int32 –> | An int value that indicates the popup's height. |
| autoPan | Boolean<!– System.Boolean –> | A boolean value indicating whether to pan the map if necessary to show the full popup. |
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.
Overloads
Initialize an instance of the Popup class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.2C_PointShape.2C_Int32.2C_Int32.2C_Boolean.2C_Boolean.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.2C_PointShape.2C_Int32.2C_Int32.2C_Boolean.2C_Boolean.29</a>
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | The identifier by which you can find the popup. |
| position | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | A point shape in world coordinates that indicates the position of the popup. |
| width | Int32<!– System.Int32 –> | An int value that indicates the popup's width. |
| height | Int32<!– System.Int32 –> | An int value that indicates the popup's height. |
| autoPan | Boolean<!– System.Boolean –> | A boolean value indicating whether to pan the map if necessary to show the full popup. |
| hasCloseButton | Boolean<!– System.Boolean –> | A boolean value indicating whether the popup should have a close button. |
Public Methods
CloneShallow()
Creates a shallow copy of the current popup object.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#CloneShallow.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#CloneShallow.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Popup<!– ThinkGeo.MapSuite.WebEdition.Popup –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WebEdition.Popup –> Go Back
Equals(Object)
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Equals.28Object.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Equals.28Object.29</a>
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
GetHashCode()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#GetHashCode.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#GetHashCode.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetType()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#GetType.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#GetType.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
ToJson()
Returns a JSON string which contains the popup's information and is used to create the popup at the client side.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#ToJson.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#ToJson.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> | A string that is used to create the popup at the client side. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WebEdition.Popup –> Go Back
ToString()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#ToString.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#ToString.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
Finalize()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Finalize.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Finalize.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
MemberwiseClone()
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#MemberwiseClone.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#MemberwiseClone.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Public Properties
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
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#AutoPan” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#AutoPan</a>
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Popup –> Go Back
AutoSize
Gets or sets a value that indicates whether the popup is automatically resized to fit its contents.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#AutoSize” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#AutoSize</a>
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Popup –> Go Back
HasCloseButton
Gets or sets a value that indicates whether the popup window has a close button in the upper right corner.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#HasCloseButton” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#HasCloseButton</a>
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Popup –> Go Back
Height
Gets or sets the height of the popup.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Height” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Height</a>
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.WebEdition.Popup –> Go Back
Id
Gets the identifier by which you can find the popup.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Id” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Id</a>
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.WebEdition.Popup –> Go Back
IsVisible
Gets or sets a value that indicates whether the popup is visible on the map.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#IsVisible” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#IsVisible</a>
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.WebEdition.Popup –> Go Back
OffsetXInPixels
Gets or sets the popup's pixel offset in X direction.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#OffsetXInPixels” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#OffsetXInPixels</a>
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.WebEdition.Popup –> Go Back
OffsetYInPixels
Gets or sets the popup's pixel offset in Y direction.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#OffsetYInPixels” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#OffsetYInPixels</a>
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.WebEdition.Popup –> Go Back
Opacity
Gets or sets the opacity level of the popup.
Remarks
The <strong>Opacity</strong> 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
| Return Type |
|---|
| Single<!– System.Single –> |
<!– ThinkGeo.MapSuite.WebEdition.Popup –> Go Back
Position
Gets or sets a point shape in world coordinates that represents the position of the popup.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Position” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Position</a>
Return Value
| Return Type |
|---|
| PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> |
<!– ThinkGeo.MapSuite.WebEdition.Popup –> Go Back
Width
Gets or sets the width of the popup.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Width” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Width</a>
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.WebEdition.Popup –> Go Back
Protected Properties
PopupType
Gets a string that represents the type of the Popup object.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#PopupType” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#PopupType</a>
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.WebEdition.Popup –> Go Back
Public Events
thinkgeo.mapsuite.webedition.popup.1440040135.txt.gz · Last modified: 2015/09/18 03:09 (external edit)
