TakeAllScreenShots

function TakeAllScreenShots(outputType: 'pdf' | 'png', RegionControl: TcHmi.Controls.System.TcHmiRegion | null, Contents: string[]):void

The TakeAllScreenShots function captures screenshots of all contents configured within a project, based on the NavigationConfig attribute of the Configurator control. The contents are displayed one by one in a region defined by the RegionControl parameter and screenshots are taken of each. The result screenshots will be downloaded in either ‘pdf’ or ‘png’ format on the client.

For special controls that support pagination such as Table control and ZoneConfiguration control, the function will trigger sub-page changes and captures screen shots for each sub-pages.

In case of Table control, on any content that appears while iterating through all contents, the function will navigate to each sub-page of each sub-table and take screen shots.

For ZoneConfiguration control, the function will iterate through every zone group that is available on the control and take screen shots for each.

Limitations and permissions This function only takes screen shots of visible areas of the shared tab, window or full screen. It cannot trigger any scroll action or capture any out of view area in the result screen shots. To allow this function to take screen shots, the user must approve screen sharing permission that the browser will raise before taking any screen shot. The user must select a proper tab, window or full monitor and allow the browser to access the selected view to take its screen shot.

Parameter