mlreportgen.dom.NumPages Class
Namespace: mlreportgen.dom
Create placeholder for number of document pages
Description
Create a placeholder for the number of pages in a document. This object applies only to Word and PDF output. For Word output, opening a Word document causes Word to replace this object with the number of pages in the document. For PDF output, the DOM API replaces this object with the total number of pages when writing the document.
The mlreportgen.dom.NumPages
class is a handle
class.
Creation
Description
creates an
object for the total number of pages in the report.num
= NumPages
Properties
CustomAttributes
— Custom attributes of document element
[]
(default) | array of mlreportgen.dom.CustomAttribute
objects
Custom attributes of this document element, specified as an array of mlreportgen.dom.CustomAttribute
objects. The custom attributes must be
supported by the output format of the document element to which this object is
appended.
Attributes:
NonCopyable | true |
Style
— Format specification
{}
(default) | array of DOM format objects
Format specification for this document element object, specified as an array of DOM
format objects. The formats specified by this property override corresponding formats
specified by the StyleName
property of this element. Formats that
do not apply to this document element object are ignored.
Attributes:
NonCopyable | true |
StyleName
— Name of stylesheet-defined style
[]
(default) | character vector | string scalar
Style name, specified as a character vector or string scalar. The style name is the
name of a style specified in the style sheet of the document or document part to which
this element is appended. The specified style defines the appearance of this element in
the output document unless overridden by the formats specified by the
Style
property of this element. To learn more about using style
sheets, see Use Style Sheet Styles.
Note
Microsoft® Word output ignores the style name.
Attributes:
NonCopyable | true |
Data Types: char
| string
Parent
— Parent of mlreportgen.dom.NumPages
object
document element object
Parent of mlreportgen.dom.NumPages
object, specified as a document element
object. A document element must have only one parent.
Attributes:
SetAccess | private |
NonCopyable | true |
Children
— Children of mlreportgen.dom.NumPages
object
array of document element objects
Children of mlreportgen.dom.NumPages
object, specified as an array of document
element objects. This property contains the document element objects appended using the
append
method.
Attributes:
SetAccess | private |
NonCopyable | true |
Tag
— Tag for mlreportgen.dom.NumPages
object
character vector | string scalar
Tag for the mlreportgen.dom.NumPages
object, specified as a character vector or
string scalar. The DOM API generates a session-unique tag as part of the creation of
this object. The generated tag has the form
CLASS:ID
, where
CLASS
is the object class and
ID
is the value of the
Id
property of the object. Specify your own tag value to help
you identify where to look when an issue occurs during document generation.
Attributes:
NonCopyable | true |
Data Types: char
| string
Id
— Object identifier for mlreportgen.dom.NumPages
object
character vector | string scalar
Object identifier for the mlreportgen.dom.NumPages
object, specified as a
character vector or string scalar. The DOM API generates a session-unique identifier
when it creates the document element object. You can specify your own value for
Id
.
Attributes:
NonCopyable | true |
Data Types: char
| string
Methods
Public Methods
Method | Purpose |
---|---|
Copy this object. |
Examples
Insert Total Number of Pages
This example inserts the total number of document pages in a page footer. Use this class to display the current page number along with the total number of pages, such as Page 1 of 3.
import mlreportgen.dom.*; d = Document('mydoc','docx'); open(d); % Create page footer footer = DOCXPageFooter('default'); d.CurrentPageLayout.PageFooters = footer; % Define page number and add to footer. d.CurrentPageLayout.FirstPageNumber = 1; t = Text('Page '); t.WhiteSpace = 'preserve'; t1 = Text(' of '); t1.WhiteSpace = 'preserve'; pageinfo = Paragraph(); pageinfo.HAlign = 'center'; append(pageinfo,t); append(pageinfo,Page()); append(pageinfo,t1); append(pageinfo,NumPages()); append(footer,pageinfo); % Create several pages. p = Paragraph('Hello World'); append(d,p); p = Paragraph('Another page'); p.Style = {PageBreakBefore(true)}; append(d,p); append(d,clone(p)); close(d); rptview(d.OutputPath);
Version History
Introduced in R2016a
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)