Class
GridViewSynchronizationService

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

Definition

Constructors

GridViewSynchronizationService()

Initializes a new instance of the GridViewSynchronizationService class.

Declaration

cs-api-definition
public GridViewSynchronizationService()

Properties

DispatchingEvent

Gets the event that is currently being dispatched.

Declaration

cs-api-definition
public GridViewEvent DispatchingEvent { get; }

Property Value

GridViewEvent

IsDataEventDispatchSuspended

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

Declaration

cs-api-definition
public bool IsDataEventDispatchSuspended { get; }

Property Value

bool

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

IsDispatchSuspended

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

Declaration

cs-api-definition
public bool IsDispatchSuspended { get; }

Property Value

bool

IsDispatching

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

Declaration

cs-api-definition
public bool IsDispatching { get; }

Property Value

bool

IsInBeginDispatchBlock

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

Declaration

cs-api-definition
public bool IsInBeginDispatchBlock { get; }

Property Value

bool

IsUIEventDispatchSuspended

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

Declaration

cs-api-definition
public bool IsUIEventDispatchSuspended { get; }

Property Value

bool

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

Methods

AddListener(IGridViewEventListener)

Adds the listener.

Declaration

cs-api-definition
public void AddListener(IGridViewEventListener listener)

Parameters

listener

IGridViewEventListener

The listener.

BeginDispatch()

Begins a Dispatch process.

Declaration

cs-api-definition
public void BeginDispatch()

CanBeSuspended(GridViewEventInfo)

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

Declaration

cs-api-definition
protected virtual bool CanBeSuspended(GridViewEventInfo eventInfo)

Parameters

eventInfo

GridViewEventInfo

The event info.

Returns

bool

ContainsEvent(Predicate<GridViewEvent>)

Determines whether the specified predicate contains event.

Declaration

cs-api-definition
public bool ContainsEvent(Predicate<GridViewEvent> predicate)

Parameters

predicate

Predicate<GridViewEvent>

The predicate.

Returns

bool

ContainsListener(IGridViewEventListener)

Determines whether the specified listener contains listener.

Declaration

cs-api-definition
public bool ContainsListener(IGridViewEventListener listener)

Parameters

listener

IGridViewEventListener

The listener.

Returns

bool

DispatchEvent(GridViewEvent)

Dispatches the event.

Declaration

cs-api-definition
public void DispatchEvent(GridViewEvent gridEvent)

Parameters

gridEvent

GridViewEvent

The grid event.

DispatchEvent(GridViewTemplate, GridViewEvent, bool)

Dispatches GridViewEvent

Declaration

cs-api-definition
public static void DispatchEvent(GridViewTemplate template, GridViewEvent eventData, bool postUI)

Parameters

template

GridViewTemplate

The template.

eventData

GridViewEvent

The instance of GridViewEvent which will be dispatched.

postUI

bool

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

cs-api-definition
protected override void DisposeManagedResources()

Overrides DisposableObject.DisposeManagedResources()

EndDispatch()

Ends Dispatch transaction without flushing pending events.

Declaration

cs-api-definition
public void EndDispatch()

EndDispatch(bool)

Ends Dispatch transaction and flushes all pending events.

Declaration

cs-api-definition
public void EndDispatch(bool flushEvents)

Parameters

flushEvents

bool

FlushEvents()

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

Declaration

cs-api-definition
public void FlushEvents()

IsColumnsCollectionChangedEvent(GridViewEvent)

Determines whether the specified grid view event is ColumnsCollectionChanged.

Declaration

cs-api-definition
public static bool IsColumnsCollectionChangedEvent(GridViewEvent gridViewEvent)

Parameters

gridViewEvent

GridViewEvent

The grid view event.

Returns

bool

IsConditionalFormattingCollectionChangedEvent(GridViewEvent)

Determines whether the specified grid view event ConditionalFormattingCollectionChanged.

Declaration

cs-api-definition
public static bool IsConditionalFormattingCollectionChangedEvent(GridViewEvent gridViewEvent)

Parameters

gridViewEvent

GridViewEvent

The grid view event.

Returns

bool

IsEventSuspended(GridViewTemplate, KnownEvents)

Determines whether the event is suspended for the specified template.

Declaration

cs-api-definition
public static bool IsEventSuspended(GridViewTemplate template, KnownEvents eventId)

Parameters

template

GridViewTemplate

The template.

