Class GeoMapElement

Base class definition for top level data items

Inheritance

object

GeoMapElement

GeoArc

GeoCircle

GeoLine

GeoLineString

GeoMapAction

GeoMapIcon

GeoMapImage

GeoPoint

GeoPolygon

Implements

IGeoMapElement

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: FpAssistantCore.Geographical

Assembly: FpAssistantCoreScl.dll

Syntax

public abstract class GeoMapElement : IGeoMapElement

Remarks

When implement the drawing of map elements in your graphical system, an assessment of what data you want to include from the properties in this class will be needed

Constructors

GeoMapElement()

Constructor for class GeoMapElement

Declaration

public GeoMapElement()

Properties

Color

Gets or sets the colour of the map element

Declaration

public FpaColour Color { get; set; }

Property Value

Type	Description
FpaColour

DataList

A Key/Value pair for holding other data

Declaration

public Dictionary<string, string> DataList { get; }

Property Value

Type	Description
Dictionary<string, string>	Pair of string objects held in a Dictionary (Key and Value)

Remarks

A simple two column list to hold a list of data. The Key must be unique

Description

Gets or sets the description of the map element

Declaration

public string Description { get; set; }

Property Value

Type	Description
string

Remarks

A general description for a map element, can be left blank but used when needed

GraphicalLayerName

Gets or sets a graphical layer name

Declaration

public string GraphicalLayerName { get; set; }

Property Value

Type	Description
string

Remarks

Any graphical object can have the option of being drawn to a 'layer' which could be displayed or not. This is optional

GroupNames

Gets or sets a grouping option

Declaration

public List<string> GroupNames { get; set; }

Property Value

Type	Description
List<string>

Remarks

Some graphical system offer a feature to group graphics, this property contains a list of groups that any map element could be associated with. This is optional

Name

Gets or sets the name of the map element

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Remarks

This can have have any text literal and is made available for your own naming of Map Elements

Thickness

Gets or sets the thickness of the map element

Declaration

public int Thickness { get; set; }

Property Value

Type	Description
int

UniqueId

Gets or sets the unique id of the map element

Declaration

public Guid UniqueId { get; set; }

Property Value

Type	Description
Guid

Methods

AddDataList(string, string)

Add a row entry to the data list

Declaration

public void AddDataList(string uniqueKey, string value)

Parameters

Type	Name	Description
string	uniqueKey	Unique indexer of the data item
string	value	Value of the data item

Exceptions

Type	Condition
ArgumentException	If key has already been added to the list

AssignProperties(MapObjectProperties)

Method to assign properties to a GeoMapElement

Declaration

public virtual void AssignProperties(MapObjectProperties mapObjectProperties)

Parameters

Type	Name	Description
MapObjectProperties	mapObjectProperties	Properties to assign to the GeoMapElement

Exceptions

Type	Condition
NullReferenceException	If parameter 'mapObjectProperties' is null

Draw()

Method to draw the MapElement

Declaration

public virtual void Draw()

Implements

IGeoMapElement