API Events VPS

OnProvideAdditionalDateLine

This event, which is triggered during the (re)loading phase, can be used to configure an additional dateline that is not bound to an object.

If the event is handled and a DateTime is specified, the line is shown, otherwise a possibly existing line is removed (at reload). If no values are specified for parameters that describe the appearance of the line, the default of the ControlAddin results.

[IntegrationEvent(/*IncludeSender*/false, /*GlobalVarAccess*/false)]

procedure OnProvideAdditionalDateLine(pClientGuid: Guid; var pDateLineDateTime: DateTime;
var pDescription: text; var pColor: text; var pDescriptionColor: text;
var pThickness: integer; var pDashArray: text; var pHandled: Boolean)

 

 

Data type

Description

Parameter:

 

 

pClientGuid

Guid

This value is used for the global identification of VPS Control-AddIn on a page.

 

var pDateLineDateTime

DateTime

Date of the additional date line 

var pDescription

Text

Description of the additional date line 

var pColor

Text

Color of the additional date line 

var pDescriptionColor

Text

Color of the description of the additional date line 

var pThickness

Integer

Line thickness of the additional date line

var pDashArray

Text

Dash of the additional date line 

var pHandled

Boolean

If it returns true, an already existing date line is removed (reload)