Differences

This shows you the differences between two versions of the page.

Link to this comparison view

desktop:calendarevent [2019/10/23 05:53] (current)
Line 1: Line 1:
 +====== Enumerations ======
 +^ Name      ^ Values ​      ^
 +|  | This class exposes no enumerations. |
  
 +====== Constants ======
 +^ Name      ^ Type     ^ Value       ^
 +| RepeatNever | Number | -1 |
 +| RepeatDaily | Number | 0 |
 +| RepeatWeekly | Number | 1 |
 +| RepeatMonthly | Number | 2 |
 +| RepeatYearly | Number | 3 |
 +
 +====== Events ======
 +^ Definition ​     ^ Description ​      ^
 +|  | This class exposes no events. |
 +
 +====== Methods ======
 +^ Definition ​     ^ Description ​      ^
 +| Constructor(sTitle as String, dStart as Date, dEnd as Date = Nil) | Method for creating a new class instance. |
 +| Constructor(sTitle as String, dStart as Date, dEnd as Date, iFrequency as Integer, iPeriod as Integer = 0, BGColor as Color = &​c1111ff,​ Border as Color = &​c1111ff,​ ForeColor as Color = &​cffffff) | Method for creating a new class instance. |
 +
 +====== Properties ======
 +^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
 +| AllDay | Boolean | False | When True, this event will span the entire day. |
 +| BackgroundColor | Color | &​c3a87ad | Background color of the event. |
 +| BorderColor | Color | &​c3a87ad | Border color of the event. |
 +| CanMove | Boolean | False | Determines whether the user can move the event in the display. |
 +| CanResize | Boolean | False | Determines whether the user can resize the event. |
 +| Description | String | ""​ | Description of the event. |
 +| EndDate | Date | Nil | The ending date/time of the event. |
 +| ID (READ-ONLY) | String | Auto-generated | The unique identifier of the event. |
 +| Location | String | ""​ | The assigned location for the event, such as "​Joe'​s Office"​. |
 +| RepeatFrequency | Integer | -1 | How often the event repeats (see Constants). |
 +| RepeatPreiod | Integer | 1 | Interval between repeats. |
 +| StartDate | Date | Nil | The starting date of the event. |
 +| Tag | Variant | Nil | Custom value for developer use. |
 +| TextColor | Color | &​cFFFFFF | The text color of the event. |
 +| Title | String | ""​ | Title of the event. |
 +| URL | String | ""​ | URL of the event, if loaded from an external source. |
 +
 +====== Examples ======
 +There are currently no examples for this class.
 +
 +====== Changes to this Page ======
 +^ Date ^ Edit ^ Editor ^
 +| 08/04/2017 | Document Created | Anthony G. Cyphers |