Edit

Share via

WordLayout Property

  • Article

Version: Available or changed with runtime version 1.0.

Sets the Word layout that is used on a report and returns it as a data stream.

Applies to

  • Report
  • Report Extension

Note

Reports support both Excel, RDL, and Word layouts. For more information, see DefaultLayout Property.

Remarks

The Word file must be in the same folder as the AL object.

Warning

Using the report properties DefaultLayout, ExcelLayout, RDLCLayout, and WordLayout should be avoided as these properties will be deprecated in a later release. Instead, it's recommended to use the property DefaultRenderingLayout together with the new rendering syntax introduced in runtime version 9.0.

In Visual Studio Code, when hovering over any line with the ExcelLayout, RDLLayout, or WordLayout property, you can use the code action Convert to 'Rendering' to convert to the new rendering syntax.

For more information, see DefaultRenderingLayout Property.

The use of any of these report properties impact performance as every call loads the full layout in memory even if the intent is only to check if a given report had a layout of the given type.

Example

The following example shows how to use this property to generate the MyWordReport.docx file.

pageextension 50100 MyExtension extends "Customer List"
{
    trigger OnOpenPage();
    begin
        report.Run(Report::MyWordReport);
    end;
}

report 50124 MyWordReport
{
    DefaultLayout = Word;
    WordLayout = 'MyWordReport.docx';
}

Creating a Word Layout Report
RDLCLayout Property
Creating an RDL Layout Report