Non-dimensional attributes
Description¶
Non-dimensional functions related to forms and reports have attributes that make it possible to obtain information on those objects.
The non-dimensional attributes of forms and report lists are described below.
The Code attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Applicability | Non-dimensional "form" object |
| Syntax | code |
| Value returned | String with the code of the current form |
Example
report.code
Returns the current form code.
The Desc attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Applicability | Non-dimensional "form" object |
| Syntax | desc([language]) |
| Parameters | language (optional) Code of the table language indicated as a whole number |
| Value returned | String with the description of the current form. The optional parameter is only supported with multiple descriptions. If omitted, the user language is used. |
Example
report.desc(2)
Returns the description of the current form in table language 2.
The Path attribute
| Element | Description |
|---|---|
| Availability | From 4.2.0 |
| Applicability | Non-dimensional "form" object |
| Syntax | Path([level], [separator]) |
| Parameters | - level (optional) The number of levels to go up in the form group. If omitted or zero, it goes to the root of the group - separator (optional) Separator to be used between each element in the string. Of omitted, a backslash "\" is used |
| Value returned | String obtained from the concatenation of expressions defined on the nodes of the current element's path. |
Example
With a form related to the "DE - Data Entry" \ "CE - Profit And Loss" nodes of form group "$":
- Report.path
Returns the string "$\DE\CE".
- Report.path(2)
Returns the string "DE\CE".
- Report.path(".")
Returns the string "$.DE.CE".
The ReportFile attribute
| Element | Description |
|---|---|
| Availability | From 4.2.1 (SP20) |
| Syntax | reportFile |
| Attributes | - filename - filepath - fullName |
| Value returned | If the current form is an ad hoc form, it returns some information related to the file on disk containing the form structure. If the form is shared, it returns an empty string. |
Example
To find out whether a form is ad hoc:
if(report.reportFile.filename="", "Form shared", "Form Ad hoc")
Report.reportfile.filename
Returns:
- the string "myReport.xlsx" for "myReport.xlsx" ad hoc forms,
- an empty string for shared forms,
- "book1" for ad hoc forms that have not yet been saved.
Report.reportfile.filepath
Returns:
- the string "C:\Users\Username\Documents" string for "myReport.xlsx" for "myReport.xlsx" ad hoc forms saved in the user's documents folder,
- empty string for shared forms,
- an empty string for ad hoc forms that have not yet been saved.
Report.reportfile.fullFileName
Returns:
- the string "C:\Users\Username\Documents\myReport.xlsx" for "myReport.xlsx" ad hoc forms saved in the user's documents folder,
- empty string for shared forms,
- "book1" for ad hoc forms that have not yet been saved.
The RunDate attribute
| Element | Description |
|---|---|
| Availability | From 3.0903 |
| Syntax | runDate([dataFormat],[timeFormat]) |
| Parameters | - dataFormat: can take one of the following values: - -1: no format. The date is not printed - 0: the Full format is used - 1: the Long format is used - 2: the dd-mmm-yyyy format is used - 3 (or omitted): the Short format is used - timeFormat: can take one of the following values: - -1 (or omitted): no format. The date is not printed - 1: the Full format is used - 2: the Long format is used - 3: the hh.mm format is used |
| Value returned | Date and time at which the form was run in the time zone of the application server. Poiché l’attributo RunDate è valorizzato in base al contesto di esecuzione del form, è possibile che data e ora risultino differenti quando il form viene eseguito dal Web rispetto all’esecuzione tramite Excel Add‑in. Optionally, it is possible to specify one format type for the date and one for the time. Effective formatting also will depend on the user's local formatting. |
Example
A form run on 15 March 2013 at 15:27 with format setting = "Italian".
- report.runDate
Returns 15/03/13.
- report.runDate(0)
Returns Friday 15 March 2013.
- report.runDate(1)
Returns 15 March 2013.
- report.runDate(2)
Returns 15-Mar-2013.
- report.runDate(1,1)
Returns 15 March 2013 15.27.59 GMT+01:00.
- report.runDate(1,2)
Returns 15 March 2013 15.27.59.
- report.runDate(1,3)
Returns 15 March 2013 15.27.
- report.runDate(-1,2)
Returns 15.27.59.
The Code attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Applicability | Non-dimensional "ReportList" object |
| Syntax | code |
| Value returned | String containing the code of the form containing the Report list |
Example
ReportList.code
Returns the form code of the current Report list.
The Desc attribute
| Element | Description |
|---|---|
| Availability | From 3.0912 |
| Applicability | Non-dimensional "ReportList" object |
| Syntax | desc([language]) |
| Parameters | - language (optional) Code of the table language indicated as a whole number |
| Value returned | String containing the description of the form containing the Report list. The parameter is only supported with multiple descriptions. If omitted, the user language is used |
Example
ReportList.desc
Returns the description of the report containing the current report list.
The ReportListFile attribute
| Element | Description |
|---|---|
| Availability | From 4.2.1 (SP20) |
| Syntax | ReportListFile |
| Attributes | - filename - filepath - fullName |
| Value returned | Form containing the current Report list. In the absence of a containing form, with the report list therefore created "on the fly", an error will be generated. Can only be used with parametric expressions inserted in the Report list creation wizard. |
Example
${reportList.reportListFile.filePath}\myOutput.xlsx
Defines a "myOutput.xlsx" file in the same folder as the Report list structure as the output file of a report list.
ReportList.reportListfile.filename
Returns:
- the string "myReportList.xlsx" for "myReportList.xlsx" report lists,
- an empty string for report lists saved in the table,
- the string "book 1" for ad hoc report lists that have not yet been saved.
ReportList.reportListFile.filePath
Returns:
- "C:\Users\Nomeutente\Documents" for "myReportList.xlsx" report lists saved in the user's documents folder,
- an empty string for reports run in the table,
- an empty string for ad hoc reports that have not yet been saved.
Report.reportfile.fullFileName
Returns:
- "C:\Users\Username\Documents\myReportList.xlsx" for "myReportList.xlsx" report lists saved in the documents folder,
- an empty string for reports lists saved in the table,
- "book 1" for ad hoc report lists that have not yet been saved