RetrieveVirtualEventEventArgs

Namespace: Wisej.Web.Ext.FullCalendar

Assembly: Wisej.Web.Ext.FullCalendar (4.1.0.0)

Provides data for the RetrieveVirtualEvent event.

C#

public class RetrieveVirtualEventEventArgs : EventArgs

VB.NET

Public Class RetrieveVirtualEventEventArgs
    Inherits EventArgs

The event is requested either by index (EventIndex) or by ID (EventID).

Example:

Returning the requested event from a cache:

private void fullCalendar1_RetrieveVirtualEvent(object sender, RetrieveVirtualEventEventArgs e)
{
    // this.cache is your own List<Event>.
    e.Event = e.EventID != null
        ? this.cache.Find(ev => ev.Id == e.EventID)
        : this.cache[e.EventIndex];
}

Constructors

RetrieveVirtualEventEventArgs(index)

Initializes a new instance of the RetrieveVirtualEventEventArgs class.

Name	Type	Description
index	Int32	The index of the event to retrieve.

Throws:

• ArgumentOutOfRangeException index is less than 0.

RetrieveVirtualEventEventArgs(id)

Initializes a new instance of the RetrieveVirtualEventEventArgs class.

Name	Type	Description
id	String	The ID of the event to retrieve.

Throws:

• ArgumentNullException id is null.

Properties

Event

Event: Returns or sets the Event retrieved from the cache.

Value: The Event retrieved from the cache.

The handler must set this property: when it's null, the EventCollection indexer throws an InvalidOperationException.

EventID

String: Returns the ID of the Event to retrieve from the cache.

Value: The ID of the Event to retrieve from the cache.

The value is null when the event is requested by index (EventIndex). The calendar requests events by ID when the user clicks, drags or resizes an event.

EventIndex

Int32: Returns the index of the Event to retrieve from the cache.

Value: The index of the Event to retrieve from the cache.

The value is 0 when the event is requested by ID; check EventID first.

Used By

Name	Description
RetrieveVirtualEventEventHandler	Represents the method that will handle the RetrieveVirtualEvent event.