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_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.
double AxMap.get_LayerMinVisibleScale (int LayerHandle)
 Gets the minimum scale at which the layer is visible on the map.
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 approriate routines.
bool AxMap.get_LayerVisible (int LayerHandle)
 Gets the visibility of the specified layer.
void AxMap.set_LayerDescription (int LayerHandle, string __p2)
 Sets the description of the layer.
void AxMap.set_LayerDynamicVisibility (int LayerHandle, bool __p2)
 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 __p2)
 Sets a string associated with a layer in the map.
void AxMap.set_LayerLabels (int LayerHandle, MapWinGIS.Labels __p2)
 Sets the labels associated with the layer.
void AxMap.set_LayerMaxVisibleScale (int LayerHandle, double __p2)
 Sets the maximum scale at which the layer is visible on the map.
void AxMap.set_LayerMinVisibleScale (int LayerHandle, double __p2)
 Sets the minimum scale at which the layer is visible on the map.
void AxMap.set_LayerName (int LayerHandle, string __p2)
 Sets the name of the specified layer.
void AxMap.set_LayerSkipOnSaving (int LayerHandle, bool __p2)
 Sets a boolean value which indicates whether the layer will be serialized by approriate routines.
void AxMap.set_LayerVisible (int LayerHandle, bool __p2)
 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_8.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_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
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
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 approriate 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.
void AxMap.set_LayerDescription ( int  LayerHandle,
string  __p2 
)

Sets the description of the layer.

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

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

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.
__p2True 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  __p2 
)

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.
__p2The string to be associated with layer.
void AxMap.set_LayerLabels ( int  LayerHandle,
MapWinGIS.Labels  __p2 
)

Sets the labels associated with the layer.

Parameters:
LayerHandleThe handle of the layer.
__p2The 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  __p2 
)

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

Parameters:
LayerHandleThe handle of the layer.
__p2The maximum visible scale for the layer.
New API 4.8:
Added in version 4.8
void AxMap.set_LayerMinVisibleScale ( int  LayerHandle,
double  __p2 
)

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

Parameters:
LayerHandleThe handle of the layer.
__p2The minimum visible scale for the layer.
New API 4.8:
Added in version 4.8
void AxMap.set_LayerName ( int  LayerHandle,
string  __p2 
)

Sets the name of the specified layer.

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

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

This property affects AxMap.SaveMapState, AxMap.SerializeMapState.

Parameters:
LayerHandleThe handle of the layer.
__p2True 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  __p2 
)

Sets the visibility of the specified layer.

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