Class GridViewSynchronizationService

Core entry point for all internal events in RadGridView. Provides synchronization semantic for all received notifications and dispatches them to all listeners.

Inheritance
System.Object
DisposableObject
GridViewSynchronizationService
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

public class GridViewSynchronizationService : DisposableObject, IDisposable

Constructors

GridViewSynchronizationService()

Initializes a new instance of the GridViewSynchronizationService class.

Declaration
public GridViewSynchronizationService()

Properties

DispatchingEvent

Gets the event that is currently being dispatched.

Declaration
public GridViewEvent DispatchingEvent { get; }
Property Value
GridViewEvent

IsDataEventDispatchSuspended

Gets a value indicating whether the dispatching of Data events is suspended.

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

true if the Data Event dispatching is suspended; otherwise, false.

IsDispatching

Determines whether the service is currently in a process of dispatching all queued events.

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

IsDispatchSuspended

Determines whether event dispatching is suspended. If true any incomming events will not be queued.

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

IsInBeginDispatchBlock

Determines whether the service is queuing any incomming events without dispatching them.

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

IsUIEventDispatchSuspended

Gets a value indicating whether the dispatching of UI events is suspended.

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

true if the UI event dispatching is suspended; otherwise, false.

Methods

AddListener(IGridViewEventListener)

Adds the listener.

Declaration
public void AddListener(IGridViewEventListener listener)
Parameters
IGridViewEventListener listener

The listener.

BeginDispatch()

Begins a Dispatch process.

Declaration
public void BeginDispatch()

CanBeSuspended(GridViewEventInfo)

Determines whether this instance can be suspended passing the specified event info.

Declaration
protected virtual bool CanBeSuspended(GridViewEventInfo eventInfo)
Parameters
GridViewEventInfo eventInfo

The event info.
Returns
System.Boolean

ContainsEvent(Predicate<GridViewEvent>)

Determines whether the specified predicate contains event.

Declaration
public bool ContainsEvent(Predicate<GridViewEvent> predicate)
Parameters
System.Predicate<GridViewEvent> predicate

The predicate.
Returns
System.Boolean

ContainsListener(IGridViewEventListener)

Determines whether the specified listener contains listener.

Declaration
public bool ContainsListener(IGridViewEventListener listener)
Parameters
IGridViewEventListener listener

The listener.
Returns
System.Boolean

DispatchEvent(GridViewEvent)

Dispatches the event.

Declaration
public void DispatchEvent(GridViewEvent gridEvent)
Parameters
GridViewEvent gridEvent

The grid event.

DispatchEvent(GridViewTemplate, GridViewEvent, Boolean)

Dispatches GridViewEvent

Declaration
public static void DispatchEvent(GridViewTemplate template, GridViewEvent eventData, bool postUI)
Parameters
GridViewTemplate template

The template.
GridViewEvent eventData

The instance of GridViewEvent which will be dispatched.
System.Boolean postUI

if set to true, the UI will be asynchronously processed when GridEventType.Both is dispatched.

DisposeManagedResources()

Disposes all managed resources - such as Bitmaps, GDI+ objects, etc.

Declaration
protected override void DisposeManagedResources()
Overrides

EndDispatch()

Ends Dispatch transaction without flushing pending events.

Declaration
public void EndDispatch()

EndDispatch(Boolean)

Ends Dispatch transaction and flushes all pending events.

Declaration
public void EndDispatch(bool flushEvents)
Parameters
System.Boolean flushEvents

FlushEvents()

Forces any events present on the events queue to be immediately dispatched.

Declaration
public void FlushEvents()

IsColumnsCollectionChangedEvent(GridViewEvent)

Determines whether the specified grid view event is ColumnsCollectionChanged.

Declaration
public static bool IsColumnsCollectionChangedEvent(GridViewEvent gridViewEvent)
Parameters
GridViewEvent gridViewEvent

The grid view event.
Returns
System.Boolean

IsConditionalFormattingCollectionChangedEvent(GridViewEvent)

Determines whether the specified grid view event ConditionalFormattingCollectionChanged.

Declaration
public static bool IsConditionalFormattingCollectionChangedEvent(GridViewEvent gridViewEvent)
Parameters
GridViewEvent gridViewEvent

The grid view event.
Returns
System.Boolean

IsEventSuspended(GridViewTemplate, KnownEvents)

