Documentation

MATLAB Report Generator Functions

Alphabetical List By Category

Interactive Report Creation

Create Reports

Report Setup

rptlist Retrieve list of all report setup files in MATLAB path
setedit Start Report Explorer

Format Reports

rptconvert Convert DocBook XML files into supported document formats

Generate Reports

report Generate reports from report setup file
rptconvert Convert DocBook XML files into supported document formats

Customize Components and Style Sheets

Information Components

compwiz Create custom MATLAB Report Generator components

Programmatic Report Creation

Create Report Content

mlreportgen.dom.Document.append Append DOM or MATLAB object to document
mlreportgen.dom.Paragraph.append Append content to paragraph
mlreportgen.dom.ExternalLink.append Append custom element to external link
mlreportgen.dom.LinkTarget.append Append content to link target
mlreportgen.dom.Paragraph.clone Copy paragraph object
mlreportgen.dom.Document.open Open document
mlreportgen.dom.Document.close Close document
rptview Display DOM report
mlreportgen.dom.MessageDispatcher.getTheDispatcher Return DOM message dispatcher
mlreportgen.dom.MessageDispatcher.dispatch Dispatch DOM status message
mlreportgen.dom.Document.createTemplate Create DOM template
zipTemplate Package DOM HTML template in zip file
unzipTemplate Unzip zipped DOM template
mlreportgen.dom.ProgressMessage.formatAsHTML Wrap message in HTML tags
mlreportgen.dom.ProgressMessage.formatAsText Format message as text
mlreportgen.dom.ProgressMessage.passesFilter Determine if message passes filter
mlreportgen.dom.Document.package Add OPC part files to document package
mlreportgen.dom.Document.getCoreProperties Get document or template core properties
mlreportgen.dom.Document.setCoreProperties Set OPC core properties of output document or template
mlreportgen.dom.Document.getMainPartPath Return path of main part of document output package
mlreportgen.dom.Document.getOPCMainPart Return main part of document, document part, or template
mlreportgen.dom.Document.getImagePrefix Get generated image name prefix
mlreportgen.dom.Document Report definition document
mlreportgen.dom.Text Text object
mlreportgen.dom.Paragraph Formatted block of text (paragraph)
mlreportgen.dom.Heading Heading paragraph
mlreportgen.dom.OrderedList Create ordered list
mlreportgen.dom.UnorderedList Unordered (bulleted) list
mlreportgen.dom.ListItem Create item for ordered or unordered list
mlreportgen.dom.Table Create table
mlreportgen.dom.FormalTable Formal table
mlreportgen.dom.Image Create image to be included in report
mlreportgen.dom.HorizontalRule Horizontal line between report content
mlreportgen.dom.Group Group of document objects
mlreportgen.dom.CoreProperties OPC core properties of document or template
mlreportgen.dom.MessageDispatcher DOM message dispatcher
mlreportgen.dom.MessageEventData Holds message triggering message event
mlreportgen.dom.MessageFilter Filter to control message dispatcher
mlreportgen.dom.DebugMessage Debugging message
mlreportgen.dom.ErrorMessage Error message
mlreportgen.dom.ProgressMessage Progress message
mlreportgen.dom.WarningMessage Warning message
mlreportgen.dom.OPCPart Document part to include in OPC package

Report Format Basics

mlreportgen.dom.Document.createTemplate Create DOM template
mlreportgen.dom.Container.clone Copy container object
mlreportgen.dom.Container.append Append DOM object to container
mlreportgen.dom.Container Container of document objects

Create Form-Based Reports

mlreportgen.dom.Document.createTemplate Create DOM template
mlreportgen.dom.Document.moveToNextHole Move document append point to next template hole
mlreportgen.dom.Document Report definition document
mlreportgen.dom.DocumentPart Document part
mlreportgen.dom.Template Create document template

Create Object-Oriented Reports

mlreportgen.dom.Document.fill Fill document holes with generated content
mlreportgen.dom.Document Report definition document

Create and Format Report Objects

