Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Reports Forms in FrameworkX are formatted text documents rich in details about presenting values from your solution variables. They can be saved to disk as text or PDF files, or displayed directly within the solutiona display.

On this page:

Table of Contents
maxLevel3
stylenone

Tip
titleSolution Example

Report Form Example



Image Added

ReportForm Configuration

Configuring the Report Forms

You create the text, formatting, and values by using the text editorintegrated ReportForms Editor. To create or edit a report:

  1. Go toReports / Forms.
  2. Select a report Form name or select the insert row (first row) to create a new reportForm.
  3. Enter or select information in the Form’s row, as needed.

Report Configuration Properties

Field

Description

NameEnter a name for the report. The system allows you to know if the name is not valid.
PaddingSelect padding when replacing a tag name with its value (the field for a tag will have the same number of spaces as the tag name is long). 
  • Compact - Removes any extra characters and displays only the tag value.
  • PadRight - Puts extra space for each character to the right of the tag value.
  • PadLeft - Puts extra space for each character to the left of the tag value.
SaveFormatSelect the report format:
  • XPS
  • HTML
  • Unicode
  • ASCII
  • PDF
SaveFileNameEnter a string and {ObjectProperties}. Use the full path.
SaveTriggerEnter an object property that will be the trigger.
AppendEnter the file to append the report
SizeReport size configuration.
EditSecurityCheck what user groups can edit the report
HeaderChoose another report to be the Header.
FooterChoose another report to be the Footer.
LegacyRead-only. Show if the report is a legacy.
DescriptionEnter a description of this report.
Info

To change the report format between “portrait” and “landscape”, you need to change it in both NovaPDF (printer used by our Platform ) and the target printer.

You can edit the contents of the ReportForm in the Reports Forms Editor.


Visualizing Reports in Runtime

To visualize the reports created from a ReportForm at runtime is straightforward.

When using Windows WPF clients, you can use the following visualization controls. 

When using Web HTML5, or portable displays, you can use the following visualization control:


Properties Reference

ReportForms Configuration table

Properties Reference

Forms

Property

Description

ID

Identifies the unique identifier assigned.

VersionID

Specifies the version number.

Name

Indicates the name assigned for identification.

Padding

Determines space around content: 'Compact' for no extra characters, 'PadRight' for extra space to the right, 'PadLeft' for extra space to the left.

SaveFormat

Sets the file format for saving the document: 'Text', 'HTML', 'Unicode', 'ASCII' or '

ASCII

PDF'.

SaveFileName

Specifies the full path and filename for saving the document.

SaveTrigger

Sets an object property to trigger the save action.

Append

Specifies the file

where

to which the document will be appended.

Header

Selects another document to serve as the header.

Footer

Selects another document to serve as the footer.

Size

Length

Configures the size of the document.

EditSecurity

Checks which user groups have edit permissions for the document.

Legacy

Indicates if the document is a legacy version (read-only).

Level

Determines the access level required for interaction.

Category

Organizes the document into a management category.

LockState

Shows the current lock status of the document for editing or changes.

LockOwner

Identifies the user who has locked the document for exclusive editing.

DateCreated

Records the date and time of the document's creation.

DateModified

Records the date and time the document was last modified.

Description

Provides a summary or explanation of the document's content.



In this section...

Page Tree
root@parent
spacesV10