CaptionPeriodHeader (Property)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage properties

Properties associated with reports and controls

AllModifiableWithReportsAndQueries

BackgroundImagePrinted

EndDatePeriodDisplayed

FontAppointmentContent

InterfaceModifiableWithReportsAndQueries

RTFWithImagesAndTables

StartDatePeriodDisplayed

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

CaptionPeriodHeader (Property)

In french: LibelléPériodeEntête

The CaptionPeriodHeader property is used to get and change the caption of the time period displayed in the header of a Scheduler or Agenda control in a report.

Versions 21 and later

This property is now available in Universal Windows 10 App mode.

New in version 21

This property is now available in Universal Windows 10 App mode.

Example

// "Before printing" event of the header block
SCH_MySchedule.CaptionPeriodHeader = ...
" Week from " + DateToString(SCH_MySchedule.StartDatePeriodDisplayed) + ...
" to " + DateToString(SCH_MySchedule.EndDatePeriodDisplayed)

Syntax

Finding out the caption of the period Hide the details

<Period caption> = <Control used>.CaptionPeriodHeader

<Period caption>: Character string

Caption of the period displayed in the control header.

<Control used>: Control name

Name of the Scheduler or Organizer control in the report.

Modifying the caption of the period Hide the details

<Control used>.CaptionPeriodHeader = <New caption text>

<Control used>: Control name

Name of the Scheduler or Organizer control found in the report.

<New caption text>: Character string

New caption of the period to display in the control header.

Remarks

When called in the "Before printing" event of the header block, the CaptionPeriodHeader property is used to change default caption in order to display it in a specific language (for example : caption displayed in Polish).
The CaptionPeriodHeader property has no effect on Scheduler reports with resources displayed in columns, because there are no captions in this case.