mlreportgen.dom.Document.append Append DOM or MATLAB object to document
mlreportgen.dom.Paragraph.append Append content to paragraph
mlreportgen.dom.Paragraph.clone Copy paragraph object
mlreportgen.dom.Document.createAutoNumberStream Create numbering stream
mlreportgen.dom.Document.getAutoNumberStream Return numbering stream
mlreportgen.dom.OrderedList.append Append content to ordered list
mlreportgen.dom.ExternalLink.append Append custom element to external link
mlreportgen.dom.LinkTarget.append Append content to link target
mlreportgen.dom.Table.row Access table row
mlreportgen.dom.TableRow.append Append content to table row
mlreportgen.dom.Table.entry Access table entry
mlreportgen.dom.Group.append Add DOM object to group
mlreportgen.dom.Document.createTemplate Create DOM template
mlreportgen.dom.FormalTable.appendFooterRow Append row to table footer
mlreportgen.dom.FormalTable.appendHeaderRow Append row to table header
mlreportgen.dom.CustomElement.append Append HTML content to custom element
mlreportgen.dom.Text Text object
mlreportgen.dom.Paragraph Formatted block of text (paragraph)
mlreportgen.dom.OrderedList Create ordered list
mlreportgen.dom.UnorderedList Unordered (bulleted) list
mlreportgen.dom.ListItem Create item for ordered or unordered list
mlreportgen.dom.Table Create table
mlreportgen.dom.FormalTable Formal table
mlreportgen.dom.TableRow Table row
mlreportgen.dom.Display Display option for DOM objects
mlreportgen.dom.TableEntry Table entry
mlreportgen.dom.TableHeader Table header
mlreportgen.dom.ExternalLink Hyperlink to a location outside of document
mlreportgen.dom.InternalLink Hyperlink to a location in same document
mlreportgen.dom.LinkTarget Target for internal or external links or image area links
mlreportgen.dom.Image Create image to be included in report
mlreportgen.dom.ImageArea Define image area as hyperlink
mlreportgen.dom.AutoNumber Automatically generated number
mlreportgen.dom.AutoNumberStream Numbering stream
mlreportgen.dom.CounterInc Number stream counter incrementer
mlreportgen.dom.DocumentPart Document part
mlreportgen.dom.Display Display option for DOM objects
mlreportgen.dom.HorizontalRule Horizontal line between report content
mlreportgen.dom.Border Border properties of object
mlreportgen.dom.FontFamily Font family
mlreportgen.dom.FontSize Font size
mlreportgen.dom.Bold Bold for text object
mlreportgen.dom.Italic Italic for text object
mlreportgen.dom.Color Color of document element
mlreportgen.dom.Strike Strike through text
mlreportgen.dom.Underline Draw line under text
mlreportgen.dom.LineSpacing Spacing between lines of paragraph
mlreportgen.dom.WhiteSpace White space type
mlreportgen.dom.CharEntity Create character entity reference
mlreportgen.dom.BackgroundColor Background color of document element
mlreportgen.dom.FirstLineIndent Indent first line of paragraph
mlreportgen.dom.VerticalAlign Vertical alignment of text
mlreportgen.dom.KeepLinesTogether Start paragraph on new page if necessary
mlreportgen.dom.KeepWithNext Keep paragraph on same page as next
mlreportgen.dom.PageBreakBefore Start paragraph on new page
mlreportgen.dom.WidowOrphanControl Widow and orphan handling
mlreportgen.dom.OutlineLevel Level of paragraph in outline
mlreportgen.dom.FlowDirection Direction of text or table column flow
mlreportgen.dom.TableBody Body of formal table
mlreportgen.dom.TableFooter Formal table footer
mlreportgen.dom.TableColSpec Formatting for one or more adjacent table columns
mlreportgen.dom.TableColSpecGroup Define style for group of table columns
mlreportgen.dom.ResizeToFitContents Allow table to resize its columns
mlreportgen.dom.TableHeaderEntry Entry in table header
mlreportgen.dom.RepeatAsHeaderRow Repeat table row
mlreportgen.dom.RowHeight Height of table row
mlreportgen.dom.AllowBreakAcrossPages Allow row to straddle page break
mlreportgen.dom.BorderCollapse Collapse HTML table borders
mlreportgen.dom.ColSep Draw lines between table columns
mlreportgen.dom.RowSep Draw lines between table rows
mlreportgen.dom.ImageMap Map of hyperlink areas in image
mlreportgen.dom.CounterReset Reset numbering stream counter
mlreportgen.dom.HAlign Specify horizontal alignment of document object
mlreportgen.dom.VAlign Vertical alignment of document object
mlreportgen.dom.Height Height of object
mlreportgen.dom.Width Object width
mlreportgen.dom.ScaleToFit Scale image to fit page
mlreportgen.dom.InnerMargin Margin between content and bounding box
mlreportgen.dom.OuterMargin Margin between bounding box and its surroundings
mlreportgen.dom.DOCXSubDoc Reference to external Microsoft Word document
mlreportgen.dom.DOCXPageFooter Page footer definition for Microsoft Word document
mlreportgen.dom.DOCXPageHeader Page header definition for Microsoft Word document
mlreportgen.dom.DOCXSection Page format and layout for Microsoft Word document section
mlreportgen.dom.CustomAttribute Custom element attribute
mlreportgen.dom.CustomElement Custom element of document
mlreportgen.dom.CustomText Plain text appended to custom element
mlreportgen.dom.DOCXRawFormat XML markup for array of Microsoft Word formats
mlreportgen.dom.RawText Word XML or HTML markup to insert in document
mlreportgen.dom.Template Create document template

