Class MapShapeReaderBase

Represents the MapShapeReaderBase class.

Inheritance
System.Object
MapShapeReaderBase
MapShapeReader
SqlGeospatialDataReader
Namespace: Telerik.Windows.Controls.Map
Assembly: Telerik.Windows.Controls.DataVisualization.dll

Syntax

public abstract class MapShapeReaderBase : Freezable

Constructors

MapShapeReaderBase()

Declaration
protected MapShapeReaderBase()

Fields

ClearLayerProperty

Identifies the ClearLayer dependency property.

Declaration
public static readonly DependencyProperty ClearLayerProperty
Field Value
System.Windows.DependencyProperty

CoordinateConverterProperty

Identifies the CoordinateConverter dependency property.

Declaration
public static readonly DependencyProperty CoordinateConverterProperty
Field Value
System.Windows.DependencyProperty

ExtendedPropertySetProperty

Identifies the ExtendedPropertySet dependency property.

Declaration
public static readonly DependencyProperty ExtendedPropertySetProperty
Field Value
System.Windows.DependencyProperty

PointTemplateProperty

Identifies the PointTemplateProperty dependency property.

Declaration
public static readonly DependencyProperty PointTemplateProperty
Field Value
System.Windows.DependencyProperty

ToolTipFormatProperty

Identifies the ToolTipFormat dependency property.

Declaration
public static readonly DependencyProperty ToolTipFormatProperty
Field Value
System.Windows.DependencyProperty

ToolTipStyleProperty

Identifies the ToolTipStyle dependency property.

Declaration
public static readonly DependencyProperty ToolTipStyleProperty
Field Value
System.Windows.DependencyProperty

ToolTipTemplateProperty

Identifies the ToolTipTemplate dependency property.

Declaration
public static readonly DependencyProperty ToolTipTemplateProperty
Field Value
System.Windows.DependencyProperty

Properties

ClearLayer

Gets or sets the ClearLayer property. If it is set to true, then the reader clears its information layer after reading.

Declaration
public bool ClearLayer { get; set; }
Property Value
System.Boolean

CoordinateConverter

Gets or sets the CoordinateConverter applied to the reader.

Declaration
public ICoordinateConverter CoordinateConverter { get; set; }
Property Value
ICoordinateConverter

ExtendedPropertySet

Gets or sets extended property set which will be used during shape file (KML or ESRI) reading.

Declaration
public ExtendedPropertySet ExtendedPropertySet { get; set; }
Property Value
ExtendedPropertySet

Remarks

Can be null. In this case extended property set will be created depends on the extended data available in the KML file or in the attributes file (DBF).

Layer

Target information layer.

Declaration
public InformationLayer Layer { get; set; }
Property Value
InformationLayer

PointTemplate

Gets or sets content template for the point (reader uses the MapContentControl to represent a point).

Declaration
public DataTemplate PointTemplate { get; set; }
Property Value
System.Windows.DataTemplate

ToolTipFormat

Gets or sets tooltip format. Either ToolTipFormat or ToolTipTemplate should be specified. If both properties are set, then ToolTipTemplate will be used.

Declaration
public string ToolTipFormat { get; set; }
Property Value
System.String

Examples

The tooltip format can be specified in a few different ways: as simple name of the extended property, as formatted extended property, or as format string which can use number of the extended properties.

// Using of the single extended property name.
this.informationLayer.Reader.ToolTipFormat = "CNTRY_NAME";

// Using of the formatted extended property.
// The '|' character is used to separate extended property name and its output format.
this.informationLayer.Reader.ToolTipFormat = "SUM_SQMI_A|F2";

// Format string with number of the extended properties.
this.informationLayer.Reader.ToolTipFormat = "{CNTRY_NAME} Miles: {SUM_SQMI_A|F2}, KM: {SUM_SQKM_A|F1}";
' Using of the single extended property name.
Me.informationLayer.Reader.ToolTipFormat = "CNTRY_NAME"

' Using of the formatted extended property.
' The '|' character is used to separate extended property name and its output format.
Me.informationLayer.Reader.ToolTipFormat = "SUM_SQMI_A|F2"

 Format string with number of the extended properties.
Me.informationLayer.Reader.ToolTipFormat = "{CNTRY_NAME} Miles: {SUM_SQMI_A|F2}, KM: {SUM_SQKM_A|F1}"
<telerik:MapShapeReader Source="/Telerik.RadMap.Silverlight;component/africa"
    ToolTipFormat="CNTRY_NAME">

<telerik:MapShapeReader Source="/Telerik.RadMap.Silverlight;component/africa"
    ToolTipFormat="SUM_SQMI_A|F2">

<telerik:MapShapeReader Source="/Telerik.RadMap.Silverlight;component/africa"
    ToolTipFormat="{}{CNTRY_NAME} Miles: {SUM_SQMI_A|F2}, KM: {SUM_SQKM_A|F1}">
.

ToolTipStyle

