Functions
Layer properties
Map modules

Functions

string AxMap.get_LayerDescription (int LayerHandle)
 Gets the description of the layer from the associated .mwsymb file.
bool AxMap.get_LayerDynamicVisibility (int LayerHandle)
 Gets the boolean value which indicates whether the layer will be displayed at all scales or only within the chosen range of scales.
string AxMap.get_LayerFilename (int layerHandle)
 Gets filename of datasource for the specified layer.
string AxMap.get_LayerKey (int LayerHandle)
 Gets a string associated with a layer in the map.
MapWinGIS.Labels AxMap.get_LayerLabels (int LayerHandle)
 Returns labels associated with layer.
double AxMap.get_LayerMaxVisibleScale (int LayerHandle)
 Gets the maximum scale at which the layer is visible on the map.
int AxMap.get_LayerMaxVisibleZoom (int layerHandle)
 Gets maximum zoom at which the layer will be displayed.
double AxMap.get_LayerMinVisibleScale (int LayerHandle)
 Gets the minimum scale at which the layer is visible on the map.
int AxMap.get_LayerMinVisibleZoom (int layerHandle)
 Gets minimum zoom at which the layer will be displayed.
string AxMap.get_LayerName (int LayerHandle)
 Gets the name of the specified layer.
bool AxMap.get_LayerSkipOnSaving (int LayerHandle)
 Gets a boolean value which indicates whether the layer will be serialized by appropriate routines.
bool AxMap.get_LayerVisible (int LayerHandle)
 Gets the visibility of the specified layer.
object AxMap.GetColorScheme (int LayerHandle)
 Returns a color scheme for the specified layer.
void AxMap.set_LayerDescription (int LayerHandle, string newValue)
 Sets the description of the layer.
void AxMap.set_LayerDynamicVisibility (int LayerHandle, bool newValue)
 Sets the boolean value which indicates whether the layer will be displayed at all scales or only within the chosen range of scales.
void AxMap.set_LayerKey (int LayerHandle, string newValue)
 Sets a string associated with a layer in the map.
void AxMap.set_LayerLabels (int LayerHandle, MapWinGIS.Labels newValue)
 Sets the labels associated with the layer.
void AxMap.set_LayerMaxVisibleScale (int LayerHandle, double newValue)
 Sets the maximum scale at which the layer is visible on the map.
void AxMap.set_LayerMaxVisibleZoom (int layerHandle, int param0)
 Sets maximum zoom at which the layer will be displayed.
void AxMap.set_LayerMinVisibleScale (int LayerHandle, double newValue)
 Sets the minimum scale at which the layer is visible on the map.
void AxMap.set_LayerMinVisibleZoom (int layerHandle, int param0)
 Sets minimum zoom at which the layer will be displayed.
void AxMap.set_LayerName (int LayerHandle, string newValue)
 Sets the name of the specified layer.
void AxMap.set_LayerSkipOnSaving (int LayerHandle, bool newValue)
 Sets a boolean value which indicates whether the layer will be serialized by appropriate routines.
void AxMap.set_LayerVisible (int LayerHandle, bool newValue)
 Sets the visibility of the specified layer.

Detailed Description

Here is a list of properties common to all data layers. This module is a part of the documentation of AxMap class.

dot_inline_dotgraph_5.png

Graph description


Function Documentation

string AxMap.get_LayerDescription ( int  LayerHandle)

Gets the description of the layer from the associated .mwsymb file.

Parameters:
LayerHandleThe handle of the layer.
Returns:
The string with description.
New API 4.8:
Added in version 4.8
bool AxMap.get_LayerDynamicVisibility ( int  LayerHandle)

Gets the boolean value which indicates whether the layer will be displayed at all scales or only within the chosen range of scales.

Parameters:
LayerHandleThe handle of the layer.
Returns:
True in case the layer will be displayed between specified scales only.
See also:
AxMap.get_LayerMaxVisibleScale, AxMap.get_LayerMinVisibleScale
New API 4.8:
Added in version 4.8
string AxMap.get_LayerFilename ( int  layerHandle)

Gets filename of datasource for the specified layer.

Parameters:
layerHandleLayer handle.
Returns:
Filename of the layer including path.
New API 4.9.0:
Added in version 4.9.0
string AxMap.get_LayerKey ( int  LayerHandle)

Gets a string associated with a layer in the map.

This string can be used to store any string data desired by the developer.

Parameters:
LayerHandleThe handle for the layer for which the layer key is to be set.
Returns:
The layer key for the specified layer in string format.
MapWinGIS.Labels AxMap.get_LayerLabels ( int  LayerHandle)

Returns labels associated with layer.

Labels can also be obtained by using Shapefile.Labels and Image.Labels.

Parameters:
LayerHandleThe handle of the layer.
Returns:
The labels associated with the layer.
New API 4.8:
Added in version 4.8
double AxMap.get_LayerMaxVisibleScale ( int  LayerHandle)

Gets the maximum scale at which the layer is visible on the map.

Parameters:
LayerHandleThe handle of the layer.
Returns:
The maximum visible scale for the layer.
New API 4.8:
Added in version 4.8
int AxMap.get_LayerMaxVisibleZoom ( int  layerHandle)

Gets maximum zoom at which the layer will be displayed.

Parameters:
layerHandle
Returns:

It's analogous to get_LayerMaxVisibleScale, only scale specified as zoom level of the current tile provider (Map.Tiles.Provider).

New API 4.9.1:
Added in version 4.9.1
double AxMap.get_LayerMinVisibleScale ( int  LayerHandle)

