Class RuntimeMapLayer

Represents a runtime map layer. Use CreateMapLayer(RuntimeMap, ILayerDefinition) to create instances of this class.

Inheritance

System.Object

MapObservable

RuntimeMapLayer

Implements

System.ComponentModel.INotifyPropertyChanged

Inherited Members

MapObservable._disableChangeTracking

MapObservable.SetField<T>(T, T, String)

MapObservable.ObservableSet<T>(T, T, Action<T>, String)

MapObservable.PropertyChanged

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.MaestroAPI.Mapping

Assembly: OSGeo.MapGuide.MaestroAPI.dll

Syntax

public class RuntimeMapLayer : MapObservable, INotifyPropertyChanged

Constructors

| Improve this Doc View Source

RuntimeMapLayer()

Declaration

protected RuntimeMapLayer()

| Improve this Doc View Source

RuntimeMapLayer(RuntimeMap)

Initializes this instance

Declaration

protected RuntimeMapLayer(RuntimeMap parent)

Parameters

Type	Name	Description
RuntimeMap	parent

| Improve this Doc View Source

RuntimeMapLayer(RuntimeMap, ILayerDefinition, Boolean)

Initializes a new instance of the RuntimeMapLayer class.

Declaration

protected RuntimeMapLayer(RuntimeMap parent, ILayerDefinition ldf, bool suppressErrors)

Parameters

Type	Name	Description
RuntimeMap	parent	The parent.
ILayerDefinition	ldf	The Layer Definition.
System.Boolean	suppressErrors	If true, any errors while creating the layer are suppressed. The nature of the error may result in un-selectable layers

| Improve this Doc View Source

RuntimeMapLayer(RuntimeMap, IBaseMapLayer, ILayerDefinition, Boolean)

Initializes a new instance

Declaration

protected RuntimeMapLayer(RuntimeMap parent, IBaseMapLayer source, ILayerDefinition ldf, bool suppressErrors)

Parameters

Type	Name	Description
RuntimeMap	parent
IBaseMapLayer	source
ILayerDefinition	ldf
System.Boolean	suppressErrors

| Improve this Doc View Source

RuntimeMapLayer(RuntimeMap, IMapLayer, ILayerDefinition, Boolean)

Initializes a new instance

Declaration

protected RuntimeMapLayer(RuntimeMap parent, IMapLayer source, ILayerDefinition ldf, bool suppressErrors)

Parameters

Type	Name	Description
RuntimeMap	parent
IMapLayer	source
ILayerDefinition	ldf
System.Boolean	suppressErrors

| Improve this Doc View Source

RuntimeMapLayer(RuntimeMap, IMapLayer, Boolean)

Initializes a new instance of the RuntimeMapLayer class.

Declaration

protected RuntimeMapLayer(RuntimeMap parent, IMapLayer source, bool suppressErrors)

Parameters

Type	Name	Description
RuntimeMap	parent	The parent.
IMapLayer	source	The source.
System.Boolean	suppressErrors

Properties

| Improve this Doc View Source

DisplayOrder

Gets the display order

Declaration

public virtual double DisplayOrder { get; }

Property Value

Type	Description
System.Double

| Improve this Doc View Source

DisplayString

Gets a display string for this layer for presentation purposes

Declaration