Create DOM Reports from HTML

mlreportgen.dom.Document.addHTML Append HTML string to document
mlreportgen.dom.Document.addHTMLFile Append HTML file contents to document
mlreportgen.dom.HTML.append Append HTML string to HTML object
mlreportgen.dom.HTML.clone Copy HTML object
mlreportgen.dom.HTMLFile.append Append HTML to HTMLFile object
mlreportgen.dom.HTML Convert HTML text to container of DOM objects
mlreportgen.dom.HTMLFile Convert contents of HTML file to container of DOM objects
mlreportgen.dom.Document Report definition document
mlreportgen.dom.DocumentPart Document part
mlreportgen.dom.Display Display option for DOM objects

Create Report Templates

mlreportgen.dom.Document.createTemplate Create DOM template
mlreportgen.dom.Document.package Add OPC part files to document package
mlreportgen.dom.Document.getImageDirectory Get image folder of document
zipTemplate Package DOM HTML template in zip file
unzipTemplate Unzip zipped DOM template
mlreportgen.dom.Template Create document template
mlreportgen.dom.TemplateHole Hole to append to template

Format Microsoft Word Pages

mlreportgen.dom.DOCXSection Page format and layout for Microsoft Word document section
mlreportgen.dom.DOCXSubDoc Reference to external Microsoft Word document
mlreportgen.dom.DOCXPageFooter Page footer definition for Microsoft Word document
mlreportgen.dom.DOCXPageHeader Page header definition for Microsoft Word document
mlreportgen.dom.DOCXPageSize Size and orientation of pages in Microsoft Word document
mlreportgen.dom.DOCXPageMargins Page margins for Microsoft Word page layout

Programmatic PowerPoint Presentation Creation

Create Presentation Content

mlreportgen.ppt.Presentation.open Open presentation
mlreportgen.ppt.Presentation.close Close presentation
mlreportgen.ppt.Presentation.getMasterNames Get names of slide masters for presentation
mlreportgen.ppt.Presentation.getLayoutNames Get names of layouts for presentation slide master
mlreportgen.ppt.Presentation.getTableStyleNames Get table style names for presentation
mlreportgen.ppt.Presentation.add Add slide to presentation
mlreportgen.ppt.Presentation.replace Replace paragraphs, tables, or pictures in presentation
mlreportgen.ppt.MessageDispatcher.dispatch Dispatch PPT status message
mlreportgen.ppt.MessageDispatcher.getTheDispatcher Return PPT message dispatcher
mlreportgen.ppt.ProgressMessage.formatAsText Format message as text
mlreportgen.ppt.ProgressMessage.formatAsHTML Wrap message in HTML tags
mlreportgen.ppt.ProgressMessage.passesFilter Determine if message passes filter
mlreportgen.ppt.Presentation Create PowerPoint presentation
mlreportgen.ppt.Slide Presentation slide
mlreportgen.ppt.Text Text
mlreportgen.ppt.TextBox Text box
mlreportgen.ppt.ExternalLink Hyperlink to location outside of presentation
mlreportgen.ppt.Table Table
mlreportgen.ppt.Picture Create picture to include in presentation
mlreportgen.ppt.ContentPlaceholder Placeholder for presentation content in slide
mlreportgen.ppt.TextBoxPlaceholder Slide placeholder to replace with text box
mlreportgen.ppt.TablePlaceholder Slide placeholder to replace with table
mlreportgen.ppt.PicturePlaceholder Slide placeholder to replace with picture
mlreportgen.ppt.MessageDispatcher PPT message dispatcher
mlreportgen.ppt.MessageEventData Holds message triggering message event
mlreportgen.ppt.MessageFilter Filter to control message dispatcher
mlreportgen.ppt.ProgressMessage Progress message
mlreportgen.ppt.DebugMessage Debugging message
mlreportgen.ppt.ErrorMessage Error message
mlreportgen.ppt.WarningMessage Warning message

