PageInfo
Inheritance: java.lang.Object
public class PageInfo
Represents page setup data which is present in MPP file format and used for printing.
Constructors
Constructor | Description |
---|---|
PageInfo() | Initializes a new instance of the PageInfo class. |
Methods
Method | Description |
---|---|
getFooter() | Gets an instance of the HeaderFooterInfo class which represents a footer data. |
getHeader() | Gets the instance of the HeaderFooterInfo class which represents a header data. |
getLegend() | Gets an instance of the PageLegend class which specifies rendering options of page legend. |
getMargins() | Gets an instance of the PageMargins class which specifies page margins. |
getName() | Gets the name of the view for which set-up data is used. |
getPageSettings() | Gets an instance of the PageSettings (getPageSettings()) class which specifies page printing settings. |
getPageViewSettings() | Gets an instance of the PageViewSettings (getPageViewSettings()) class which specifies page view printing settings. |
setFooter(HeaderFooterInfo value) | Sets an instance of the HeaderFooterInfo class which represents a footer data. |
setHeader(HeaderFooterInfo value) | Sets the instance of the HeaderFooterInfo class which represents a header data. |
setLegend(PageLegend value) | Sets an instance of the PageLegend class which specifies rendering options of page legend. |
PageInfo()
public PageInfo()
Initializes a new instance of the PageInfo class. Represents page setup data which is present in MPP file format and used for printing.
getFooter()
public final HeaderFooterInfo getFooter()
Gets an instance of the HeaderFooterInfo class which represents a footer data.
Returns: HeaderFooterInfo - an instance of the HeaderFooterInfo class which represents a footer data.
getHeader()
public final HeaderFooterInfo getHeader()
Gets the instance of the HeaderFooterInfo class which represents a header data.
Returns: HeaderFooterInfo - the instance of the HeaderFooterInfo class which represents a header data.
getLegend()
public final PageLegend getLegend()
Gets an instance of the PageLegend class which specifies rendering options of page legend.
Currently is applicable only to Gantt Chart views.
Returns: PageLegend - an instance of the PageLegend class which specifies rendering options of page legend.
getMargins()
public final PageMargins getMargins()
Gets an instance of the PageMargins class which specifies page margins.
Returns: PageMargins - an instance of the PageMargins class which specifies page margins.
getName()
public final String getName()
Gets the name of the view for which set-up data is used.
Returns: java.lang.String - the name of the view for which set-up data is used.
getPageSettings()
public final PageSettings getPageSettings()
Gets an instance of the PageSettings
(getPageSettings()) class which specifies page printing settings.
Returns:
PageSettings - an instance of the PageSettings
(getPageSettings()) class which specifies page printing settings.
getPageViewSettings()
public final PageViewSettings getPageViewSettings()
Gets an instance of the PageViewSettings
(getPageViewSettings()) class which specifies page view printing settings.
Returns:
PageViewSettings - an instance of the PageViewSettings
(getPageViewSettings()) class which specifies page view printing settings.
setFooter(HeaderFooterInfo value)
public final void setFooter(HeaderFooterInfo value)
Sets an instance of the HeaderFooterInfo class which represents a footer data.
Parameters:
Parameter | Type | Description |
---|---|---|
value | HeaderFooterInfo | an instance of the HeaderFooterInfo class which represents a footer data. |
setHeader(HeaderFooterInfo value)
public final void setHeader(HeaderFooterInfo value)
Sets the instance of the HeaderFooterInfo class which represents a header data.
Parameters:
Parameter | Type | Description |
---|---|---|
value | HeaderFooterInfo | the instance of the HeaderFooterInfo class which represents a header data. |
setLegend(PageLegend value)
public final void setLegend(PageLegend value)
Sets an instance of the PageLegend class which specifies rendering options of page legend.
Currently is applicable only to Gantt Chart views.
Parameters:
Parameter | Type | Description |
---|---|---|
value | PageLegend | an instance of the PageLegend class which specifies rendering options of page legend. |