public string DisplayString { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ExpandInLegend

Gets or sets a value indicating whether [expand in legend].

Declaration

public virtual bool ExpandInLegend { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [expand in legend]; otherwise, `false`.

| Improve this Doc View Source

FeatureSourceID

Gets or sets the feature source ID.

Declaration

public virtual string FeatureSourceID { get; }

Property Value

Type	Description
System.String	The feature source ID.

| Improve this Doc View Source

Filter

Gets the filter.

Declaration

public virtual string Filter { get; }

Property Value

Type	Description
System.String	The filter.

| Improve this Doc View Source

GeometryPropertyName

Gets the name of the geometry property.

Declaration

public virtual string GeometryPropertyName { get; }

Property Value

Type	Description
System.String	The name of the geometry property.

| Improve this Doc View Source

Group

Gets or sets the group.

Declaration

public virtual string Group { get; set; }

Property Value

Type	Description
System.String	The group.

| Improve this Doc View Source

HasTooltips

Gets whether this layer has tooltips

Declaration

public virtual bool HasTooltips { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IdentityProperties

Gets the identity properties.

Declaration

public PropertyInfo[] IdentityProperties { get; }

Property Value

Type	Description
PropertyInfo[]	The identity properties.

| Improve this Doc View Source

IncludeBoundsForSelectedFeatures

Indicates if bounds information should be returned for selected features

Declaration

public bool IncludeBoundsForSelectedFeatures { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

LayerDefinitionID

Gets the layer definition ID.

Declaration

public virtual string LayerDefinitionID { get; }

Property Value

Type	Description
System.String	The layer definition ID.

| Improve this Doc View Source

LegendLabel

Gets or sets the legend label.

Declaration

public virtual string LegendLabel { get; set; }

Property Value

Type	Description
System.String	The legend label.

| Improve this Doc View Source

Name

Gets or sets the name.

Declaration

public virtual string Name { get; set; }

Property Value

Type	Description
System.String	The name.

| Improve this Doc View Source

NeedsRefresh

Gets whether this layer needs to be refreshed

Declaration

public virtual bool NeedsRefresh { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

ObjectId

Gets the object id.

Declaration

public virtual string ObjectId { get; }

Property Value

Type	Description
System.String	The object id.

| Improve this Doc View Source

Parent

Gets the RuntimeMap that this layer belongs to

Declaration

public RuntimeMap Parent { get; }

Property Value

Type	Description
RuntimeMap

| Improve this Doc View Source

QualifiedClassName

Gets the name of the qualified name of the feature class.

Declaration

public virtual string QualifiedClassName { get; }

Property Value

Type	Description
System.String	The name of the qualified name of the feature class.

| Improve this Doc View Source

ScaleRanges

Gets the applicable scale ranges for this layer

Declaration

public RuntimeMapLayer.ScaleRange[] ScaleRanges { get; }

Property Value

Type	Description
RuntimeMapLayer.ScaleRange[]

| Improve this Doc View Source

SchemaName

Gets the schema name

Declaration

public string SchemaName { get; }

Property Value

Type	Description
System.String

Remarks

For drawing layers, the schema name will always be empty

| Improve this Doc View Source

Selectable

Gets or sets a value indicating whether this RuntimeMapLayer is selectable.

Declaration

public virtual bool Selectable { get; set; }

Property Value

Type	Description
System.Boolean	`true` if selectable; otherwise, `false`.

| Improve this Doc View Source

ShowInLegend

Gets or sets a value indicating whether [show in legend].

Declaration

public virtual bool ShowInLegend { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [show in legend]; otherwise, `false`.

| Improve this Doc View Source

Type

Gets the type

Declaration

public virtual int Type { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

Visible

Gets or sets a value indicating whether this RuntimeMapLayer is visible.

Declaration

public virtual bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	`true` if visible; otherwise, `false`.

Methods

| Improve this Doc View Source

Deserialize(MgBinaryDeserializer)

Initializes this instance with the specified binary stream

Declaration

public virtual void Deserialize(MgBinaryDeserializer d)

Parameters

Type	Name	Description
MgBinaryDeserializer	d

| Improve this Doc View Source

ForceRefresh()

Sets the refresh flag for this layer

Declaration

public virtual void ForceRefresh()

| Improve this Doc View Source

GetClassDefinition()

Convenience method to get the associated class definition

Declaration

public ClassDefinition GetClassDefinition()

Returns

Type	Description
ClassDefinition

| Improve this Doc View Source

Initialize(ILayerDefinition, Boolean)

Initializes this instances from the specified Layer Definition

Declaration

protected void Initialize(ILayerDefinition ldf, bool suppressErrors)

Parameters

Type	Name	Description
ILayerDefinition	ldf
System.Boolean	suppressErrors

| Improve this Doc View Source

IsVisibleAtScale(Double)

Determines whether this layer is potentially visible at the specified scale

Declaration

public bool IsVisibleAtScale(double scale)

Parameters

Type	Name	Description
System.Double	scale	The scale to check for potential visibility

Returns

Type	Description
System.Boolean

Remarks

Current layer visibility does not factor into the final result

| Improve this Doc View Source

OnPropertyChanged(String)

Raises the System.ComponentModel.INotfiyPropertyChanged.PropertyChanged event

Declaration

protected override void OnPropertyChanged(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName

Overrides

MapObservable.OnPropertyChanged(String)

| Improve this Doc View Source

ParseSelectionValues(String)

Parses encoded id string into an array of values

Declaration

public object[] ParseSelectionValues(string encodedId)

Parameters

Type	Name	Description
System.String	encodedId	The encoded id string.

Returns

Type	Description
System.Object[]

| Improve this Doc View Source

Serialize(MgBinarySerializer)

Serializes this instance to a binary stream

Declaration

public virtual void Serialize(MgBinarySerializer s)

Parameters

Type	Name	Description
MgBinarySerializer	s

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods

Extensions.GetParentGroup(RuntimeMapLayer)