Back to all docs
API Reference / Telerik.WinControls.UI / AsyncReaderBase

Class
AsyncReaderBase

Base class for the asynchronous map shape readers (KML, ESRI, WKT/WKB).

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.RadMap.dll

Syntax:
cs-api-definition
public abstract class AsyncReaderBase : RadObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor

Inheritance: objectDisposableObjectRadObjectAsyncReaderBase

Derived Classes: AsyncFileReaderBaseAsyncSqlGeospatialDataReader

Implements: ICustomTypeDescriptorIDisposableINotifyPropertyChanged

Inherited Members RadObject.BindingContextPropertyRadObject.RadTypeRadObject.ReplaceDefaultDescriptors(PropertyDescriptorCollection)RadObject.DisposeManagedResources()RadObject.ClearPropertyStore()RadObject.SuspendPropertyNotifications()RadObject.ResumePropertyNotifications()RadObject.GetPropertyValue(RadProperty)RadObject.SetDefaultValueOverride(RadProperty, object)RadObject.GetValue(RadProperty)RadObject.SetValue(RadProperty, object)RadObject.ResetValue(RadProperty)RadObject.ResetLocalValue(RadProperty)RadObject.ResetValue(RadProperty, ValueResetFlags)RadObject.UpdateValue(RadProperty)RadObject.GetValueSource(RadProperty)RadObject.GetRegisteredRadProperty(string)RadObject.UpdateValueCore(RadPropertyValue)RadObject.SetValueCore(RadPropertyValue, object, object, ValueSource)RadObject.ResetValueCore(RadPropertyValue, ValueResetFlags)RadObject.GetDefaultValue(RadPropertyValue, object)RadObject.CoerceValue(RadPropertyValue, object)RadObject.ShouldSerializeProperty(RadProperty)RadObject.CanRaisePropertyChangeNotifications(RadPropertyValue)RadObject.BindProperty(RadProperty, RadObject, RadProperty, PropertyBindingOptions)RadObject.UnbindProperty(RadProperty)RadObject.AddStylePropertySetting(IPropertySetting)RadObject.GetInheritedValue(RadProperty)RadObject.OnPropertyChanging(RadPropertyChangingEventArgs)RadObject.OnPropertyChanged(RadPropertyChangedEventArgs)RadObject.OnNotifyPropertyChanged(string)RadObject.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadObject.OnShouldSerializeProperty(ShouldSerializePropertyEventArgs)RadObject.IsPropertyCancelable(RadPropertyMetadata)RadObject.PropertyValuesRadObject.PropertyFilterRadObject.RadObjectTypeRadObject.BindingContextRadObject.PropertyChangedRadObject.RadPropertyChangedRadObject.RadPropertyChangingDisposableObject.GetBitState(long)DisposableObject.SetBitState(long, bool)DisposableObject.OnBitStateChanged(long, bool, bool)DisposableObject.Dispose()DisposableObject.Dispose(bool)DisposableObject.PerformDispose(bool)DisposableObject.DisposeUnmanagedResources()DisposableObject.BitStateDisposableObject.EventsDisposableObject.IsDisposingDisposableObject.IsDisposedDisposableObject.DisposedDisposableObject.Disposing

Constructors

AsyncReaderBase()

Declaration

cs-api-definition
protected AsyncReaderBase()

Fields

ClearLayerProperty

Declaration

cs-api-definition
public static readonly RadProperty ClearLayerProperty

Field Value

RadProperty

CoordinateConverterProperty

Declaration

cs-api-definition
public static readonly RadProperty CoordinateConverterProperty

Field Value

RadProperty

ExtendedPropertySetProperty

Declaration

cs-api-definition
public static readonly RadProperty ExtendedPropertySetProperty

Field Value

RadProperty

ToolTipFormatProperty

Declaration

cs-api-definition
public static readonly RadProperty ToolTipFormatProperty

Field Value

RadProperty

Properties

ClearLayer

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

Declaration

cs-api-definition
public bool ClearLayer { get; set; }

Property Value

bool

CoordinateConverter

Gets or sets the CoordinateConverter applied to the reader.

Declaration

cs-api-definition
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

cs-api-definition
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 layer.

Declaration

cs-api-definition
public MapLayer Layer { get; set; }

Property Value

MapLayer

ToolTipFormat

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

Declaration

cs-api-definition
public string ToolTipFormat { get; set; }

Property Value

string

Methods

CancelAsync()

Cancels loading of shapes.

Declaration

cs-api-definition
public void CancelAsync()

CancelAsync(int)

Cancels loading of shapes by process id.

Declaration

cs-api-definition
public void CancelAsync(int processId)

Parameters

processId

int

Id of the process.

OnReaderPropertyChanged(RadPropertyChangedEventArgs)

Occurs when the properties which are used for loading are changed.

Declaration

cs-api-definition
protected virtual void OnReaderPropertyChanged(RadPropertyChangedEventArgs eventArgs)

Parameters

eventArgs

RadPropertyChangedEventArgs

Event arguments.

ReadAsync()

Reads geospatial data using asynchronous mode.

Declaration

cs-api-definition
public abstract int ReadAsync()

Returns

int

ReadAsync(object)

Reads geospatial data using asynchronous mode.

Declaration

cs-api-definition
public abstract int ReadAsync(object userState)

Parameters

userState

object

A user-defined object that is passed to the method invoked when the asynchronous operation completes.

Returns

int

ReaderPropertyChanged(RadObject, RadPropertyChangedEventArgs)

Starts loading when the properties which are used for loading are changed.

Declaration

cs-api-definition
protected static void ReaderPropertyChanged(RadObject source, RadPropertyChangedEventArgs eventArgs)

Parameters

source

RadObject

Source object.

eventArgs

RadPropertyChangedEventArgs

Event arguments.

Events

PreviewReadShapeData

Occurs when a shape data is read.

Declaration

cs-api-definition
public event PreviewReadShapeDataCompletedEventHandler PreviewReadShapeData

Event Value

PreviewReadShapeDataCompletedEventHandler

PreviewReadShapeDataCompleted

Occurs when the reader completes to read shapes.

Declaration

cs-api-definition
public event PreviewReadShapeDataCompletedEventHandler PreviewReadShapeDataCompleted

Event Value

PreviewReadShapeDataCompletedEventHandler

ProgressChanged

Occurs when part of data is read.

Declaration

cs-api-definition
public event ProgressChangedEventHandler ProgressChanged

Event Value

ProgressChangedEventHandler

ReadShapeDataCompleted

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

Declaration

cs-api-definition
public event ReadShapeDataCompletedEventHandler ReadShapeDataCompleted

Event Value

ReadShapeDataCompletedEventHandler

In this article
DefinitionConstructorsAsyncReaderBase()FieldsClearLayerPropertyCoordinateConverterPropertyExtendedPropertySetPropertyToolTipFormatPropertyPropertiesClearLayerCoordinateConverterExtendedPropertySetLayerToolTipFormatMethodsCancelAsync()CancelAsync(int)OnReaderPropertyChanged(RadPropertyChangedEventArgs)ReadAsync()ReadAsync(object)ReaderPropertyChanged(RadObject, RadPropertyChangedEventArgs)EventsPreviewReadShapeDataPreviewReadShapeDataCompletedProgressChangedReadShapeDataCompleted
Not finding the help you need?
Contact Support