Gets the minimum scale at which the layer is visible on the map.

Parameters:
LayerHandleThe handle of the layer.
Returns:
The minimum visible scale for the layer.
New API 4.8:
Added in version 4.8
int AxMap.get_LayerMinVisibleZoom ( int  layerHandle)

Gets minimum zoom at which the layer will be displayed.

Parameters:
layerHandle
Returns:

It's analogous to get_LayerMinVisibleScale, only scale specified as zoom level of the current tile provider (Map.Tiles.Provider).

New API 4.9.1:
Added in version 4.9.1
string AxMap.get_LayerName ( int  LayerHandle)

Gets the name of the specified layer.

Parameters:
LayerHandleThe handle of the layer for which the name is to be set.
Returns:
The layer name for the specified layer.
Examples:
SortLayers.cs, and SplitByAttribute.cs.
bool AxMap.get_LayerSkipOnSaving ( int  LayerHandle)

Gets a boolean value which indicates whether the layer will be serialized by appropriate routines.

This property affects AxMap.SaveMapState, AxMap.SerializeMapState.

Parameters:
LayerHandleThe handle of the layer.
Returns:
True in case the layer will be excluded from serialization and false otherwise.
New API 4.8:
Added in version 4.8
bool AxMap.get_LayerVisible ( int  LayerHandle)

Gets the visibility of the specified layer.

Parameters:
LayerHandleThe handle of the layer for which the visibility is being set.
Returns:
A boolean value representing whether the layer is to be visible or not.
object AxMap.GetColorScheme ( int  LayerHandle)

Returns a color scheme for the specified layer.

Parameters:
LayerHandleThe layer handle of the layer for which the coloring scheme is required
Returns:
The color scheme for the specified layer
void AxMap.set_LayerDescription ( int  LayerHandle,
string  newValue 
)

Sets the description of the layer.

The information will be stored in .mwsymb file associated with data layer.

Parameters:
LayerHandleThe handle of the layer.
newValueThe description of the layer.
New API 4.8:
Added in version 4.8
void AxMap.set_LayerDynamicVisibility ( int  LayerHandle,
bool  newValue 
)

Sets the boolean value which indicates whether the layer will be displayed at all scales or only within the chosen range of scales.

Parameters:
LayerHandleThe handle of the layer.
newValueTrue in case the layer will be displayed between specified scales only.
See also:
set_LayerMaxVisibleScale, set_LayerMinVisibleScale
New API 4.8:
Added in version 4.8
void AxMap.set_LayerKey ( int  LayerHandle,
string  newValue 
)

Sets a string associated with a layer in the map.

This string can be used to store any string data desired by the developer.

Parameters:
LayerHandleThe handle of the layer.
newValueThe string to be associated with layer.
void AxMap.set_LayerLabels ( int  LayerHandle,
MapWinGIS.Labels  newValue 
)

Sets the labels associated with the layer.

Parameters:
LayerHandleThe handle of the layer.
newValueThe new instance of the Labels class to be associated with the layer.
New API 4.8:
Added in version 4.8
void AxMap.set_LayerMaxVisibleScale ( int  LayerHandle,
double  newValue 
)

Sets the maximum scale at which the layer is visible on the map.

Parameters:
LayerHandleThe handle of the layer.
newValueThe maximum visible scale for the layer.
New API 4.8:
Added in version 4.8
void AxMap.set_LayerMaxVisibleZoom ( int  layerHandle,
int  param0 
)

Sets maximum zoom at which the layer will be displayed.

Parameters:
layerHandleLayer handle.
param0The new value of max zoom.

It's analogous to set_LayerMaxVisibleScale, only scale specified as zoom level of the current tile provider (Map.Tiles.Provider).

New API 4.9.1:
Added in version 4.9.1
void AxMap.set_LayerMinVisibleScale ( int  LayerHandle,
double  newValue 
)

Sets the minimum scale at which the layer is visible on the map.

Parameters:
LayerHandleThe handle of the layer.
newValueThe minimum visible scale for the layer.
New API 4.8:
Added in version 4.8
void AxMap.set_LayerMinVisibleZoom ( int  layerHandle,
int  param0 
)

Sets minimum zoom at which the layer will be displayed.

Parameters:
layerHandleLayer handle.
param0The new value of max zoom.

It's analogous to set_LayerMinVisibleScale, only scale specified as zoom level of the current tile provider (Map.Tiles.Provider).

New API 4.9.1:
Added in version 4.9.1
void AxMap.set_LayerName ( int  LayerHandle,
string  newValue 
)

Sets the name of the specified layer.

Parameters:
LayerHandleThe handle of the layer for which the name is to be set.
newValueThe name to be set for the layer.
Examples:
AddLayers.cs, and SplitByAttribute.cs.
void AxMap.set_LayerSkipOnSaving ( int  LayerHandle,
bool  newValue 
)

Sets a boolean value which indicates whether the layer will be serialized by appropriate routines.

This property affects AxMap.SaveMapState, AxMap.SerializeMapState.

Parameters:
LayerHandleThe handle of the layer.
newValueTrue in case the layer will be excluded from serialization and false otherwise.
New API 4.8:
Added in version 4.8
void AxMap.set_LayerVisible ( int  LayerHandle,
bool  newValue 
)

Sets the visibility of the specified layer.

Parameters:
LayerHandleThe handle of the layer for which the visibility is returned.
newValueA boolean value representing whether the layer is to be visible or not.
 All Classes Files Functions Enumerations Properties Events