Class MapDefinitionExtensions

Extension method class

Inheritance

System.Object

MapDefinitionExtensions

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: OSGeo.MapGuide.ObjectModels.MapDefinition

Assembly: OSGeo.MapGuide.ObjectModels.dll

Syntax

public static class MapDefinitionExtensions

Methods

AddBaseLayerGroup(IMapDefinition, String)

Adds the specified base layer group to the map definition

Declaration

public static IBaseMapGroup AddBaseLayerGroup(this IMapDefinition map, string name)

Parameters

Type	Name	Description
IMapDefinition	map
System.String	name

Returns

Type	Description
IBaseMapGroup

AddFiniteDisplayScale(IMapDefinition, Double)

Adds the specified finite display scale to the Map Definition

Declaration

public static void AddFiniteDisplayScale(this IMapDefinition map, double scale)

Parameters

Type	Name	Description
IMapDefinition	map
System.Double	scale

AutoSetExtentsFromLayer(IMapDefinition, String)

Sets the extents of the map definition from the id of the the given layer definition Does nothing if the extent is already set

Declaration

public static void AutoSetExtentsFromLayer(this IMapDefinition mdf, string layerDefinitionId)

Parameters

Type	Name	Description
IMapDefinition	mdf
System.String	layerDefinitionId

ConvertToTileSet(IMapDefinition, Version)

Converts the given base map section to a Tile Set Definition reference

Declaration

public static ITileSetDefinition ConvertToTileSet(this IMapDefinition map, Version schemaVersion)

Parameters

Type	Name	Description
IMapDefinition	map
System.Version	schemaVersion

Returns

Type	Description
ITileSetDefinition

GetDynamicLayerCount(IMapDefinition)

Gets the number of layers (non-tiled) on this map

Declaration

public static int GetDynamicLayerCount(this IMapDefinition map)

Parameters

Type	Name	Description
IMapDefinition	map

Returns

Type	Description
System.Int32

GetGroupByName(IMapDefinition, String)

Gets a group by its name

Declaration

public static IMapLayerGroup GetGroupByName(this IMapDefinition map, string name)

Parameters

Type	Name	Description
IMapDefinition	map
System.String	name

Returns

Type	Description
IMapLayerGroup

GetGroupCount(IMapDefinition)

Gets the number of groups (non-tiled) on this map

Declaration

public static int GetGroupCount(this IMapDefinition map)

Parameters

Type	Name	Description
IMapDefinition	map

Returns

Type	Description
System.Int32

GetGroupsForGroup(IMapDefinition, String)

Gets all the groups that belong to the specified group

Declaration

public static IEnumerable<IMapLayerGroup> GetGroupsForGroup(this IMapDefinition map, string name)

Parameters

Type	Name	Description
IMapDefinition	map
System.String	name

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMapLayerGroup>

GetLayerByName(IMapDefinition, String)

Get a layer by its name

Declaration

public static IMapLayer GetLayerByName(this IMapDefinition map, string name)

Parameters

Type	Name	Description
IMapDefinition	map
System.String	name

Returns

Type	Description
IMapLayer

GetLayersForGroup(IMapDefinition, String)

Gets all the layers that belong to the specified group

Declaration

public static IEnumerable<IMapLayer> GetLayersForGroup(this IMapDefinition map, string name)

Parameters

Type	Name	Description
IMapDefinition	map
System.String	name

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMapLayer>

GetLayersWithoutGroups(IMapDefinition)

Gets all that layers that do not belong to a group

Declaration

public static IEnumerable<IMapLayer> GetLayersWithoutGroups(this IMapDefinition map)

Parameters

Type	Name	Description
IMapDefinition	map

Returns

Type	Description
System.Collections.Generic.IEnumerable<IMapLayer>

RemoveAllFiniteDisplayScales(IMapDefinition, Boolean)

Removes all finite display scales from the Map Definition

Declaration

public static void RemoveAllFiniteDisplayScales(this IMapDefinition map, bool bDetachIfEmpty)

Parameters

Type	Name	Description
IMapDefinition	map
System.Boolean	bDetachIfEmpty

RemoveBaseLayerGroup(IMapDefinition, IBaseMapGroup, Boolean)

Removes the given base layer group from the Map Definition

Declaration

public static void RemoveBaseLayerGroup(this IMapDefinition map, IBaseMapGroup group, bool bDetachIfEmpty)

Parameters

Type	Name	Description
IMapDefinition	map
IBaseMapGroup	group
System.Boolean	bDetachIfEmpty

RemoveFiniteDisplayScale(IMapDefinition, Double, Boolean)

Removes the specified finite display scale from the Map Definition

Declaration

public static void RemoveFiniteDisplayScale(this IMapDefinition map, double scale, bool bDetachIfEmpty)

Parameters

Type	Name	Description
IMapDefinition	map
System.Double	scale
System.Boolean	bDetachIfEmpty

RemoveLayerGroupAndChildLayers(IMapDefinition, String)

Removes a layer group and all layers associated with this group

Declaration

public static int RemoveLayerGroupAndChildLayers(this IMapDefinition map, string groupName)

Parameters

Type	Name	Description
IMapDefinition	map
System.String	groupName

Returns

Type	Description
System.Int32	The number of layers removed. Returns 0 if the group is empty or does not exist

UpdateDynamicGroupName(IMapDefinition, String, String)

Updates the group name references of all layers belonging to a particular group

Declaration

public static void UpdateDynamicGroupName(this IMapDefinition map, string oldGroupName, string newGroupName)

Parameters

Type	Name	Description
IMapDefinition	map	The map.
System.String	oldGroupName	Old name of the group.
System.String	newGroupName	New name of the group.