EWSoftware.PDI Namespace Documentation
VTo
This class represents a VTODO component that can appear in a calendar
Definition
Namespace: EWSoftware.PDI.Objects
Assembly: EWSoftware.PDI.Data (in EWSoftware.PDI.Data.dll) Version: 2023.1.2.0
Assembly: EWSoftware.PDI.Data (in EWSoftware.PDI.Data.dll) Version: 2023.1.2.0
C#
public class VToDo : RecurringObjectVB
Public Class VToDo
Inherits RecurringObjectC++
public ref class VToDo : public RecurringObjectF#
type VToDo =
class
inherit RecurringObject
end- Inheritance
- Object PDIObject CalendarObject RecurringObject VToDo
Constructors
| VToDo | Default constructor. Unless the version is changed, the object will conform to the iCalendar 2.0 specification. |
Properties
| Alarms | This is used to get the alarm properties. There may be more than one. |
| Attachments | This is used to get the Attachments (ATTACH) properties. There may be more than one |
| Attendees | This is used to get the Attendee (ATTENDEE) properties. There may be more than one. |
| Categories | This is used to get the categories (CATEGORIES) property |
| Classification | This is used to get the access classification (CLASS) property |
| Comment | This is used to get the comment (COMMENT) property |
| CompletedDateTime | This is used to get the completed date/time (COMPLETED) property |
| Contacts | This is used to get the Contact (CONTACT) properties. There may be more than one. |
| CustomProperties | This is a catch-all that holds all unknown or extension properties |
| DateCreated | This is used to get the date created (DCREATED) property |
| Description | This is used to get the description (DESCRIPTION) property |
| DueDateTime | This is used to get the due date/time (DUE) property |
| Duration | This is used to get the duration (DURATION) property |
| ExceptionDates |
This is used to get the Exception Date (EXDATE) properties. There may be more than one.
(Inherited from RecurringObject) |
| ExceptionRules |
This is used to get the Exception Rule (EXRULE) properties. There may be more than one.
(Inherited from RecurringObject) |
| ExcludeStartDateTime |
This property can be used to override the specification and exclude the start date/time if it is not
generated by one of the recurrence rule or recurrence date properties.
(Inherited from RecurringObject) |
| GeographicPosition | This is used to get the geographic position (GEO) property |
| InstanceDuration |
This must be implemented to return the duration for the recurring instances
(Overrides RecurringObjectInstanceDuration) |
| IsRecurring |
This can be used to see if an item has recurrence information
(Inherited from RecurringObject) |
| LastModified | This is used to get the Last Modified (LAST-MODIFIED) property |
| Organizer | This is used to get the organizer (ORGANIZER) property |
| PercentComplete | This is used to get the percent complete (PERCENT-COMPLETE) property |
| Priority | This is used to get the priority (PRIORITY) property |
| RecurDates |
This is used to get the Recur Date (RDATE) properties. There may be more than one.
(Inherited from RecurringObject) |
| RecurrenceCount | This is used to get the recurrence count (RNUM) property |
| RecurrenceId | This is used to get the recurrence ID (RECURRENCE-ID) property |
| RecurrenceRules |
This is used to get the Recurrence Rule (RRULE) properties. There may be more than one.
(Inherited from RecurringObject) |
| RelatedTo | This is used to get the Related To (RELATED-TO) properties. There may be more than one. |
| RequestStatuses | This is used to get the Request Status (REQUEST-STATUS) properties There may be more than one. |
| Resources | This is used to get the resources (RESOURCES) property |
| Sequence | This is used to get the revision sequence number (SEQUENCE) property |
| StartDateTime |
This is used to get the start date/time (DTSTART) property
(Overrides RecurringObjectStartDateTime) |
| Status | This is used to get the status (STATUS) property |
| Summary | This is used to get the summary (SUMMARY) property |
| TimeStamp | This is used to get the time stamp (DTSTAMP) property |
| TimeZoneId |
This must be implemented to return the time zone ID for the start date
(Overrides RecurringObjectTimeZoneId) |
| UniqueId | This is used to get the Unique ID (UID) property |
| Url | This is used to get the Uniform Resource Locator (URL) property |
| Version |
This is overridden to propagate the version to all properties in the object that need it when the
version is set on the item.
(Inherited from CalendarObject) |
| VersionsSupported |
This is used to establish the specification versions supported by the PDI object
(Overrides PDIObjectVersionsSupported) |
Methods
| AllInstances |
This method is used to return all recurring instances based on the current settings alone
(Inherited from RecurringObject) |
| ApplyTimeZone |
This is used to apply the selected time zone to all date/time objects in the component and convert
them to the new time zone.
(Overrides RecurringObjectApplyTimeZone(VTimeZone)) |
| ClearProperties |
The method can be called to clear all current property values from the To-Do object. The version is
left unchanged.
(Overrides RecurringObjectClearProperties) |
| Clone |
This is overridden to allow cloning of a PDI object
(Overrides PDIObjectClone) |
| Clone(PDIObject) |
This is overridden to allow copying of the additional properties
(Overrides RecurringObjectClone(PDIObject)) |
| Equals |
This is overridden to allow proper comparison of To-Do objects
(Overrides ObjectEquals(Object)) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode |
Get a hash code for the calendar object
(Overrides ObjectGetHashCode) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| InstancesBetween |
This method is used to return all recurring instances between the two specified date/times based on
the current settings.
(Inherited from RecurringObject) |
| LastInstance |
This method can be used to quickly determine the end date of an item regardless of whether it uses
recurrence or not.
(Inherited from RecurringObject) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OccursOn |
This method is used to determine whether or not an instance of the recurrence falls on the specified
date/time.
(Inherited from RecurringObject) |
| PropagateVersion |
This is used to propagate the version to all properties in the object that need it
(Overrides RecurringObjectPropagateVersion) |
| SetTimeZone |
This is used to set the selected time zone in all date/time objects in the component without
modifying the date/time values.
(Overrides RecurringObjectSetTimeZone(VTimeZone)) |
| TimeZonesUsed |
This is used to get a list of time zones used by all owned objects
(Overrides RecurringObjectTimeZonesUsed(StringCollection)) |
| ToString |
Convert the object instance to its string form
(Inherited from CalendarObject) |
| UpdateTimeZoneId |
This is used to replace an old time zone ID with a new time zone ID in all properties of a calendar
object.
(Overrides RecurringObjectUpdateTimeZoneId(String, String)) |
| WriteToStream(TextWriter) |
This can be used to write a calendar object to a PDI data stream
(Inherited from CalendarObject) |
| WriteToStream(TextWriter, StringBuilder) |
This can be used to write a To-Do object to a PDI data stream
(Overrides RecurringObjectWriteToStream(TextWriter, StringBuilder)) |