Calendar Works home page

Overview

Components
TcwDayView
TcwWeekView
TcwMonthView
TcwManager
TcwEvents
TcwMemoryEvents

Classes
TcwEvent
TcwEventIterator

Additional Information
Constants & Types
Miscellaneous routines
HTML Reference
FAQ's Frequently asked questions
Tips & Tricks

Help File
Download help file

Feedback
Report a bug with this manual

How do you rate this manual?
Great
OK
Poor

Comments


Best viewed with
Microsoft Internet Explorer
TcwEventIterator

Unit: cwMan

Provides a way to iterate through events

Properties
EntityIDs, Event, EventIDs, EventTypeIDs, FromDateTime_Low, FromDateTime_High, ResourceIDs, SiteIDs, ToDateTime_Low, ToDateTime_High,

Methods
Create, Destroy, First, Next,



Properties
EntityIDs

EntityIDs : string;

Description Use EntityIDs to iterate through events for specific EntityID's. To iterate through events regardless of their EntityID set EntityIDs to '' (empty string)

Please note EntityIDs is a comma delimited list

Event

Event : TcwEvent; Read only


Description Use Event to refer to the "current" event during the iteration.

EventIDs

EventIDs : string;

Description Use EventIDs to iterate through events for specific EventID's. To iterate through events regardless of their EventID set EventIDs to '' (empty string)

Please note EventIDs is a comma delimited list

EventTypeIDs

EventTypeIDs : string;

Description Use EventTypeIDs to iterate through events for specific EventTypeID's. To iterate through events regardless of their EventTypeID set EventTypeIDs to '' (empty string)

Please note EventTypeIDs is a comma delimited list

FromDateTime_Low

FromDateTime_Low : TDateTime;

Description Set FromDateTime_Low to only select events where Event.FromDateTime is greater than (or equal to) FromDateTime_Low.

FromDateTime_High

FromDateTime_High : TDateTime;

Description Set FromDateTime_High to only select events where Event.FromDateTime is less than (or equal to) FromDateTime_High.

ResourceIDs

ResourceIDs : string;

Description Use ResourceIDs to iterate through events for specific ResourceID's. To iterate through events regardless of their ResourceID set ResourceIDs to '' (empty string)

Please note ResourceIDs is a comma delimited list

SiteIDs

SiteIDs : string;

Description Use SiteIDs to iterate through events for specific SiteID's. To iterate through events regardless of their SiteID set SiteIDs to '' (empty string)

Please note SiteIDs is a comma delimited list

ToDateTime_Low

ToDateTime_Low : TDateTime;

Description Set ToDateTime_Low to only select events where Event.ToDateTime is greater than (or equal to) ToDateTime_Low.

ToDateTime_High

ToDateTime_High : TDateTime;

Description Set ToDateTime_High to only select events where Event.ToDateTime is less than (or equal to) ToDateTime_High.


Methods
Create

constructor Create(Events: TcwEvents);

Destroy

destructor Destroy; override

First

function First : boolean;

Description Get the first event.

Please note If there are no events false is returned

See also Next

Example Iterate through all events
var
   EventIterator : TcwEventIterator;
begin
   EventIterator := TcwEventIterator.Create(cwManager1.Events);
   if EventIterator.First then
      repeat
         // Do something with EventIterator.Event here
      until not EventIterator.Next;
   EventIterator.Free;
end;

Next

function Next : boolean;

Description Get the next event.

Please note If there are no more events false is returned

See also First



Copyright © 1998-2007 Innova Software ALL RIGHTS RESERVED
All trademarks are the property of their respective owners.
Webmaster webmaster@innovasoftware.com