This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.webedition.popup [2015/08/20 03:08] 127.0.0.1 external edit |
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}} | ||
| - | |||
| - | <!-- Class --> | ||
| 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. | ||
| - | === 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 ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.WebEdition.Popup]] | + | ***ThinkGeo.MapSuite.WebEdition.Popup** |
| - | ***[[ThinkGeo.MapSuite.WebEdition.CloudPopup]] | + | *[[ThinkGeo.MapSuite.WebEdition.CloudPopup]] |
| - | ***[[ThinkGeo.MapSuite.WebEdition.CustomPopup]] | + | *[[ThinkGeo.MapSuite.WebEdition.CustomPopup]] |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| ==== Protected Constructors ==== | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:ProtectedMethod.gif|}} Popup() ** |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Popup()|Popup]] | | | Initialize an instance of the Popup class. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Popup(String)|Popup]] | String | | Initialize an instance of the Popup class with the identifier specified. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Popup(String, PointShape)|Popup]] | String, [[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | | Initialize an instance of the Popup class with the identifier and position specified. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Popup(String, PointShape, Int32, Int32)|Popup]] | String, [[ThinkGeo.MapSuite.Core.PointShape|PointShape]], Int32, Int32 | | Initialize an instance of the Popup class with the identifier, position, width and height specified. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Popup(String, PointShape, Int32, Int32, Boolean)|Popup]] | String, [[ThinkGeo.MapSuite.Core.PointShape|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. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Popup(String, PointShape, Int32, Int32, Boolean, Boolean)|Popup]] | String, [[ThinkGeo.MapSuite.Core.PointShape|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 Popup class.// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Popup(String) ** | ||
| + | |||
| + | * //Initialize an instance of the Popup class with the identifier specified.// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * //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 == | ||
| + | * //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 == | ||
| + | * //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 == | ||
| + | * //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 == | ||
| + | * //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 == | ||
| + | * //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 == | ||
| + | * //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 == | ||
| + | * //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 == | ||
| + | * //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 ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} CloneShallow() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#CloneShallow()|CloneShallow]] | | | Creates a shallow copy of the current popup object. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToJson()|ToJson]] | | | Returns a JSON string which contains the popup's information and is used to create the popup at the client side. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| - | ==== Protected Methods ==== | + | * //Creates a shallow copy of the current popup object.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#CloneShallow.28.29// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | ==== Public Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:[[ThinkGeo.MapSuite.WebEdition.Popup|Popup]] |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#AutoPan|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. | | + | * Description:N/A |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#AutoSize|AutoSize]] | Boolean | | Gets or sets a value that indicates whether the popup is automatically resized to fit its contents. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#HasCloseButton|HasCloseButton]] | Boolean | | Gets or sets a value that indicates whether the popup window has a close button in the upper right corner. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Height|Height]] | Int32 | | Gets or sets the height of the popup. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Id|Id]] | String | | Gets the identifier by which you can find the popup. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]] | Boolean | | Gets or sets a value that indicates whether the popup is visible on the map. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#OffsetXInPixels|OffsetXInPixels]] | Int32 | | Gets or sets the popup's pixel offset in X direction. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#OffsetYInPixels|OffsetYInPixels]] | Int32 | | Gets or sets the popup's pixel offset in Y direction. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Opacity|Opacity]] | Single | | Gets or sets the opacity level of the popup. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Position|Position]] | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]] | | Gets or sets a point shape in world coordinates that represents the position of the popup. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Width|Width]] | Int32 | | Gets or sets the width of the popup. | | + | |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#PopupType|PopupType]] | String | | Gets a string that represents the type of the Popup object. | | + | ** {{wiki:PublicMethod.gif|}} ToJson() ** |
| - | ==== Public Events ==== | + | * //Returns a JSON string which contains the popup's information and is used to create the popup at the client side.// |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#ToJson.28.29// | ||
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ===== Protected Constructors ===== | + | * Type:String |
| - | ==== Popup() ==== | + | * Description:A string that is used to create the popup at the client side. |
| - | 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 ^ | + | |
| - | [[#Protected Constructors|Go Back]] | + | == Parameters == |
| - | ==== Popup(String) ==== | + | <div newline></div> |
| - | Initialize an instance of the Popup class with the identifier specified. | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | === 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. | | + | |
| - | [[#Protected Constructors|Go Back]] | + | * //N/A// |
| - | ==== Popup(String, PointShape) ==== | + | == Remarks == |
| - | Initialize an instance of the Popup class with the identifier and position specified. | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#ToString.28.29// |
| - | === 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 | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | A point shape in world coordinates that indicates the position of the popup. | | + | |
| - | [[#Protected Constructors|Go Back]] | + | == Return Value == |
| - | ==== Popup(String, PointShape, Int32, Int32) ==== | + | * Type:String |
| - | Initialize an instance of the Popup class with the identifier, position, width and height specified. | + | * Description:N/A |
| - | === 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 | [[ThinkGeo.MapSuite.Core.PointShape|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. | | + | |
| - | [[#Protected Constructors|Go Back]] | + | == Parameters == |
| - | ==== Popup(String, PointShape, Int32, Int32, Boolean) ==== | + | <div newline></div> |
| - | 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. | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | === 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 | [[ThinkGeo.MapSuite.Core.PointShape|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. | | + | |
| - | [[#Protected Constructors|Go Back]] | + | * //N/A// |
| - | ==== Popup(String, PointShape, Int32, Int32, Boolean, Boolean) ==== | + | == Remarks == |
| - | 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. | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Equals.28Object.29// |
| - | === 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 | [[ThinkGeo.MapSuite.Core.PointShape|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. | | + | |
| - | [[#Protected Constructors|Go Back]] | + | == Return Value == |
| - | ===== Public Methods ===== | + | * Type:Boolean |
| - | ==== CloneShallow() ==== | + | * Description:N/A |
| - | 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 ^ | + | |
| - | | [[ThinkGeo.MapSuite.WebEdition.Popup|Popup]]<!-- ThinkGeo.MapSuite.WebEdition.Popup --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //obj// |
| + | * Type:Object | ||
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Popup --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | ==== 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 === | + | * //N/A// |
| - | ^ 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.Popup#GetHashCode.28.29// |
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== GetHashCode() ==== | + | * Description:N/A |
| - | === 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 === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetType() ==== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#GetType.28.29// |
| - | === 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 === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Type |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== ToJson() ==== | + | ==== Protected Methods ==== |
| - | Returns a JSON string which contains the popup's information and is used to create the popup at the client side. | + | ** {{wiki:ProtectedMethod.gif|}} 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#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 === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Finalize.28.29// | ||
| - | <!-- ThinkGeo.MapSuite.WebEdition.Popup --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== ToString() ==== | + | * Description:N/A |
| - | === 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 === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ===== Protected Methods ===== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#MemberwiseClone.28.29// |
| - | ==== 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 === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Object |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | ==== MemberwiseClone() ==== | + | ==== Public Properties ==== |
| - | === Remarks === | + | ** {{wiki:PublicProperty.gif|}} Id ** |
| - | 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 === | + | Gets the identifier by which you can find the popup. |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Id | ||
| + | == Return Value == | ||
| + | * Type:String | ||
| - | <!-- System.Object --> | + | ** {{wiki:PublicProperty.gif|}} Position ** |
| - | [[#Protected Methods|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 --> | + | Gets or sets a point shape in world coordinates that represents the position of the popup. |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== AutoSize ==== | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Position |
| - | Gets or sets a value that indicates whether the popup is automatically resized to fit its contents. | + | == Return Value == |
| - | === Remarks === | + | * Type:[[ThinkGeo.MapSuite.Core.PointShape|PointShape]] |
| - | 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 --> | + | ** {{wiki:PublicProperty.gif|}} Width ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== HasCloseButton ==== | + | Gets or sets the width of 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.Popup#Width |
| - | 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 Value === | + | * Type:Int32 |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | ** {{wiki:PublicProperty.gif|}} Height ** |
| - | <!-- ThinkGeo.MapSuite.WebEdition.Popup --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Height ==== | ||
| Gets or sets the height of the popup. | 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.Popup#Height" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#Height</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 == |
| - | ^ 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.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 --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsVisible ==== | ||
| 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 == |
| - | 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> | + | 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 == |
| - | ^ 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.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 --> | + | |
| - | [[#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.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 --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Opacity ==== | ||
| Gets or sets the opacity level of the popup. | Gets or sets the opacity level of the popup. | ||
| - | === Remarks === | + | == 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. | + | 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.Popup#Position" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#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.Popup#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.Popup#Width" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#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.Popup#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.Popup#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.Popup#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.Popup#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. | 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.Popup#PopupType" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.Popup#PopupType</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 == |
| - | ^ Return Type ^ | + | * Type:String |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.Popup --> | + | ==== Public Events ==== |
| - | [[#Protected Properties|Go Back]] | + | |
| - | ===== Public Events ===== | + | |
| - | __NOTOC__ | + | |
| - | [[Category:WebEdition]] | + | |
| - | [[Category:ThinkGeo.MapSuite.WebEdition]] | + | |
| - | [[Category:UpdateDocumentation]] | + | |