PrintGantt
HTTP Request Format
POST api/PrintGantt
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/PrintGantt
Description
The PrintGantt REST API command sends the Gantt View to the printer and allows you to modify the Gantt View printing options. One or more of the optional attributes may be included in the command, but none are required.
Parameters
All parameters are optional
| {AttributeName} | <Parameters> | Parameters Values |
|---|---|---|
| BottomMargin | "BottomMargin" : "50" | Bottom margin in inches. Must be a value between 0-100 |
| LeftMargin | "LeftMargin" : "50" | Left margin in inches. Must be a value between 0-100 |
| RightMargin | "RightMargin" : "50" | Right margin in inches. Must be a value between 0-100 |
| TopMargin | "TopMargin" : "50" | Top margin in inches. Must be a value between 0-100 |
| ColorMode | "ColorMode" : "vcGrayShade" | Color mode of print. Options are "vcBlackAndWhite" or "vcColor" or "vcGrayShade" |
| Fit | "Fit" : "TRUE" | Boolean to determine if image will be made to fit on one page |
| MaxHPageCount | "MaxHPageCount" : "5" | Integer greater than 0 defining the maximum page count |
| MaxVPageCount | "MaxVPageCount" : "5" | Integer greater than 0 defining the maximum page count |
| Orientation | "Orientation" : "vcPortrait" | Orientation of the print. Options are "vcLandscape" or "vcPortrait" |
| PaperSize | "PaperSize" : "vcUS_LETTER" | Paper size for print. Options are "vcUS_LETTER", "vcUS_LEGAL", "vcDIN_A3", "VCDIN_A4", "vcISO_C", "vcISO_D", "vcISO_E", "vcDIN_A2". |
| ZoomFactor | "ZoomFactor" : "50" | Zoom factor for print. Must be a value between 0-100 |
Examples
Prints the Gantt View in a landscape orientation in grayscale color mode and US Letter size
POST api/PrintGantt
Body:
{
"ColorMode" : "vcGrayShade",
"Orientation" : "vcLandscape",
"PaperSize" : "vcUS_LETTER"
}
Return Message
If activated, a standard response for a successful HTTP response shall appear.
Group Membership
This command belongs to the following group(s):
Version
12.3