Presentation Format Basics

mlreportgen.ppt.Presentation.getMasterNames Get names of slide masters for presentation
mlreportgen.ppt.Presentation.getLayoutNames Get names of layouts for presentation slide master
mlreportgen.ppt.Presentation.open Open presentation
mlreportgen.ppt.Presentation.close Close presentation
mlreportgen.ppt.Presentation Create PowerPoint presentation
mlreportgen.ppt.Slide Presentation slide
mlreportgen.ppt.FontFamily Font family
mlreportgen.ppt.FontColor Font color of presentation element
mlreportgen.ppt.FontSize Font size
mlreportgen.ppt.Bold Bold for text object
mlreportgen.ppt.Italic Italic for text object
mlreportgen.ppt.Strike Strike through text
mlreportgen.ppt.Underline Underline text
mlreportgen.ppt.Subscript Subscript
mlreportgen.ppt.Superscript Superscript
mlreportgen.ppt.HAlign Horizontal alignment of paragraph
mlreportgen.ppt.VAlign Vertical alignment of table entry content
mlreportgen.ppt.ColSpec Formatting for table column
mlreportgen.ppt.ColWidth Table column width

Update PowerPoint Presentation Content

mlreportgen.ppt.Presentation.getMasterNames Get names of slide masters for presentation
mlreportgen.ppt.Presentation.getLayoutNames Get names of layouts for presentation slide master
mlreportgen.ppt.Presentation.getTableStyleNames Get table style names for presentation
mlreportgen.ppt.Presentation.find Search in presentation
mlreportgen.ppt.Slide.add Add text box, table, or picture to slide
mlreportgen.ppt.Slide.replace Replace paragraphs, tables, or pictures in slide
mlreportgen.ppt.Slide.find Search in slide
mlreportgen.ppt.ContentPlaceholder.add Add paragraph or paragraphs to content placeholder
mlreportgen.ppt.ContentPlaceholder.replace Replace content in content placeholder
mlreportgen.ppt.TextBox.add Add paragraph to text box
mlreportgen.ppt.TextBox.replace Replace text box paragraphs
mlreportgen.ppt.TextBoxPlaceholder.add Add paragraphs to text box placeholder
mlreportgen.ppt.TextBoxPlaceholder.replace Replace text box placeholder paragraphs
mlreportgen.ppt.TablePlaceholder.replace Replace table in table placeholder
mlreportgen.ppt.PicturePlaceholder.replace Replace picture in picture placeholder
mlreportgen.ppt.Presentation Create PowerPoint presentation
mlreportgen.ppt.Slide Presentation slide
mlreportgen.ppt.ContentPlaceholder Placeholder for presentation content in slide
mlreportgen.ppt.TextBoxPlaceholder Slide placeholder to replace with text box
mlreportgen.ppt.PicturePlaceholder Slide placeholder to replace with picture
mlreportgen.ppt.TablePlaceholder Slide placeholder to replace with table
mlreportgen.ppt.TextBox Text box
mlreportgen.ppt.Paragraph Formatted block of text (paragraph)
mlreportgen.ppt.Text Text
mlreportgen.ppt.ExternalLink Hyperlink to location outside of presentation
mlreportgen.ppt.Picture Create picture to include in presentation
mlreportgen.ppt.Table Table
mlreportgen.ppt.TableRow Table row
mlreportgen.ppt.TableEntry Table entry
mlreportgen.ppt.ColSpec Formatting for table column
mlreportgen.ppt.ColWidth Table column width

Create Complete PowerPoint Presentations

