504-Software-Development-Group
/
GCS-GISControlDlg-for-981A-and-981C
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
master
dev/cbwu
dev/zpx
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '602b841e7a'
${ noResults }
GCS-GISControlDlg-for-981A-.../MapWinGIS_SDK/AxInterop.MapWinGIS.XML

3337 lines
210 KiB
XML
Raw Blame History

<?xml version="1.0"?>
<doc>
<assembly>
<name>AxInterop.MapWinGIS</name>
</assembly>
<members>
<member name="T:AxMapWinGIS.AxMap">
<summary>
Map component for visualization of vector, raster or grid data.
</summary>
Here is a class diagram for the AxMap class:
\dot
digraph map_diagram {
nodesep = 0.3;
ranksep = 0.3;
splines = ortho;
node [shape= "polygon", peripheries = 1, fontname=Helvetica, fontsize=9, color = lightsalmon, style = filled, height = 0.3, width = 1.0];
map [ label="AxMap" URL="\ref AxMap"];
node [shape = "polygon", color = gray, peripheries = 3, style = filled, height = 0.2, width = 0.8]
img [ label="Image" URL="\ref Image"];
sf [ label="Shapefile" URL="\ref Shapefile"];
node [color = tan, peripheries = 1, height = 0.3, width = 1.0];
gp [ label="GeoProjection" URL="\ref GeoProjection"];
meas [ label="Measuring" URL="\ref Measuring"];
tiles [ label="Tiles" URL="\ref Tiles"];
fm [ label="FileManager" URL="\ref FileManager"];
se [ label="ShapeEditor" URL="\ref ShapeEditor"];
edge [ dir = "none", style = solid, fontname = "Arial", fontsize = 9, fontcolor = blue, color = "#606060", labeldistance = 0.6 ]
map -> sf [ URL="\ref AxMap.get_Shapefile()", tooltip = "AxMap.get_Shapefile()", headlabel = " n"];
map -> img [URL="\ref AxMap.get_Image()", tooltip = "AxMap.get_Image()", headlabel = " n"]
gp -> map [ URL="\ref AxMap.GeoProjection", tooltip = "AxMap.GeoProjection", taillabel = "1 "];
meas -> map [URL="\ref AxMap.Measuring", tooltip = "AxMap.Measuring", taillabel = "1 "]
tiles -> map [URL="\ref AxMap.Tiles", tooltip = "AxMap.Tiles", taillabel = "1 "]
fm -> map [URL="\ref AxMap.FileManager", tooltip = "AxMap.FileManager", taillabel = "1 "]
se -> map [URL="\ref AxMap.ShapeEditor", tooltip = "AxMap.ShapeEditor", taillabel = "1 "]
}
\enddot
<a href = "diagrams.html">Graph description</a>\n\n
Here are groups of API members for AxMap class:
\dotfile mapgroups.dot
<a href = "diagrams.html">Graph description</a>
</member>
<member name="P:AxMapWinGIS.AxMap.UDCursorHandle">
<summary>
Gets or sets the user defined cursor handle. The handle is a windows cursor handle.
</summary>
</member>
<member name="P:AxMapWinGIS.AxMap.Tiles">
<summary>
Gets or sets the object of Tiles class associated with map.
</summary>
\new490 Added in version 4.9.0
</member>
<member name="P:AxMapWinGIS.AxMap.FileManager">
<summary>
Gets FileManager object associated with map. The object is used by AxMap.AddLayerFromFilename methods.
</summary>
\new491 Added in version 4.9.1
</member>
<member name="P:AxMapWinGIS.AxMap.BackColor">
<summary>
Gets or sets the background color of the map.
</summary>
<remarks>When using VB.NET the color is represented as a System.Drawing.Color.
When using VB 6 the color can be an OLE_COLOR or an integer representation of an RGB value.</remarks>
</member>
<member name="M:AxMapWinGIS.AxMap.DrawBackBuffer(System.IntPtr,System.Int32,System.Int32)">
<summary>
Draws the content of the back buffer to specified device context.
</summary>
<remarks>If the size of the back buffer differ from the provided dimensions, the scaling of the buffer content will be made.</remarks>
<param name="hdc">The handle of the device context.</param>
<param name="ImageWidth">The width of the resulting image.</param>
<param name="ImageHeight">The height of the resulting image.</param>
</member>
<member name="P:AxMapWinGIS.AxMap.GlobalCallback">
<summary>
The global callback is the interface used by MapWinGIS to pass progress and error events to interested applications.
</summary>
<remarks>.NET clients passing ICallback implementation to this property must make respective
class COM visible by setting ComVisible(true) attribute. In fact ComVisible(true) is set by default
for public classes, so it's enough to make sure that it isn't explicitly set to false for the class
or assembly where the class is defined. Otherwise InvalidCastException may occur at runtime.</remarks>
\deprecated v4.9.3 Use GlobalSettings.ApplicationCallback instead.
</member>
<member name="M:AxMapWinGIS.AxMap.HWnd">
<summary>
Returns the handle of the window of map control.
</summary>
<returns>The handle of window.</returns>
</member>
<member name="P:AxMapWinGIS.AxMap.Key">
<summary>
The key may be used by the programmer to store any string data associated with the object.
</summary>
</member>
<member name="P:AxMapWinGIS.AxMap.LastErrorCode">
<summary>
Retrieves the last error generated in the object.
</summary>
</member>
<member name="P:AxMapWinGIS.AxMap.MapCursor">
<summary>
Gets or sets the cursor used with the map. When using crsrUserDefined be sure to set a UDCursorHandle.
</summary>
</member>
<member name="P:AxMapWinGIS.AxMap.MapResizeBehavior">
<summary>
Gets or sets the value which indicates how the control adjust its content after the resizing operations.
</summary>
</member>
<member name="M:AxMapWinGIS.AxMap.Redraw">
<summary>
Redraws all layers in the map if the map is not locked.
</summary>
<remarks>The same as AxMap.Redraw2(tkRedrawType.RedrawAll).</remarks>
</member>
<member name="M:AxMapWinGIS.AxMap.Resize(System.Int32,System.Int32)">
<summary>
Resizes the map to the given width and height.
</summary>
<param name="Width">The new width of the control.</param>
<param name="Height">The new hight of the control.</param>
</member>
<member name="P:AxMapWinGIS.AxMap.ShowRedrawTime">
<summary>
Gets or sets a value which indicates whether the time of map redraw will be displayed on the screen.
</summary>
<remarks>Only times of full redraws when data layers are drawn anew are displayed.</remarks>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.ShowToolTip(System.String,System.Int32)">
<summary>
Shows tooltip near the mouse cursor.
</summary>
<param name="Text">Text of the tooltip.</param>
<param name="Milliseconds">The duration of tooltip display.</param>
</member>
<member name="P:AxMapWinGIS.AxMap.ShowVersionNumber">
<summary>
Gets or sets a boolean value which indicate whether control's version number will be displayed on the screen.
</summary>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.SnapShot(System.Object)">
<summary>
Takes snap shot of the contents of the map within the bounds of the specified rectangle, returning an image of the results.
</summary>
<param name="BoundBox">The bounds (rectangle) in map units to get the snapshot from.</param>
<returns>An image of the contents of the map displayed inside the bounds of the specified rectangle.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.SnapShot2(System.Int32,System.Double,System.Int32)">
<summary>
Takes snap shot of the contents of the map and returns it as an image object.
</summary>
<param name="ClippingLayerNbr">The position of the layer which extents will be used for taking snapshot.</param>
<param name="Zoom">The amount of zoom.</param>
<param name="pWidth">The width of the resulting image.</param>
<returns>An image of the contents of the map.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.SnapShot3(System.Double,System.Double,System.Double,System.Double,System.Int32)">
<summary>
Takes snap shot of the contents of the map in the specified bounding box and returns it as an image object.
</summary>
<param name="left">The x coordinate of the lower left corner of the extents.</param>
<param name="right">The x coordinate of the top right corner of the extents.</param>
<param name="top">The y coordinate of the top right corner of the extents.</param>
<param name="bottom">The y coordinate of the lower left corner of the extents.</param>
<param name="Width">The width of the resulting image in pixels.</param>
<returns>An image of the contents of the map.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.SnapShotToDC(System.IntPtr,MapWinGIS.Extents,System.Int32)">
<summary>
Performs drawing of the map contents to the specified device context.
</summary>
<param name="hdc">The handle of the device context.</param>
<param name="Extents">The map extents to be drawn.</param>
<param name="Width">The width of the resulting image inShowVersionNumber pixels.</param>
<returns>True on success and false otherwise.</returns>
</member>
<member name="P:AxMapWinGIS.AxMap.VersionNumber">
<summary>
Gets or sets version number of the control.
</summary>
<remarks>The set part of the property isn't supported.</remarks>
</member>
<member name="M:AxMapWinGIS.AxMap.get_ErrorMsg(System.Int32)">
<summary>
Retrieves the error message associated with the specified error code.
</summary>
<param name="ErrorCode">The error code for which the error message is required. </param>
<returns>The error message description for the specified error code.</returns>
</member>
<member name="P:AxMapWinGIS.AxMap.TileProvider">
<summary>
Gets or sets tile provider for the map.
</summary>
<remarks>This property is a shortcut for AxMap.Tiles.Provider property.
Setting it to ProviderNone will change AxMap.Tiles.Visible property to false.</remarks>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.FindSnapPoint(System.Double,System.Double,System.Double,System.Double@,System.Double@)">
<summary>
Returns coordinate of the shapefile point closest to specified point on screen.
</summary>
<param name="tolerance">Tolerance in screen pixels. If no vertex is found within the tolerance, operation fails.</param>
<param name="xScreen">X coordinate on screen.</param>
<param name="yScreen">Y coordinate on screen.</param>
<param name="xFound">X coordinate of the vertex (map coordinates).</param>
<param name="yFound">Y coordinate of the vertex (map coordinates).</param>
<returns>True on success.</returns>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.LoadTilesForSnapshot(MapWinGIS.Extents,System.Int32,System.String,MapWinGIS.tkTileProvider)">
<summary>
Loads tiles for the specified map extents.
</summary>
<param name="extents">Extents to load tiles for (in map coordinates).</param>
<param name="width">The width of the canvas on which the extents will be rendered.</param>
<param name="key">Arbitrary key, to distinguish this request from others in AxMap.TilesLoaded event.</param>
<param name="provider">Provider to load tiles from.</param>
<remarks>If tiles aren't already loaded in cache, the operation will be performed asynchronously.
Use AxMap.TilesLoaded event to be notified of it's completion. The main purpose: loading of tiles
for printing.</remarks>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.Redraw2(MapWinGIS.tkRedrawType)">
<summary>
Performs specific type of map redraw.
</summary>
<param name="redrawType">Type of redraw.</param>
<remarks>Different types of redraw are necessary for performance reasons. If it's known that
only a specific part of map content has changed there is no need to run the full rendering,
screen buffer can be used instead. According to the amount of content being redrawn the different
types can be ordered like this (from minimum to the full one):
RedrawMinimal -> RedrawSkipAllLayers -> RedrawSkipDataLayers -> RedrawAll.
Each subsequent type includes preceding types, so it's never necessary to call two types in a row.
If it's not clear which type of redraw is appropriate for particular situation,
start with the minimal one and then go to the subsequent types until the changes
which were made are rendered. Also if datasource being used are small it's easier to ignore this method
altogether and call AxMap.Redraw instead ( equivalent to AxMap.Redraw2(tkRedrawType.RedrawAll)). </remarks>
\new491 Added in version 4.9.1
</member>
<member name="P:AxMapWinGIS.AxMap.UndoList">
<summary>
Gets list actions performed by user via interactive shape editor. Provides undo/redo capability.
</summary>
\new493 Added in version 4.9.3
</member>
<member name="P:AxMapWinGIS.AxMap.Identifier">
<summary>
Gets an %Identifier object which holds settings of cmIdentify tools.
</summary>
\new493 Added in version 4.9.3
</member>
<member name="P:AxMapWinGIS.AxMap.ShapeEditor">
<summary>
Gets instance of shape editor class associated with map which stores data entered by interactive editing tools.
</summary>
\new493 Added in version 4.9.3
</member>
<member name="P:AxMapWinGIS.AxMap.UseSeamlessPan">
\addtogroup map_interaction Map interaction
Here is a list of properties and methods which affect the way a user interacts with the map. This module is a part of the documentation of AxMap class.
\dot
digraph map_interaction {
splines = true;
node [shape= "polygon", fontname=Helvetica, fontsize=9, style = filled, color = palegreen, height = 0.3, width = 1.2];
lb [ label="AxMap" URL="\ref AxMap"];
node [shape = "ellipse", color = khaki, width = 0.2, height = 0.2, style = filled]
gr [label="Map Interaction" URL="\ref map_interaction"];
edge [ arrowhead="open", style = solid, arrowsize = 0.6, fontname = "Arial", fontsize = 9, fontcolor = blue, color = "#606060" ]
lb -> gr;
}
\enddot
<a href = "diagrams.html">Graph description</a>
@{
<summary>
Gets or sets a boolean value which indicate whether map will be redrawn in the course of panning operation.
</summary>
<remarks>The default value is false. Setting this value to true can improve the user experience but
decrease the performance in case large layers are displayed.</remarks>
\new48 Added in version 4.8
</member>
<member name="P:AxMapWinGIS.AxMap.CursorMode">
<summary>
Gets or sets the cursor mode for the map.
</summary>
<remarks>The cursor mode determines how the map handles mouse click events on the map. The only mode not handled by the map is cmNone.</remarks>
</member>
<member name="P:AxMapWinGIS.AxMap.ZoomBehavior">
<summary>
Gets or sets zoom behaviour for the map control.
</summary>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.ZoomToSelected(System.Int32)">
<summary>
Zoomes map to display selected shapes of the specified shapefile.
</summary>
<param name="layerHandle">Layer handle of shapefile layer with selected shapes.</param>
<returns>True on success.</returns>
<remarks>If the layer isn't shapefile or there is no selected shapes in it, nothing will happen.</remarks>
\new490 Added in version 4.9.0
</member>
<member name="M:AxMapWinGIS.AxMap.ZoomToTileLevel(System.Int32)">
<summary>
Zooms map to specified zoom level of the active tile provider (Map.Tiles.Provider).
</summary>
<param name="zoom">Zoom</param>
<returns>True if the zooming took place.</returns>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.ZoomToWorld">
<summary>
Zooms to World extents (-180.0; 180.0; -90.0; 90.0)
</summary>
<remarks>Projection should be specified for map in order for this methods to work.</remarks>
<returns>True on success.</returns>
\new490 Added in version 4.9.0
</member>
<member name="P:AxMapWinGIS.AxMap.IsLocked">
<summary>
Checks to see if the map is currently locked or not.
</summary>
</member>
<member name="M:AxMapWinGIS.AxMap.LockWindow(MapWinGIS.tkLockMode)">
<summary>
Locks the window so that any changes will not be displayed until it is unlocked.
</summary>
<remarks>This is very useful if you are making a large number of changes at once and don't want the map to be redrawn between each change.
The changes of drawing options in the related classes (Shapefile, Labels, etc.) won't cause the redraw of the map even if it's not locked.</remarks>
<param name="LockMode">The state of the lock mode.</param>
</member>
<member name="P:AxMapWinGIS.AxMap.DisableWaitCursor">
<summary>
Gets or sets a boolean value which indicates whether a wait cursor will be displayed on map redraw.
</summary>
</member>
<member name="P:AxMapWinGIS.AxMap.MouseWheelSpeed">
<summary>
Gets or sets the speed of zooming with mouse wheel.
</summary>
<remarks>The default values is 0.5. The values in 0.1 - 10.0 range are accepted. The value 1.0 will turn off
the zooming by mouse wheel.</remarks>
</member>
<member name="P:AxMapWinGIS.AxMap.SendMouseDown">
<summary>
Gets or sets whether the map sends mouse down events.
</summary>
</member>
<member name="P:AxMapWinGIS.AxMap.SendMouseMove">
<summary>
Gets or sets whether the map sends mouse move events.
</summary>
</member>
<member name="P:AxMapWinGIS.AxMap.SendMouseUp">
<summary>
Gets or sets whether the map sends mouse up events.
</summary>
</member>
<member name="P:AxMapWinGIS.AxMap.SendOnDrawBackBuffer">
<summary>
Gets or sets a boolean value which indicates whether the map sends on draw back buffer events.
</summary>
</member>
<member name="P:AxMapWinGIS.AxMap.SendSelectBoxDrag">
<summary>
Gets or sets whether the map sends the SelectBoxDrag event.
</summary>
</member>
<member name="P:AxMapWinGIS.AxMap.SendSelectBoxFinal">
<summary>
Gets or sets whether the map sends the SelectBoxFinal event.
</summary>
</member>
<member name="P:AxMapWinGIS.AxMap.TrapRMouseDown">
<summary>
Gets or sets a boolean value which can affect the displaying of the context menus in client code by the right click.
</summary>
</member>
<member name="M:AxMapWinGIS.AxMap.ZoomIn(System.Double)">
<summary>
Zooms the display in by the given factor.
</summary>
<param name="Percent">The factor to zoom in by.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.ZoomOut(System.Double)">
<summary>
Zooms the display out by the specified factor.
</summary>
<param name="Percent">The factor to zoom out by.</param>
</member>
<member name="P:AxMapWinGIS.AxMap.ZoomPercent">
<summary>
Gets or sets the factor by which to zoom the view of the map in or out.
</summary>
</member>
<member name="M:AxMapWinGIS.AxMap.ZoomToLayer(System.Int32)">
<summary>
Zooms the map display to the specified layer.
</summary>
<param name="LayerHandle">The handle of the layer to zoom to.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.ZoomToMaxExtents">
<summary>
Zooms the map to the maximum extents of all loaded layers.
</summary>
<remarks>Layers which are not visible are still used to compute maximum extents.</remarks>
</member>
<member name="M:AxMapWinGIS.AxMap.ZoomToMaxVisibleExtents">
<summary>
Zooms the map to the maximum extents of all loaded visible layers.
</summary>
<remarks> Layers which are not visible are not used to compute maximum extents.</remarks>
</member>
<member name="M:AxMapWinGIS.AxMap.ZoomToPrev">
<summary>
Zooms the map view to the previous extents if there are previous extents in the extents history.
</summary>
<returns>Returns the number of extents left in the extents history after zooming to previous extents.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.ZoomToShape(System.Int32,System.Int32)">
<summary>
Zooms the map display to the specified shape in the shapefile contained by the specified layer.
</summary>
<param name="LayerHandle">The handle of the layer containing the shape to zoom to.</param>
<param name="Shape">The index of the shape to zoom to.</param>
</member>
<member name="P:AxMapWinGIS.AxMap.ShowZoomBar">
<summary>
Gets or sets a value indicating whether zoom bar will be displayed on the map.
</summary>
<remarks>Zoom bar can be displayed only if projection of the map is set. Zoom levels
depend upon tile of the current tile provider.</remarks>
/see AxMap.TileProvider, AxMap.Projection
\new492 Added in version 4.9.2
</member>
<member name="P:AxMapWinGIS.AxMap.AnimationOnZooming">
<summary>
Gets or sets a value indicating whether animation will be displayed zooming map in or out.
</summary>
<remarks>Default csAuto value will display animation only if there are no data layers
within visisble extents. Animation also won't be displayed if there are more than 4
zoom levels between current and target level.</remarks>
\new492 Added in version 4.9.2
</member>
<member name="P:AxMapWinGIS.AxMap.InertiaOnPanning">
<summary>
Gets or sets a value indicating whether animation will be displayed to simulate
inertia after panning operation.
</summary>
<remarks>Default csAuto value will display animation only if there are no data layers
within visisble extents.
\note Mouse panning is somewhat more tricky than the one with smartphone's touch screen,
so some practice may be needed to learn not to stop mouse motion before releasing the button )))
</remarks>
\new492 Added in version 4.9.2
</member>
<member name="P:AxMapWinGIS.AxMap.ReuseTileBuffer">
<summary>
Gets or sets a value indicating whether currently rendered tile buffer should be scaled
and reused during the next redraw.
</summary>
\new492 Added in version 4.9.2
</member>
<member name="P:AxMapWinGIS.AxMap.UseAlternatePanCursor">
<summary>
Gets or sets a value indicating whether the legacy 'hand' cursor should be used
for map panning rather than the standard 'NSEW' four-point cursor.
</summary>
\new495 Added in version 4.9.5
</member>
<member name="P:AxMapWinGIS.AxMap.ZoomBarVerbosity">
<summary>
Gets or sets the amount of information to be displayed in zoom bar tool tip.
</summary>
\new492 Added in version 4.9.2
</member>
<member name="P:AxMapWinGIS.AxMap.ZoomBoxStyle">
<summary>
Gets or sets a style of zoom box, which is used to select a region with Zoom In tool.
</summary>
\new492 Added in version 4.9.2
</member>
<member name="P:AxMapWinGIS.AxMap.ZoomBarMinZoom">
<summary>
Gets or sets minimum zoom level to be used by zoom bar.
</summary>
<remarks>This property won't increase the number of available levels,
if certain levels aren't supported by the provider they still won't be displayed.</remarks>
\new492 Added in version 4.9.2
</member>
<member name="P:AxMapWinGIS.AxMap.ZoomBarMaxZoom">
<summary>
Gets or sets maximum zoom level to be used by zoom bar.
</summary>
<remarks>This property won't increase the number of available levels,
if certain levels aren't supported by the provider they still won't be displayed.</remarks>
\new492 Added in version 4.9.2
</member>
<member name="P:AxMapWinGIS.AxMap.RecenterMapOnZoom">
<summary>
Gets or sets a value indicating whether to move the mouse click point to the center of the map
when using the Zoom In or Zoom Out tools.
</summary>
<remarks>The default value is False, indicating that the map is not recentered,
but instead keeps the click point at the mouse position and zooms around that point.</remarks>
\new495 Added in version 4.9.5
</member>
<member name="M:AxMapWinGIS.AxMap.Undo">
<summary>
Reverts the last operation performed by user in interactive shape editor.
</summary>
<remarks>This method is preferable over AxMap.UndoList.Undo since it can
also undo point added during creation of new shape, which are not registered in the undo list.</remarks>
\new493 Added in version 4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap.SerializeLayer(System.Int32)">
\addtogroup map_serialization Map serialization
Here is a list of properties and methods to preserve the state of the map and particular layers. This module is a part of the documentation of AxMap class.
\dot
digraph map_serialization {
splines = true;
node [shape= "polygon", fontname=Helvetica, fontsize=9, style = filled, color = palegreen, height = 0.3, width = 1.2];
lb [ label="AxMap" URL="\ref AxMap"];
node [shape = "ellipse", color = khaki, width = 0.2, height = 0.2, style = filled]
gr [label="Map Serialization" URL="\ref map_serialization"];
edge [ arrowhead="open", style = solid, arrowsize = 0.6, fontname = "Arial", fontsize = 9, fontcolor = blue, color = "#606060" ]
lb -> gr;
}
\enddot
<a href = "diagrams.html">Graph description</a>
@{
<summary>
Serializes the layer settings to the string.
</summary>
<remarks>The serialized string will not include information about the data source. Therefore
the same options can later be applied to any data layer of the same type (either shapefile or image).</remarks>
<param name="LayerHandle">The handle of the layer.</param>
<returns>The string with serialized layer settings.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.DeserializeLayer(System.Int32,System.String)">
<summary>
Restores the state of the layer from the string generated by AxMap.SerializeLayer().
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="newVal">The string to restore values from.</param>
<returns>True on success and false otherwise.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.SerializeMapState(System.Boolean,System.String)">
<summary>
Serializes map state to the string.
</summary>
<param name="RelativePaths">A value which indicates whether relative or absolute paths to data sources will be used.</param>
<param name="BasePath">The path to the base folder starting from which relative paths will be calculated.</param>
<returns>The string with the serialized map state.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.DeserializeMapState(System.String,System.Boolean,System.String)">
<summary>
Restores map state from the string generated by AxMap.SerializeMapState.
</summary>
<remarks>This method will remove all the existing layers and load the layers specified in the string.</remarks>
<param name="State">The string with serialized state.</param>
<param name="LoadLayers">A boolean value which indicates whether layers or only options of the map control will restored.</param>
<param name="BasePath">The path to the base folder starting from which relative paths were calculated.</param>
<returns>True on success and false otherwise.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.LoadLayerOptions(System.Int32,System.String,System.String@)">
<summary>
Applies to the layer a set of settings from file with the specified name.
</summary>
<remarks>The options will be loaded from the file with the name [LayerName].[OptionsName].mwsymb</remarks>
<param name="LayerHandle">The handle of the layer.</param>
<param name="OptionsName">The name of the set of options.</param>
<param name="Description">The output string which will hold the description of the options stored in file.</param>
<returns>True on success and false otherwise.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.RemoveLayerOptions(System.Int32,System.String)">
<summary>
Removes set of options for the layer with the specified name.
</summary>
<remarks>The options are stored in files with the name [LayerName].[OptionsName].mwsymb</remarks>
<param name="LayerHandle">The handle of the layer.</param>
<param name="OptionsName">The name of the set of options.</param>
<returns>True on success and false otherwise.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.SaveLayerOptions(System.Int32,System.String,System.Boolean,System.String)">
<summary>
Saves settings of the layer to the file.
</summary>
<remarks>The options are saved to the file with name [LayerName].[OptionsName].mwsymb</remarks>
<param name="LayerHandle">The handle of the layer.</param>
<param name="OptionsName">The name which will be attached to the set of options.</param>
<param name="Overwrite">A value which indicates whether the existing file will be overwritten.</param>
<param name="Description">The description associated with the set of options.</param>
<returns>True on success and false otherwise.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.LoadMapState(System.String,System.Object)">
<summary>
Loads the state of the map from the file created by AxMap.SaveMapState method.
</summary>
<param name="Filename">The name of the file.</param>
<param name="Callback">A callback object to return information about progress and errors.</param>
<returns>True on success and false otherwise.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.SaveMapState(System.String,System.Boolean,System.Boolean)">
<summary>
Saves the state of the map to the specified file.
</summary>
<remarks>Use AxMap.LoadState for reverse operation.</remarks>
The serialized state include:
- properties of the control;
- references to the layers;
- drawing options for the layers.
.
<param name="Filename">The name of the file.</param>
<param name="RelativePaths">A value which indicates whether absolute or relative paths should be used.</param>
<param name="Overwrite">A value which indicates whether the exiting file will be overwritten.</param>
<returns>True on success and false otherwise.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerMaxVisibleZoom(System.Int32)">
\addtogroup map_layer_properties Layer properties
Here is a list of properties common to all data layers. This module is a part of the documentation of AxMap class.
\dot
digraph map_layer_properties {
splines = true;
node [shape= "polygon", fontname=Helvetica, fontsize=9, style = filled, color = palegreen, height = 0.3, width = 1.2];
lb [ label="AxMap" URL="\ref AxMap"];
node [shape = "ellipse", color = khaki, width = 0.2, height = 0.2, style = filled]
gr [label="Layer Properties" URL="\ref map_layer_properties"];
edge [ arrowhead="open", style = solid, arrowsize = 0.6, fontname = "Arial", fontsize = 9, fontcolor = blue, color = "#606060" ]
lb -> gr;
}
\enddot
<a href = "diagrams.html">Graph description</a>
@{
<summary>
Gets maximum zoom at which the layer will be displayed.
</summary>
<param name="layerHandle"></param>
<returns></returns>
<remarks>It's analogous to get_LayerMaxVisibleScale, only scale specified as zoom level
of the current tile provider (Map.Tiles.Provider).</remarks>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.set_LayerMaxVisibleZoom(System.Int32,System.Int32)">
<summary>
Sets maximum zoom at which the layer will be displayed.
</summary>
<param name="layerHandle">Layer handle.</param>
<param name="param0">The new value of max zoom.</param>
<remarks>It's analogous to set_LayerMaxVisibleScale, only scale specified as zoom level
of the current tile provider (Map.Tiles.Provider).</remarks>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerFilename(System.Int32)">
<summary>
Gets filename of datasource for the specified layer.
</summary>
<param name="layerHandle">Layer handle.</param>
<returns>Filename of the layer including path.</returns>
\new490 Added in version 4.9.0
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerMinVisibleZoom(System.Int32)">
<summary>
Gets minimum zoom at which the layer will be displayed.
</summary>
<param name="layerHandle"></param>
<returns></returns>
<remarks>It's analogous to get_LayerMinVisibleScale, only scale specified as zoom level
of the current tile provider (Map.Tiles.Provider).</remarks>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.set_LayerMinVisibleZoom(System.Int32,System.Int32)">
<summary>
Sets minimum zoom at which the layer will be displayed.
</summary>
<param name="layerHandle">Layer handle.</param>
<param name="param0">The new value of max zoom.</param>
<remarks>It's analogous to set_LayerMinVisibleScale, only scale specified as zoom level
of the current tile provider (Map.Tiles.Provider).</remarks>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.set_LayerDescription(System.Int32,System.String)">
<summary>
Sets the description of the layer.
</summary>
<remarks>The information will be stored in .mwsymb file associated with data layer.</remarks>
<param name="LayerHandle">The handle of the layer.</param>
<param name="newValue">The description of the layer.</param>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerDescription(System.Int32)">
<summary>
Gets the description of the layer from the associated .mwsymb file.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<returns>The string with description.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerDynamicVisibility(System.Int32)">
<summary>
Gets the boolean value which indicates whether the layer will be displayed at all scales or only within the chosen range of scales.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<returns>True in case the layer will be displayed between specified scales only.</returns>
\see AxMap.get_LayerMaxVisibleScale, AxMap.get_LayerMinVisibleScale
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.set_LayerDynamicVisibility(System.Int32,System.Boolean)">
<summary>
Sets the boolean value which indicates whether the layer will be displayed at all scales or only within the chosen range of scales.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="newValue">True in case the layer will be displayed between specified scales only.</param>
\see set_LayerMaxVisibleScale, set_LayerMinVisibleScale
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerKey(System.Int32)">
<summary>
Gets a string associated with a layer in the map.
</summary>
<remarks>This string can be used to store any string data desired by the developer.</remarks>
<param name="LayerHandle">The handle for the layer for which the layer key is to be set.</param>
<returns>The layer key for the specified layer in string format.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_LayerKey(System.Int32,System.String)">
<summary>
Sets a string associated with a layer in the map.
</summary>
<remarks>This string can be used to store any string data desired by the developer.</remarks>
<param name="LayerHandle">The handle of the layer.</param>
<param name="newValue">The string to be associated with layer.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerLabels(System.Int32)">
<summary>
Returns labels associated with layer.
</summary>
<remarks>Labels can also be obtained by using Shapefile.Labels and Image.Labels.</remarks>
<param name="LayerHandle">The handle of the layer.</param>
<returns>The labels associated with the layer.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.set_LayerLabels(System.Int32,MapWinGIS.Labels)">
<summary>
Sets the labels associated with the layer.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="newValue">The new instance of the Labels class to be associated with the layer.</param>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerMaxVisibleScale(System.Int32)">
<summary>
Gets the maximum scale at which the layer is visible on the map.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<returns>The maximum visible scale for the layer.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.set_LayerMaxVisibleScale(System.Int32,System.Double)">
<summary>
Sets the maximum scale at which the layer is visible on the map.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="newValue">The maximum visible scale for the layer.</param>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerMinVisibleScale(System.Int32)">
<summary>
Gets the minimum scale at which the layer is visible on the map.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<returns>The minimum visible scale for the layer.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.set_LayerMinVisibleScale(System.Int32,System.Double)">
<summary>
Sets the minimum scale at which the layer is visible on the map.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="newValue">The minimum visible scale for the layer.</param>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerName(System.Int32)">
<summary>
Gets the name of the specified layer.
</summary>
<param name="LayerHandle">The handle of the layer for which the name is to be set.</param>
<returns>The layer name for the specified layer. </returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_LayerName(System.Int32,System.String)">
<summary>
Sets the name of the specified layer.
</summary>
<param name="LayerHandle">The handle of the layer for which the name is to be set.</param>
<param name="newValue">The name to be set for the layer.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerSkipOnSaving(System.Int32)">
<summary>
Gets a boolean value which indicates whether the layer will be serialized by appropriate routines.
</summary>
<remarks>This property affects AxMap.SaveMapState, AxMap.SerializeMapState.</remarks>
<param name="LayerHandle">The handle of the layer.</param>
<returns>True in case the layer will be excluded from serialization and false otherwise.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.set_LayerSkipOnSaving(System.Int32,System.Boolean)">
<summary>
Sets a boolean value which indicates whether the layer will be serialized by appropriate routines.
</summary>
<remarks>This property affects AxMap.SaveMapState, AxMap.SerializeMapState.</remarks>
<param name="LayerHandle">The handle of the layer.</param>
<param name="newValue">True in case the layer will be excluded from serialization and false otherwise.</param>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerVisible(System.Int32)">
<summary>
Gets the visibility of the specified layer.
</summary>
<param name="LayerHandle">The handle of the layer for which the visibility is being set. </param>
<returns>A boolean value representing whether the layer is to be visible or not.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_LayerVisible(System.Int32,System.Boolean)">
<summary>
Sets the visibility of the specified layer.
</summary>
<param name="LayerHandle">The handle of the layer for which the visibility is returned. </param>
<param name="newValue">A boolean value representing whether the layer is to be visible or not.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.GetColorScheme(System.Int32)">
<summary>
Returns a color scheme for the specified layer.
</summary>
<param name="LayerHandle">The layer handle of the layer for which the coloring scheme is required</param>
<returns>The color scheme for the specified layer</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.Clear">
\addtogroup map_layer_management Layer management
Here is a list of properties and methods which allow to work with layers of the map. This module is a part of the documentation of AxMap class.
\dot
digraph map_layer {
splines = true;
node [shape= "polygon", fontname=Helvetica, fontsize=9, style = filled, color = palegreen, height = 0.3, width = 1.2];
lb [ label="AxMap" URL="\ref AxMap"];
node [shape = "ellipse", color = khaki, width = 0.2, height = 0.2, style = filled]
gr [label="Layer Management" URL="\ref map_layer_management"];
edge [ arrowhead="open", style = solid, arrowsize = 0.6, fontname = "Arial", fontsize = 9, fontcolor = blue, color = "#606060" ]
lb -> gr;
}
\enddot
<a href = "diagrams.html">Graph description</a>
@{
<summary>
Removes all data from the map and sets its properties to the default state.
</summary>
\new491 Added in version 4.9.1
</member>
<!-- Badly formed XML comment ignored for member "M:AxMapWinGIS.AxMap.AddLayerFromDatabase(System.String,System.String,System.Boolean)" -->
<member name="M:AxMapWinGIS.AxMap.AddLayerFromFilename(System.String,MapWinGIS.tkFileOpenStrategy,System.Boolean)">
<summary>
Adds layer from the specified datasource.
</summary>
<remarks>Additional information on failure can be obtained through AxMap.FileManager property.
</remarks>
<param name="filename">Filename of datasource</param>
<param name="openStrategy">Open strategy (fosAutoDetect the default recommended value).</param>
<param name="visible">A value indicating whether a new layer will be visible.</param>
<returns>Handle of the newly added layer or -1 on failure.</returns>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.AddLayer(System.Object,System.Boolean)">
<summary>
Adds a layer to the map.
</summary>
<remarks>In case of OgrDatasource all layers will be added to the map. For grid datasources
an instance of Image class created with Grid.OpenAsImage will be used for rendering.</remarks>
<param name="Object">The object to add to the map. The following types are supported:
Shapefile, Image, Grid, OgrLayer, OgrDatasource.</param>
<param name="Visible">Sets whether the layer is visible after being added to the map.</param>
<returns>Returns the integer handle for the layer added to the map.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerHandle(System.Int32)">
<summary>
Gets the handle of the layer at the given position in the map. Returns -1 if there is no layer at the specified position
</summary>
<param name="LayerPosition">The position of the layer for which the layer handle is required.</param>
<returns>The layer handle for the layer at the specified position.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerPosition(System.Int32)">
<summary>
Gets the position of the specified layer in the map.
</summary>
<param name="LayerHandle">The layer handle of the layer for which the layer position is required.</param>
<returns>The layer position of the specified layer in the map.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.MoveLayer(System.Int32,System.Int32)">
<summary>
Moves a layer in the map from the initial position to a target position.
</summary>
<param name="InitialPosition">The initial position of the layer to be moved.</param>
<param name="TargetPosition">The final position of the layer being moved.</param>
<returns></returns>
</member>
<member name="M:AxMapWinGIS.AxMap.MoveLayerBottom(System.Int32)">
<summary>
Moves the specified layer below all other layers.
</summary>
<param name="InitialPosition">The position of the layer to move to the bottom</param>
<returns>Boolean value representing success when true, and failure when false.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.MoveLayerDown(System.Int32)">
<summary>
Moves the specified layer down one layer in the map.
</summary>
<param name="InitialPosition">The position of the layer to be moved.</param>
<returns>Boolean value representing success when true, and failure when false.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.MoveLayerTop(System.Int32)">
<summary>
Moves the specified layer to the top of all other layers.
</summary>
<param name="InitialPosition">The position of the layer to be moved.</param>
<returns>Boolean value representing success when true, failure when false.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.MoveLayerUp(System.Int32)">
<summary>
Moves the specified layer up one layer in the map.
</summary>
<param name="InitialPosition">The initial position of the layer to be moved.</param>
<returns>Boolean value representing success when true, failure when false.</returns>
</member>
<member name="P:AxMapWinGIS.AxMap.NumLayers">
<summary>
Gets the number of layers loaded in the map.
</summary>
</member>
<member name="M:AxMapWinGIS.AxMap.RemoveAllLayers">
<summary>
Removes all layers from the map.
</summary>
</member>
<member name="M:AxMapWinGIS.AxMap.ReSourceLayer(System.Int32,System.String)">
<summary>
Changes the data source for the specified layer without its closing.
</summary>
<remarks>The new data source must be of the same type, i.e. either Shapefile or Image.</remarks>
<param name="LayerHandle">The handle of the layer.</param>
<param name="newSrcPath">The the name of the new data source.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.RemoveLayer(System.Int32)">
<summary>
Removes the specified layer from the map
</summary>
<param name="LayerHandle">The handle of the layer to be removed from the map.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.RemoveLayerWithoutClosing(System.Int32)">
<summary>
Removes layer from the map without its closing.
</summary>
<remarks>Shapefile.Close or Image.Close won't be called while removing the layer.</remarks>
<param name="LayerHandle">The handle of the layer.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_Image(System.Int32)">
<summary>
Gets image object associated with the layer.
</summary>
<remarks>This method along with AxMap.get_Shapefile() can used to substitute AxMap.get_GetObject().</remarks>
<param name="LayerHandle">The handle of the layer.</param>
<returns>The reference to the image or NULL reference in case of invalid handle or wrong layer type.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.set_Image(System.Int32,MapWinGIS.Image)">
<summary>
Replaces the image object associated with the layer.
</summary>
<remarks>The old image will not be closed.</remarks>
<param name="LayerHandle">The handle of the layer.</param>
<param name="newValue">The new image object.</param>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.get_Shapefile(System.Int32)">
<summary>
Gets shapefile object associated with the layer.
</summary>
<remarks>This method along with AxMap.get_Image() can be used to substitute AxMap.get_GetObject().</remarks>
<param name="LayerHandle">The handle of the layer.</param>
<returns>The reference to the shapefile or NULL reference in case of invalid handle or wrong layer type.</returns>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.set_Shapefile(System.Int32,MapWinGIS.Shapefile)">
<summary>
Replaces the shapefile object associated with the layer.
</summary>
<remarks>The old shapefile will not be closed.</remarks>
<param name="LayerHandle">The handle of the layer.</param>
<param name="newValue">The new shapefile object.</param>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.get_GetObject(System.Int32)">
<summary>
Returns the layer object with the given handle. The object could be a Shapefile, Grid, or Image object.
</summary>
<remarks>For OGR layers this method will return underlying shapefile from OgrLayer.GetBuffer().
Use AxMap.get_OgrLayer to access instance of OgrLayer itself.</remarks>
<param name="LayerHandle">The handle of the layer to be retrieved.</param>
<returns>A Shapefile, Grid, or Image object.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.get_OgrLayer(System.Int32)">
<summary>
Gets instance of OGR layer object associated with the specified layer.
</summary>
<param name="layerHandle">The handle of the layer.</param>
<returns>OGR layer or null in case of invalid layer index or wrong layer type.</returns>
\new493 Added in version 4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap.get_LayerVisibleAtCurrentScale(System.Int32)">
<summary>
Gets a value which indicates whether a layer is visible at current map scale.
</summary>
<param name="layerHandle">Handle of the layer.</param>
<returns>True in case the layer is visible.</returns>
<remarks>The property checks whether or not the layer is hidden because of AxMap.LayerDynamicVisibility property.
However it doesn't check that the layer has any objects within the current map extents.</remarks>
\new493 Added in version 4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap.set_DrawingLabels(System.Int32,MapWinGIS.Labels)">
\addtogroup map_drawing_layers Drawing layers
Here is a list of methods and properties to interact with the drawing layers of the map. This module is a part of the documentation of AxMap class.
\dot
digraph map_drawing_layers {
splines = true;
node [shape= "polygon", fontname=Helvetica, fontsize=9, style = filled, color = palegreen, height = 0.3, width = 1.2];
lb [ label="AxMap" URL="\ref AxMap"];
node [shape = "ellipse", color = khaki, width = 0.2, height = 0.2, style = filled]
gr [label="Drawing Layers" URL="\ref map_drawing_layers"];
edge [ arrowhead="open", style = solid, arrowsize = 0.6, fontname = "Arial", fontsize = 9, fontcolor = blue, color = "#606060" ]
lb -> gr;
}
\enddot
<a href = "diagrams.html">Graph description</a>
@{
<summary>
Replaces the labels associated with the drawing layer.
</summary>
<param name="DrawingLayerIndex">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<param name="newValue">The new instance of the Labels class to associate with the layer.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_DrawingLabels(System.Int32)">
<summary>
Gets labels associated with the drawing layer.
</summary>
<param name="DrawingLayerIndex">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<returns>The reference to the Labels class or NULL reference on the invalid handle.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.ClearDrawing(System.Int32)">
<summary>
Clears all the drawings on the drawing layer specified.
</summary>
<param name="DrawHandle">Drawing handle of the drawing layer for which all drawings are to be cleared.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.ClearDrawings">
<summary>
Clears all drawings on all drawing layers. This method is slower than using ClearDrawing on a specific layer
</summary>
</member>
<member name="M:AxMapWinGIS.AxMap.DrawCircle(System.Double,System.Double,System.Double,System.UInt32,System.Boolean)">
<summary>
Draws a circle on the last drawing layer created by NewDrawing
</summary>
<param name="x">Center x coordinate for the circle to be drawn.</param>
<param name="y">Center y coordinate for the circle to be drawn.</param>
<param name="pixelRadius">Radius in pixels of the circle to be drawn.</param>
<param name="Color">Color of the circle to be drawn. This is a UInt32 representation of an RGB color.</param>
<param name="fill">Boolean value which determines whether the circle will be drawn with a fill or not.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.DrawCircleEx(System.Int32,System.Double,System.Double,System.Double,System.UInt32,System.Boolean)">
<summary>
Draws a circle on the specified drawing layer.
</summary>
<param name="LayerHandle">The handle of the drawing layer created with AxMap.NewDrawing call.</param>
<param name="x">Center x coordinate for the circle to be drawn.</param>
<param name="y">Center y coordinate for the circle to be drawn.</param>
<param name="pixelRadius">Radius in pixels of the circle to be drawn.</param>
<param name="Color">Color of the circle to be drawn. This is a UInt32 representation of an RGB color.</param>
<param name="fill">Boolean value which determines whether the circle will be drawn with a fill or not.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.DrawLine(System.Double,System.Double,System.Double,System.Double,System.Int32,System.UInt32)">
<summary>
Draws a line on the last drawing layer created using NewDrawing.
</summary>
<param name="x1">X coordinate of the first point used to draw the line</param>
<param name="y1">Y coordinate of the first point used to draw the line.</param>
<param name="x2">X coordinate of the second point used to draw the line.</param>
<param name="y2">Y coordinate of the second point used to draw the line.</param>
<param name="pixelWidth">Width of the line in pixels.</param>
<param name="Color">Color to draw the line with. This is a UInt32 representation of an RGB value.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.DrawLineEx(System.Int32,System.Double,System.Double,System.Double,System.Double,System.Int32,System.UInt32)">
<summary>
Draws a line on the specified drawing layer.
</summary>
<param name="LayerHandle">The handle of the drawing layer created with AxMap.NewDrawing call.</param>
<param name="x1">X coordinate of the first point used to draw the line</param>
<param name="y1">Y coordinate of the first point used to draw the line.</param>
<param name="x2">X coordinate of the second point used to draw the line.</param>
<param name="y2">Y coordinate of the second point used to draw the line.</param>
<param name="pixelWidth">Width of the line in pixels.</param>
<param name="Color">Color to draw the line with. This is a UInt32 representation of an RGB value.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.DrawPoint(System.Double,System.Double,System.Int32,System.UInt32)">
<summary>
Draws a point on the last drawing layer created by NewDrawing.
</summary>
<param name="x">The x coordinate of the point to draw</param>
<param name="y">The y coordinate of the point to draw.</param>
<param name="pixelSize">The size in pixels of the point to be drawn.</param>
<param name="Color">The color of the point to be drawn. This is a UInt32 representation of an RGB color.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.DrawPointEx(System.Int32,System.Double,System.Double,System.Int32,System.UInt32)">
<summary>
Draws a point on the specified drawing layer.
</summary>
<param name="LayerHandle">The handle of the drawing layer created with AxMap.NewDrawing call.</param>
<param name="x">The x coordinate of the point to draw</param>
<param name="y">The y coordinate of the point to draw.</param>
<param name="pixelSize">The size in pixels of the point to be drawn.</param>
<param name="Color">The color of the point to be drawn. This is a UInt32 representation of an RGB color.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.DrawPolygon(System.Object@,System.Object@,System.Int32,System.UInt32,System.Boolean)">
<summary>
Draws a polygon on the last drawing layer created using NewDrawing.
</summary>
<param name="xPoints">An array containing x-coordinates for each point in the polygon.</param>
<param name="yPoints">An array containing y-coordinates for each point in the polygon.</param>
<param name="numPoints">The number of points in the polygon.</param>
<param name="Color">The color to use when drawing the polygon. This is a UInt32 representation of an RGB color.</param>
<param name="fill">A boolean value representing whether the polygon is drawn with a fill or not.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.DrawPolygonEx(System.Int32,System.Object@,System.Object@,System.Int32,System.UInt32,System.Boolean)">
<summary>
Draws a polygon on the specified drawing layer.
</summary>
<param name="LayerHandle">The handle of the drawing layer created with AxMap.NewDrawing call.</param>
<param name="xPoints">An array containing x-coordinates for each point in the polygon.</param>
<param name="yPoints">An array containing y-coordinates for each point in the polygon.</param>
<param name="numPoints">The number of points in the polygon.</param>
<param name="Color">The color to use when drawing the polygon. This is a UInt32 representation of an RGB color.</param>
<param name="fill">A boolean value representing whether the polygon is drawn with a fill or not.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.DrawWideCircle(System.Double,System.Double,System.Double,System.UInt32,System.Boolean,System.Int16)">
<summary>
Draws a circle with custom outline width on the last drawing layer created by NewDrawing.
</summary>
<param name="x">Center x coordinate for the circle to be drawn.</param>
<param name="y">Center y coordinate for the circle to be drawn.</param>
<param name="pixelRadius">Radius in pixels of the circle to be drawn.</param>
<param name="Color">Color of the circle to be drawn. This is a UInt32 representation of an RGB color.</param>
<param name="fill">Boolean value which determines whether the circle will be drawn with a fill or not.</param>
<param name="Width">The width of the outline.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.DrawWideCircleEx(System.Int32,System.Double,System.Double,System.Double,System.UInt32,System.Boolean,System.Int16)">
<summary>
Draws a circle with custom outline width on the specified drawing layer.
</summary>
<param name="LayerHandle">The handle of the drawing layer created with AxMap.NewDrawing call.</param>
<param name="x">Center x coordinate for the circle to be drawn.</param>
<param name="y">Center y coordinate for the circle to be drawn.</param>
<param name="radius">Radius in pixels of the circle to be drawn.</param>
<param name="Color">Color of the circle to be drawn. This is a UInt32 representation of an RGB color.</param>
<param name="fill">Boolean value which determines whether the circle will be drawn with a fill or not.</param>
<param name="OutlineWidth">The width of the outline.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.DrawWidePolygon(System.Object@,System.Object@,System.Int32,System.UInt32,System.Boolean,System.Int16)">
<summary>
Draws a polygon with custom width of outline on the last drawing layer created using NewDrawing.
</summary>
<param name="xPoints">An array containing x-coordinates for each point in the polygon.</param>
<param name="yPoints">An array containing y-coordinates for each point in the polygon.</param>
<param name="numPoints">The number of points in the polygon.</param>
<param name="Color">The color to use when drawing the polygon. This is a UInt32 representation of an RGB color.</param>
<param name="fill">A boolean value representing whether the polygon is drawn with a fill or not.</param>
<param name="Width">The width of the outline.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.DrawWidePolygonEx(System.Int32,System.Object@,System.Object@,System.Int32,System.UInt32,System.Boolean,System.Int16)">
<summary>
Draws a polygon with custom width of outline on the last drawing layer created using NewDrawing.
</summary>
<param name="LayerHandle">The handle of the drawing layer created with AxMap.NewDrawing call.</param>
<param name="xPoints">An array containing x-coordinates for each point in the polygon.</param>
<param name="yPoints">An array containing y-coordinates for each point in the polygon.</param>
<param name="numPoints">The number of points in the polygon.</param>
<param name="Color">The color to use when drawing the polygon. This is a UInt32 representation of an RGB color.</param>
<param name="fill">A boolean value representing whether the polygon is drawn with a fill or not.</param>
<param name="OutlineWidth">The width of the outline.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.NewDrawing(MapWinGIS.tkDrawReferenceList)">
<summary>
Creates a new drawing layer on the map returning its handle.
</summary>
<param name="Projection">Sets the coordinate system to use for the new drawing layer to be created. (ScreenReferenced
uses pixels in screen coordinates. SpatiallyReferenced uses projected map units.)</param>
<returns>The handle for the new drawing layer in the map.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.get_DrawingKey(System.Int32)">
<summary>
Gets the drawing key which may be used by the programmer to store any string for a drawing layer with specified handle.
</summary>
<param name="DrawHandle">The handle of the drawing layer.</param>
<returns>The string associated with the layer.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_DrawingKey(System.Int32,System.String)">
<summary>
Sets the drawing key may be used by the programmer to store any string for a drawing layer with specified handle.
</summary>
<param name="DrawHandle">The handle of the drawing layer.</param>
<param name="newValue">The string associated with the layer.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.SetDrawingLayerVisible(System.Int32,System.Boolean)">
<summary>
Sets the boolean value which indicates whether the labels of the drawing layer are visible.
</summary>
<param name="LayerHandle">The handle of the drawing layer.</param>
<param name="Visible">A boolean value which indicates whether the labels are visible.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.ClearDrawingLabels(System.Int32)">
<summary>
Clears labels on the specified drawing layer.
</summary>
<param name="DrawHandle">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_DrawingLabelsVisible(System.Int32)">
<summary>
Gets a boolean value which indicates whether labels of the drawing layer are visible.
</summary>
<remarks>This property corresponds to the Labels.Visible property.</remarks>
<param name="DrawHandle">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<returns>True in case labels are visible and false otherwise.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_DrawingLabelsVisible(System.Int32,System.Boolean)">
<summary>
Sets a boolean value which indicates whether labels of the drawing layer are visible.
</summary>
<remarks>This property corresponds to the Labels.Visible property.</remarks>
<param name="DrawHandle">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<param name="newValue">True in case labels are visible and false otherwise.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.DrawLabel(System.String,System.Double,System.Double,System.Double)">
<summary>
Draws a label on the current drawing layer.
</summary>
<param name="Text">Text of the label.</param>
<param name="x">X coordinate, in either screen or map units depending on the parameters of AxMap.NewDrawing used to create the layer.</param>
<param name="y">Y coordinate, in either screen or map units depending on the parameters of AxMap.NewDrawing used to create the layer.</param>
<param name="Rotation">Rotation angle in degrees.</param>
<returns>Layer handle if the label was added successfully or -1 on failure.</returns>
\new493 Added in version 4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap.DrawLabelEx(System.Int32,System.String,System.Double,System.Double,System.Double)">
<summary>
Draws a label on the specified drawing layer.
</summary>
<param name="DrawHandle">Handle of the layer.</param>
<param name="Text">Text of the label.</param>
<param name="x">X coordinate, in either screen or map units depending on the parameters of AxMap.NewDrawing used to create the layer.</param>
<param name="y">Y coordinate, in either screen or map units depending on the parameters of AxMap.NewDrawing used to create the layer.</param>
<param name="Rotation">Rotation angle in degrees.</param>
<returns>Layer handle if the label was added successfully or -1 on failure.</returns>
\new493 Added in version 4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap.get_ShapeLayerDrawFill(System.Int32)">
\addtogroup map_shapefile Shapefile visualization
Here is a list of properties for changing appearance of shapefile layer added to the map.
Consider the usage of ShapeDrawingOptions class to access wider set of options.
See Shapefile.DefaultDrawingOptions for details. This module is a part of the documentation of AxMap class.
\dot
digraph map_shapefile {
splines = true;
node [shape= "polygon", fontname=Helvetica, fontsize=9, style = filled, color = palegreen, height = 0.3, width = 1.2];
lb [ label="AxMap" URL="\ref AxMap"];
node [shape = "ellipse", color = khaki, width = 0.2, height = 0.2, style = filled]
gr [label="Shapefile visualization" URL="\ref map_shapefile"];
edge [ arrowhead="open", style = solid, arrowsize = 0.6, fontname = "Arial", fontsize = 9, fontcolor = blue, color = "#606060" ]
lb -> gr;
}
\enddot
<a href = "diagrams.html">Graph description</a>
@{
<summary>
Gets whether the specified layer is drawn with a fill. Only works on polygon shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer for which the fill is to be set.</param>
<returns>Gets whether the layer is being drawn with a fill or not.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_ShapeLayerDrawFill(System.Int32,System.Boolean)">
<summary>
Sets whether the specified layer is drawn with a fill. Only works on polygon shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer for which the fill is to be set. </param>
<param name="newValue">Sets whether the layer is drawn with a fill or not.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_ShapeLayerDrawLine(System.Int32)">
<summary>
Gets whether the lines for the shapefile in specified layer are drawn.
</summary>
<param name="LayerHandle">Handle of the layer to test if it is being drawn with a lines or not.</param>
<returns>Gets whether the layer is being drawn with lines or not.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_ShapeLayerDrawLine(System.Int32,System.Boolean)">
<summary>
Sets whether the lines for the shapefile in specified layer are drawn.
</summary>
<param name="LayerHandle">Handle of the layer for which the lines are to be set.</param>
<param name="newValue">Sets whether the layer is drawn with lines or not.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_ShapeLayerDrawPoint(System.Int32)">
<summary>
Gets whether the points/vertices for the shapefile in specified layer are drawn.
</summary>
<param name="LayerHandle">Handle of the layer to test if it is being drawn with a points or not.</param>
<returns>Gets whether the layer is being drawn with points or not.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_ShapeLayerDrawPoint(System.Int32,System.Boolean)">
<summary>
Sets whether the points/vertices for the shapefile in specified layer are drawn.
</summary>
<param name="LayerHandle">Handle of the layer for which the points are to be set.</param>
<param name="newValue">Sets whether the layer is drawn with points or not.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_ShapeLayerFillColor(System.Int32)">
<summary>
Gets the fill color for the specified layer. Only works on polygon shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer for which the fill color is required. </param>
<returns>Fill color for the polygon shapefile.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_ShapeLayerFillColor(System.Int32,System.UInt32)">
<summary>
Sets the fill color for the specified layer. Only works on polygon shapefiles
</summary>
<param name="LayerHandle">Handle of the layer for which the fill color is to be set.</param>
<param name="newValue">Fill color for the polygon shapefile. This is a System.UInt32 representation of an RGB color.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_ShapeLayerFillStipple(System.Int32)">
<summary>
Gets the fill stipple for the specified layer. Only works on polygon shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer for which the fill stipple is required. </param>
<returns>Gets the fill stipple for the specified layer.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_ShapeLayerFillStipple(System.Int32,MapWinGIS.tkFillStipple)">
<summary>
Sets the fill stipple for the specified layer. Only works on polygon shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer for which the fill stipple is to be set.</param>
<param name="newValue">Sets fill stipple for the specified layer.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_ShapeLayerFillTransparency(System.Int32)">
<summary>
Gets the percentage of fill transparency for the specified layer. Only works on polygon shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer to get percentage of fill transparency. </param>
<returns>Gets the percentage of fill transparency for the specified layer.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_ShapeLayerFillTransparency(System.Int32,System.Single)">
<summary>
Sets the percentage of fill transparency for the specified layer. Only works on polygon shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer for which the fill transparency is to be set. </param>
<param name="newValue">Sets the percentage of fill transparency for the specified layer.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_ShapeLayerLineColor(System.Int32)">
<summary>
Gets the line color for the specified layer. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer for which the line color is required. </param>
<returns>Line color for the polygon shapefile. </returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_ShapeLayerLineColor(System.Int32,System.UInt32)">
<summary>
Sets the line color for the specified layer. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer for which the line color is to be set.</param>
<param name="newValue">Line color for the polygon shapefile. This is a System.UInt32 representation of an RGB color.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_ShapeLayerLineStipple(System.Int32)">
<summary>
Gets the line stipple for the specified layer. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer for which the line stipple is required.</param>
<returns>Line stipple for the shapefile.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_ShapeLayerLineStipple(System.Int32,MapWinGIS.tkLineStipple)">
<summary>
Sets the line stipple for the specified layer. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer for which the line stipple is required.</param>
<param name="newValue">Line stipple for the shapefile.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_ShapeLayerLineWidth(System.Int32)">
<summary>
Gets the line width for the specified layer. Only works on shapefiles.
Suggested values for line width: 1 - 5
</summary>
<param name="LayerHandle">Handle of the layer for which the line width is required.</param>
<returns>Line width for the shapefile.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_ShapeLayerLineWidth(System.Int32,System.Single)">
<summary>
Sets the line width for the specified layer. Only works on shapefiles.
Suggested values for line width: 1 - 5
</summary>
<param name="LayerHandle">Handle of the layer for which the line width is to be set.</param>
<param name="newValue">Line width for the shapefile.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_ShapeLayerPointColor(System.Int32)">
<summary>
Gets the point color for the specified layer. Only works on shapefiles
</summary>
<param name="LayerHandle">Handle of the layer for which the point color is required. </param>
<returns>Point color for the polygon shapefile. </returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_ShapeLayerPointColor(System.Int32,System.UInt32)">
<summary>
Sets the point color for the specified layer. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer for which the point color is to be set.</param>
<param name="newValue">Point color for the polygon shapefile. This is a System.UInt32 representation of an RGB color.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_ShapeLayerPointSize(System.Int32)">
<summary>
Gets the line point/vertex size for the specified layer. Only works on shapefiles.
</summary>
<param name="LayerHandle">Gets or sets the line point/vertex size for the specified layer. Only works on shapefiles. </param>
<returns>Point/vertex size for the shapefile. </returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_ShapeLayerPointSize(System.Int32,System.Single)">
<summary>
Sets the line point/vertex size for the specified layer. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer for which the point/vertex size is to be set.</param>
<param name="newValue">Point/vertex size for the shapefile.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_ShapeLayerPointType(System.Int32)">
<summary>
Gets the line point type for the specified layer. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer for which the point type is required.</param>
<returns>%Point type for the shapefile.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_ShapeLayerPointType(System.Int32,MapWinGIS.tkPointType)">
<summary>
Sets the line point type for the specified layer. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer for which the point type is to be set.</param>
<param name="newValue">%Point type for the shapefile.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.get_ShapeLayerStippleColor(System.Int32)">
<summary>
Gets the color of the polygon stipple for shapefile layer.
</summary>
<remarks>This property corresponds to the ShapeDrawingOptions.FillHatchStyle property.</remarks>
<param name="LayerHandle">The handle of the shapefile layer.</param>
<returns>The color of stipple.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_ShapeLayerStippleColor(System.Int32,System.UInt32)">
<summary>
Sets the color of the polygon stipple for shapefile layer.
</summary>
<remarks>This property corresponds to the ShapeDrawingOptions.FillBgTransparent property.</remarks>
<remarks>This property corresponds to the ShapeDrawingOptions.FillHatchStyle property.</remarks>
<param name="LayerHandle">The handle of the shapefile layer.</param>
<param name="newValue">The color of stipple.</param>
\see Shapefile.DefaultDrawingOptions
</member>
<member name="M:AxMapWinGIS.AxMap.get_ShapeLayerStippleTransparent(System.Int32)">
<summary>
Gets a boolean value which indicates whether the background of fill stipple for polygon shapefile layer will be transparent.
</summary>
<remarks>This property corresponds to the ShapeDrawingOptions.FillBgTransparent property.</remarks>
<param name="LayerHandle">The handle of the shapefile layer.</param>
<returns>True in case the background is transparent and false otherwise.</returns>
</member>
<member name="M:AxMapWinGIS.AxMap.set_ShapeLayerStippleTransparent(System.Int32,System.Boolean)">
<summary>
Sets a boolean value which indicates whether the background of fill stipple for polygon shapefile layer will be transparent.
</summary>
<remarks>This property corresponds to the ShapeDrawingOptions.FillBgTransparent property.</remarks>
<param name="LayerHandle">The handle of the shapefile layer.</param>
<param name="newValue">True in case the background is transparent and false otherwise.</param>
</member>
<member name="M:AxMapWinGIS.AxMap.SetGeographicExtents2(System.Double,System.Double,System.Double)">
\addtogroup map_extents Max extents and zoom
Here is list of properties and methods that affect map extents and zoom level. This module is a part of the documentation of AxMap class.
\dot
digraph map_extents {
splines = true;
node [shape= "polygon", fontname=Helvetica, fontsize=9, style = filled, color = palegreen, height = 0.3, width = 1.2];
lb [ label="AxMap" URL="\ref AxMap"];
node [shape = "ellipse", color = khaki, width = 0.2, height = 0.2, style = filled]
gr [label="Map extents adn zoom" URL="\ref map_extents"];
edge [ arrowhead="open", style = solid, arrowsize = 0.6, fontname = "Arial", fontsize = 9, fontcolor = blue, color = "#606060" ]
lb -> gr;
}
\enddot
<a href = "diagrams.html">Graph description</a>
@{
<summary>
Sets geographic extents for the map.
</summary>
<param name="xLongitude">Longitude of center of the screen (degrees).</param>
<param name="yLatitude">Latitude of center of the screen (degrees).</param>
<param name="widthKilometers">Width of displayed extents in kilometres.</param>
<remarks>Projection for the must be specified in order for this method to work.</remarks>
<returns>True on success.</returns>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.GetKnownExtents(MapWinGIS.tkKnownExtents)">
<summary>
Gets known extents.
</summary>
<param name="extents">Known extents to retrieve.</param>
<returns>Extents object.</returns>
\new491 Added in version 4.9.1
</member>
<member name="P:AxMapWinGIS.AxMap.GeographicExtents">
<summary>
Gets geographic extents of the map in decimal degrees.
</summary>
<remarks>For operation to succeed, projection must be set for the map (see AxMap.GeoProjection property).
Otherwise null will be returned.</remarks>
\new490 Added in version 4.9.0
</member>
<member name="M:AxMapWinGIS.AxMap.SetGeographicExtents(MapWinGIS.Extents)">
<summary>
Sets geographic extents in decimal degrees for the map.
</summary>
<param name="pVal">Geographic extents in decimal degrees.</param>
<returns>True on success.</returns>
<remarks>For operation to succeed, projection must be set for the map (see AxMap.GeoProjection property)</remarks>
\new490 Added in version 4.9.0
</member>
<member name="P:AxMapWinGIS.AxMap.Latitude">
<summary>
Gets or sets latitude of the center of screen (in decimal degrees).
</summary>
<remarks>Map projection must be set in order for this property to work.</remarks>
\new491 Added in version 4.9.1
</member>
<member name="P:AxMapWinGIS.AxMap.Longitude">
<summary>
Gets or sets longitude of the center of screen (in decimal degrees).
</summary>
<remarks>Map projection must be set in order for this property to work.</remarks>
\new491 Added in version 4.9.1
</member>
<member name="P:AxMapWinGIS.AxMap.CurrentZoom">
<summary>
Gets or sets the current zoom level for the map. It corresponds to the zoom level of current tile provider.
</summary>
<remarks>Map projection must be set in order for this property to work.</remarks>
\new491 Added in version 4.9.1
</member>
<member name="P:AxMapWinGIS.AxMap.KnownExtents">
<summary>
Gets or sets known extents for the map.
</summary>
<remarks>Map projection must be set in order for this property to work.</remarks>
\new491 Added in version 4.9.1
</member>
<member name="P:AxMapWinGIS.AxMap.CurrentScale">
<summary>
Gets or sets the current map scale.
</summary>
<remarks>The scale depends on the AxMap.MapUnits property. Number of pixels per logical inch and the size of window are used to
determine the size of the displaying device. The calculations represent the closest approximation as there is no way
to determine the physical size of displaying device. The operation of setting the new scale preserve the map coordinates
of the center point on the screen.</remarks>
\new48 Added in version 4.8
</member>
<member name="P:AxMapWinGIS.AxMap.ExtentHistory">
<summary>
Gets or sets the number of extents to cache in the extents history
</summary>
</member>
<member name="P:AxMapWinGIS.AxMap.ExtentPad">
<summary>
Gets or sets the percentage of the view used to pad the extents of a layer when zooming to a layer or maximum extents.
</summary>
<remarks>
Padding makes it so that there is a small border around the layer when you zoom to it.</remarks>
</member>
<member name="P:AxMapWinGIS.AxMap.Extents">
<summary>
Gets or sets the extents of the map using an Extents object.
</summary>
<remarks>If the given extents do not fit the aspect ratio of the map, the map will fit the given extents as well as possible.</remarks>
\new495 Return value changed to IExtents in version 4.9.5
</member>
<member name="P:AxMapWinGIS.AxMap.MaxExtents">
<summary>
Gets or sets the extents of the map displayed by the control.
</summary>
</member>
<member name="P:AxMapWinGIS.AxMap.Measuring">
\addtogroup map_coordinates Map projection and coordinates
Here is list of properties and methods which are related to coordinate system, projection of map and units conversion.
This module is a part of the documentation of AxMap class.
\dot
digraph map_projection {
splines = true;
node [shape= "polygon", fontname=Helvetica, fontsize=9, style = filled, color = palegreen, height = 0.3, width = 1.2];
lb [ label="AxMap" URL="\ref AxMap"];
node [shape = "ellipse", color = khaki, width = 0.2, height = 0.2, style = filled]
gr [label="Max projection and coordianates" URL="\ref map_coordinates"];
edge [ arrowhead="open", style = solid, arrowsize = 0.6, fontname = "Arial", fontsize = 9, fontcolor = blue, color = "#606060" ]
lb -> gr;
}
\enddot
<a href = "diagrams.html">Graph description</a>\n\n
\anchor a_projection
\section proj1 A. Setting projection for the map.
No matter what type of GIS application you are going to write, the decision about map coordinate system and projection is one of the first to be made.
MapWinGIS provides the following options.
\dot
digraph projection_options {
splines = true;
ranksep = 0.15;
nodesep = 0.5;
node [shape = oval, peripheries = 1, fontname=Helvetica, fontsize=9, fillcolor = gray, color = "gray", style = filled, height = 0.3, width = 0.8];
render [ label="Choosing map projection"];
node [shape = "note", width = 0.3, height = 0.3, peripheries = 1 fillcolor = "khaki" ]
s1 [label=" Set projection manullay\l"];
s2 [label=" Grab projection from data\l"];
s3 [label=" Don't use projection at all\l"];
edge [dir = none, arrowhead="open", style = solid, arrowsize = 0.6, fontname = "Arial", fontsize = 9, fontcolor = blue, color = "#808080" minlen=2 ]
render -> s1;
render -> s2;
render -> s3;
}
\enddot
Let's consider each of the approaches.
<b>1. Settings projection manually.</b> \n\n
It can be done using one of the following approaches:\n\n
a) AxMap.Projection property - provides only most common projections (Spherical Mercator, WGS84) but available in Properties Window of Form designer.
\code
axMap1.Projection = tkMapProjection.PROJECTION_WGS84;
\endcode
b) For all other projections - GeoProjection class and AxMap.GeoProjection property:
\code
var gp = new GeoProjection();
// one of the following methods can be used; see more in GeoProjection class
// - use projections provided by MapWinGIS enumerations:
gp.SetWgs84Projection(tkWgs84Projection.Wgs84_UTM_zone_22N);
gp.SetWellKnownGeogCS(tkCoordinateSystem.csNAD83);
// - EPSG code of coordinate system; in this example Pulkovo 1942(83) / 3-degree Gauss-Kruger zone 5; see wwww.spatialreference.org for EPSG codes
gp.ImportFromEPSG(2399);
// - importing from proj4 or WKT string; in this example proj4 string for Amersfoort / RD New projection for Netherlands
gp.ImportFromAutoDetect("+proj=sterea +lat_0=52.15616055555555 +lon_0=5.38763888888889 +k=0.9999079 +x_0=155000 +y_0=463000 +ellps=bessel +units=m +no_defs ");
// applying projection
axMap1.GeoProjection = gp;
\endcode
<b>2. Grabbing coordinate system and projection from data.</b>
\code
axMap1.GrabProjectionFromData = true; // default value
axMap1.AddLayerFromFilename(@"d:\some_shapefile.shp", tkFileOpenStrategy.fosVectorLayer, true);
\endcode
GeoProjection will be taken from the first layer added to the map which has metadata about projection. AxMap.GeoProjection property will be updated from this metadata.
When last layer is removed from map AxMap.GeoProjection property will be cleared (set to empty projection).
<b>3. Don't specify coordinate system at all.\n</b>
- AxMap.Projection property is equal to PROJECTION_NONE (the default value);
- map units should be set manually via AxMap.MapUnits;
- calculation of distance and area will use Euclidean geometry with no account to the shape of Earth;
- it won't be possible to display tiles from TMS servers.
To setup map to work without geoprojection use the code:
\code
axMap1.Projection = tkMapProjection.PROJECTION_NONE;
axMap1.GrabProjectionFromData = false;
axMap1.MapUnits = tkUnitsOfMeasure.umMeters; // or another, depending on the data you display
\endcode
\section proj2 B. Interaction with already set projection
To check that map actually has a projection:
\code
Debug.WriteLine("Map has projection:" + (axMap1.Projection != tkMapProjection.PROJECTION_NONE));
// or with mode details
Debug.WriteLine("Projection of the map: " + (axMap1.GeoProjection.IsEmpty() ? "None" : axMap1.GeoProjection.ExportToWKT());
\endcode
Another way to check whether map has geoprojection is to see how coordinates are displayed when AxMap.ShowCoordinates is set to cdmAuto.
In case decimal degrees are displayed (Lat/Lng) - map has geoprojection, if x/y pair is shown - no geoprojection was set.
All of these methods will result in updating AxMap.GeoProjection property. GeoProjection object assigned to map is protected from changes,
i.e. GeoProjection.IsFrozen = true. To change already assigned projection, a new instance of GeoProjection object must be created:
\code
// this one will fail, because projection is frozen
if (!axMap1.GeoProjection.ImportFromEPSG(2399))
{
Debug.WriteLine("Projection wasn't set: " + axMap1.GeoProjection.get_ErrorMsg(axMap1.GeoProjection.LastErrorCode));
}
// this one will succeed as a new GeoProjection instance is created by Clone method:
var gp = axMap1.GeoProjection.Clone();
if (gp.ImportFromEPSG(2399))
{
axMap1.GeoProjection = gp;
}
\endcode
Regardless of the method for settings projection MapWinGIS will update AxMap.MapUnits. IF coordinate system is geographic one umDecimalDegrees
will be set, otherwise umMeters. This will ensure that scalebar and measuring will work correctly.
\section proj3 C. Choosing projection
When making decision about coordinate system and projection consider:\n\n
1. Whether it's important to display tiles from online services. Most TMS servers use Shperical Mercator projection (EPSG:3857),
therefore to avoid distortions of tiles map projection should be set to GoogleMercator as well:
\code
axMap1.Projection = tkMapProjection.PROJECTION_GOOGLE_MERCATOR;
\endcode
\note See more details on the issue in description of Tiles class.\n\n
2. What data you plan to display and what projection it's using. It's possible to do a reprojection with:
- Utils.ReprojectShapefile for shapefiles;
- Utils.GDALWarp for images and grids.
But it should be considered whether it is worth the effort.
Starting from version 4.9.2. built-in projection mismatch testing is implemented + optional
transformation for shapefiles. See GlobalSettings.AllowProjectionMismatch, GlobalSettings.ReprojectLayersOnAdding.
@{
<summary>
Gets measuring object associated with map.
</summary>
\new491 Added in version 4.9.1
</member>
<member name="P:AxMapWinGIS.AxMap.MapUnits">
<summary>
Gets or sets the units of measure for the map.
</summary>
<remarks>This units must be the same as the units of the datasources being displayed.
This method affects the calculation of map scale (see AxMap.CurrentScale).</remarks>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.PixelToProj(System.Double,System.Double,System.Double@,System.Double@)">
<summary>
Converts pixel coordinates to projected map coordinates
</summary>
<param name="pixelX">The x pixel coordinate to be converted into the projected x map coordinate.</param>
<param name="pixelY">The y pixel coordinate to be converted into the projected y map coordinate</param>
<param name="projX">The projected x map coordinate is returned through this reference parameter.</param>
<param name="projY">The projected y map coordinate is returned through this reference parameter.</param>
</member>
<member name="P:AxMapWinGIS.AxMap.PixelsPerDegree">
<summary>
Gets the number of screen pixels per the decimal degree of the data.
</summary>
<remarks>The set part of this property isn't supported. The correctness of results depends on AxMap.MapUnits property.</remarks>
\new48 Added in version 4.8
</member>
<member name="M:AxMapWinGIS.AxMap.ProjToPixel(System.Double,System.Double,System.Double@,System.Double@)">
<summary>
Converts projected map coordinates into screen pixel units
</summary>
<param name="projX">The projected x map coordinate to be converted into the x pixel coordinate.</param>
<param name="projY">The projected y map coordinate to be converted into the y pixel coordinate.</param>
<param name="pixelX">The pixel x coordinate is returned through this reference parameter</param>
<param name="pixelY">The pixel y coordinate is returned through this reference parameter.</param>
</member>
<member name="P:AxMapWinGIS.AxMap.ShowCoordinates">
<summary>
Gets or sets a value indicating whether coordinates of the current mouse position will be displayed on map.
</summary>
\new491 Added in version 4.9.1
</member>
<member name="P:AxMapWinGIS.AxMap.ScalebarVisible">
<summary>
Gets or sets a value which indicate whether scalebar will be displayed on the map.
</summary>
\new490 Added in version 4.9.0
</member>
<member name="P:AxMapWinGIS.AxMap.ScalebarUnits">
<summary>
Gets or sets units to be displayed for map scalebar.
</summary>
\new491 Added in version 4.9.1
</member>
<member name="P:AxMapWinGIS.AxMap.GrabProjectionFromData">
<summary>
Gets or sets a value indicating whether projection for will be taken from the first datasource added to it.
</summary>
<remarks>If set to true projection will be taken from the first layer added to the map which has a projection.
On removing the last layer projection of the map will be cleared (set to an empty one).</remarks>
\new491 Added in version 4.9.1
</member>
<member name="P:AxMapWinGIS.AxMap.Projection">
<summary>
Sets projection of the map. It providers 2 most commonly used coordinate system/projections to be easily set from Form Designer.
To set other projections initialize GeoProjection object manually and use AxMap.GeoProjection property.
</summary>
<remarks></remarks>
\new491 Added in version 4.9.1
</member>
<member name="P:AxMapWinGIS.AxMap.GeoProjection">
<summary>
Gets or sets projection for map.
</summary>
<remarks>Projection layered set to map must not be changed, but rather a new instance
of GeoProjection should be created (GeoProjection.Clone) and set to the property.
This property must be set in order for certain functionality to work (tiles, for example).</remarks>
\new490 Added in version 4.9.0
</member>
<member name="M:AxMapWinGIS.AxMap.ProjToDegrees(System.Double,System.Double,System.Double@,System.Double@)">
<summary>
Converts projected map coordinates to decimal degrees (map projection must be specified for this method to work).
</summary>
<param name="projX">Projected X map coordinate.</param>
<param name="projY">Projected Y map coordinate.</param>
<param name="degreesLngX">Converted longitude in decimal degrees</param>
<param name="degreesLatY">Converted latitude in decimal degrees</param>
<returns>True on success.</returns>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.PixelToDegrees(System.Double,System.Double,System.Double@,System.Double@)">
<summary>
Converts coordinates in decimal degrees to pixel coordinates (map projection must be specified for this method to work).
</summary>
<param name="pixelX">X screen coordinate.</param>
<param name="pixelY">Y screen coordinate.</param>
<param name="degreesLngX">Converted longitude in decimal degrees</param>
<param name="degreesLatY">Converted latitude in decimal degrees</param>
<returns>True on success.</returns>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.DegreesToProj(System.Double,System.Double,System.Double@,System.Double@)">
<summary>
Converts coordinates in decimal degrees to projected map coordinates (map projection must be specified for this method to work).
</summary>
<param name="degreesLngX">Longitude in decimal degrees.</param>
<param name="degreesLatY">Latitude in decimal degrees.</param>
<param name="projX">Resulting projected X map coordinate.</param>
<param name="projY">Resulting Projected Y map coordinate.</param>
<returns>True on success.</returns>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.DegreesToPixel(System.Double,System.Double,System.Double@,System.Double@)">
<summary>
Converts pixel coordinates to decimal degrees (map projection must be specified for this method to work).
</summary>
<param name="degreesLngX">Longitude in decimal degrees.</param>
<param name="degreesLatY">Latitude in decimal degrees.</param>
<param name="pixelX">Converted X screen coordinate.</param>
<param name="pixelY">Converted Y screen coordinate.</param>
<returns>True on success.</returns>
\new491 Added in version 4.9.1
</member>
<member name="M:AxMapWinGIS.AxMap.GeodesicArea(MapWinGIS.Shape)">
<summary>
Calculates area of polygon taking into account the shape of Earth.
</summary>
<remarks>For the time being only single-part polygons are accepted as input. Calculation are made using
<a href = "http://geographiclib.sourceforge.net/html/">GeographicLib</a>.</remarks>
<param name="polygon">Single part polygon shape defined in coordinates of map.</param>
<returns>Area of shape in square meters or 0.0 if current map projection doesn't support transformation to WGS84.</returns>
\new493 Added in version 4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap.GeodesicDistance(System.Double,System.Double,System.Double,System.Double)">
<summary>
Calculates geodesic distance between 2 points defined in map coordinate system.
</summary>
<remarks>To calculate geodesic distance between 2 points in screen coordinates use AxMap.PixelToProj first.
Calculation are made using <a href = "http://geographiclib.sourceforge.net/html/">GeographicLib</a>.</remarks>
<param name="projX1">X coordinate of the first point.</param>
<param name="projY1">Y coordinate of the first point.</param>
<param name="projX2">X coordinate of the second point.</param>
<param name="projY2">Y coordinate of the second point.</param>
<returns>Distance between 2 points in meters 0.0 if current map projection doesn't support transformation to WGS84</returns>
\new493 Added in version 4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap.GeodesicLength(MapWinGIS.Shape)">
<summary>
Calculates length of polyline or perimeter of polygon taking into account the shape of Earth.
</summary>
<remarks>For the time being only single-part shapes are accepted as input. Calculation are made using
<a href = "http://geographiclib.sourceforge.net/html/">GeographicLib</a>.</remarks>
<param name="polyline">Single part polygon or polyline shape defined in coordinates of map.</param>
<returns>Length of polyline or perimeter of polygon in meters or 0.0 if current map projection doesn't support transformation to WGS84.</returns>
\new493 Added in version 4.9.3
</member>
<member name="E:AxMapWinGIS.AxMap.AfterDrawing">
\addtogroup map_events Map events
\dot
digraph map_events_graph {
splines = true;
node [shape= "polygon", fontname=Helvetica, fontsize=9, style = filled, color = palegreen, height = 0.3, width = 1.2];
lb [ label="AxMap" URL="\ref AxMap"];
node [shape = "ellipse", color = gray, width = 0.2, height = 0.2, style = filled]
gr [label="Map events" URL="\ref map_events"];
edge [ arrowhead="open", style = solid, arrowsize = 0.6, fontname = "Arial", fontsize = 9, fontcolor = blue, color = "#606060" ]
lb -> gr;
}
\enddot
<a href = "diagrams.html">Graph description</a>
@{
<summary>
This event is fired after the rendering of drawing layers. Handle of device context is passed to allow the user to implement custom drawing.
</summary>
<param name="hdc">Handle of device context of screen buffer.</param>
<param name="xMin">Minimum X coordinate of the rectangle being rendered.</param>
<param name="xMax">Maximum X coordinate of the rectangle being rendered.</param>
<param name="yMin">Minimum Y coordinate of the rectangle being rendered.</param>
<param name="yMax">Maximum Y coordinate of the rectangle being rendered.</param>
<param name="handled">Passed by reference.
The value should be set to blnTrue in case some additional drawing is performed in client code.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.AfterLayers">
<summary>
This event is fired after the rendering of standard layers. Handle of device context is passed to allow the user to implement custom drawing.
</summary>
<param name="hdc">Handle of device context of screen buffer.</param>
<param name="xMin">Minimum X coordinate of the rectangle being rendered.</param>
<param name="xMax">Maximum X coordinate of the rectangle being rendered.</param>
<param name="yMin">Minimum Y coordinate of the rectangle being rendered.</param>
<param name="yMax">Maximum Y coordinate of the rectangle being rendered.</param>
<param name="handled">Passed by reference.
The value should be set to blnTrue in case some additional drawing is performed in client code.</param>
\new495 Added in version 4.9.5
</member>
<member name="E:AxMapWinGIS.AxMap.AfterShapeEdit">
<summary>
This event is fired after interactive editing of shape is finished (AxMap.CursorMode is set to cmEditShape).
</summary>
<param name="operation">The type of editing operation that was performed.</param>
<param name="layerHandle">Handle of the layer the shape being edited belongs to.</param>
<param name="shapeIndex">Index of the shape withing layer.</param>
<remarks>The common use of the event is set attributes of the shape, update its label or style.
The operation parameter can be one of the following values: uoAddShape, uoRemoveShape, uoEditShape.</remarks>
</member>
<member name="E:AxMapWinGIS.AxMap.BackgroundLoadingFinished">
<summary>
This event is fired when background loading of data for OgrLayer.Finishes.
</summary>
<param name="taskId">Unique Id of the loading task.</param>
<param name="layerHandle">Handle of the layer the loading is peformed for.</param>
<param name="numFeatures">Number of features within current map extents.</param>
<param name="numLoaded">Number of features that were actually loaded.</param>
<remarks>The loading task may be finished without any features being loaded under the following circumstances:
- number of features within current extents is larger than GlobalSettings.OgrLayerMaxFeatureCount parameter;
- the extents of map have been changed since the loading was started so the data being loaded is no longer needed;
- there is a problem with accessing the datasource (e.g. lost network connection).\n
In case of failure, i.e. (numLoaded = 0) the event will be fired from background thread. In case
of success - from the main thread before the rendering of the loaded data.
</remarks>
</member>
<member name="E:AxMapWinGIS.AxMap.BackgroundLoadingStarted">
<summary>
This event is fired when background loading of data for OgrLayer starts.
</summary>
<param name="taskId">Unique Id of the loading task,
which can be tracked down in BackgroundLoadingFinished to determine the results of the operation.</param>
<param name="layerHandle">Handle of the layer loading starts for.</param>
<remarks>The event is fired after map extents change for each OgrLayer with OgrLayer.DynamicLoading proprety set to true,
when the layer doesn't have the necessary data in its buffer (OgrLayer.GetBuffer). The event can be used
to display some kind of loading indicator to notify the user that some data is still being loaded.</remarks>
</member>
<member name="E:AxMapWinGIS.AxMap.BeforeDeleteShape">
<summary>
This event is fired before shape is deleted in interactive Shape Editor.
</summary>
<param name="target">What element of shape (whole shape, part, single vertex) is to be deleted.</param>
<param name="cancel">Passed by reference. To cancel the operation this value should be set to blnTrue.</param>
<remarks>This event is fired when shape (or some of its elements) is selected in Shape Editor (AxMap.CursorMode = cmEditShape)
and user presses Delete button. The common use of his event is to display a message box asking the user whether
the operation should be performed.</remarks>
</member>
<member name="E:AxMapWinGIS.AxMap.BeforeDrawing">
<summary>
This event is fired before the rendering of drawing layers. Handle of device context is passed to allow the user to implement custom drawing.
</summary>
<param name="hdc">Handle of device context of screen buffer.</param>
<param name="xMin">Minimum X coordinate of the rectangle being rendered.</param>
<param name="xMax">Maximum X coordinate of the rectangle being rendered.</param>
<param name="yMin">Minimum Y coordinate of the rectangle being rendered.</param>
<param name="yMax">Maximum Y coordinate of the rectangle being rendered.</param>
<param name="handled">Passed by reference.
The value should be set to blnTrue in case some additional drawing is performed in client code.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.BeforeLayers">
<summary>
This event is fired before the rendering of standard layers. Handle of device context is passed to allow the user to implement custom drawing.
</summary>
<param name="hdc">Handle of device context of screen buffer.</param>
<param name="xMin">Minimum X coordinate of the rectangle being rendered.</param>
<param name="xMax">Maximum X coordinate of the rectangle being rendered.</param>
<param name="yMin">Minimum Y coordinate of the rectangle being rendered.</param>
<param name="yMax">Maximum Y coordinate of the rectangle being rendered.</param>
<param name="handled">Passed by reference.
The value should be set to blnTrue in case some additional drawing is performed in client code.</param>
\new495 Added in version 4.9.5
</member>
<member name="E:AxMapWinGIS.AxMap.BeforeShapeEdit">
<summary>
This event is fired before editing starts for particular shape (after user click on the shape when map cursor is set to cmEditShape).
</summary>
<param name="layerHandle">Handle of the layer the shape was selected from.</param>
<param name="shapeIndex">Index of shape to be edited.</param>
<param name="cancel">Passed by reference. Allows user to cancel the editing operations by setting the value to blnTrue.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.ChooseLayer">
<summary>
The event is fired when current map tool asks for the layer to work with.
</summary>
<param name="xProj">X coordinate of mouse click in map coordinates (if the event was triggered by mouse click).</param>
<param name="yProj">Y coordinate of mouse click in map coordinates (if the event was triggered by mouse click).</param>
<param name="layerHandle">Passed by reference. Handle of the layer to apply the tool to should be set.</param>
<remarks>LayerHadle parameter in most cases is initially set to -1, which means "layer not defined".
If this value is left unchanged the pending operation won't be preformed. Further details are provided
in description of particular tools.</remarks>
</member>
<member name="E:AxMapWinGIS.AxMap.DblClick">
<summary>
The event is fired when user performs double click with left mouse button while cursor is within the map control.
</summary>
</member>
<member name="E:AxMapWinGIS.AxMap.ExtentsChanged">
<summary>
This event is fired when the extents of the map change.
</summary>
</member>
<member name="E:AxMapWinGIS.AxMap.FileDropped">
<summary>
This event is fired when a user drags a file and drops it on the map.
</summary>
<param name="filename">The filename of the file dropped on the map.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.LayerAdded">
<summary>
This event is fired when a new layer has been added to the map.
</summary>
<param name="layerHandle">Handle of the newly added layer.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.LayerProjectionIsEmpty">
<summary>
This event is fired when a new layer has been added to the map and it has no metadata about its coordinate system and projection.
</summary>
<param name="layerHandle">Handle of the layer.</param>
<param name="cancelAdding">Passed by reference. The value should be set to blnTrue to cancel the adding operation.</param>
<remarks>If this event is not handled then decision about the layer will be taken based on
the value of GlobalSettings.AllowLayersWithoutProjections property.</remarks>
</member>
<member name="E:AxMapWinGIS.AxMap.LayerRemoved">
<summary>
This event is fired when a layer has been removed from map.
</summary>
<param name="layerHandle">Handle of the layer.</param>
<param name="fromRemoveAllLayers">The value will be set to true in case layer removal is caused by AxMap.RemoveAllLayers call.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.LayerReprojected">
<summary>
This event is fired after a layer was reprojected (its original projection was different from the map projection).
</summary>
<param name="layerHandle">Handle of the layer.</param>
<param name="success">True in case reprojection was peformed successfully. False</param>
<remarks>Automatic reprojection if peformed in case of projection mismatch for vector datasources.
Reprojected datasource will be represented by in-memory shapefile, no disk version will be saved automatically.
Raster datasource will be rejected without an attempt to reproject them.
The projection mismatch behavior is controlled by GlobalSettings.AllowProjectionMismatch,
GlobalSettings.ReprojectionLayerOnAdding properties.</remarks>
</member>
<member name="E:AxMapWinGIS.AxMap.MapStateEvent">
<summary>
This event is fired for each layer in the map when the map state is changed
</summary>
<param name="layerHandle">Handle of the layer.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.MeasuringChanged">
<summary>
This event is fired after the user adds or removes a point from the path of measuring tool.
</summary>
<param name="action">Particular action performed by user.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.MouseDownEvent">
<summary>
This event is fired when a user has pressed a mouse button while the cursor is inside the map control.
The map property SendMouseDown must be set to True for this event to be fired.
</summary>
<remarks> </remarks>
<param name="Button">Mouse button that was pressed.</param>
<param name="Shift">The shift/ctrl modifiers pressed during the creation of this event. </param>
<param name="x">X coordinate of mouse cursor position in pixels relative to control's origin.</param>
<param name="y">Y coordinate of mouse cursor position in pixels relative to control's origin.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.MouseMoveEvent">
<summary>
This event is fired when the mouse is moved while the cursor is inside the map control.
The map property SendMoveMouse must be set to True for this event to be fired.
</summary>
<param name="Button">Mouse button that was pressed.</param>
<param name="Shift">The shift/ctrl modifiers pressed during the creation of this event.</param>
<param name="x">X coordinate of mouse cursor position in pixels relative to control's origin.</param>
<param name="y">Y coordinate of mouse cursor position in pixels relative to control's origin.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.MouseUpEvent">
<summary>
This event is fired when the mouse button is released while the cursor is in the map control.
The map property SendMouseUp must be set to True for this event to be fired.
</summary>
<param name="Button">Mouse button that was pressed.</param>
<param name="Shift">The shift/ctrl modifiers pressed during the creation of this event.</param>
<param name="x">X coordinate of mouse cursor position in pixels relative to control's origin.</param>
<param name="y">Y coordinate of mouse cursor position in pixels relative to control's origin.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.OnDrawBackBuffer">
<summary>
This event is fired during the rendering of map after data layers and drawing layers were rendered.
The map property SendMouseUp SendOnDrawBackBuffer must be set to True for this event to be fired.
</summary>
<param name="BackBuffer">Handle of the device context of back buffer bitmap.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.ProjectionChanged">
<summary>
The event is fired when projection of the map control was changed.
</summary>
</member>
<member name="E:AxMapWinGIS.AxMap.ProjectionMismatch">
<summary>
This event is fired when a layer was added to the map with projection / coordinate system different from
those of the map control.
</summary>
<param name="layerHandle">Handle of the layer.</param>
<param name="cancelAdding">Passed by reference. The value should be set to blnTrue in case the adding of the layer should be cancelled.</param>
<param name="reproject">Passed by reference. The value should be set to blnTrue to instruct the control
to run automatic reprojection of the layer.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.SelectBoxDrag">
<summary>
This event is fired while the user is dragging a selection box in the map control.
The map property SendSelectBoxDrag must be set to True for this event to be fired.
</summary>
<param name="left">The left boundary of the selection box in pixel coordinates.</param>
<param name="right">The right boundary of the selection box in pixel coordinates.</param>
<param name="bottom">The bottom boundary of the selection box in pixel coordinates.</param>
<param name="top">The top boundary of the selection box in pixel coordinates.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.SelectBoxFinal">
<summary>
This event is fired when the user finishes dragging a selection box in the map control.
The map property SendSelectBoxFinal must be set to True for this event to be fired.
</summary>
<param name="left">The left boundary of the selection box in pixel coordinates.</param>
<param name="right">The right boundary of the selection box in pixel coordinates.</param>
<param name="bottom">The bottom boundary of the selection box in pixel coordinates.</param>
<param name="top">The top boundary of the selection box in pixel coordinates.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.SelectionChanged">
<summary>
This event is fired after shapes were selected with cmSelection tool.
</summary>
<param name="layerHandle">Handle of the layer the shapes were selected on.</param>
<remarks>The event will be fired only when selection is done by AxMap control internally, i.e.
- AxMap.CursorMode set to cmSelection;
- a layer handle is passed to AxMap.ChooseLayer event handler;
- user changes selection by clicking on shapes or drawing selection box.
When Shapefile.ShapeSelected property is changed from client code no event is fired.</remarks>
</member>
<member name="E:AxMapWinGIS.AxMap.ShapeHighlighted">
<summary>
This event is fired when mouse cursor is being moved by user and the cursor enters or leaves neighborhood of particular shape.
</summary>
<param name="layerHandle">Handle of the layer the shape belongs to.</param>
<param name="shapeIndex">Index of the shape.</param>
<remarks>The event is fired when:
- AxMap.CursorMode is set to cmIdentify tool or one of the editing tools (cmAddShape, cmEditShape, etc.);
- number shapes within visible extents is smaller than GlobalSettings.HotTrackingMaxShapeCount.
For cmIdentify tool the shape will be automatically highlighted (see AxMap.Identifier for details);
For editing cursors vertices of the shape under cursor will be displayed (see ShapeEditor.HighlightVertices property).
</remarks>
</member>
<member name="E:AxMapWinGIS.AxMap.ShapeIdentified">
<summary>
This event is fired when user click on a shape with cmIdentify tool active.
</summary>
<param name="layerHandle">Handle of the layer.</param>
<param name="shapeIndex">Index of the shape.</param>
<param name="projX">X coordinate of mouse click position in map coordinates.</param>
<param name="projY">Y coordinate of mouse click position in map coordinates</param>
</member>
<member name="E:AxMapWinGIS.AxMap.ShapeValidationFailed">
<summary>
This event is fired when shape being created or edited has topological errors and therefore can't be saved to the layer.
</summary>
<param name="errorMessage">Message about the reasons as to why the validation has failed.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.TilesLoaded">
<summary>
This event is fired when complete set of tiles has been loaded for the new map extents.
</summary>
<param name="snapshot">True in case the loading of tiles was done as a part of making snapshot of the map.</param>
<param name="key">A key of operation set in AxMap.LoadTilesForSnapshot method.</param>
</member>
<member name="E:AxMapWinGIS.AxMap.UndoListChanged">
<summary>
This event is fired when an operations is added or removed from undo/redo list of interactive Shape Editor.
</summary>
</member>
<member name="E:AxMapWinGIS.AxMap.ValidateShape">
<summary>
This event is fired before a shape which is being created or edited is about to be saved back to the layer.
</summary>
<param name="layerHandle">Handle of the layer.</param>
<param name="shape">Shape to be validated.</param>
<param name="cancel">Passed by reference. This value should be set to blnTrue in case shape don't pass custom validation.</param>
<remarks>Shape Editor performs its own validation determined by ShapeEditor.ValidationMode, so there is
no need to run the same checks once again here (like Shape.IsValid). However is some form of custom
rules should be enforced, there is a right place to do it.</remarks>
</member>
<member name="E:AxMapWinGIS.AxMap.GridOpened">
<summary>
This event is fired after grid datasource was added to the map.
</summary>
<param name="layerHandle">Handle of the layer.</param>
<param name="gridFilename">The filename of the original datasource.</param>
<param name="bandIndex">Index of band which is used for visualization.</param>
<param name="isUsingProxy">Whether the datasource is rendered by Image class directly or
by using an RBG image that was created to serve as proxy.</param>
</member>
<member name="T:AxMapWinGIS.AxMap_Deprecated">
<summary>
Holds members that once were a part of %AxMap class.
New API members to substitute deprecated ones are listed in description.
</summary>
</member>
<member name="P:AxMapWinGIS.AxMap_Deprecated.LineSeparationFactor">
<summary>
Gets or sets line separation factor.
</summary>
\deprecated v4.8. Use LinePattern class, and ShapeDrawingOptions.LinePattern property instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_UDFillStipple(System.Int32,System.Int32)">
<summary>
Gets one user defined stipple row.
</summary>
<remarks>The user defined fill stipple contains 32 rows of 32 bits. The stipple is created by
setting patterns in the bits contained in each row.</remarks>
<param name="LayerHandle">The handle of the layer for which the fill stipple is to be set. </param>
<param name="StippleRow">The row in the custom stipple for which the pattern is to be set. </param>
<returns>The custom fill stipple as an integer value where the stipple is defined
by arranging the 32 bits in desired pattern.</returns>
\deprecated v.4.8. Use ShapeDrawingOptions.FillHatchStyle instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_UDFillStipple(System.Int32,System.Int32,System.Int32)">
<summary>
Sets one user defined stipple row.
</summary>
<remarks>The user defined fill stipple contains 32 rows of 32 bits.
The stipple is created by setting patterns in the bits contained in each row.</remarks>
<param name="LayerHandle">The handle of the layer for which the fill stipple is to be set. </param>
<param name="StippleRow">The row in the custom stipple for which the pattern is to be set. </param>
<param name="newValue">The custom fill stipple as an integer value where the stipple is defined
by arranging the 32 bits in desired pattern</param>
\deprecated v.4.8. Use ShapeDrawingOptions.FillHatchStyle instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_UDLineStipple(System.Int32)">
<summary>
Gets the user defined line stipple for the specified layer.
</summary>
<remarks>The user defined line stipple is represented by an Integer (VB.NET) or a Long (VB 6). The first digit represents the stipple
multiplier. Each of the following digits alternate between representing pixels drawn and pixels skipped in the pattern. The
number of pixels to be drawn or skipped are determined by multiplying the digit representing that segment of the stipple by
the stipple multiplier.\n
This custom line stipple would draw six pixels(2*3), skip eight pixels(2*4), draw ten pixels(2*5), skip twelve pixels(2*6), with
the pattern repeating from the beginning after that. The largest valid line stipple is 2147483647. Any value greater than this
will result in overflow. A line stipple value less than 111 will result in a solid line.</remarks>
<param name="LayerHandle">The handle of the layer for which the user defined shape line stipple is to be set.</param>
<returns>The user defined line stipple.</returns>
\deprecated v.4.8. Use LinePattern class instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_UDLineStipple(System.Int32,System.Int32)">
<summary>
Sets the user defined line stipple for the specified layer.
</summary>
<remarks>The user defined line stipple is represented by an Integer (VB.NET) or a Long (VB 6). The first digit represents the stipple
multiplier. Each of the following digits alternate between representing pixels drawn and pixels skipped in the pattern. The
number of pixels to be drawn or skipped are determined by multiplying the digit representing that segment of the stipple by
the stipple multiplier.\n
This custom line stipple would draw six pixels(2*3), skip eight pixels(2*4), draw ten pixels(2*5), skip twelve pixels(2*6), with
the pattern repeating from the beginning after that. The largest valid line stipple is 2147483647. Any value greater than this
will result in overflow. A line stipple value less than 111 will result in a solid line.
</remarks>
<param name="LayerHandle">The handle of the layer for which the user defined shape line stipple is to be set.</param>
<param name="newValue">The user defined line stipple.</param>
\deprecated v.4.8. Use LinePattern class instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_UDPointFontCharFont(System.Int32,System.String,System.Single,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Sets the font for point markers defined by font characters.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="FontName">The name of the font.</param>
<param name="FontSize">The size of the font.</param>
<param name="isBold">A boolean value which indicates whether the font is bold.</param>
<param name="isItalic">A boolean value which indicates whether the font is italic.</param>
<param name="isUnderline">A boolean value which indicates whether the font is underlined.</param>
\deprecated v.4.8. Use ShapeDrawingOptions.PointCharacter and ShapefileCategories instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_UDPointFontCharFontSize(System.Int32,System.Single)">
<summary>
Sets the font size for point markers defined by font characters.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="FontSize">The size of the font.</param>
\deprecated v.4.8. Use ShapeDrawingOptions.PointCharacter and ShapefileCategories instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_UDPointFontCharListAdd(System.Int32,System.Int32,System.UInt32)">
<summary>
Adds a new item in the list of point markers defined by font characters
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="newValue">The ANSI code of the new character.</param>
<param name="Color">The color of the marker.</param>
<returns>The index of the new font character in the list of markers.</returns>
\deprecated v.4.8. Use ShapeDrawingOptions.PointCharacter and ShapefileCategories instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_UDPointImageListAdd(System.Int32,System.Object)">
<summary>
Allows you to build an image list so that one point shapefile can have multiple icons.
</summary>
<param name="LayerHandle">The layer handle of the layer for which the image list is defined.</param>
<param name="newValue">The Integer index for the image to retrieve </param>
<returns>The image object which is used as the point image for the specified layer.</returns>
\deprecated v.4.8. Use ShapeDrawingOptions.Picture and ShapefileCategories instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_UDPointImageListCount(System.Int32)">
<summary>
Gets the number of images currently stored in the image list for custom points images.
</summary>
<param name="LayerHandle">The layer handle of the layer for which the image list is defined. </param>
<returns>The Count of images currently stored in the image index of custom point types for that layer.
Remember to subtract 1 from this count when indexing the 0 based image list.
</returns>
\deprecated v.4.8. Use ShapeDrawingOptions.Picture and ShapefileCategories instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_UDPointImageListItem(System.Int32,System.Int32)">
<summary>
Allows you to build an image list so that one point shapefile can have multiple icons.
</summary>
<param name="LayerHandle">The layer handle of the layer for which the image list is defined.</param>
<param name="ImageIndex">The Integer index for the image to retrieve</param>
<returns>The image object which is used as the point image for the specified layer.</returns>
\deprecated v.4.8. Use ShapeDrawingOptions.Picture and ShapefileCategories instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_UDPointType(System.Int32)">
<summary>
Gets the image used when drawing points on the specified layer.
</summary>
<param name="LayerHandle">The layer handle of the layer for which the point type is required.</param>
<returns>The image object which is used as the point image for the specified layer.</returns>
\deprecated v.4.8. Use ShapeDrawingOptions.PointType instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_UDPointType(System.Int32,System.Object)">
<summary>
Sets the image used when drawing points on the specified layer.
</summary>
<param name="LayerHandle">The layer handle of the layer for which the point type is required.</param>
<param name="newValue">The image object which is used as the point image for the specified layer.</param>
\deprecated v.4.8. Use ShapeDrawingOptions.PointType instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapeDrawFill(System.Int32,System.Int32)">
<summary>
Deprecated. Gets whether the specified shape is drawn with a fill. Only works on polygon shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the fill is to be set.</param>
<param name="Shape">Handle of the shape for which the fill is to be set.</param>
<returns>Sets whether the shape is drawn with a fill or not.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.FillVisible property. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapeDrawFill(System.Int32,System.Int32,System.Boolean)">
<summary>
Deprecated. Sets whether the specified shape is drawn with a fill. Only works on polygon shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the fill is to be set. </param>
<param name="Shape">Handle of the shape for which the fill is to be set.</param>
<param name="newValue">Sets whether the shape is drawn with a fill or not. </param>
\deprecated v. 4.8. Use ShapeDrawingOptions.FillVisible property. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapeDrawLine(System.Int32,System.Int32)">
<summary>
Deprecated. Gets whether the lines for the specified shape are drawn.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the lines are to be set.</param>
<param name="Shape">Handle of the shape for which the lines are to be set.</param>
<returns>Sets whether the shape is drawn with lines or not.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.LineVisible instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapeDrawLine(System.Int32,System.Int32,System.Boolean)">
<summary>
Deprecated. Sets whether the lines for the specified shape are drawn.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the lines are to be set.</param>
<param name="Shape">Handle of the shape for which the lines are to be set. </param>
<param name="newValue">Sets whether the shape is drawn with lines or not.</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.LineVisible instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapeDrawPoint(System.Int32,System.Int32)">
<summary>
Deprecated. Gets whether the points/vertices in specified shape are drawn.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the points are to be set.</param>
<param name="Shape">Handle of the shape for which the points are to be set.</param>
<returns>Sets whether the shape is drawn with points or not.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.Visible instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapeDrawPoint(System.Int32,System.Int32,System.Boolean)">
<summary>
Deprecated. Sets whether the points/vertices in specified shape are drawn.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the points are to be set.</param>
<param name="Shape">Handle of the shape for which the points are to be set.</param>
<param name="newValue">Sets whether the shape is drawn with points or not.</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.Visible instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapeFillColor(System.Int32,System.Int32)">
<summary>
Deprecated. Gets the fill color for the specified shape. Only works on polygon shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the fill color is to be set.</param>
<param name="Shape">Handle for the shape for which the fill color is to be set.</param>
<returns>Fill color for the shape in the polygon shapefile. This is a System.UInt32 representation of an RGB color.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.FillColor instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapeFillColor(System.Int32,System.Int32,System.UInt32)">
<summary>
Deprecated. Sets the fill color for the specified shape. Only works on polygon shapefiles
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the fill color is to be set.</param>
<param name="Shape">Handle for the shape for which the fill color is to be set. </param>
<param name="newValue">Fill color for the shape in the polygon shapefile. This is a System.UInt32 representation of an RGB color</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.FillColor instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapeFillStipple(System.Int32,System.Int32)">
<summary>
Deprecated. Gets the fill stipple for the specified shape. Only works on polygon shapefiles
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the fill stipple is to be set.</param>
<param name="Shape">Handle of the shape for which the fill stipple is required.</param>
<returns>Gets the fill stipple for the specified shape.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.FillHatchStyle instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapeFillStipple(System.Int32,System.Int32,MapWinGIS.tkFillStipple)">
<summary>
Deprecated. Sets the fill stipple for the specified shape. Only works on polygon shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the fill stipple is to be set.</param>
<param name="Shape">Handle of the shape for which the fill stipple is to be set.</param>
<param name="newValue">Sets fill stipple for the specified shape.</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.FillHatchStyle instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapeFillTransparency(System.Int32,System.Int32)">
<summary>
Deprecated. Gets the percentage of fill transparency for the specified layer. Only works on polygon shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the fill transparency is to be set. </param>
<param name="Shape">Handle of the shape for which the fill transparency is to be set.</param>
<returns>Gets the percentage of fill transparency for the specified shape.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.FillTransparency instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapeFillTransparency(System.Int32,System.Int32,System.Single)">
<summary>
Deprecated. Sets the percentage of fill transparency for the specified layer. Only works on polygon shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the fill transparency is to be set. </param>
<param name="Shape">Handle of the shape for which the fill transparency is to be set. </param>
<param name="newValue">Sets the percentage of fill transparency for the specified shape. </param>
\deprecated v. 4.8. Use ShapeDrawingOptions.FillTransparency instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapeLineColor(System.Int32,System.Int32)">
<summary>
Deprecated. Gets the line color for the specified shape. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the line color is required.</param>
<param name="Shape">Handle of the shape for which the line color is required.</param>
<returns>Line color for the shape in the polygon shapefile.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.LineColor instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapeLineColor(System.Int32,System.Int32,System.UInt32)">
<summary>
Deprecated. Sets the line color for the specified shape. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the line color is to be set.</param>
<param name="Shape">Handle of the shape for which the line color is to be set.</param>
<param name="newValue">Line color for the shape in the polygon shapefile. This is a System.UInt32 representation of an RGB color</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.LineColor instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapeLineStipple(System.Int32,System.Int32)">
<summary>
Deprecated. Gets the line stipple for the specified shape. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the line stipple is required.</param>
<param name="Shape">Handle of the shape for which the line stipple is required.</param>
<returns>Line stipple for the shape in the shapefile. </returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.LineStipple instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapeLineStipple(System.Int32,System.Int32,MapWinGIS.tkLineStipple)">
<summary>
Deprecated. Sets the line stipple for the specified shape. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the line stipple is to be set. </param>
<param name="Shape">Handle of the shape for which the line stipple is to be set.</param>
<param name="newValue">Line stipple for the shape in the shapefile.</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.LineStipple instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapeLineWidth(System.Int32,System.Int32)">
<summary>
Deprecated. Gets the line width for the specified shape. Only works on shapefiles.
Suggested values for line width: 1 - 5
</summary>
<param name="LayerHandle">Handle of the layer for which the line width is required. </param>
<param name="Shape">Handle of the shape for which the line width is required.</param>
<returns>Line width for the shape in the shapefile.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.LineWidth instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapeLineWidth(System.Int32,System.Int32,System.Single)">
<summary>
Deprecated. Sets the line width for the specified shape. Only works on shapefiles.
Suggested values for line width: 1 - 5
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the line width is to be set.</param>
<param name="Shape">Handle of the shape for which the line width is to be set</param>
<param name="newValue">Line width for the shape in the shapefile.</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.LineWidth instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapePointColor(System.Int32,System.Int32)">
<summary>
Deprecated. Gets the point color for the specified shape. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the point color is required. </param>
<param name="Shape">Handle of the shape for which the point color is required.</param>
<returns>Point color for the shape in the polygon shapefile.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.FillColor for point shapefiles and ShapeDrawingOptions.VerticesColor
for polylines and polygons instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapePointColor(System.Int32,System.Int32,System.UInt32)">
<summary>
Deprecated. Sets the point color for the specified shape. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the point color is to be set.</param>
<param name="Shape">Handle of the shape for which the point color is to be set. </param>
<param name="newValue">Point color for the shape in the polygon shapefile. This is a System.UInt32 representation of an RGB color</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.FillColor for point shapefiles and ShapeDrawingOptions.VerticesColor
for polylines and polygons instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapePointFontCharListID(System.Int32,System.Int32)">
<summary>
Deprecated. Gets the index of the point marker represented by font character.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="Shape">The index of the shape.</param>
<returns>The index of the marker associated with shape.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.PointCharacter instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapePointFontCharListID(System.Int32,System.Int32,System.Int32)">
<summary>
Deprecated. Sets the index of the point marker represented by font character.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="Shape">The index of the shape.</param>
<param name="newValue">The index of the marker associated with shape.</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.PointCharacter instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapePointImageListID(System.Int32,System.Int32)">
<summary>
Allows you specify an image from the image list so that one point shapefile can have multiple icons.
</summary>
<param name="LayerHandle">The layer handle of the layer for which the image list is defined. </param>
<param name="Shape">The specific shape in the layer that you wish to determine the image index for</param>
<returns>The index in the image list of user defined images.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.Picture instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapePointImageListID(System.Int32,System.Int32,System.Int32)">
<summary>
Allows you specify an image from the image list so that one point shapefile can have multiple icons
</summary>
<param name="LayerHandle">The layer handle of the layer containing the list to specify an image from.</param>
<param name="Shape">The specific shape to be assigned a value in the layer. </param>
<param name="newValue">The index of the image in the imagelist that you want to assign to the specified shape</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.Picture instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapePointSize(System.Int32,System.Int32)">
<summary>
Gets the line point/vertex size for the specified shape. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the point/vertex size is required. </param>
<param name="Shape">Handle of the shape for which the point/vertex size is required</param>
<returns>Point/vertex size for the shape in the shapefile.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.PointSize instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapePointSize(System.Int32,System.Int32,System.Single)">
<summary>
Sets the line point/vertex size for the specified shape. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the point/vertex size is to be set.</param>
<param name="Shape">Handle of the shape for which the point/vertex size is to be set.</param>
<param name="newValue">Point/vertex size for the shape in the shapefile.</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.PointSize instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapePointType(System.Int32,System.Int32,MapWinGIS.tkPointType)">
<summary>
Deprecated. Sets the line point type for the specified shape. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the point type is to be set. </param>
<param name="Shape">Handle of the shape for which the point type is to be set.</param>
<param name="newValue">Point type for the shape in the shapefile.</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.PointType instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapePointType(System.Int32,System.Int32)">
<summary>
Deprecated. Gets the line point type for the specified shape. Only works on shapefiles.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the point type is required. </param>
<param name="Shape">Handle of the shape for which the point type is required. </param>
<returns>Point type for the shape in the shapefile.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.PointType instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapeStippleColor(System.Int32,System.Int32)">
<summary>
Deprecated. Gets the color of the polygon fill stipple for the given shape of the layer.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="Shape">The index of the shape.</param>
<returns>The color of stipple.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.FillHatchStyle instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapeStippleColor(System.Int32,System.Int32,System.UInt32)">
<summary>
Deprecated. Sets the color of the polygon fill stipple for the given shape of the layer.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="Shape">The index of the shape.</param>
<param name="newValue">The color of stipple.</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.FillHatchStyle instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapeStippleTransparent(System.Int32,System.Int32)">
<summary>
Deprecated. Gets a boolean value which indicates whether the background of fill stipple for given shape of will be transparent.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="Shape">The index of the shape.</param>
<returns>True in case the background is transparent and false otherwise.</returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.FillBgTransparent instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapeStippleTransparent(System.Int32,System.Int32,System.Boolean)">
<summary>
Deprecated. Sets a boolean value which indicates whether the background of fill stipple for given shape of will be transparent.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="Shape">The index of the shape.</param>
<param name="newValue">True in case the background is transparent and false otherwise.</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.FillBgTransparent instead. See ShapefileCategories, Shapefile.set_ShapeCategory to setup
visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ShapeVisible(System.Int32,System.Int32)">
<summary>
Deprecated. Gets the visibility of the specified shape.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the visibility is required.</param>
<param name="Shape">Handle of the shape for which the visibility is required.</param>
<returns>Boolean value representing whether the the shape is visible or not. </returns>
\deprecated v. 4.8. Use ShapeDrawingOptions.Visible and Shapefile.VisibilityExpression instead.
See ShapefileCategories, Shapefile.set_ShapeCategory to setup visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ShapeVisible(System.Int32,System.Int32,System.Boolean)">
<summary>
Deprecated. Sets the visibility of the specified shape.
</summary>
<param name="LayerHandle">Handle of the layer containing the shape for which the visibility is to be set</param>
<param name="Shape">Handle of the shape for which the visibility is to be set.</param>
<param name="newValue">Boolean value representing whether the shape is to be visible or not.</param>
\deprecated v. 4.8. Use ShapeDrawingOptions.Visible and Shapefile.VisibilityExpression instead.
See ShapefileCategories, Shapefile.set_ShapeCategory to setup visualization of individual shapes.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.ApplyLegendColors(System.Object)">
<summary>
Applies the coloring scheme to a layer (the layer handle is specified in the coloring scheme object).
</summary>
<remarks>Deprecated for shapefile layers.</remarks>
<param name="Legend">The coloring scheme to apply.</param>
<returns>Boolean value indicating the successful application when true, unsuccessful application when false.</returns>
\deprecated v4.9.3 No longer used.
\removed493 Removed in v4.9.3.
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.IsTIFFGrid(System.String)">
<summary>
Returns a boolean value which indicates whether the specified file holds tiff grid.
</summary>
<param name="Filename">The name of the file.</param>
<returns>True on success and false otherwise.</returns>
\deprecated v4.9.3 Use Utils.IsTiffGrid instead.
\removed493 Removed in v4.9.3.
</member>
<member name="P:AxMapWinGIS.AxMap_Deprecated.ShapeDrawingMethod">
<summary>
Gets or sets the drawing method for vector layers.
</summary>
<remarks>The default value is vdmNewSymbology. From the version 4.8 this is the only value supported.</remarks>
\new48 Added in version 4.8
\deprecated v4.8 No longer used.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.SetImageLayerColorScheme(System.Int32,System.Object)">
<summary>
Sets a coloring scheme to be associated with an image layer.
</summary>
<remarks>The coloring scheme is for reference purposes only and has no effect the coloring or display of the image.</remarks>
<param name="LayerHandle">The handle of the image layer to attach the coloring scheme to.</param>
<param name="ColorScheme">The coloring scheme to attach to the specified image layer.</param>
<returns>Boolean value representing success when true, failure when false.</returns>
\deprecated v4.8 Use Image.CustomColorScheme instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.UpdateImage(System.Int32)">
<summary>
Updates the display of the specified image object.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
\deprecated v4.9.3 No longer used.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_GridFileName(System.Int32)">
<summary>
Gets or sets the filename of the Grid object associated with an Image object loaded into the map.
</summary>
<param name="LayerHandle">The handle of the layer for which the grid filename is to be set.</param>
<returns>The grid filename to be associated with the specified layer.</returns>
\deprecated v 4.9.1 Use AxMap.get_Image, Image.SourceGridName instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_ImageLayerPercentTransparent(System.Int32)">
<summary>
Gets or sets the percentage of transparency of an Image layer.
</summary>
<param name="LayerHandle">The layer handle of the Image layer for which the transparency is to be set.</param>
<returns>The percentage of transparency for the specified image layer.</returns>
\deprecated v4.9.3 Use AxMap.get_Image, Image.TransparencyPercent instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_GridFileName(System.Int32,System.String)">
<summary>
Sets the filename of the grid associated with the specified layer.
</summary>
<remarks>MapWinGIS will create a bitmap representation for the grid and use instance of Image class for display.</remarks>
<param name="LayerHandle">The layer handle.</param>
<param name="newValue">The name of the file with grid.</param>
\deprecated v 4.9.1 Use Image.SourceGridName instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.AddLabel(System.Int32,System.String,System.UInt32,System.Double,System.Double,tkHJustification)">
<summary>
Adds a label to the map.
</summary>
<param name="LayerHandle">The handle of the layer where the label will be added to.</param>
<param name="Text">The text to be used for the label.</param>
<param name="Color">The color of the added label. This is a UInt32 representation of an RGB color.</param>
<param name="x">The x coordinate in projected map units which determines where the label will be added on the map.</param>
<param name="y">The y coordinate in projected map units which determines where the label will be added on the map.</param>
<param name="hJustification">Specifies whether to justify the label's text right, left, or center. </param>
\deprecated v.4.8 The method will ignore Color and hJustification parameters. Use Labels interface ( AxMap.get_LayerLabels ) to change these settings.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.AddLabelEx(System.Int32,System.String,System.UInt32,System.Double,System.Double,tkHJustification,System.Double)">
<summary>
Adds an extended label to the map, allowing for rotated labels.
</summary>
<param name="LayerHandle">The handle of the layer where the label will be added to.</param>
<param name="Text">The text to be used for the label.</param>
<param name="Color">The color of the added label. This is a UInt32 representation of an RGB color.</param>
<param name="x">The x coordinate in projected map units which determines where the label will be added on the map.</param>
<param name="y">The y coordinate in projected map units which determines where the label will be added on the map.</param>
<param name="hJustification">Specifies whether to justify the label's text right, left, or center.</param>
<param name="Rotation">The number of degrees to rotate the label. Positive angles rotate the text counter-clockwise, and
negative angles rotate the text clockwise</param>
\deprecated v.4.8 The method will ignore Color and hJustification parameters. Use Labels interface ( AxMap.get_LayerLabels ) to change these settings.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.ClearLabels(System.Int32)">
<summary>
Clears all labels that have been added to the specified layer.
</summary>
<param name="LayerHandle">Handle of the layer.</param>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.Clear instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_LayerLabelsOffset(System.Int32)">
<summary>
Gets the offset for the labels on the layer.
</summary>
<remarks>The offset is the distance in pixels from the label point to the text.</remarks>
<param name="LayerHandle">The handle of the layer for which the offset is to be set.</param>
<returns>The offset for the labels on the specified layer.</returns>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.OffsetX, Labels.OffsetY instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_LayerLabelsOffset(System.Int32,System.Int32)">
<summary>
Sets the offset for the labels on the layer.
</summary>
<remarks>The offset is the distance in pixels from the label point to the text.</remarks>
<param name="LayerHandle">The handle of the layer for which the offset is to be set. </param>
<param name="newValue">The offset for the labels on the specified layer.</param>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.OffsetX, Labels.OffsetY instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_LayerLabelsScale(System.Int32)">
<summary>
Gets whether to scale the labels on the layer.
</summary>
<param name="LayerHandle">The handle of the layer for which the scaling of labels is to be set.</param>
<returns>A boolean value representing whether or not to scale the labels on the specified layer.</returns>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.ScaleLabels instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_LayerLabelsScale(System.Int32,System.Boolean)">
<summary>
Sets whether to scale the labels on the layer
</summary>
<param name="LayerHandle">The handle of the layer for which the scaling of labels is to be set.</param>
<param name="newValue">A boolean value representing whether or not to scale the labels on the specified layer.</param>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.ScaleLabels instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_LayerLabelsShadow(System.Int32)">
<summary>
Gets whether to use shadows for the labels on the layer.
</summary>
<param name="LayerHandle">The handle of the layer for which the use of label shadows is to be set.</param>
<returns>A boolean value representing whether or not label shadows will be used for the specified layer. </returns>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.HaloVisible instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_LayerLabelsShadow(System.Int32,System.Boolean)">
<summary>
Sets whether to use shadows for the labels on the layer.
</summary>
<param name="LayerHandle">The handle of the layer for which the use of label shadows is to be set. </param>
<param name="newValue">A boolean value representing whether or not label shadows will be used for the specified layer.</param>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.HaloVisible instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_LayerLabelsShadowColor(System.Int32)">
<summary>
Gets the shadow color for the labels on the layer
</summary>
<param name="LayerHandle">The handle of the layer for which the shadow color is to be set.</param>
<returns>The color to use the shadow color of the specified layer.
This is a System.UInt32 representation of an RGB color.</returns>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.HaloColor instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_LayerLabelsShadowColor(System.Int32,System.UInt32)">
<summary>
Sets the shadow color for the labels on the layer.
</summary>
<param name="LayerHandle">The layer handle of the layer for which the shadow color is to be set.</param>
<param name="newValue">The color of use as the shadow color of the specified layer.
This is a System.UInt32 representation of an RGB color.</param>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.HaloColor instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_LayerLabelsVisible(System.Int32)">
<summary>
Gets label visibility for the specified layer.
</summary>
<param name="LayerHandle">The handle for the layer for which its label's visibility are to be set.</param>
<returns>A boolean value which determines whether the specified layer's labels are visible or not.</returns>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.Visible instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_LayerLabelsVisible(System.Int32,System.Boolean)">
<summary>
Sets label visibility for the specified layer.
</summary>
<param name="LayerHandle">The layer handle for the layer for which its label's visibility are to be set.</param>
<param name="newValue">A boolean value which determines whether the specified layer's labels are visible or not. </param>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.Visible instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.GetLayerStandardViewWidth(System.Int32,System.Double@)">
<summary>
Gets the standard view width used to scale the labels on the layer
</summary>
<param name="LayerHandle">The handle of the layer for which the standard view width is required.</param>
<param name="Width">Reference parameter. The standard view width for the specified layer is returned through this parameter.</param>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.BasicScale instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.SetLayerStandardViewWidth(System.Int32,System.Double)">
<summary>
Sets the standard view width used to scale the labels on the layer.
</summary>
<param name="LayerHandle">The handle of the layer for which the standard view width is to be set.</param>
<param name="Width">The new standard view width for the specified layer.</param>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.BasicScale instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_UseLabelCollision(System.Int32)">
<summary>
Gets a boolean value which indicates whether overlapping labels will be allowed for the layer.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<returns>True in case overlapping labels will be prevented and false otherwise.</returns>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.AvoidCollisions instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_UseLabelCollision(System.Int32,System.Boolean)">
<summary>
Sets a boolean value which indicates whether overlapping labels will be allowed for the layer.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="newValue">True in case overlapping labels will be forbidden and false otherwise.</param>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.AvoidCollisions instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.LabelColor(System.Int32,System.UInt32)">
<summary>
Sets the color of the font for labels of the layer.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="LabelFontColor">The color of the labels font.</param>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.FontColor instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.LayerFont(System.Int32,System.String,System.Int32)">
<summary>
Sets the font to use when drawing labels for a layer.
</summary>
<param name="LayerHandle">Layer handle of the layer for which the label fonts are to be set.</param>
<param name="FontName">Name of the font to use for the labels. (Ex: "Arial") </param>
<param name="FontSize">Size of the font to use for the labels.</param>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.FontName, Labels.FontSize instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.LayerFontEx(System.Int32,System.String,System.Int32,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Sets the font for labels of the layer.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<param name="FontName">The name of the font.</param>
<param name="FontSize">The size of the font.</param>
<param name="isBold">A boolean value which indicates whether the font is bold.</param>
<param name="isItalic">A boolean value which indicates whether the font is italic.</param>
<param name="isUnderline">A boolean value which indicates whether the font is underlined.</param>
\deprecated v4.9.3 Use AxMap.get_LayerLabels, Labels.FontName, Labels.FontSize, Labels.FontBold, Labels.FontItalic, Labels.FontUnderline instead.
\removed493 Removed in v4.9.3
</member>
<member name="P:AxMapWinGIS.AxMap_Deprecated.MultilineLabels">
<summary>
Gets or sets a boolean value which indicates whether multiline labels will be drawn correctly on the map.
</summary>
\deprecated v 4.8. Multiline labels will be drawn after specification of appropriate label expression.
\see Labels.Expression.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.AddDrawingLabel(System.Int32,System.String,System.UInt32,System.Double,System.Double,tkHJustification)">
<summary>
Adds label to the specified drawing layer.
</summary>
<remarks>This method corresponds to the Labels.AddLabel method.</remarks>
<param name="DrawHandle">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<param name="Text">The text of the label.</param>
<param name="Color">The color of the label.</param>
<param name="x">The x coordinate of the label.</param>
<param name="y">The y coordinate of the label.</param>
<param name="hJustification">The justification of the label.</param>
\deprecated v4.9.3 Use AxMap.DrawLabel, AxMap.DrawLabelEx instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.AddDrawingLabelEx(System.Int32,System.String,System.UInt32,System.Double,System.Double,tkHJustification,System.Double)">
<summary>
Adds label to the specified drawing layer. Angle of rotation is accepted.
</summary>
<remarks>This method corresponds to the Labels.AddLabel method.</remarks>
<param name="DrawHandle">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<param name="Text">The text of the label.</param>
<param name="Color">The color of the label.</param>
<param name="x">The x coordinate of the label.</param>
<param name="y">The y coordinate of the label.</param>
<param name="hJustification">The justification of the label.</param>
<param name="Rotation">The angle of rotation in degrees.</param>
\deprecated v4.9.3 Use AxMap.DrawLabel, AxMap.DrawLabelEx instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.GetDrawingStandardViewWidth(System.Int32,System.Double@)">
<summary>
Gets the value which affects the scaling of labels.
</summary>
<param name="DrawHandle">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<param name="Width">The standard width of the view in pixels to use normal size of labels.</param>
\deprecated v 4.8. Use AxMap.get_DrawingLabels, Labels.BasicScale instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_DrawingLabelsOffset(System.Int32)">
<summary>
Gets the vertical offset of the labels for the specified drawing layer in pixels.
</summary>
<param name="DrawHandle">The index of the drawing layer returned by AxMap.NewDrawing method.</param>
<returns>The offset in pixels.</returns>
\deprecated v. 4.8. Use AxMap.get_DrawingLabels and Labels.OffsetX, Labels.OffsetY instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_DrawingLabelsOffset(System.Int32,System.Int32)">
<summary>
Sets the vertical offset of the labels for the specified drawing layer in pixels.
</summary>
<param name="DrawHandle">The index of the drawing layer returned by AxMap.NewDrawing method.</param>
<param name="newValue">The offset in pixels.</param>
\deprecated v. 4.8. Use AxMap.get_DrawingLabels and Labels.OffsetX, Labels.OffsetY instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_DrawingLabelsScale(System.Int32)">
<summary>
Gets a boolean value which indicates whether the labels of the drawing layer will be scaled.
</summary>
<remarks>This property corresponds to the Labels.ScaleLabels property.</remarks>
<param name="DrawHandle">he index of the drawing layer returned by AxMap.NewDrawing method.</param>
<returns>True if the labels are scaled and false otherwise.</returns>
\deprecated v 4.9.3 Use AxMap.get_DrawingLabels, Labels.ScaleLabels instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_DrawingLabelsScale(System.Int32,System.Boolean)">
<summary>
Sets a boolean value which indicates whether the labels of the drawing layer will be scaled.
</summary>
<remarks>This property corresponds to the Labels.ScaleLabels property.</remarks>
<param name="DrawHandle">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<param name="newValue">True if the labels are scaled and false otherwise.</param>
\deprecated v 4.9.3 Use AxMap.get_DrawingLabels, Labels.ScaleLabels instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_DrawingLabelsShadow(System.Int32)">
<summary>
Gets a boolean value which indicates whether a shadow will be displayed for the labels of the drawing layer.
</summary>
<remarks>This property corresponds to the Labels.HaloVisible property.</remarks>
<param name="DrawHandle">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<returns>True if the shadow is displayed and false otherwise.</returns>
\deprecated v 4.9.3 Use AxMap.get_DrawingLabels, Labels.HaloVisible instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_DrawingLabelsShadow(System.Int32,System.Boolean)">
<summary>
Sets a boolean value which indicates whether a shadow will be displayed for the labels of the drawing layer.
</summary>
<remarks>This property corresponds to the Labels.HaloVisible property.</remarks>
<param name="DrawHandle">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<param name="newValue">True if the shadow is displayed and false otherwise.</param>
\deprecated v 4.9.3 Use AxMap.get_DrawingLabels, Labels.HaloVisible instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_DrawingLabelsShadowColor(System.Int32)">
<summary>
Gets the color of the shadow for the labels of the specified drawing layer.
</summary>
<remarks>This property corresponds to the Labels.HaloColor property.</remarks>
<param name="DrawHandle">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<returns>The color of shadow.</returns>
\deprecated v 4.9.3 Use AxMap.get_DrawingLabels, Labels.HaloColor instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_DrawingLabelsShadowColor(System.Int32,System.UInt32)">
<summary>
Sets the color of the shadow for the labels of the specified drawing layer.
</summary>
<remarks>This property corresponds to the Labels.HaloColor property.</remarks>
<param name="DrawHandle">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<param name="newValue">The color of shadow.</param>
\deprecated v 4.9.3 Use AxMap.get_DrawingLabels, Labels.HaloColor instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.get_UseDrawingLabelCollision(System.Int32)">
<summary>
Gets a boolean value which indicates whether overlapping labels will be allowed for drawing layer.
</summary>
<remarks>This property corresponds to the Labels.AvoidCollisions property.</remarks>
<param name="DrawHandle">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<returns>True in case overlapping labels are removed and false otherwise.</returns>
\deprecated v 4.9.3 Use AxMap.get_DrawingLabels, Labels.AvoidCollisions instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_UseDrawingLabelCollision(System.Int32,System.Boolean)">
<summary>
Sets a boolean value which indicates whether overlapping labels will be allowed for drawing layer.
</summary>
<remarks>This property corresponds to the Labels.AllowCollisions property.</remarks>
<param name="DrawHandle">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<param name="newValue">True in case overlapping labels are removed and false otherwise.</param>
\deprecated v 4.9.3 Use AxMap.get_DrawingLabels, Labels.AvoidCollisions instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.DrawingFont(System.Int32,System.String,System.Int32)">
<summary>
Sets the font for the labels of the drawing layer.
</summary>
<param name="DrawHandle">The handle of the drawing layer returned by AxMap.NewDrawing method.</param>
<param name="FontName">The name of the font.</param>
<param name="FontSize">The size of the font.</param>
\deprecated v 4.9.3 Use AxMap.get_DrawingLabels, Labels.FontName, Labels.FontSize instead.
\removed493 Removed in v4.9.3
</member>
<member name="P:AxMapWinGIS.AxMap_Deprecated.MapRotationAngle">
<summary>
Gets or sets the angle of map rotation in degrees.
</summary>
\deprecated v.4.9.3 The functionality is no longer supported.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.set_ImageLayerPercentTransparent(System.Int32,System.Single)">
<summary>
Sets the numeric value which determines the transparency of the given image layer.
</summary>
<remarks>It is recommended to the properties of the Image class directly.</remarks>
<param name="LayerHandle">The handle of the layer with the image.</param>
<param name="newValue">The value ranging from 0.0(transparent) to 1.0(opaque).</param>
\deprecated v4.9.3 Use AxMap.get_Image(), Image.TransparencyPercent instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.SetDrawingStandardViewWidth(System.Int32,System.Double)">
<summary>
Deprecated. Affects the scaling of the labels of the specified drawing layer.
</summary>
<param name="DrawHandle">The handle of the drawing layer.</param>
<param name="Width">The width in pixels.</param>
\deprecated v.4.8. Use AxMap.get_DrawingLabels, Labels.BasicScale and Labels.ScaleLabels instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.ClearUDPointImageList(System.Int32)">
<summary>
Clears the images from the user defined list of point symbols.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
\deprecated v4.9.3 Use ShapeDrawingOptions.Picture instead.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.GetBaseProjectionPoint(System.Double,System.Double)">
<summary>
Gets or set the point which is used as a center of the map rotation/
</summary>
<param name="rotX">The x coordinate of the rotation point in map units.</param>
<param name="rotY">The y coordinate of the rotation point in map units.</param>
<returns>The base point for rotation.</returns>
\new48 Added in version 4.8
\deprecated v.4.9.3 The functionality is no longer supported.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.GetRotatedExtent">
<summary>
Gets the bounding box which holds the extents of the map when rotation is applied.
</summary>
<remarks>The bounding box is equal to the map extents when rotation angle is 0 and larger than
map extents if the angle differs from it.</remarks>
<returns>The bounding box of the rotated extents.</returns>
\new48 Added in version 4.8
\deprecated v.4.9.3 The functionality is no longer supported.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.IsSameProjection(System.String,System.String)">
<summary>
Tests the identity of 2 projections.
</summary>
<param name="proj4_a">The first projection string.</param>
<param name="proj4_b">The second projection string.</param>
<returns></returns>
\deprecated v4.9.3 Use GeoProjection.get_IsSame, GeoProjection.get_IsSameExt instead.
\removed493 Removed in v4.9.3
</member>
<member name="P:AxMapWinGIS.AxMap_Deprecated.CanUseImageGrouping">
<summary>
Gets or sets a boolean value which indicates how images with identical size and position on the map will be drawn.
</summary>
<remarks>When set to true such images will be merged into a single bitmap. This may improve performance
in case of low number of data pixels (those which differ from the transparent color). The default value is false.</remarks>
\new48 Added in version 4.8
\deprecated v.4.9.3 The functionality is no longer supported.
\removed493 Removed in v4.9.3
</member>
<member name="P:AxMapWinGIS.AxMap_Deprecated.DoubleBuffer">
<summary>
Gets or sets whether or not the map uses double buffering.
</summary>
<remarks>Double buffering uses a little more memory, but allows the view to be smoother with less flickering.
The default value is true. It's not recommended to change it.</remarks>
\deprecated v.4.9.3 Double buffer is used in all cases.
\removed493 Removed in v4.9.3
</member>
<member name="P:AxMapWinGIS.AxMap_Deprecated.MapState">
<summary>
Gets or sets the MapState string which stores all information needed to restore a view.
</summary>
<remarks>This includes layer information and coloring schemes.</remarks>
\deprecated v.4.8 Use AxMap.SerializeMapState instead.
\removed493 Removed in v4.9.3
</member>
<member name="P:AxMapWinGIS.AxMap_Deprecated.SerialNumber">
<summary>
Serial number functionality is deprecated as MapWindow is now Open Source. This property may be left unset.
</summary>
\deprecated v4.8 This property is no longer used.
\removed493 Removed in v4.9.3
</member>
<member name="M:AxMapWinGIS.AxMap_Deprecated.AdjustLayerExtents(System.Int32)">
<summary>
Deprecated. Updates the extents of the layer before the drawing.
</summary>
<param name="LayerHandle">The handle of the layer.</param>
<returns>True on success and false in case of invalid layer handle.</returns>
\deprecated v.4.8. The call is incorporated into drawing routine.
\removed493 Removed in v4.9.3
</member>
<member name="T:tkHJustification">
<summary>
Justification of the labels
</summary>
</member>
<member name="T:tkShapeDrawingMethod">
<summary>
Shape drawing method
</summary>
</member>
</members>
</doc>
Reference in New Issue View Git Blame Copy Permalink