ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.mvcedition.custompopup
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.MvcEdition.CustomPopup
<!– Class –> Represents a pop up window whose style and background can be customized.
Remarks
The <strong>CustomPopup</strong> class provides you an easy way to create your customized popup. You can easily change the popup's color and border by specifying the <strong>BackgroundColor</strong>, <strong>BorderColor</strong> and <strong>BorderWidth</strong> properties. Or you can totally change the popup's appearance by putting a background image behind. With the <strong>BackgroundImageVirtualPath</strong> property, you can customize the popup in any shape you like.
Inheritance Hierarchy
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 CustomPopup | Initialize an instance of the CustomPopup class. | ||
| CustomPopup | String | Initialize an instance of the CustomPopup class. | |
| CustomPopup | String, PointShape | Initialize an instance of the CustomPopup class. | |
| CustomPopup | String, PointShape, String | Initialize an instance of the CustomPopup class. | |
| CustomPopup | String, PointShape, String, Int32, Int32 | Initialize an instance of the CustomPopup class. | |
| CustomPopup | String, PointShape, String, Int32, Int32, Boolean | Initialize an instance of the CustomPopup class. | |
| CustomPopup | String, PointShape, String, Int32, Int32, Boolean, Boolean | Initialize an instance of the CustomPopup class. | |
| CustomPopup | String, PointShape, String, Int32, Int32, Boolean, Boolean, Int32 | Initialize an instance of the CustomPopup class. |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| CloneShallow | Popup | Creates a shallow copy of the current popup object. | |
| Equals | Object | Object | |
| FromJson | String | Popup | |
| GetHashCode | Object | ||
| GetType | Object | ||
| ToJson | Popup | Returns a JSON string which contains the popup's information and is used to create the popup at the client side. | |
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Finalize | Object | ||
| MemberwiseClone | Object |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 AutoPan | Boolean | 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. |
| AutoSize | Boolean | Popup | Gets or sets a value that indicates whether the popup is automatically resized to fit its contents. |
| BackgroundColor | GeoColor | Gets or sets the color applied to the background of the popup object. | |
| BackgroundImageVirtualPath | String | Gets or sets the virtual path of the background image. You can set any image as the popup's background. | |
| BorderColor | GeoColor | Gets or sets the color applied to the border of the popup object. | |
| BorderWidth | Int32 | Gets or sets the width of the popup's border. | |
| ContentHtml | String | Gets or sets the content HTML of the popup window. | |
| HasCloseButton | Boolean | Popup | Gets or sets a value that indicates whether the popup window has a close button in the upper right corner. |
| Height | Int32 | Popup | Gets or sets the height of the popup. |
| Id | String | Popup | Gets the identifier by which you can find the popup. |
| IsVisible | Boolean | Popup | Gets or sets a value that indicates whether the popup is visible on the map. |
| OffsetXInPixels | Int32 | Popup | Gets or sets the popup's pixel offset in X direction. |
| OffsetYInPixels | Int32 | Popup | Gets or sets the popup's pixel offset in Y direction. |
| Opacity | Single | Popup | Gets or sets the opacity level of the popup. |
| Position | PointShape | Popup | Gets or sets a point shape in world coordinates that represents the position of the popup. |
| Width | Int32 | Popup | Gets or sets the width of the popup. |
Protected Properties
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|
Public Constructors
CustomPopup()
Initialize an instance of the CustomPopup class.
Overloads
Initialize an instance of the CustomPopup class.
Parameters
| Name | Type | Description |
|---|
CustomPopup(String)
Initialize an instance of the CustomPopup class.
Overloads
Initialize an instance of the CustomPopup class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> |
CustomPopup(String, PointShape)
Initialize an instance of the CustomPopup class.
Overloads
Initialize an instance of the CustomPopup class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | |
| position | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> |
CustomPopup(String, PointShape, String)
Initialize an instance of the CustomPopup class.
Overloads
Initialize an instance of the CustomPopup class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | |
| position | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| contentHtml | String<!– System.String –> |
CustomPopup(String, PointShape, String, Int32, Int32)
Initialize an instance of the CustomPopup class.
Overloads
Initialize an instance of the CustomPopup class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | |
| position | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| contentHtml | String<!– System.String –> | |
| width | Int32<!– System.Int32 –> | |
| height | Int32<!– System.Int32 –> |
CustomPopup(String, PointShape, String, Int32, Int32, Boolean)
Initialize an instance of the CustomPopup class.
Overloads
Initialize an instance of the CustomPopup class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | |
| position | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| contentHtml | String<!– System.String –> | |
| width | Int32<!– System.Int32 –> | |
| height | Int32<!– System.Int32 –> | |
| autoPan | Boolean<!– System.Boolean –> |
CustomPopup(String, PointShape, String, Int32, Int32, Boolean, Boolean)
Initialize an instance of the CustomPopup class.
Overloads
Initialize an instance of the CustomPopup class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | |
| position | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| contentHtml | String<!– System.String –> | |
| width | Int32<!– System.Int32 –> | |
| height | Int32<!– System.Int32 –> | |
| autoPan | Boolean<!– System.Boolean –> | |
| hasCloseButton | Boolean<!– System.Boolean –> |
CustomPopup(String, PointShape, String, Int32, Int32, Boolean, Boolean, Int32)
Initialize an instance of the CustomPopup class.
Overloads
Initialize an instance of the CustomPopup class.
Parameters
| Name | Type | Description |
|---|---|---|
| id | String<!– System.String –> | |
| position | PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> | |
| contentHtml | String<!– System.String –> | |
| width | Int32<!– System.Int32 –> | |
| height | Int32<!– System.Int32 –> | |
| autoPan | Boolean<!– System.Boolean –> | |
| hasCloseButton | Boolean<!– System.Boolean –> | |
| borderWidth | Int32<!– System.Int32 –> |
Protected Constructors
Public Methods
CloneShallow()
Creates a shallow copy of the current popup object.
Return Value
| Return Type | Description |
|---|---|
| Popup<!– ThinkGeo.MapSuite.MvcEdition.Popup –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.MvcEdition.Popup –> Go Back
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
FromJson(String)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| jsonString | String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Popup –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetType()
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
ToJson()
Returns a JSON string which contains the popup's information and is used to create the popup at the client side.
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 –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Public Properties
AutoPan
Gets or sets a value that indicates whether to pan the map to display the entire popup if the popup is not fully displayed.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.MvcEdition.Popup –> 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 –> Go Back
BackgroundColor
Gets or sets the color applied to the background of the popup object.
Return Value
| Return Type |
|---|
| GeoColor<!– ThinkGeo.MapSuite.Core.GeoColor –> |
<!– ThinkGeo.MapSuite.MvcEdition.CustomPopup –> Go Back
BackgroundImageVirtualPath
Gets or sets the virtual path of the background image. You can set any image as the popup's background.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.CustomPopup –> Go Back
BorderColor
Gets or sets the color applied to the border of the popup object.
Return Value
| Return Type |
|---|
| GeoColor<!– ThinkGeo.MapSuite.Core.GeoColor –> |
<!– ThinkGeo.MapSuite.MvcEdition.CustomPopup –> Go Back
BorderWidth
Gets or sets the width of the popup's border.
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.MvcEdition.CustomPopup –> Go Back
ContentHtml
Gets or sets the content HTML of the popup window.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.CustomPopup –> 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 –> Go Back
Height
Gets or sets the height of the popup.
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.MvcEdition.Popup –> Go Back
Id
Gets the identifier by which you can find the popup.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.MvcEdition.Popup –> 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 –> 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 –> 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 –> 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 –> Go Back
Position
Gets or sets a point shape in world coordinates that represents the position of the popup.
Return Value
| Return Type |
|---|
| PointShape<!– ThinkGeo.MapSuite.Core.PointShape –> |
<!– ThinkGeo.MapSuite.MvcEdition.Popup –> Go Back
Width
Gets or sets the width of the popup.
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.MvcEdition.Popup –> 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(overriden) –> Go Back
Public Events
thinkgeo.mapsuite.mvcedition.custompopup.1440040131.txt.gz · Last modified: 2015/09/21 03:32 (external edit)