SetRelativeDate

Parent Previous Next

SetRelativeDate

This function sets the Relative Start Date of the Alarm Object. This function has two ways to be used:


Function Definition:


void SetRelativeDate(DateTime date);


.     DateTime date: A DateTime parameter that Represents the date that will be the start date.



            void SetRelativeDate(string date);


.     String date: A string parameter that Represents the date that will be the start date.



To configure this property, follow the steps below:


1.   In an object event, configure the SetRelativeDate function: AlarmObjectName.SetRelativeDate(date);


2.   During the execution of RunTime, run the configured event.



Example with SetRelativeDate(DateTime date):


In the graphic document, the user has one Alarm object (named as Alarm1). In a Button object (named as Button1) the user configures the MouseUp event with the following event:


Alarm1.SetRelativeDate(@dateTag);


In this event, the Relative Start Date will be set to the DateTime tag "@dateTag".



 

Note: This property exists only to the following objects:

.    Alarm