thinkgeo.mapsuite.mvcedition.popup
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mvcedition.popup [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.MvcEdition.Popup ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | Serves as the base class that defines the methods and properties common to all types of popups. | ||
| - | === Remarks === | ||
| - | A <strong>Popup</strong> is a special type of window overlaid on the map, which is typically used for dialog boxes, message boxes and other temporary windows. | ||
| - | |||
| - | The <strong>Position</strong> property determines where the popup is. The <strong>Width</strong> and <strong>Height</strong> properties determine the popup's size. | ||
| - | |||
| - | Set the <strong>Opacity</strong> property to a value between 0 and 1 to make the popup transparent. The smaller the value is, the more transparent the popup is. The <strong>Opacity</strong> is 1 (fully opaque) by default. | ||
| - | |||
| - | Set the <strong>AutoSize</strong> to true to make the popup adjust its size automatically to fit its content. | ||
| - | |||
| - | Set the <strong>AutoPan</strong> to true to always show the entire popup by automatically panning the map if the popup is only partially displayed. | ||
| - | |||
| - | The <strong>HasCloseButton</strong> property indicates whether the popup has a close button in the upper right corner. | ||
| - | |||
| - | The <strong>OffsetXInPixels</strong> and <strong>OffsetYInPixels</strong> properties determine the offset from its origin at which the popup will be displayed. Use these properties to move the popup if it is obscuring something beneath it. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.MvcEdition.Popup]] | ||
| - | ***[[ThinkGeo.MapSuite.MvcEdition.CloudPopup]] | ||
| - | ***[[ThinkGeo.MapSuite.MvcEdition.CustomPopup]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{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. | | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{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}}[[#FromJson(String)|FromJson]] | String | | | | ||
| - | | {{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 ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{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. | | ||
| - | | {{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 ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#PopupType|PopupType]] | String | | Gets a string that represents the type of the Popup object. | | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ===== Protected Constructors ===== | ||
| - | ==== Popup() ==== | ||
| - | Initialize an instance of the Popup class. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the Popup class. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Protected Constructors|Go Back]] | ||
| - | ==== Popup(String) ==== | ||
| - | Initialize an instance of the Popup class with the identifier specified. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the Popup class. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | id | String<!-- System.String --> | The identifier by which you can find the popup. | | ||
| - | |||
| - | [[#Protected Constructors|Go Back]] | ||
| - | ==== Popup(String, PointShape) ==== | ||
| - | Initialize an instance of the Popup class with the identifier and position specified. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the Popup class. | ||
| - | === 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]] | ||
| - | ==== Popup(String, PointShape, Int32, Int32) ==== | ||
| - | Initialize an instance of the Popup class with the identifier, position, width and height specified. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the Popup class. | ||
| - | === 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]] | ||
| - | ==== Popup(String, PointShape, Int32, Int32, Boolean) ==== | ||
| - | Initialize an instance of the CloundPopup class with an Id string, position, popup content, popup size and a boolean value that determines whether to pan the map if necessary to show the full popup. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the Popup class. | ||
| - | === 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]] | ||
| - | ==== Popup(String, PointShape, Int32, Int32, Boolean, Boolean) ==== | ||
| - | Initialize an instance of the CloundPopup class with an Id string, position, popup's content, popup size, a boolean value for whether to pan the map to show the popup, and a boolean value for whether to have a close button on the popup. | ||
| - | === Overloads === | ||
| - | Initialize an instance of the Popup class. | ||
| - | === 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]] | ||
| - | ===== Public Methods ===== | ||
| - | ==== CloneShallow() ==== | ||
| - | Creates a shallow copy of the current popup object. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.MvcEdition.Popup|Popup]]<!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Equals(Object) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== FromJson(String) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | jsonString | String<!-- System.String --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToJson() ==== | ||
| - | Returns a JSON string which contains the popup's information and is used to create the popup at the client side. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | A string that is used to create the popup at the client side. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== AutoSize ==== | ||
| - | Gets or sets a value that indicates whether the popup is automatically resized to fit its contents. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== HasCloseButton ==== | ||
| - | Gets or sets a value that indicates whether the popup window has a close button in the upper right corner. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Height ==== | ||
| - | Gets or sets the height of the popup. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Id ==== | ||
| - | Gets the identifier by which you can find the popup. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsVisible ==== | ||
| - | Gets or sets a value that indicates whether the popup is visible on the map. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== OffsetXInPixels ==== | ||
| - | Gets or sets the popup's pixel offset in X direction. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== OffsetYInPixels ==== | ||
| - | Gets or sets the popup's pixel offset in Y direction. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Opacity ==== | ||
| - | Gets or sets the opacity level of the popup. | ||
| - | === Remarks === | ||
| - | The <strong>Opacity</strong> property enables you to specify a level of transparency for the popup. When this property is set to a value less than 100 percent (1.00), the entire popup (including its content) is made more transparent. The lower the value, the more transparent it is. Setting this property to a value of 0 percent (0.00) makes the popup completely invisible. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Position ==== | ||
| - | Gets or sets a point shape in world coordinates that represents the position of the popup. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.PointShape|PointShape]]<!-- ThinkGeo.MapSuite.Core.PointShape --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Width ==== | ||
| - | Gets or sets the width of the popup. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ==== PopupType ==== | ||
| - | Gets a string that represents the type of the Popup object. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.Popup --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MvcEdition]] | ||
| - | [[Category:ThinkGeo.MapSuite.MvcEdition]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.mvcedition.popup.1440040131.txt.gz ยท Last modified: 2015/09/21 03:35 (external edit)