mlreportgen.ppt.Presentation.getMasterNames Get names of slide masters for presentation
mlreportgen.ppt.Presentation.getLayoutNames Get names of layouts for presentation slide master
mlreportgen.ppt.Presentation.getTableStyleNames Get table style names for presentation
mlreportgen.ppt.Presentation.find Search in presentation
mlreportgen.ppt.Slide.add Add text box, table, or picture to slide
mlreportgen.ppt.Slide.replace Replace paragraphs, tables, or pictures in slide
mlreportgen.ppt.Slide.find Search in slide
mlreportgen.ppt.ContentPlaceholder.add Add paragraph or paragraphs to content placeholder
mlreportgen.ppt.ContentPlaceholder.replace Replace content in content placeholder
mlreportgen.ppt.TextBox.add Add paragraph to text box
mlreportgen.ppt.TextBox.replace Replace text box paragraphs
mlreportgen.ppt.TextBoxPlaceholder.add Add paragraphs to text box placeholder
mlreportgen.ppt.TextBoxPlaceholder.replace Replace text box placeholder paragraphs
mlreportgen.ppt.TablePlaceholder.replace Replace table in table placeholder
mlreportgen.ppt.PicturePlaceholder.replace Replace picture in picture placeholder
mlreportgen.ppt.Presentation Create PowerPoint presentation
mlreportgen.ppt.Slide Presentation slide
mlreportgen.ppt.ContentPlaceholder Placeholder for presentation content in slide
mlreportgen.ppt.TextBoxPlaceholder Slide placeholder to replace with text box
mlreportgen.ppt.PicturePlaceholder Slide placeholder to replace with picture
mlreportgen.ppt.TablePlaceholder Slide placeholder to replace with table
mlreportgen.ppt.TextBox Text box
mlreportgen.ppt.Paragraph Formatted block of text (paragraph)
mlreportgen.ppt.Text Text
mlreportgen.ppt.ExternalLink Hyperlink to location outside of presentation
mlreportgen.ppt.Picture Create picture to include in presentation
mlreportgen.ppt.Table Table
mlreportgen.ppt.TableRow Table row
mlreportgen.ppt.TableEntry Table entry
mlreportgen.ppt.ColSpec Formatting for table column
mlreportgen.ppt.ColWidth Table column width

Create and Format Presentation Objects

mlreportgen.ppt.Paragraph.append Append content to paragraph
mlreportgen.ppt.TextBox.add Add paragraph to text box
mlreportgen.ppt.TextBox.replace Replace text box paragraphs
mlreportgen.ppt.Picture.replace Replace picture
mlreportgen.ppt.Table.append Append row to table
mlreportgen.ppt.Table.row Access table row
mlreportgen.ppt.Table.entry Access table entry
mlreportgen.ppt.Table.replace Replace table with another table
mlreportgen.ppt.TableRow.append Append table entry to table row
mlreportgen.ppt.TableEntry.append Append string or paragraph to table entry
mlreportgen.ppt.Presentation Create PowerPoint presentation
mlreportgen.ppt.Slide Presentation slide
mlreportgen.ppt.Paragraph Formatted block of text (paragraph)
mlreportgen.ppt.TextBox Text box
mlreportgen.ppt.Text Text
mlreportgen.ppt.Table Table
mlreportgen.ppt.TableEntry Table entry
mlreportgen.ppt.TableRow Table row
mlreportgen.ppt.Picture Create picture to include in presentation
mlreportgen.ppt.ExternalLink Hyperlink to location outside of presentation
mlreportgen.ppt.FontFamily Font family
mlreportgen.ppt.FontColor Font color of presentation element
mlreportgen.ppt.FontSize Font size
mlreportgen.ppt.Bold Bold for text object
mlreportgen.ppt.Italic Italic for text object
mlreportgen.ppt.Strike Strike through text
mlreportgen.ppt.Underline Underline text
mlreportgen.ppt.Subscript Subscript
mlreportgen.ppt.Superscript Superscript
mlreportgen.ppt.HAlign Horizontal alignment of paragraph
mlreportgen.ppt.VAlign Vertical alignment of table entry content
mlreportgen.ppt.ColSpec Formatting for table column
mlreportgen.ppt.ColWidth Table column width
Was this topic helpful?