Codeunit wDCR_DesignFileMgt¶
Provides all implementation related to the flow of Document Creator Design Files and Support Files.
-
A Document Creator Design File is an archive including the layout, wordxmlpart, design settings (and optionally a dataset), which can be opened and edited in the Document Creator Report Designer.
-
A Document Creator Support File is an archive including the layout, wordxmlpart and a dataset for a report, which can be run from any installation from the Document Creator Design/Support File Analysis page.
Properties¶
| Name | Value |
|---|---|
| Access | Public |
Methods¶
wgFncExportDesignFile¶
Creates a Document Creator Design File from a Report Layout List record. Optionally, the report will open a request page to run the report and generate a dataset to include in the file.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Report Layout List" |
pRecReportLayoutList |
The Report Layout List record |
Boolean |
pExportWithData |
Specifies whether a dataset should be included in the Design file. |
wgFncExportDesignFile¶
Creates a Document Creator Design File from a Report Layout List record. Optionally, the report will open a request page to run the report and generate a dataset to include in the file.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Report Layout List" |
pRecReportLayoutList |
The Report Layout List record |
Codeunit "Temp Blob" |
vCduTempBlobDesignFile |
The Temp Blob that will contain the contents of the resulting design file. |
Returns¶
| Type | Description |
|---|---|
Boolean |
true iff the operation has completed successfully. |
wgFncExportDesignFile¶
Creates a Document Creator Design File from a Report Layout List record. Optionally, the report will open a request page to run the report and generate a dataset to include in the file.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Report Layout List" |
pRecReportLayoutList |
The Report Layout List record |
Text |
pXmlParameters |
The XML parameters to use to generate the dataset for the design file. |
Codeunit "Temp Blob" |
vCduTempBlobDesignFile |
The Temp Blob that will contain the contents of the resulting design file. |
Returns¶
| Type | Description |
|---|---|
Boolean |
true iff the operation has completed successfully. |
wgFncExportDesignFile¶
Obsolete
Document Creator layouts have been moved to the report layout system tables. 2.0.0.0
Creates a Document Creator Design File from a Custom Report Layout record. Optionally, the report will open a request page to run the report and generate a dataset to include in the file.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Custom Report Layout" |
pRecCustomRptLayout |
The Custom Report Layout record |
Boolean |
pExportWithData |
Specifies whether a dataset should be included in the Design file. |
wgFncExportDesignFile¶
Obsolete
Document Creator layouts have been moved to the report layout system tables. 2.0.0.0
Creates a Document Creator Design File from a Custom Report Layout record. Optionally, the report will open a request page to run the report and generate a dataset to include in the file.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Custom Report Layout" |
pRecCustomRptLayout |
The Custom Report Layout record |
Codeunit "Temp Blob" |
vCduTempBlobDesignFile |
The Temp Blob that will contain the contents of the resulting design file. |
wgFncExportDesignFile¶
Obsolete
Document Creator layouts have been moved to the report layout system tables. 2.0.0.0
Creates a Document Creator Design File from a Custom Report Layout record. Optionally, the report will open a request page to run the report and generate a dataset to include in the file.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Custom Report Layout" |
pRecCustomRptLayout |
The Custom Report Layout record |
Text |
pXmlParameters |
The XML parameters to use to generate the dataset for the design file. |
Codeunit "Temp Blob" |
vCduTempBlobDesignFile |
The Temp Blob that will contain the contents of the resulting design file. |
wgFncExportDesignFile¶
Creates a Document Creator Design File from a Tenant Report Layout record. Optionally, the report will open a request page to run the report and generate a dataset to include in the file.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Tenant Report Layout" |
pRecTenantReportLayout |
The Tenant Report Layout record |
Boolean |
pExportWithData |
Specifies whether a dataset should be included in the Design file. |
wgFncExportDesignFile¶
Creates a Document Creator Design File from a Tenant Report Layout record. Optionally, the report will open a request page to run the report and generate a dataset to include in the file.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Tenant Report Layout" |
pRecTenantReportLayout |
The Tenant Report Layout record |
Codeunit "Temp Blob" |
vCduTempBlobDesignFile |
The Temp Blob that will contain the contents of the resulting design file. |
wgFncExportDesignFile¶
Creates a Document Creator Design File from a Tenant Report Layout record. Optionally, the report will open a request page to run the report and generate a dataset to include in the file.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Tenant Report Layout" |
pRecTenantReportLayout |
The Tenant Report Layout record |
Text |
pXmlParameters |
The XML parameters to use to generate the dataset for the design file. |
Codeunit "Temp Blob" |
vCduTempBlobDesignFile |
The Temp Blob that will contain the contents of the resulting design file. |
wgFncExportDesignFileEntry¶
Exports one of the entries from a Document Creator Design File.
Parameters¶
| Type | Name | Description |
|---|---|---|
Codeunit "Temp Blob" |
pCduTempBlobDesign |
The design file. |
Enum "wDCR_DesignFileEntryType" |
pDesignFileEntryType |
The type of entry to export. |
wgFncExportDesignFileEntry¶
Exports one of the entries from a Document Creator Design File.
Parameters¶
| Type | Name | Description |
|---|---|---|
Codeunit "Temp Blob" |
pCduTempBlobDesign |
The design file. |
Enum "wDCR_DesignFileEntryType" |
pDesignFileEntryType |
The type of entry to export. |
Codeunit "Temp Blob" |
vCduTempBlobDesignFileEntry |
The output (file entry) as a stream |
wgFncExportSupportFile¶
Creates a Document Creator Support File from a Report Layout List record.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Report Layout List" |
pRecReportLayoutList |
The Report Layout List record |
wgFncExportSupportFile¶
Creates a Document Creator Support File from a Report Layout List record.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Report Layout List" |
pRecReportLayoutList |
The Report Layout List record |
Text |
pXmlParameters |
The XML parameters to use to generate the dataset for the support file. |
Codeunit "Temp Blob" |
vCduTempBlobSupportFile |
The Temp Blob that will contain the contents of the resulting support file. |
wgFncExportSupportFile¶
Obsolete
Document Creator layouts have been moved to the report layout system tables. 2.0.0.0
Creates a Document Creator Support File from a Custom Report Layout record.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Custom Report Layout" |
pRecCustomRptLayout |
The Custom Report Layout record |
wgFncExportSupportFile¶
Obsolete
Document Creator layouts have been moved to the report layout system tables. 2.0.0.0
Creates a Document Creator Support File from a Custom Report Layout record.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Custom Report Layout" |
pRecCustomRptLayout |
The Custom Report Layout record |
Text |
pXmlParameters |
The XML parameters to use to generate the dataset for the support file. |
Codeunit "Temp Blob" |
vCduTempBlobSupportFile |
The Temp Blob that will contain the contents of the resulting support file. |
wgFncGetDesignSettings¶
Gets the design settings as a JSON object for a Document Creator report layout.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Report Layout List" |
pRecReportLayoutList |
The report layout. |
Integer |
pDataLocaleID |
The locale ID/region of the dataset. |
JsonObject |
vJsonDesignSettings |
The design settings in a JSON object. |
Returns¶
| Type | Description |
|---|---|
Boolean |
true iff the design settings were retrieved successfully. |
wgFncGetDesignSettings¶
Gets the design settings as a JSON object from a Document Creator Design File (.dcrd).
Parameters¶
| Type | Name | Description |
|---|---|---|
Codeunit "Temp Blob" |
pCduTempBlobDesignFile |
The Temp Blob containing the design file. |
JsonObject |
vJsonDesignSettings |
The design settings as a JSON object. |
Returns¶
| Type | Description |
|---|---|
Boolean |
true iff the design settings could be retrieved successfully |
wgFncGetDocumentCreatorDesignFileExtension¶
Returns the file extension for Document Creator Design Files.
Returns¶
| Type | Description |
|---|---|
Text[4] |
Document Creator Design file extension. |
wgFncGetDocumentCreatorDesignFileExtFilter¶
Returns the file extension filter for Document Creator Design Files.
Returns¶
| Type | Description |
|---|---|
Text |
Document Creator Design file extension filter. |
wgFncGetDocumentCreatorDesignFileFilter¶
Returns the file filter for Document Creator Design Files.
Returns¶
| Type | Description |
|---|---|
Text |
Document Creator Design file filter. |
wgFncGetDocumentCreatorSupportFileExtension¶
Returns the file extension for Document Creator Support Files.
Returns¶
| Type | Description |
|---|---|
Text[4] |
Document Creator Support file extension. |
wgFncGetDocumentCreatorSupportFileExtFilter¶
Returns the file extension filter for Document Creator Support Files.
Returns¶
| Type | Description |
|---|---|
Text |
Document Creator Support file extension filter. |
wgFncGetDocumentCreatorSupportFileFilter¶
Returns the file filter for Document Creator Support Files.
Returns¶
| Type | Description |
|---|---|
Text |
Document Creator Support file filter. |
wgFncImportDesignFile¶
Imports a design file into a report layout list record.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Report Layout List" |
pRecReportLayoutList |
The report layout list record to import the design file into. |
wgFncImportDesignFile¶
Obsolete
Document Creator layouts have been moved to the report layout system tables. 2.0.0.0
Imports the layout from a Document Creator Design File into a Custom Report Layout record, prompting the user for the design file. The original version of the layout is archived in the custom report layout archive before the import.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Custom Report Layout" |
vRecCustomReportLayout |
The Custom Report Layout record to import the layout into. |
wgFncImportDesignFile¶
Imports a design file into a tenant report layout record.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Tenant Report Layout" |
pRecTenantReportLayout |
The tenant report layout record to import the design file into. |
wgFncImportDesignFile¶
Imports a design file into a report layout list record.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Report Layout List" |
pRecReportLayoutList |
The report layout list record to import the design file into. |
InStream |
pInStreamDesignFile |
The InStream containing the design file to import. |
wgFncImportDesignFile¶
Imports a design file into a tenant report layout record.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Tenant Report Layout" |
pRecTenantReportLayout |
The tenant report layout record to import the design file into. |
InStream |
pInStreamDesign |
The InStream containing the design file to import. |
wgFncRunReportRequestPageWithStoredRequestParameters¶
Runs the request page with stored parameters.
Parameters¶
| Type | Name | Description |
|---|---|---|
Integer |
pReportID |
Report ID |
Text |
pCompanyName |
Company Name |
Text |
pUserID |
User ID |
Text |
pXmlParameters |
XML request page parameters to use instead of the stored. |
Returns¶
| Type | Description |
|---|---|
Text |
The XML parameters after closing the request page. Empty if cancelled. |