eventId

KnownEvents

The event id.

Returns

bool

IsEventSuspended(KnownEvents)

Determines whether event is suspended by the specified event id.

Declaration

cs-api-definition
public bool IsEventSuspended(KnownEvents eventId)

Parameters

eventId

KnownEvents

The event id.

Returns

bool

IsGroupCollectionChangedEvent(GridViewEvent)

Declaration

cs-api-definition
public static bool IsGroupCollectionChangedEvent(GridViewEvent gridViewEvent)

Parameters

gridViewEvent

GridViewEvent

Returns

bool

IsRowPropertyChangedEvent(GridViewEvent)

Determines whether the specified grid view event RowPropertyChanged.

Declaration

cs-api-definition
public static bool IsRowPropertyChangedEvent(GridViewEvent gridViewEvent)

Parameters

gridViewEvent

GridViewEvent

The grid view event.

Returns

bool

IsTemplatePropertyChangedEvent(GridViewEvent)

Determines whether the specified grid view event is TemplatePropertyChanged.

Declaration

cs-api-definition
public static bool IsTemplatePropertyChangedEvent(GridViewEvent gridViewEvent)

Parameters

gridViewEvent

GridViewEvent

The grid view event.

Returns

bool

IsTemplatePropertyChangingEvent(GridViewEvent)

Determines whether the specified grid view event is TemplatePropertyChanging.

Declaration

cs-api-definition
public static bool IsTemplatePropertyChangingEvent(GridViewEvent gridViewEvent)

Parameters

gridViewEvent

GridViewEvent

The grid view event.

Returns

bool

NotifyListeners(GridViewEvent)

Notifies the listeners.

Declaration

cs-api-definition
protected virtual void NotifyListeners(GridViewEvent gridEvent)

Parameters

gridEvent

GridViewEvent

The grid event.

RaiseCurrentChanged(GridViewTemplate, GridViewRowInfo, GridViewColumn, bool)

Raises the current changed.

Declaration

cs-api-definition
public static void RaiseCurrentChanged(GridViewTemplate template, GridViewRowInfo row, GridViewColumn column, bool user)

Parameters

template

GridViewTemplate

The template.

row

GridViewRowInfo

The row.

column

GridViewColumn

The column.

user

bool

The user.

RemoveListener(IGridViewEventListener)

Removes the listener.

Declaration

cs-api-definition
public void RemoveListener(IGridViewEventListener listener)

Parameters

listener

IGridViewEventListener

The listener.

ResumeDispatch()

Resumes event dispatching, previously suspended by a SuspendDispatch call.

Declaration

cs-api-definition
public void ResumeDispatch()

ResumeDispatch(GridEventType)

Resumes the dispatch.

Declaration

cs-api-definition
public void ResumeDispatch(GridEventType type)

Parameters

type

GridEventType

The type.

ResumeEvent(GridViewTemplate, KnownEvents)

Resumes the event.

Declaration

cs-api-definition
public static void ResumeEvent(GridViewTemplate template, KnownEvents eventId)

Parameters

template

GridViewTemplate

The template.

eventId

KnownEvents

The event id.

ResumeEvent(KnownEvents)

Resumes dispatching of events with the specified ID.

Declaration

cs-api-definition
public void ResumeEvent(KnownEvents eventId)

Parameters

eventId

KnownEvents

SuspendDispatch()

Suspends event dispatching.

Declaration

cs-api-definition
public void SuspendDispatch()

SuspendDispatch(GridEventType)

Suspends the dispatch.

Declaration

cs-api-definition
public void SuspendDispatch(GridEventType type)

Parameters

type

GridEventType

The type.

SuspendEvent(GridViewTemplate, KnownEvents)

Suspends the event.

Declaration

cs-api-definition
public static void SuspendEvent(GridViewTemplate template, KnownEvents eventId)

Parameters

template

GridViewTemplate

The template.

eventId

KnownEvents

The event id.

SuspendEvent(KnownEvents)

Suspends dispatching of events with the specified ID.

Declaration

cs-api-definition
public void SuspendEvent(KnownEvents eventId)

Parameters

eventId

KnownEvents

VerifyDispatch(GridViewEvent)

Verifies the dispatch.

Declaration

cs-api-definition
protected virtual bool VerifyDispatch(GridViewEvent gridEvent)

Parameters

gridEvent

GridViewEvent

The grid event.

Returns

bool