MATLAB: What is the difference between mlreportgen.ppt.Text and mlreportgen.ppt.Paragraph

MATLAB Report Generator

I am using the Report Generator to generate a PowerPoint presentation. The documentation distinguishes between Text and Paragraph objects. What is the difference between these two objects?

Best Answer

A Paragraph is a container for strings and Text objects. A Paragraph object specifies a format that applies to all the strings that it contains. Paragraph objects also allow you to align text horizontally (left, center, right) relative to the sides of a slide or table entry.

Text objects can override the paragraph formatting for the strings they contain. For example, you could use a Text object to make one word red in a sea of black.

Related Solutions

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);

MATLAB: Has anyone had success in creating a Report generator class to properly fill holes in a Word document

To generate a report from a DOM-based document object:

Derive your report class from mlreportgen.dom.Document class, for example

% MyReport.m
class MyReport < mlreportgen.dom.Document
    method
       function rpt = MyReport(name)
          rpt@mlreportgen.dom.Document(name, 'docx', 'MyTemplate');
       end
    end
end

Provide a public fill<HOLEID> method for each hole in your report template, where HOLEID is the name of the hole, for example,

    class MyReport < mlreportgen.dom.Document
        method
           function rpt = MyReport(name)
              rpt@mlreportgen.dom.Document(name, 'docx', 'MyTemplate');
           end
           % This method is called by mlreportgen.dom.Document's fill method.
           % Do not call it yourself.
           function fillReportDate(rpt)
               append(rpt, date);
           end
        end
    end

Create a report program (i.e., script or function) to run the report.
In the report program, create an instance of your report class and call its fill method (inherited from mlreportgen.dom.Document class), for example,

% runMyReport.m
rpt = MyReport('myreport');
fill(rpt);
rptview(rpt.OutputPath);

Best Answer

Related Solutions

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

MATLAB: Has anyone had success in creating a Report generator class to properly fill holes in a Word document

Related Question