Back to all docs
API Reference / Telerik.WinControls.UI / AsyncReaderBase
New to Telerik UI for WinForms? Start a free 30-day trial

AsyncReaderBase

Class

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

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.RadMap.dll

Syntax:
C#
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()

C#
protected AsyncReaderBase()

Fields

ClearLayerProperty

C#
public static readonly RadProperty ClearLayerProperty

CoordinateConverterProperty

C#
public static readonly RadProperty CoordinateConverterProperty

ExtendedPropertySetProperty

C#
public static readonly RadProperty ExtendedPropertySetProperty

ToolTipFormatProperty

C#
public static readonly RadProperty ToolTipFormatProperty

Properties

ClearLayer

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

C#
public bool ClearLayer { get; set; }

CoordinateConverter

Gets or sets the CoordinateConverter applied to the reader.

C#
public ICoordinateConverter CoordinateConverter { get; set; }

ExtendedPropertySet

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

C#
public ExtendedPropertySet ExtendedPropertySet { get; set; }
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.

C#
public MapLayer Layer { get; set; }

ToolTipFormat

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

C#
public string ToolTipFormat { get; set; }

Methods

CancelAsync()

Cancels loading of shapes.

C#
public void CancelAsync()

CancelAsync(int)

Cancels loading of shapes by process id.

C#
public void CancelAsync(int processId)
Parameters:processIdint

Id of the process.

OnReaderPropertyChanged(RadPropertyChangedEventArgs)

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

C#
protected virtual void OnReaderPropertyChanged(RadPropertyChangedEventArgs eventArgs)
Parameters:eventArgsRadPropertyChangedEventArgs

Event arguments.

ReadAsync()

Reads geospatial data using asynchronous mode.

C#
public abstract int ReadAsync()
Returns:

int

ReadAsync(object)

Reads geospatial data using asynchronous mode.

C#
public abstract int ReadAsync(object userState)
Parameters:userStateobject

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.

C#
protected static void ReaderPropertyChanged(RadObject source, RadPropertyChangedEventArgs eventArgs)
Parameters:sourceRadObject

Source object.

eventArgsRadPropertyChangedEventArgs

Event arguments.

Events

PreviewReadShapeData

Occurs when a shape data is read.

C#
public event PreviewReadShapeDataCompletedEventHandler PreviewReadShapeData

PreviewReadShapeDataCompleted

Occurs when the reader completes to read shapes.

C#
public event PreviewReadShapeDataCompletedEventHandler PreviewReadShapeDataCompleted

ProgressChanged

Occurs when part of data is read.

C#
public event ProgressChangedEventHandler ProgressChanged

ReadShapeDataCompleted

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

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