TimeFunction

 

Remarks Properties Methods DynProperties Samples

ED
avaliable
RT
avaliable

Remarks:Top

The "TimeFunction" object, also called "Time control" in zenOn, enables the user to define function calls which should be executed at a defined (fixed) time or cyclically.

When defining the time control functions for the month or year changes it is important to define the date correctly because this lays down the day after the month or year change on which the function is executed.

Properties:Top

Active Cycled ID
IntervalTime MonthSwitch Name
Parent StartTime YearSwitch

Methods:Top

CheckIn CheckOut DynPropertiesEnum[GET]
DynProperties[GET] DynProperties[PUT] Get
IsCheckedOut IsDaySelected IsDifferent
IsLocked ItemRtFunction SetDaySelected
UndoCheckOut    

DynProperties:Top

Name Type Description
Active Boolean

Active

Active: The time-function is executed in the Runtime.
Inactive: The time-function is not executed in the Runtime.
Default: active.

Read more in the online manual

ExecuteDate ZT_DateTIME

Start time

Date, on which or from which the time-function should be executed.

Read more in the online manual

Friday Boolean

Friday

Active: Function is (also) executed on Fridays.
Inactive: Function is not executed on Fridays.
Default: active.

Read more in the online manual

Function ZT_FUNCTION

Function

Function, that should be executed time-controlled.
Opens the function selection dialog.
If more than one function should be executed here, a script with all the desired functions has to be created and the function for executing the script is linked here.

Read more in the online manual

Interval ZT_ZEIT

interval

Time interval, in which the function should be executed.
Default: 00:15:00.

Read more in the online manual

Monday Boolean

Monday

Active: Function is (also) executed on Mondays.
Inactive: Function is not executed on Mondays.
Default: active.

Read more in the online manual

Monthly Boolean

Turn of month

Only available with cyclic "Execution type":
Active: The function is only executed on the turn of a month (Length of interval: 1 month).
Inactive: The other settings for the execution of the function are used.
Default: inactive.

Read more in the online manual

Name String

Name

Name of the time-function.
Default: Time-Function x (where x is a consecutive number).

ATTENTION: This property is not available for language switching.

Read more in the online manual

Saturday Boolean

Saturday

Active: Function is (also) executed on Saturdays.
Inactive: Function is not executed on Saturdays.
Default: active.

Read more in the online manual

Sunday Boolean

Sunday

Active: Function is (also) executed on Sundays.
Inactive: Function is not executed on Sundays.
Default: active.

Read more in the online manual

Thursday Boolean

Thursday

Active: Function is (also) executed on Thursdays.
Inactive: Function is not executed on Thursdays.
Default: active.

Read more in the online manual

Tuesday Boolean

Tuesday

Active: Function is (also) executed on Tuesdays.
Inactive: Function is not executed on Tuesdays.
Default: active.

Read more in the online manual

Type Long

Execution type

from that day: The function is executed from the defined day every day at the defined time.
only on that day: The function is executed once on the defined day at the defined time.
cyclic from that day on: The function is executed cyclically from the defined day in the defined interval.
cyclic only on that day: The function is executed cyclically only on the defined weekday in the defined interval.

Read more in the online manual

Wednesday Boolean

Wednesday

Active: Function is (also) executed on Wednesdays.
Inactive: Function is not executed on Wednesdays.
Default: active.

Read more in the online manual

Yearly Boolean

Turn of year

Only available with cyclic "Execution type":
Active: The function is only executed at the turn of a year (Length of interval: 1 year).Inactive: The other settings for the execution of the function are used.
Default: inactive.

Read more in the online manual

Samples:Top

Sub CreateTimeFunction()

	Dim zFCT As RtFunction

	Dim zTFT As TimeFunction

	'define the zenOn function to execute

	Set zFCT = MyWorkspace.ActiveDocument.RtFunctions.Item("fct_PrintReport")

	'create timefunction...

	Set zTFT = MyWorkspace.ActiveDocument.TimeFunctions.Create("TimeFunction_1", zFCT.ID)

	'change timefunction settings...

	With zTFT

		.Active = True

		.Cycled = True

		.IntervalTime = 10

		'....

	End With

End Sub