====== ThinkGeo.MapSuite.MvcEdition.MapBuilder ====== {{section>upgrade_map_suite_to_10.0}} Defines the fluent interface for configuring the Map control. ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.MapSuite.MvcEdition.MvcControlBuilderBase`2[[ThinkGeo.MapSuite.MvcEdition.Map, MvcEdition, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null],[ThinkGeo.MapSuite.MvcEdition.MapBuilder, MvcEdition, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]] ***ThinkGeo.MapSuite.MvcEdition.MapBuilder** ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} MapBuilder(Map) ** * //Initializes a new instance of the MapBuilder.// == Remarks == * //N/A// == Parameters == * //map// * Type:[[ThinkGeo.MapSuite.MvcEdition.Map|Map]] * Description:The map control instance.
** {{wiki:PublicMethod.gif|}} MapBuilder(Map,ViewContext) ** * //Initializes a new instance of the MapBuilder.// == Remarks == * //N/A// == Parameters == * //map// * Type:[[ThinkGeo.MapSuite.MvcEdition.Map|Map]] * Description:The map control instance. * //viewContext// * Type:ViewContext * Description:The ViewContext of the page.
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} ZoomLevelSet(ZoomLevelSet) ** * //Sets the ZoomLevelSet applied to the map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //zoomLevelSet// * Type:[[ThinkGeo.MapSuite.Core.ZoomLevelSet|ZoomLevelSet]] * Description:ZoomLevels that will be applied to map.
** {{wiki:PublicMethod.gif|}} MapBackground(BackgroundLayer) ** * //Sets the BackgroundLayer object that paints the map background.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //backgroundLayer// * Type:[[ThinkGeo.MapSuite.Core.BackgroundLayer|BackgroundLayer]] * Description:BackgroundLayer of the map.
** {{wiki:PublicMethod.gif|}} ContextMenu(Action) ** * //Sets the ContextMenu of the map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //addContextMenuAction// * Type:Action<[[ThinkGeo.MapSuite.MvcEdition.ContextMenuSetting|ContextMenuSetting]]> * Description:The action.
** {{wiki:PublicMethod.gif|}} CurrentExtent(Double,Double,Double,Double) ** * //Sets the current extent of the map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //minX// * Type:Double * Description:This property specifies the minimum X value. This is also the upper left X. * //maxY// * Type:Double * Description:This property specifies the maximum Y value. This is also the upper left Y. * //maxX// * Type:Double * Description:This property specifies the maximum X value. This is also the lower right X. * //minY// * Type:Double * Description:This property specifies the minimum Y value. This is also the lower right Y.
** {{wiki:PublicMethod.gif|}} Cursor(CursorType) ** * //Sets the cursor that appears when the mouse pointer is over the map control.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //cursorType// * Type:[[ThinkGeo.MapSuite.MvcEdition.CursorType|CursorType]] * Description:The type of the cursor that appears when the pointer moves over the map.
** {{wiki:PublicMethod.gif|}} WebConfigRegisterMode(WebConfigRegistrationMode) ** * //Sets a value that indicates whether the application allows map to register the Web.config on the fly in runtime. The default value is "WebConfigRegisterMode.AutoRegistered", otherwise, you need to copy the code below to the web.config manually.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //webConfigRegisterMode// * Type:[[ThinkGeo.MapSuite.MvcEdition.WebConfigRegistrationMode|WebConfigRegistrationMode]] * Description:The register mode that indicates whether the application allows map to register the Web.config on the fly in runtime.
** {{wiki:PublicMethod.gif|}} ResourceDeploymentMode(ResourceDeploymentMode) ** * //sets a value that indicates whether the application allows map to copy its resource images under "~/theme/default/img/". The default value is "ResourceDeploymentMode.Automatically", otherwise, you need to copy images to the directory.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //resourceDeploymentMode// * Type:[[ThinkGeo.MapSuite.MvcEdition.ResourceDeploymentMode|ResourceDeploymentMode]] * Description:The depolymentMode indicates whether the control creates and releases the theme files to application folder automatically.
** {{wiki:PublicMethod.gif|}} IsDefaultJavascriptLibraryDisabled(Boolean) ** * //Gets or sets whether the default javascript library is disabled or not.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //disabled// * Type:Boolean * Description:N/A
** {{wiki:PublicMethod.gif|}} MapUnit(GeographyUnit) ** * //Sets the GeographyUnit of the map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //mapUnit// * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] * Description:GeographyUnit of the map.
** {{wiki:PublicMethod.gif|}} ActiveBaseOverlay(Overlay) ** * //Sets the active base Overlay.// == Remarks == * //The map can contain multiple base Overlays, though only one of them can be displayed at a time. The ActiveBaseOverlay property specifies the one that is currently displayed. When you switch the base Overlays in the OverSwitcher, the currently selected overlay will be synchronized to this property after postback.// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //overlay// * Type:[[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] * Description:The overlay selected from the overlay's collection.
** {{wiki:PublicMethod.gif|}} BackgroundOverlay(Overlay) ** * //Sets an Overlay object that displays as the background map by default.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //overlay// * Type:[[ThinkGeo.MapSuite.MvcEdition.Overlay|Overlay]] * Description:A LayerOverlay object that displays as the background map by default.
** {{wiki:PublicMethod.gif|}} StaticOverlay(Action) ** * //Configures a LayerOverlay object that displays as a background map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //configOverlayAction// * Type:Action<[[ThinkGeo.MapSuite.MvcEdition.LayerOverlaySetting|LayerOverlaySetting]]> * Description:Overlay configuration action.
** {{wiki:PublicMethod.gif|}} DynamicOverlay(Action) ** * //Configures a LayerOverlay object that can overlap other overlays.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //configOverlayAction// * Type:Action<[[ThinkGeo.MapSuite.MvcEdition.LayerOverlaySetting|LayerOverlaySetting]]> * Description:Overlay configuration action.
** {{wiki:PublicMethod.gif|}} MarkerOverlay(Action) ** * //Configures an InMemoryMarkerOverlay object that renders markers by the specified features.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //configMarkerOverlayAction// * Type:Action<[[ThinkGeo.MapSuite.MvcEdition.InMemoryMarkerOverlaySetting|InMemoryMarkerOverlaySetting]]> * Description:The InMemoryMarkerOverlay configuration action.
** {{wiki:PublicMethod.gif|}} EditOverlay(Action) ** * //Configures an EditOverlay object, with which you can draw and edit shapes on client side.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //configEditOverlayAction// * Type:Action<[[ThinkGeo.MapSuite.MvcEdition.EditFeatureOverlaySetting|EditFeatureOverlaySetting]]> * Description:The editOvelay configuration action.
** {{wiki:PublicMethod.gif|}} HighlightOverlay(Action) ** * //Configures a HighlightFeatureOverlay object, which draws its features on client side and can attach the specified click event and context menu to them.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //configHighlightOverlayAction// * Type:Action<[[ThinkGeo.MapSuite.MvcEdition.HighlightFeatureOverlaySetting|HighlightFeatureOverlaySetting]]> * Description:The HighlightFeatureOverlay configuration action.
** {{wiki:PublicMethod.gif|}} AdornmentOverlay(Action) ** * //Configures a AdormentOverlay object in the map control.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //configAdormentOverlaySettingAction// * Type:Action<[[ThinkGeo.MapSuite.MvcEdition.AdornmentOverlaySetting|AdornmentOverlaySetting]]> * Description:The AdormentOverlay configuration action.
** {{wiki:PublicMethod.gif|}} MapTools(Action) ** * //Configures the MapTools in the map control.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //mapToolsSettingAction// * Type:Action<[[ThinkGeo.MapSuite.MvcEdition.MapToolsSettingCollection|MapToolsSettingCollection]]> * Description:MapTools configuration action.
** {{wiki:PublicMethod.gif|}} CurrentScale(Double) ** * //Sets the current scale of the map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //scale// * Type:Double * Description:scale value.
** {{wiki:PublicMethod.gif|}} CustomOverlays(Action) ** * //Configures the Overlays added to the map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //addOverlayAction// * Type:Action<[[ThinkGeo.MapSuite.MvcEdition.OverlayCollection|OverlayCollection]]> * Description:CustomOverlay setting action.
** {{wiki:PublicMethod.gif|}} Popups(Action) ** * //Sets the popups of the map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //addPopupAction// * Type:Action<[[ThinkGeo.MapSuite.MvcEdition.PopupCollection|PopupCollection]]> * Description:Popup setting action.
** {{wiki:PublicMethod.gif|}} RestrictedExtent(RectangleShape) ** * //Sets an extent that limits the area to which the map can be navigated within.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //extent// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:N/A
** {{wiki:PublicMethod.gif|}} OnClientDrawEnd(String) ** * //Sets the ClientDrawEnd event of the map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //clientDrawEnd// * Type:String * Description:The JavaScript function name.
** {{wiki:PublicMethod.gif|}} OnClientEditEnd(String) ** * //Sets the ClientEditEnd event of the map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //clientEditEnd// * Type:String * Description:The JavaScript function name.
** {{wiki:PublicMethod.gif|}} OnClientClick(String) ** * //Sets the client click event of the map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //clientClick// * Type:String * Description:The JavaScript function name.
** {{wiki:PublicMethod.gif|}} OnClientExtentChanged(String) ** * //Sets the ClientExtentChanged event of the map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //clientExtentChanged// * Type:String * Description:The JavaScript function name.
** {{wiki:PublicMethod.gif|}} OnClientBaseOverlayChanged(String) ** * //Sets the ClientBaseOverlayChanged event of the map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //clientBaseOverlayChanged// * Type:String * Description:The JavaScript function name.
** {{wiki:PublicMethod.gif|}} OnClientDoubleClick(String) ** * //Sets the ClientDoubleClick event of the map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //clientDoubleClick// * Type:String * Description:The JavaScript function name.
** {{wiki:PublicMethod.gif|}} OnClientTrackShapeFinished(String) ** * //Sets the OnClientTrackShapeFinished event of the map.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //clientTrackShapeFinishedEventHandler// * Type:String * Description:The JavaScript function name.
** {{wiki:PublicMethod.gif|}} OnClientPopupsRequesting(String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //clientPopupsRequestingEventHandler// * Type:String * Description:N/A
** {{wiki:PublicMethod.gif|}} OnClientPopupsRequested(String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //clientPopupsRequestedEventHandler// * Type:String * Description:N/A
** {{wiki:PublicMethod.gif|}} Render() ** * //Sends the map control content to a provided HtmlTextWriter object, which wirtes the content to be rendered on the client.// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Name(String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //name// * Type:String * Description:N/A
** {{wiki:PublicMethod.gif|}} HtmlAttributes(Dictionary) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //htmlAttributes// * Type:Dictionary * Description:N/A
** {{wiki:PublicMethod.gif|}} ScriptFileNames(Dictionary) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //scriptFileNames// * Type:Dictionary * Description:N/A
** {{wiki:PublicMethod.gif|}} ScriptBlocks(Dictionary) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //scriptBlocks// * Type:Dictionary * Description:N/A
** {{wiki:PublicMethod.gif|}} StyleSheetFileNames(IEnumerable) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.MapBuilder|MapBuilder]] * Description:N/A == Parameters == * //cssFileNames// * Type:IEnumerable * Description:N/A
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Type * Description:N/A == Parameters ==
==== Protected Methods ==== ** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Object * Description:N/A == Parameters ==
==== Public Properties ==== ==== Protected Properties ==== ** {{wiki:ProtectedProperty.gif|}} Control ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.MvcEdition.Map|Map]] ==== Public Events ====