MATLAB: Can you use Report Generator to put dynamic text in the footer

dynamicfootergeneratorMATLABmicrosoftreporttemplatetext;word

Is it possible to use Report Generator to put dynamic text in the footer of a Microsoft Word document?

Can footers on different pages be different?

Best Answer

Using dynamic text in a footer is possible and it can be done in the same way any other text can be generated.

Attached is a very basic example that uses dynamic text in a footer with different values on different pages. It uses information from the examples in the following two links:

Dynamic Reporting:

https://www.mathworks.com/products/ML_reportgenerator/features.html

Page Footer:

https://www.mathworks.com/help/rptgen/ug/mlreportgen.dom.docxpagefooter-class.html#bu7mkg7-1

Related Solutions

MATLAB: How to use a custom Word template for headers and footers in MATLAB Report Generator

To use a custom-made Word template, create a new document using the "mlreportgen.dom.Document" constructor and set the "templatePath" property to your DOTX file. Here is the documentation for a Document object:

<https://www.mathworks.com/help/rptgen/ug/mlreportgen.dom.document-class.html>

And here is a simple example using a custom-made template file from MS Word within the MALTAB Report Generator API:

import mlreportgen.dom.*

d = Document('MyWordDoc', 'docx', 'CustomTemplate.dotx'); %assuming template is in same folder; otherwise, specify full path

open(d);

append(d,'Hello World'); % add some text to generate doc

close(d);

rptview(d.OutputPath)

This formatting for headers and footers will disappear if you are adding chapters to the report. To customize chapter page headers, see the following documented examples for creating and editing chapter templates:

<https://www.mathworks.com/help/rptgen/ug/customize-chapter-page-headers-in-pdf-and-word-reports.html>

MATLAB: How to add custom text to a footer in a generated report

To add custom text to a footer in your report, you can work with the 'DOCXPageFooter' class:

Documentation Page:

https://www.mathworks.com/help/rptgen/ug/mlreportgen.dom.docxpagefooter-class.html

Example of making a footer:

https://www.mathworks.com/help/rptgen/ug/mlreportgen.dom.docxpagefooter-class.html#bu7mkg7-2

When creating a page footer, you can first specify which pages you would like it to appear on (first page only, even pages, odd pages, or all pages). Then, you can append different DOM objects to the footer, such as a page number or a paragraph.

The following code is an adaptation of the example linked above. This code demonstrates how to add a paragraph with custom text to a footer which already includes the page number:

import mlreportgen.dom.*;
d = Document('mydoc','docx');
open(d);
% Create page footer object
myfooter = DOCXPageFooter();
d.CurrentPageLayout.PageFooters = [myfooter];
% Add page number to footer
pageNum = Page();
append(d.CurrentPageLayout.PageFooters(1), pageNum);
% Add custom text to footer
txt = Paragraph('My custom text');
txt.HAlign = 'center';
append(d.CurrentPageLayout.PageFooters(1),txt);
% Create several pages.
p = Paragraph('Title page');
append(d,p);
p = Paragraph('Another page');
p.Style = {PageBreakBefore(true)};
append(d,p);
append(d,clone(p));
append(d,clone(p));
close(d);
rptview(d.OutputPath);

Best Answer

Related Solutions

MATLAB: How to use a custom Word template for headers and footers in MATLAB Report Generator

MATLAB: How to add custom text to a footer in a generated report

Related Question