Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
web:calendarevent [2017/04/09 21:16]
agcyphers [Constants]
web:calendarevent [2019/10/23 05:53] (current)
Line 1: Line 1:
-====== Enumerations ​======+==== Enumerations ====
 ^ Name      ^ Values ​      ^ ^ Name      ^ Values ​      ^
 |  | This class exposes no enumerations. | |  | This class exposes no enumerations. |
  
-====== Constants ​======+==== Constants ====
 ^ Name      ^ Type     ^ Value       ^ ^ Name      ^ Type     ^ Value       ^
 | RepeatDaily | Integer | 0 | | RepeatDaily | Integer | 0 |
Line 10: Line 10:
 | RepeatWeekly | Integer | 1 | | RepeatWeekly | Integer | 1 |
 | RepeatYearly | Integer | 3 | | RepeatYearly | Integer | 3 |
-====== Events ​======+==== Events ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
 |  | This class exposes no events. | |  | This class exposes no events. |
  
-====== Methods ​======+==== Methods ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
 | Constructor( sTitle as String, dStart as Date, dEnd as Date = Nil ) | Creates an instance of the class with the parameters as property values. | | Constructor( sTitle as String, dStart as Date, dEnd as Date = Nil ) | Creates an instance of the class with the parameters as property values. |
 | 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 ) | ::: | | 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 ) | ::: |
  
-====== Properties ​======+==== Properties ====
 ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^ ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
 | AllDay | Boolean | False | Does this event last the entire day? | | AllDay | Boolean | False | Does this event last the entire day? |
Line 30: Line 30:
 | ID | Integer | 0(Read-Only) |The display ID of the event. ​ This property should not be modified. | | ID | Integer | 0(Read-Only) |The display ID of the event. ​ This property should not be modified. |
 | Location | String | ""​ | The location where this event will take place (IE: "​Joe'​s Country Kitchen"​). | | Location | String | ""​ | The location where this event will take place (IE: "​Joe'​s Country Kitchen"​). |
-| RepeatFrequency | Integer | -1 | The frequency in which the event should repeat. | +| RepeatFrequency | Integer | -1 | The frequency in which the event should repeat, represented by one of the Repeat constants. | 
-| RepeatPeriod | Integer | 1 | The period of the repeat. |+| RepeatPeriod | Integer | 1 | The period of the repeat, IE: 1 for every one (days/​weeks/​months). |
 | StartDate | Date | Nil | The beginning date/time for the event. | | StartDate | Date | Nil | The beginning date/time for the event. |
 +| Tag | Variant | Nil | A custom property for you to store identifiable or related data. |
 | TextColor | Color | &​cFFFFFF | The text color used to display the event. | | TextColor | Color | &​cFFFFFF | The text color used to display the event. |
 | Title | String | ""​ | The title for the event (IE: "​Meeting With Joe"). | | Title | String | ""​ | The title for the event (IE: "​Meeting With Joe"). |
  
-====== Examples ​======+==== Examples ====
 There are currently no examples for this class. There are currently no examples for this class.