This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.webedition.popup [2015/09/18 03:09] admin |
thinkgeo.mapsuite.webedition.popup [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.WebEdition.Popup ====== | ====== ThinkGeo.MapSuite.WebEdition.Popup ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| Serves as the base class that defines the methods and properties common to all types of popups. | Serves as the base class that defines the methods and properties common to all types of popups. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 11: | Line 14: | ||
| ** {{wiki:ProtectedMethod.gif|}} Popup() ** | ** {{wiki:ProtectedMethod.gif|}} Popup() ** | ||
| - | Initialize an instance of the Popup class. | + | * //Initialize an instance of the Popup class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28.29// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:ProtectedMethod.gif|}} Popup(String) ** | ** {{wiki:ProtectedMethod.gif|}} Popup(String) ** | ||
| - | Initialize an instance of the Popup class with the identifier specified. | + | * //Initialize an instance of the Popup class with the identifier specified.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.29// |
| == Parameters == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 29: | Line 32: | ||
| ** {{wiki:ProtectedMethod.gif|}} Popup(String,PointShape) ** | ** {{wiki:ProtectedMethod.gif|}} Popup(String,PointShape) ** | ||
| - | Initialize an instance of the Popup class with the identifier and position specified. | + | * //Initialize an instance of the Popup class with the identifier and position specified.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.2C_PointShape.29// |
| == Parameters == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 44: | Line 47: | ||
| ** {{wiki:ProtectedMethod.gif|}} Popup(String,PointShape,Int32,Int32) ** | ** {{wiki:ProtectedMethod.gif|}} Popup(String,PointShape,Int32,Int32) ** | ||
| - | Initialize an instance of the Popup class with the identifier, position, width and height specified. | + | * //Initialize an instance of the Popup class with the identifier, position, width and height specified.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.2C_PointShape.2C_Int32.2C_Int32.29// |
| == Parameters == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 67: | Line 70: | ||
| ** {{wiki:ProtectedMethod.gif|}} Popup(String,PointShape,Int32,Int32,Boolean) ** | ** {{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. | + | * //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 == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.2C_PointShape.2C_Int32.2C_Int32.2C_Boolean.29// |
| == Parameters == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 94: | Line 97: | ||
| ** {{wiki:ProtectedMethod.gif|}} Popup(String,PointShape,Int32,Int32,Boolean,Boolean) ** | ** {{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. | + | * //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 == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Popup.28String.2C_PointShape.2C_Int32.2C_Int32.2C_Boolean.2C_Boolean.29// |
| == Parameters == | == Parameters == | ||
| * //id// | * //id// | ||
| Line 126: | Line 129: | ||
| ** {{wiki:PublicMethod.gif|}} CloneShallow() ** | ** {{wiki:PublicMethod.gif|}} CloneShallow() ** | ||
| - | Creates a shallow copy of the current popup object. | + | * //Creates a shallow copy of the current popup object.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#CloneShallow.28.29// |
| == Return Value == | == Return Value == | ||
| Line 138: | Line 141: | ||
| ** {{wiki:PublicMethod.gif|}} ToJson() ** | ** {{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. | + | * //Returns a JSON string which contains the popup's information and is used to create the popup at the client side.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#ToJson.28.29// |
| == Return Value == | == Return Value == | ||
| Line 150: | Line 153: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#ToString.28.29// |
| == Return Value == | == Return Value == | ||
| Line 162: | Line 165: | ||
| ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Equals.28Object.29// |
| == Return Value == | == Return Value == | ||
| Line 178: | Line 181: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#GetHashCode.28.29// |
| == Return Value == | == Return Value == | ||
| Line 190: | Line 193: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#GetType.28.29// |
| == Return Value == | == Return Value == | ||
| Line 203: | Line 206: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Finalize.28.29// |
| == Return Value == | == Return Value == | ||
| Line 215: | Line 218: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#MemberwiseClone.28.29// |
| == Return Value == | == Return Value == | ||
| Line 230: | Line 233: | ||
| Gets the identifier by which you can find the popup. | Gets the identifier by which you can find the popup. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Id |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 238: | Line 241: | ||
| Gets or sets a point shape in world coordinates that represents the position of the popup. | Gets or sets a point shape in world coordinates that represents the position of the popup. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Position |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | ||
| Line 246: | Line 249: | ||
| Gets or sets the width of the popup. | Gets or sets the width of the popup. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Width |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
| Line 254: | Line 257: | ||
| Gets or sets the height of the popup. | Gets or sets the height of the popup. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Height |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
| Line 262: | Line 265: | ||
| Gets or sets a value that indicates whether the popup is visible on the map. | Gets or sets a value that indicates whether the popup is visible on the map. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#IsVisible |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 270: | Line 273: | ||
| Gets or sets the opacity level of the popup. | Gets or sets the opacity level of the popup. | ||
| == Remarks == | == 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. | + | 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 == | ||
| * Type:Single | * Type:Single | ||
| Line 278: | Line 281: | ||
| Gets or sets a value that indicates whether the popup is automatically resized to fit its contents. | Gets or sets a value that indicates whether the popup is automatically resized to fit its contents. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#AutoSize |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 286: | Line 289: | ||
| Gets or sets a value that indicates whether to pan the map to display the entire popup if the popup is not fully displayed. | 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 == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#AutoPan |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 294: | Line 297: | ||
| Gets or sets a value that indicates whether the popup window has a close button in the upper right corner. | Gets or sets a value that indicates whether the popup window has a close button in the upper right corner. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#HasCloseButton |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 302: | Line 305: | ||
| Gets or sets the popup's pixel offset in X direction. | Gets or sets the popup's pixel offset in X direction. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#OffsetXInPixels |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
| Line 310: | Line 313: | ||
| Gets or sets the popup's pixel offset in Y direction. | Gets or sets the popup's pixel offset in Y direction. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#OffsetYInPixels |
| == Return Value == | == Return Value == | ||
| * Type:Int32 | * Type:Int32 | ||
| Line 319: | Line 322: | ||
| Gets a string that represents the type of the Popup object. | Gets a string that represents the type of the Popup object. | ||
| == Remarks == | == Remarks == | ||
| - | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#PopupType |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||