Differences

This shows you the differences between two versions of the page.

--- thinkgeo.mapsuite.webedition.cloudpopup [2015/08/20 03:08]
127.0.0.1 external edit
+++ thinkgeo.mapsuite.webedition.cloudpopup [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.WebEdition.CloudPopup ======
+{{section>upgrade_map_suite_to_10.0}}
-<!-- Class -->
 Represents the popups that appear in a cloud (a.k.a. balloon) shape.
-=== Remarks ===
-When you add a &lt;strong&gt;CloudPopup&lt;/strong&gt; object to map, a cloud-shaped popup will be created at the client side.You can put any HTML string in the &lt;strong&gt;ContentHtml&lt;/strong&gt; property, which will be parsed and displayed in the popup.
 ===== Inheritance Hierarchy =====
-*System.Object
+  *System.Object
-**[[ThinkGeo.MapSuite.WebEdition.Popup]]
+    *ThinkGeo.MapSuite.WebEdition.Popup
-***[[ThinkGeo.MapSuite.WebEdition.CloudPopup]]
+      ***ThinkGeo.MapSuite.WebEdition.CloudPopup**
 ===== Members Summary =====
 ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} CloudPopup() **
-| {{wiki:PublicMethod.gif|Public Method}}[[#CloudPopup()|CloudPopup]]   |    |    | Initialize an instance of the CloudPopup class.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#CloudPopup(String)|CloudPopup]]   | String   |    | Initialize an instance of the CloudPopup class with an Id string.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#CloudPopup(String, PointShape)|CloudPopup]]   | String, [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]   |    | Initialize an instance of the CloudPopup class with an Id string and the position.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#CloudPopup(String, PointShape, String)|CloudPopup]]   | String, [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], String   |    | Initialize an instance of the CloudPopup class with an Id string, position and the content of the popup.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#CloudPopup(String, PointShape, String, Int32, Int32)|CloudPopup]]   | String, [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], String, Int32, Int32   |    | Initialize an instance of the CloudPopup class with Id string, position, popup content and size.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#CloudPopup(String, PointShape, String, Int32, Int32, Boolean)|CloudPopup]]   | String, [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], String, Int32, Int32, Boolean   |    | Initialize an instance of the CloudPopup 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.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#CloudPopup(String, PointShape, String, Int32, Int32, Boolean, Boolean)|CloudPopup]]   | String, [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], String, Int32, Int32, Boolean, Boolean   |    | Initialize an instance of the CloudPopup 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.   |
-==== Protected Constructors ====
+  * //Initialize an instance of the CloudPopup class.//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28.29//
+== Parameters ==
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} CloudPopup(String) **
-==== Public Methods ====
+  * //Initialize an instance of the CloudPopup class with an Id string.//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:PublicMethod.gif|Public Method}}[[#CloneShallow()|CloneShallow]]   |    | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]   | Creates a shallow copy of the current popup object.   |
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.29//
-| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
+== Parameters ==
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
+  * //id//
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
+    * Type:String
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToJson()|ToJson]]   |    | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]   | Returns a JSON string which contains the popup's information and is used to create the popup at the client side.   |
+    * Description:The identifier by which you can find the popup.
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |
-==== Protected Methods ====
+<div newline></div>
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} CloudPopup(String,PointShape) **
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
-==== Public Properties ====
+  * //Initialize an instance of the CloudPopup class with an Id string and the position.//
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:PublicProperty.gif|Public Property}}[[#AutoPan|AutoPan]]   | Boolean   | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]   | Gets or sets a value that indicates whether to pan the map to display the entire popup if the popup is not fully displayed.   |
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.29//
-| {{wiki:PublicProperty.gif|Public Property}}[[#AutoSize|AutoSize]]   | Boolean   | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]   | Gets or sets a value that indicates whether the popup is automatically resized to fit its contents.   |
+== Parameters ==
-| {{wiki:PublicProperty.gif|Public Property}}[[#ContentHtml|ContentHtml]]   | String   |    | Gets or sets the content HTML of the popup window.   |
+  * //id//
-| {{wiki:PublicProperty.gif|Public Property}}[[#HasCloseButton|HasCloseButton]]   | Boolean   | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]   | Gets or sets a value that indicates whether the popup window has a close button in the upper right corner.   |
+    * Type:String
-| {{wiki:PublicProperty.gif|Public Property}}[[#Height|Height]]   | Int32   | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]   | Gets or sets the height of the popup.   |
+    * Description:The identifier by which you can find the popup.
-| {{wiki:PublicProperty.gif|Public Property}}[[#Id|Id]]   | String   | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]   | Gets the identifier by which you can find the popup.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]]   | Boolean   | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]   | Gets or sets a value that indicates whether the popup is visible on the map.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#OffsetXInPixels|OffsetXInPixels]]   | Int32   | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]   | Gets or sets the popup's pixel offset in X direction.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#OffsetYInPixels|OffsetYInPixels]]   | Int32   | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]   | Gets or sets the popup's pixel offset in Y direction.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Opacity|Opacity]]   | Single   | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]   | Gets or sets the opacity level of the popup.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Position|Position]]   | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]   | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]   | Gets or sets a point shape in world coordinates that represents the position of the popup.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Width|Width]]   | Int32   | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]   | Gets or sets the width of the popup.   |
-==== Protected Properties ====
+  * //position//
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+    * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]
-| {{wiki:ProtectedProperty.gif|Protected Property}}[[#PopupType|PopupType]]   | String   | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]](overriden)   | Gets a string that represents the type of the Popup object.   |
+    * Description:A point shape in world coordinates that indicates the position of the popup.
-==== Public Events ====
+<div newline></div>
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} CloudPopup(String,PointShape,String) **
-===== Public Constructors =====
+  * //Initialize an instance of the CloudPopup class with an Id string, position and the content of the popup.//
-==== CloudPopup() ====
+== Remarks ==
-Initialize an instance of the CloudPopup class.
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.2C_String.29//
-=== Overloads ===
+== Parameters ==
-Initialize an instance of the CloudPopup class.
+  * //id//
-=== Remarks ===
+    * Type:String
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28.29</a>
+    * Description:The identifier by which you can find the popup.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Public Constructors|Go Back]]
+  * //position//
-==== CloudPopup(String) ====
+    * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]
-Initialize an instance of the CloudPopup class with an Id string.
+    * Description:A point shape in world coordinates that indicates the position of the popup.
-=== Overloads ===
-Initialize an instance of the CloudPopup class.
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.29</a>
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| id   | String<!-- System.String -->   | The identifier by which you can find the popup.   |
-[[#Public Constructors|Go Back]]
+  * //contentHtml//
-==== CloudPopup(String, PointShape) ====
+    * Type:String
-Initialize an instance of the CloudPopup class with an Id string and the position.
+    * Description:An HTML string rendered as the popup content.
-=== Overloads ===
-Initialize an instance of the CloudPopup class.
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.29</a>
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| id   | String<!-- System.String -->   | The identifier by which you can find the popup.   |
-| position   | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape -->   | A point shape in world coordinates that indicates the position of the popup.   |
-[[#Public Constructors|Go Back]]
+<div newline></div>
-==== CloudPopup(String, PointShape, String) ====
+** {{wiki:PublicMethod.gif|}} CloudPopup(String,PointShape,String,Int32,Int32) **
-Initialize an instance of the CloudPopup class with an Id string, position and the content of the popup.
-=== Overloads ===
-Initialize an instance of the CloudPopup class.
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.2C_String.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.2C_String.29</a>
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| id   | String<!-- System.String -->   | The identifier by which you can find the popup.   |
-| position   | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape -->   | A point shape in world coordinates that indicates the position of the popup.   |
-| contentHtml   | String<!-- System.String -->   | An HTML string rendered as the popup content.   |
-[[#Public Constructors|Go Back]]
+  * //Initialize an instance of the CloudPopup class with Id string, position, popup content and size.//
-==== CloudPopup(String, PointShape, String, Int32, Int32) ====
+== Remarks ==
-Initialize an instance of the CloudPopup class with Id string, position, popup content and size.
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.2C_String.2C_Int32.2C_Int32.29//
-=== Overloads ===
+== Parameters ==
-Initialize an instance of the CloudPopup class.
+  * //id//
-=== Remarks ===
+    * Type:String
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.2C_String.2C_Int32.2C_Int32.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.2C_String.2C_Int32.2C_Int32.29</a>
+    * Description:The identifier by which you can find the popup.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| id   | String<!-- System.String -->   | The identifier by which you can find the popup.   |
-| position   | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape -->   | A point shape in world coordinates that indicates the position of the popup.   |
-| contentHtml   | String<!-- System.String -->   | An HTML string rendered as the popup content.   |
-| 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.   |
-[[#Public Constructors|Go Back]]
+  * //position//
-==== CloudPopup(String, PointShape, String, Int32, Int32, Boolean) ====
+    * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]
-Initialize an instance of the CloudPopup 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.
+    * Description:A point shape in world coordinates that indicates the position of the popup.
-=== Overloads ===
-Initialize an instance of the CloudPopup class.
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.2C_String.2C_Int32.2C_Int32.2C_Boolean.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.2C_String.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   | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape -->   | A point shape in world coordinates that indicates the position of the popup.   |
-| contentHtml   | String<!-- System.String -->   | An HTML string rendered as the popup content.   |
-| 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.   |
-[[#Public Constructors|Go Back]]
+  * //contentHtml//
-==== CloudPopup(String, PointShape, String, Int32, Int32, Boolean, Boolean) ====
+    * Type:String
-Initialize an instance of the CloudPopup 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.
+    * Description:An HTML string rendered as the popup content.
-=== Overloads ===
-Initialize an instance of the CloudPopup class.
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.2C_String.2C_Int32.2C_Int32.2C_Boolean.2C_Boolean.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.2C_String.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   | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape -->   | A point shape in world coordinates that indicates the position of the popup.   |
-| contentHtml   | String<!-- System.String -->   | An HTML string rendered as the popup content.   |
-| 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 Constructors|Go Back]]
+  * //width//
-===== Protected Constructors =====
+    * Type:Int32
-===== Public Methods =====
+    * Description:An int value that indicates the popup's width.
-==== 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.CloudPopup#CloneShallow.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloneShallow.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]<!-- ThinkGeo.MapSuite.WebEdition.Popup -->   |    |
-=== Parameters ===
+  * //height//
-^  Name ^  Type ^  Description ^
+    * Type:Int32
+    * Description:An int value that indicates the popup's height.
-<!-- ThinkGeo.MapSuite.WebEdition.Popup -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} CloudPopup(String,PointShape,String,Int32,Int32,Boolean) **
-==== 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.CloudPopup#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Equals.28Object.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Boolean<!-- System.Boolean -->   |    |
-=== Parameters ===
+  * //Initialize an instance of the CloudPopup 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.//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| obj   | Object<!-- System.Object -->   |    |
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.2C_String.2C_Int32.2C_Int32.2C_Boolean.29//
+== Parameters ==
+  * //id//
+    * Type:String
+    * Description:The identifier by which you can find the popup.
-<!-- System.Object -->
+  * //position//
-[[#Public Methods|Go Back]]
+    * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]
-==== GetHashCode() ====
+    * Description:A point shape in world coordinates that indicates 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.CloudPopup#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#GetHashCode.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Int32<!-- System.Int32 -->   |    |
-=== Parameters ===
+  * //contentHtml//
-^  Name ^  Type ^  Description ^
+    * Type:String
+    * Description:An HTML string rendered as the popup content.
-<!-- System.Object -->
+  * //width//
-[[#Public Methods|Go Back]]
+    * Type:Int32
-==== GetType() ====
+    * Description:An int value that indicates the popup's width.
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#GetType.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Type<!-- System.Type -->   |    |
-=== Parameters ===
+  * //height//
-^  Name ^  Type ^  Description ^
+    * Type:Int32
+    * Description:An int value that indicates the popup's height.
-<!-- System.Object -->
+  * //autoPan//
-[[#Public Methods|Go Back]]
+    * Type:Boolean
-==== ToJson() ====
+    * Description:A boolean value indicating whether to pan the map if necessary to show the full popup.
-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.CloudPopup#ToJson.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#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 ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:PublicMethod.gif|}} CloudPopup(String,PointShape,String,Int32,Int32,Boolean,Boolean) **
-<!-- ThinkGeo.MapSuite.WebEdition.Popup -->
+  * //Initialize an instance of the CloudPopup 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|Go Back]]
+== Remarks ==
-==== ToString() ====
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloudPopup.28String.2C_PointShape.2C_String.2C_Int32.2C_Int32.2C_Boolean.2C_Boolean.29//
-=== Remarks ===
+== Parameters ==
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#ToString.28.29</a>
+  * //id//
-=== Return Value ===
+    * Type:String
-^ Return Type ^ Description ^
+    * Description:The identifier by which you can find the popup.
-| String<!-- System.String -->   |    |
-=== Parameters ===
+  * //position//
-^  Name ^  Type ^  Description ^
+    * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]
+    * Description:A point shape in world coordinates that indicates the position of the popup.
-<!-- System.Object -->
+  * //contentHtml//
-[[#Public Methods|Go Back]]
+    * Type:String
-===== Protected Methods =====
+    * Description:An HTML string rendered as the popup content.
-==== Finalize() ====
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Finalize.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //width//
-^  Name ^  Type ^  Description ^
+    * Type:Int32
+    * Description:An int value that indicates the popup's width.
-<!-- System.Object -->
+  * //height//
-[[#Protected Methods|Go Back]]
+    * Type:Int32
-==== MemberwiseClone() ====
+    * Description:An int value that indicates the popup's height.
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#MemberwiseClone.28.29</a>
-=== Return Value ===
-^ Return Type ^ Description ^
-| Object<!-- System.Object -->   |    |
-=== Parameters ===
+  * //autoPan//
-^  Name ^  Type ^  Description ^
+    * Type:Boolean
+    * Description:A boolean value indicating whether to pan the map if necessary to show the full popup.
-<!-- System.Object -->
+  * //hasCloseButton//
-[[#Protected Methods|Go Back]]
+    * Type:Boolean
-===== Public Properties =====
+    * Description:A boolean value indicating whether the popup should have a close button.
-==== 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.CloudPopup#AutoPan" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#AutoPan</a>
-=== Return Value ===
-^ Return Type ^
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Popup -->
+<div newline></div>
-[[#Public Properties|Go Back]]
+==== Protected Constructors ====
-==== AutoSize ====
+==== Public Methods ====
-Gets or sets a value that indicates whether the popup is automatically resized to fit its contents.
+** {{wiki:PublicMethod.gif|}} CloneShallow() **
-=== Remarks ===
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#AutoSize" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#AutoSize</a>
+  * //Creates a shallow copy of the current popup object.//
-=== Return Value ===
+== Remarks ==
-^ Return Type ^
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#CloneShallow.28.29//
-| Boolean<!-- System.Boolean -->   |
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.WebEdition.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 ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#ToJson.28.29//
+== 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|}} ToString() **
+  * //N/A//
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#ToString.28.29//
+== Return Value ==
+  * Type:String
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
+  * //N/A//
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Equals.28Object.29//
+== Return Value ==
+  * Type:Boolean
+  * Description:N/A
+== Parameters ==
+  * //obj//
+    * Type:Object
+    * Description:N/A
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
+  * //N/A//
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#GetHashCode.28.29//
+== Return Value ==
+  * Type:Int32
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} GetType() **
+  * //N/A//
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#GetType.28.29//
+== Return Value ==
+  * Type:Type
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+==== Protected Methods ====
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
+  * //N/A//
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Finalize.28.29//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
+  * //N/A//
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#MemberwiseClone.28.29//
+== Return Value ==
+  * Type:Object
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+==== Public Properties ====
+** {{wiki:PublicProperty.gif|}} ContentHtml **
-<!-- ThinkGeo.MapSuite.WebEdition.Popup -->
-[[#Public Properties|Go Back]]
-==== ContentHtml ====
 Gets or sets the content HTML of the popup window.
-=== Remarks ===
+== Remarks ==
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#ContentHtml" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#ContentHtml</a>
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#ContentHtml
-=== Return Value ===
+== Return Value ==
-^ Return Type ^
+  * Type:String
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.CloudPopup -->
+** {{wiki:PublicProperty.gif|}} Id **
-[[#Public Properties|Go Back]]
-==== HasCloseButton ====
+Gets the identifier by which you can find the popup.
-Gets or sets a value that indicates whether the popup window has a close button in the upper right corner.
+== Remarks ==
-=== Remarks ===
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Id
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#HasCloseButton" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#HasCloseButton</a>
+== Return Value ==
-=== Return Value ===
+  * Type:String
-^ Return Type ^
-| Boolean<!-- System.Boolean -->   |
+** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Position
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]]
+** {{wiki:PublicProperty.gif|}} Width **
+Gets or sets the width of the popup.
+== Remarks ==
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Width
+== Return Value ==
+  * Type:Int32
+** {{wiki:PublicProperty.gif|}} Height **
-<!-- ThinkGeo.MapSuite.WebEdition.Popup -->
-[[#Public Properties|Go Back]]
-==== Height ====
 Gets or sets the height of the popup.
-=== Remarks ===
+== Remarks ==
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Height" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Height</a>
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Height
-=== Return Value ===
+== Return Value ==
-^ Return Type ^
+  * Type:Int32
-| Int32<!-- System.Int32 -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Popup -->
+** {{wiki:PublicProperty.gif|}} IsVisible **
-[[#Public Properties|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.CloudPopup#Id" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Id</a>
-=== Return Value ===
-^ Return Type ^
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Popup -->
-[[#Public Properties|Go Back]]
-==== IsVisible ====
 Gets or sets a value that indicates whether the popup is visible on the map.
-=== Remarks ===
+== Remarks ==
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#IsVisible" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#IsVisible</a>
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#IsVisible
-=== Return Value ===
+== Return Value ==
-^ Return Type ^
+  * Type:Boolean
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Popup -->
+** {{wiki:PublicProperty.gif|}} Opacity **
-[[#Public Properties|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.CloudPopup#OffsetXInPixels" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#OffsetXInPixels</a>
-=== Return Value ===
-^ Return Type ^
-| Int32<!-- System.Int32 -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Popup -->
-[[#Public Properties|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.CloudPopup#OffsetYInPixels" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#OffsetYInPixels</a>
-=== Return Value ===
-^ Return Type ^
-| Int32<!-- System.Int32 -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Popup -->
-[[#Public Properties|Go Back]]
-==== Opacity ====
 Gets or sets the opacity level of the popup.
-=== Remarks ===
+== Remarks ==
-The &lt;strong&gt;Opacity&lt;/strong&gt; 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.
+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 Value ==
-^ Return Type ^
+  * Type:Single
-| Single<!-- System.Single -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Popup -->
+** {{wiki:PublicProperty.gif|}} AutoSize **
-[[#Public Properties|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.CloudPopup#Position" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Position</a>
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Popup -->
+Gets or sets a value that indicates whether the popup is automatically resized to fit its contents.
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== Width ====
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#AutoSize
-Gets or sets the width of the popup.
+== Return Value ==
-=== Remarks ===
+  * Type:Boolean
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Width" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#Width</a>
-=== Return Value ===
+** {{wiki:PublicProperty.gif|}} AutoPan **
-^ Return Type ^
-| Int32<!-- System.Int32 -->   |
+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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#AutoPan
+== 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 ==
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#HasCloseButton
+== Return Value ==
+  * Type:Boolean
+** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#OffsetXInPixels
+== Return Value ==
+  * Type:Int32
+** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#OffsetYInPixels
+== Return Value ==
+  * Type:Int32
+==== Protected Properties ====
+** {{wiki:ProtectedProperty.gif|}} PopupType **
-<!-- ThinkGeo.MapSuite.WebEdition.Popup -->
-[[#Public Properties|Go Back]]
-===== Protected Properties =====
-==== PopupType ====
 Gets a string that represents the type of the Popup object.
-=== Remarks ===
+== Remarks ==
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#PopupType" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#PopupType</a>
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.CloudPopup#PopupType
-=== Return Value ===
+== Return Value ==
-^ Return Type ^
+  * Type:String
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.WebEdition.Popup(overriden) -->
+==== Public Events ====
-[[#Protected Properties|Go Back]]
-===== Public Events =====
-__NOTOC__
-[[Category:WebEdition]]
-[[Category:ThinkGeo.MapSuite.WebEdition]]
-[[Category:UpdateDocumentation]]

User Tools

Site Tools

Differences

Page Tools