//=====================================================================
/// <summary>
/// This is overridden to allow cloning of a PDI object
/// </summary>
/// <returns>A clone of the object</returns>
public override object Clone()
{
VAlarm o = new VAlarm();
o.Clone(this);
return(o);
}
/// <summary>
/// This is overridden to allow proper comparison of alarm objects
/// </summary>
/// <param name="obj">The object to which this instance is compared</param>
/// <returns>Returns true if the object equals this instance, false if it does not</returns>
public override bool Equals(object obj)
{
VAlarm a = obj as VAlarm;
if (a == null)
{
return(false);
}
// The ToString() method returns a text representation of the alarm based on all of its settings so
// it's a reliable way to tell if two instances are the same.
return(this == a || this.ToString() == a.ToString());
}
/// <summary>
/// This is overridden to allow copying of the additional properties
/// </summary>
/// <param name="p">The PDI object from which the settings are to be copied</param>
protected override void Clone(PDIObject p)
{
VAlarm o = (VAlarm)p;
this.ClearProperties();
action = (ActionProperty)o.Action.Clone();
trigger = (TriggerProperty)o.Trigger.Clone();
repeat = (RepeatProperty)o.Repeat.Clone();
duration = (DurationProperty)o.Duration.Clone();
summary = (SummaryProperty)o.Summary.Clone();
desc = (DescriptionProperty)o.Description.Clone();
this.Attendees.CloneRange(o.Attendees);
this.Attachments.CloneRange(o.Attachments);
this.CustomProperties.CloneRange(o.CustomProperties);
}
/// <summary>
/// Update the prior row with the values from the unbound controls and load the values for the new row
/// when the position changes.
/// </summary>
/// <param name="sender">The sender of the event</param>
/// <param name="e">The event arguments</param>
private void BindingSource_PositionChanged(object sender, EventArgs e)
{
VAlarm newItem = (VAlarm)this.BindingSource.Current;
// If all deleted, ignore it
if(newItem == null)
{
currentAlarm = null;
return;
}
// Save changes to the unbound controls to the prior row
this.StoreChanges();
// Load the new values into the unbound controls
currentAlarm = newItem;
if(currentAlarm.Trigger.ValueLocation == ValLocValue.Duration)
{
if(currentAlarm.Trigger.DurationValue != Duration.Zero)
txtTrigger.Text = currentAlarm.Trigger.DurationValue.ToString(Duration.MaxUnit.Weeks);
else
txtTrigger.Text = String.Empty;
chkFromEnd.Checked = currentAlarm.Trigger.RelatedToEnd;
dtpTrigger.Checked = false;
}
else
{
txtTrigger.Text = String.Empty;
chkFromEnd.Checked = false;
if(currentAlarm.Trigger.TimeZoneDateTime == DateTime.MinValue)
dtpTrigger.Checked = false;
else
{
dtpTrigger.Value = currentAlarm.Trigger.TimeZoneDateTime;
dtpTrigger.Checked = true;
}
}
if(currentAlarm.Duration.DurationValue != Duration.Zero)
txtDuration.Text = currentAlarm.Duration.DurationValue.ToString(Duration.MaxUnit.Weeks);
else
txtDuration.Text = String.Empty;
// Set attendees and attachments
ucAttendees.BindingSource.DataSource = new AttendeePropertyCollection().CloneRange(currentAlarm.Attendees);
ucAttachments.SetValues(currentAlarm.Attachments);
}
//=====================================================================
/// <summary>
/// This is overridden to allow cloning of a PDI object
/// </summary>
/// <returns>A clone of the object</returns>
public override object Clone()
{
VAlarm o = new VAlarm();
o.Clone(this);
return o;
}
/// <summary>
/// This is implemented to handle properties related to VEvent items
/// </summary>
/// <param name="propertyName">The name of the property</param>
/// <param name="parameters">A string collection containing the parameters and their values. If empty,
/// there are no parameters.</param>
/// <param name="propertyValue">The value of the property.</param>
protected virtual void VEventParser(string propertyName, StringCollection parameters, string propertyValue)
{
StringCollection sc;
string[] parts, parms;
int idx;
// The last entry is always CustomProperty so scan for length minus one
for(idx = 0; idx < ntvEvent.Length - 1; idx++)
if(ntvEvent[idx].IsMatch(propertyName))
break;
// An opening BEGIN:VEVENT property must have been seen
if(vEvent == null)
throw new PDIParserException(this.LineNumber, LR.GetString("ExParseNoBeginProp", "BEGIN:VEVENT",
propertyName));
// Handle or create the property
switch(ntvEvent[idx].EnumValue)
{
case PropertyType.Begin: // Handle nested objects
priorState.Push(currentState);
// Is it an alarm?
if(String.Compare(propertyValue.Trim(), "VALARM", StringComparison.OrdinalIgnoreCase) == 0)
{
vAlarm = new VAlarm();
vEvent.Alarms.Add(vAlarm);
currentState = VCalendarParserState.VAlarm;
}
else
{
// Unknown/custom object
currentState = VCalendarParserState.Custom;
CustomObjectParser(propertyName, parameters, propertyValue);
}
break;
case PropertyType.End:
// For this, the value must be VEVENT
if(String.Compare(propertyValue.Trim(), "VEVENT", StringComparison.OrdinalIgnoreCase) != 0)
throw new PDIParserException(this.LineNumber, LR.GetString("ExParseUnrecognizedTagValue",
ntvEvent[idx].Name, propertyValue));
// The event is added to the collection when created so we don't have to rely on an END tag
// to add it.
vEvent = null;
currentState = priorState.Pop();
break;
case PropertyType.Class:
vEvent.Classification.EncodedValue = propertyValue;
break;
case PropertyType.Categories:
// If this is seen more than once, just add the new stuff to the existing property
CategoriesProperty cp = new CategoriesProperty();
cp.DeserializeParameters(parameters);
cp.EncodedValue = propertyValue;
foreach(string s in cp.Categories)
vEvent.Categories.Categories.Add(s);
break;
case PropertyType.Resources:
// If this is seen more than once, just add the new stuff to the existing property
ResourcesProperty rp = new ResourcesProperty();
rp.DeserializeParameters(parameters);
rp.EncodedValue = propertyValue;
foreach(string s in rp.Resources)
vEvent.Resources.Resources.Add(s);
break;
case PropertyType.Url:
vEvent.Url.DeserializeParameters(parameters);
vEvent.Url.EncodedValue = propertyValue;
break;
case PropertyType.UniqueId:
vEvent.UniqueId.EncodedValue = propertyValue;
break;
case PropertyType.LastModified:
vEvent.LastModified.DeserializeParameters(parameters);
vEvent.LastModified.EncodedValue = propertyValue;
break;
case PropertyType.GeographicPosition:
vEvent.GeographicPosition.EncodedValue = propertyValue;
break;
case PropertyType.DateCreated:
vEvent.DateCreated.DeserializeParameters(parameters);
vEvent.DateCreated.EncodedValue = propertyValue;
break;
case PropertyType.StartDateTime:
vEvent.StartDateTime.DeserializeParameters(parameters);
vEvent.StartDateTime.EncodedValue = propertyValue;
break;
case PropertyType.EndDateTime:
vEvent.EndDateTime.DeserializeParameters(parameters);
vEvent.EndDateTime.EncodedValue = propertyValue;
break;
case PropertyType.TimeStamp:
vEvent.TimeStamp.DeserializeParameters(parameters);
vEvent.TimeStamp.EncodedValue = propertyValue;
break;
case PropertyType.Summary:
vEvent.Summary.DeserializeParameters(parameters);
vEvent.Summary.EncodedValue = propertyValue;
break;
case PropertyType.Description:
vEvent.Description.DeserializeParameters(parameters);
vEvent.Description.EncodedValue = propertyValue;
break;
case PropertyType.Location:
vEvent.Location.DeserializeParameters(parameters);
vEvent.Location.EncodedValue = propertyValue;
break;
case PropertyType.Priority:
vEvent.Priority.DeserializeParameters(parameters);
vEvent.Priority.EncodedValue = propertyValue;
break;
case PropertyType.Sequence:
vEvent.Sequence.DeserializeParameters(parameters);
vEvent.Sequence.EncodedValue = propertyValue;
break;
case PropertyType.Transparency:
vEvent.Transparency.DeserializeParameters(parameters);
vEvent.Transparency.EncodedValue = propertyValue;
break;
case PropertyType.RecurrenceCount:
vEvent.RecurrenceCount.DeserializeParameters(parameters);
vEvent.RecurrenceCount.EncodedValue = propertyValue;
break;
case PropertyType.Comment:
// If this is seen more than once, just add the new stuff to the existing property
if(vEvent.Comment.Value != null)
{
vEvent.Comment.EncodedValue += "\r\n";
vEvent.Comment.EncodedValue += propertyValue;
}
else
{
vEvent.Comment.DeserializeParameters(parameters);
vEvent.Comment.EncodedValue = propertyValue;
}
break;
case PropertyType.Contact:
ContactProperty c = new ContactProperty();
c.DeserializeParameters(parameters);
c.EncodedValue = propertyValue;
vEvent.Contacts.Add(c);
break;
case PropertyType.Organizer:
vEvent.Organizer.DeserializeParameters(parameters);
vEvent.Organizer.EncodedValue = propertyValue;
break;
case PropertyType.Attendee:
AttendeeProperty ap = new AttendeeProperty();
ap.DeserializeParameters(parameters);
ap.EncodedValue = propertyValue;
vEvent.Attendees.Add(ap);
break;
case PropertyType.RelatedTo:
RelatedToProperty rt = new RelatedToProperty();
rt.DeserializeParameters(parameters);
rt.EncodedValue = propertyValue;
vEvent.RelatedTo.Add(rt);
break;
case PropertyType.Attachment:
AttachProperty att = new AttachProperty();
att.DeserializeParameters(parameters);
att.EncodedValue = propertyValue;
vEvent.Attachments.Add(att);
break;
case PropertyType.RecurrenceId:
vEvent.RecurrenceId.DeserializeParameters(parameters);
vEvent.RecurrenceId.EncodedValue = propertyValue;
break;
case PropertyType.Status:
vEvent.Status.DeserializeParameters(parameters);
vEvent.Status.EncodedValue = propertyValue;
break;
case PropertyType.RequestStatus:
RequestStatusProperty rs = new RequestStatusProperty();
rs.DeserializeParameters(parameters);
rs.EncodedValue = propertyValue;
vEvent.RequestStatuses.Add(rs);
break;
case PropertyType.Duration:
vEvent.Duration.DeserializeParameters(parameters);
vEvent.Duration.EncodedValue = propertyValue;
break;
case PropertyType.AudioAlarm:
case PropertyType.DisplayAlarm:
case PropertyType.EMailAlarm:
case PropertyType.ProcedureAlarm:
// These are converted to a VAlarm object
vAlarm = new VAlarm();
ParseVCalendarAlarm(ntvEvent[idx].EnumValue, parameters, propertyValue);
vEvent.Alarms.Add(vAlarm);
vAlarm = null;
break;
case PropertyType.RecurrenceRule:
RRuleProperty rr = new RRuleProperty();
rr.DeserializeParameters(parameters);
rr.EncodedValue = propertyValue;
vEvent.RecurrenceRules.Add(rr);
break;
case PropertyType.RecurDate:
// There may be more than one date in the value. If so, split them into separate ones. This
// makes it easier to manage. They'll get written back out as individual properties but
// that's okay.
parts = propertyValue.Split(',', ';');
// It's important that we retain the same parameters for each one
parms = new string[parameters.Count];
parameters.CopyTo(parms, 0);
foreach(string s in parts)
{
sc = new StringCollection();
sc.AddRange(parms);
RDateProperty rd = new RDateProperty();
rd.DeserializeParameters(sc);
rd.EncodedValue = s;
vEvent.RecurDates.Add(rd);
}
break;
case PropertyType.ExceptionRule:
ExRuleProperty er = new ExRuleProperty();
er.DeserializeParameters(parameters);
er.EncodedValue = propertyValue;
vEvent.ExceptionRules.Add(er);
break;
case PropertyType.ExceptionDate:
// There may be more than one date in the value. If so, split them into separate ones. This
// makes it easier to manage. They'll get written back out as individual properties but
// that's okay.
parts = propertyValue.Split(',', ';');
// It's important that we retain the same parameters for each one
parms = new string[parameters.Count];
parameters.CopyTo(parms, 0);
foreach(string s in parts)
{
sc = new StringCollection();
sc.AddRange(parms);
ExDateProperty ed = new ExDateProperty();
ed.DeserializeParameters(sc);
ed.EncodedValue = s;
vEvent.ExceptionDates.Add(ed);
}
break;
case PropertyType.ExcludeStartDateTime:
// This is a custom property not defined by the spec
vEvent.ExcludeStartDateTime = (propertyValue[0] == '1');
break;
default: // Anything else is a custom property
CustomProperty cust = new CustomProperty(propertyName);
cust.DeserializeParameters(parameters);
cust.EncodedValue = propertyValue;
vEvent.CustomProperties.Add(cust);
break;
}
}
//=====================================================================
/// <summary>
/// This is overridden to handle the additional state maintained by the calendar parser
/// </summary>
/// <param name="fullReset">If true, a full reset is done (i.e. this is the start of a brand new session.
/// If false only the line state is reset (it's done parsing a property name or value).</param>
protected override void ResetState(bool fullReset)
{
if(fullReset)
{
currentState = VCalendarParserState.VCalendar;
vEvent = null;
vToDo = null;
vJournal = null;
vAlarm = null;
vFreeBusy = null;
vTimeZone = null;
obsRule = null;
priorState.Clear();
beginValue.Clear();
}
base.ResetState(fullReset);
}
/// <summary>
/// This is implemented to handle properties related to VAlarm items
/// </summary>
/// <param name="propertyName">The name of the property.</param>
/// <param name="parameters">A string collection containing the parameters and their values. If empty,
/// there are no parameters.</param>
/// <param name="propertyValue">The value of the property.</param>
protected virtual void VAlarmParser(string propertyName, StringCollection parameters, string propertyValue)
{
int idx;
// The last entry is always CustomProperty so scan for length minus one
for(idx = 0; idx < ntvAlarm.Length - 1; idx++)
if(ntvAlarm[idx].IsMatch(propertyName))
break;
// An opening BEGIN:VALARM property must have been seen
if(vAlarm == null)
throw new PDIParserException(this.LineNumber, LR.GetString("ExParseNoBeginProp", "BEGIN:VALARM",
propertyName));
// Handle or create the property
switch(ntvAlarm[idx].EnumValue)
{
case PropertyType.Begin: // Handle unknown nested objects
priorState.Push(currentState);
currentState = VCalendarParserState.Custom;
CustomObjectParser(propertyName, parameters, propertyValue);
break;
case PropertyType.End:
// For this, the value must be VALARM
if(String.Compare(propertyValue.Trim(), "VALARM", StringComparison.OrdinalIgnoreCase) != 0)
throw new PDIParserException(this.LineNumber, LR.GetString("ExParseUnrecognizedTagValue",
ntvAlarm[idx].Name, propertyValue));
// The alarm is added to the collection when created so we don't have to rely on an END tag
// to add it.
vAlarm = null;
currentState = priorState.Pop();
break;
case PropertyType.Action:
vAlarm.Action.DeserializeParameters(parameters);
vAlarm.Action.EncodedValue = propertyValue;
break;
case PropertyType.Trigger:
vAlarm.Trigger.DeserializeParameters(parameters);
vAlarm.Trigger.EncodedValue = propertyValue;
break;
case PropertyType.Repeat:
vAlarm.Repeat.DeserializeParameters(parameters);
vAlarm.Repeat.EncodedValue = propertyValue;
break;
case PropertyType.Duration:
vAlarm.Duration.DeserializeParameters(parameters);
vAlarm.Duration.EncodedValue = propertyValue;
break;
case PropertyType.Summary:
vAlarm.Summary.DeserializeParameters(parameters);
vAlarm.Summary.EncodedValue = propertyValue;
break;
case PropertyType.Description:
vAlarm.Description.DeserializeParameters(parameters);
vAlarm.Description.EncodedValue = propertyValue;
break;
case PropertyType.Attendee:
AttendeeProperty ap = new AttendeeProperty();
ap.DeserializeParameters(parameters);
ap.EncodedValue = propertyValue;
vAlarm.Attendees.Add(ap);
break;
case PropertyType.Attachment:
AttachProperty att = new AttachProperty();
att.DeserializeParameters(parameters);
att.EncodedValue = propertyValue;
vAlarm.Attachments.Add(att);
break;
default: // Anything else is a custom property
CustomProperty cust = new CustomProperty(propertyName);
cust.DeserializeParameters(parameters);
cust.EncodedValue = propertyValue;
vAlarm.CustomProperties.Add(cust);
break;
}
}