Determines whether the event is suspended for the specified template.

Declaration
public static bool IsEventSuspended(GridViewTemplate template, KnownEvents eventId)
Parameters
GridViewTemplate template

The template.
KnownEvents eventId

The event id.
Returns
System.Boolean

IsEventSuspended(KnownEvents)

Determines whether event is suspended by the specified event id.

Declaration
public bool IsEventSuspended(KnownEvents eventId)
Parameters
KnownEvents eventId

The event id.
Returns
System.Boolean

IsGroupCollectionChangedEvent(GridViewEvent)

Declaration
public static bool IsGroupCollectionChangedEvent(GridViewEvent gridViewEvent)
Parameters
GridViewEvent gridViewEvent

Returns
System.Boolean

IsRowPropertyChangedEvent(GridViewEvent)

Determines whether the specified grid view event RowPropertyChanged.

Declaration
public static bool IsRowPropertyChangedEvent(GridViewEvent gridViewEvent)
Parameters
GridViewEvent gridViewEvent

The grid view event.
Returns
System.Boolean

IsTemplatePropertyChangedEvent(GridViewEvent)

Determines whether the specified grid view event is TemplatePropertyChanged.

Declaration
public static bool IsTemplatePropertyChangedEvent(GridViewEvent gridViewEvent)
Parameters
GridViewEvent gridViewEvent

The grid view event.
Returns
System.Boolean

IsTemplatePropertyChangingEvent(GridViewEvent)

Determines whether the specified grid view event is TemplatePropertyChanging.

Declaration
public static bool IsTemplatePropertyChangingEvent(GridViewEvent gridViewEvent)
Parameters
GridViewEvent gridViewEvent

The grid view event.
Returns
System.Boolean

NotifyListeners(GridViewEvent)

Notifies the listeners.

Declaration
protected virtual void NotifyListeners(GridViewEvent gridEvent)
Parameters
GridViewEvent gridEvent

The grid event.

RaiseCurrentChanged(GridViewTemplate, GridViewRowInfo, GridViewColumn, Boolean)

Raises the current changed.

Declaration
public static void RaiseCurrentChanged(GridViewTemplate template, GridViewRowInfo row, GridViewColumn column, bool user)
Parameters
GridViewTemplate template

The template.
GridViewRowInfo row

The row.
GridViewColumn column

The column.
System.Boolean user

The user.

RemoveListener(IGridViewEventListener)

Removes the listener.

Declaration
public void RemoveListener(IGridViewEventListener listener)
Parameters
IGridViewEventListener listener

The listener.

ResumeDispatch()

Resumes event dispatching, previously suspended by a SuspendDispatch call.

Declaration
public void ResumeDispatch()

ResumeDispatch(GridEventType)

Resumes the dispatch.

Declaration
public void ResumeDispatch(GridEventType type)
Parameters
GridEventType type

The type.

ResumeEvent(GridViewTemplate, KnownEvents)

Resumes the event.

Declaration
public static void ResumeEvent(GridViewTemplate template, KnownEvents eventId)
Parameters
GridViewTemplate template

The template.
KnownEvents eventId

The event id.

ResumeEvent(KnownEvents)

Resumes dispatching of events with the specified ID.

Declaration
public void ResumeEvent(KnownEvents eventId)
Parameters
KnownEvents eventId

SuspendDispatch()

Suspends event dispatching.

Declaration
public void SuspendDispatch()

SuspendDispatch(GridEventType)

Suspends the dispatch.

Declaration
public void SuspendDispatch(GridEventType type)
Parameters
GridEventType type

The type.

SuspendEvent(GridViewTemplate, KnownEvents)

Suspends the event.

Declaration
public static void SuspendEvent(GridViewTemplate template, KnownEvents eventId)
Parameters
GridViewTemplate template

The template.
KnownEvents eventId

The event id.

SuspendEvent(KnownEvents)

Suspends dispatching of events with the specified ID.

Declaration
public void SuspendEvent(KnownEvents eventId)
Parameters
KnownEvents eventId

VerifyDispatch(GridViewEvent)

Verifies the dispatch.

Declaration
protected virtual bool VerifyDispatch(GridViewEvent gridEvent)
Parameters
GridViewEvent gridEvent

The grid event.
Returns
System.Boolean

Extension Methods