Gets or sets the style applied to the toolTip.

Declaration
public Style ToolTipStyle { get; set; }
Property Value
System.Windows.Style

ToolTipTemplate

Gets or sets tooltip content template. Either ToolTipFormat or ToolTipTemplate should be specified. If both properties are set, then ToolTipTemplate will be used. You can bind elements in the tooltip template to extended properties using ExtendedDataConverter and Data property of the ExtendedData object.

Declaration
public DataTemplate ToolTipTemplate { get; set; }
Property Value
System.Windows.DataTemplate

Examples

This example demonstrates how the tooltip template can be set.

<telerik:MapShapeReader Source="/Telerik.RadMap.Silverlight;component/africa">
    <telerik:MapShapeReader.ToolTipTemplate>
        <DataTemplate>
            <Grid>
                <Grid.ColumnDefinitions>
                    <ColumnDefinition Width="Auto" />
                    <ColumnDefinition Width="Auto" />
                </Grid.ColumnDefinitions>
                <Grid.RowDefinitions>
                    <RowDefinition Height="Auto" />
                    <RowDefinition Height="Auto" />
                    <RowDefinition Height="Auto" />
                </Grid.RowDefinitions>

                <TextBlock Grid.Column="0" Grid.Row="0" Text="Name:" />
                <TextBlock Grid.Column="1" Grid.Row="0" 
                    Text="{Binding Path=Data, Converter={StaticResource ExtendedDataConverter}, ConverterParameter='CNTRY_NAME'}" />

                <TextBlock Grid.Column="0" Grid.Row="1" Text="Population:" />
                <TextBlock Grid.Column="1" Grid.Row="1" 
                    Text="{Binding Path=Data, Converter={StaticResource ExtendedDataConverter}, ConverterParameter='SUM_POP_AD'}" />

                <TextBlock Grid.Column="0" Grid.ColumnSpan="2" Grid.Row="2" 
                    Text="{Binding Path=Data, Converter={StaticResource ExtendedDataConverter}, ConverterParameter='Miles: {SUM_SQMI_A|F2}, KM: {SUM_SQKM_A|F1}'}" />
            </Grid>
        </DataTemplate>
    </telerik:MapShapeReader.ToolTipTemplate>
</telerik:MapShapeReader>
.

Methods

add_PreviewReadCompleted(PreviewReadShapesCompletedEventHandler)

Declaration
public void add_PreviewReadCompleted(PreviewReadShapesCompletedEventHandler value)
Parameters
PreviewReadShapesCompletedEventHandler value

add_ReadCompleted(ReadShapesCompletedEventHandler)

Declaration
public void add_ReadCompleted(ReadShapesCompletedEventHandler value)
Parameters
ReadShapesCompletedEventHandler value

AddItemsToLayer(Exception, List<FrameworkElement>)

Adds items to the referenced layer.

Declaration
protected void AddItemsToLayer(Exception error, List<FrameworkElement> shapeList)
Parameters
System.Exception error

Exception.
System.Collections.Generic.List<System.Windows.FrameworkElement> shapeList

List of shapes.

CreateInstanceCore()

When implemented in a derived class, creates a new instance of the Freezable derived class.

Declaration
protected override Freezable CreateInstanceCore()
Returns
System.Windows.Freezable

Null.

OnPreviewReadCompleted(PreviewReadShapesCompletedEventArgs)

Raises the PreviewReadCompleted event.

Declaration
protected virtual void OnPreviewReadCompleted(PreviewReadShapesCompletedEventArgs previewReadCompletedArgs)
Parameters
PreviewReadShapesCompletedEventArgs previewReadCompletedArgs

The PreviewReadShapesCompletedEventArgs instance containing the event data.

OnReadCompleted(ReadShapesCompletedEventArgs)

Raises the ReadCompleted event.

Declaration
protected virtual void OnReadCompleted(ReadShapesCompletedEventArgs eventArgs)
Parameters
ReadShapesCompletedEventArgs eventArgs

The ReadShapesCompletedEventArgs instance containing the event data.

remove_PreviewReadCompleted(PreviewReadShapesCompletedEventHandler)

Declaration
public void remove_PreviewReadCompleted(PreviewReadShapesCompletedEventHandler value)
Parameters
PreviewReadShapesCompletedEventHandler value

remove_ReadCompleted(ReadShapesCompletedEventHandler)

Declaration
public void remove_ReadCompleted(ReadShapesCompletedEventHandler value)
Parameters
ReadShapesCompletedEventHandler value

Events

PreviewReadCompleted

Occurs when the reader completes to read shapes.

Declaration
public event PreviewReadShapesCompletedEventHandler PreviewReadCompleted
Event Type
PreviewReadShapesCompletedEventHandler

ReadCompleted

Occurs when the reader completes to read shapes and pass them to target information layer.

Declaration
public event ReadShapesCompletedEventHandler ReadCompleted
Event Type
ReadShapesCompletedEventHandler

Extension Methods