Difference between revisions of "Tabulation setPdfMargin"
| Line 1: | Line 1: | ||
{{Function_Template|Name=Tabulation_setPdfMargin|ReturnType=Empty | {{Function_Template|Name=Tabulation_setPdfMargin|ReturnType=Empty | ||
|Parameters= | |Parameters= | ||
| − | |Name= | + | |Name=SetMarginType|ConstantType=Number|EnumType=PDFMARGIN, |
| − | |Name= | + | |Name=SetMarginPoints|ConstantType=Number|IsInteger=1 |
}} | }} | ||
| + | {{HelpFiles}} | ||
| + | |||
| + | ==== Tabulation_setPdfMargin ==== | ||
| + | |||
| + | Sets a given margin in the Pdf report | ||
| + | |||
| + | '''Syntax''' | ||
| + | |||
| + | Tabulation_setPdfMargin(''marginType'',''margin'') | ||
| + | |||
| + | '''Arguments''' | ||
| + | |||
| + | *''marginType'': A enumeration for the margin to be set. Choose between the following: | ||
| + | |||
| + | Diagram_PdfHeader_Margin_Top | ||
| + | |||
| + | Diagram_PdfHeader_Margin_Bottom | ||
| + | |||
| + | Diagram_PdfFooter_Margin_Top | ||
| + | |||
| + | Diagram_PdfFooter_Margin_Bottom | ||
| + | |||
| + | *''margin'': The value the margin should have. Valid value: 0-100 | ||
| + | |||
=== <span style="color:#DF8621">'''Examples'''</span> === | === <span style="color:#DF8621">'''Examples'''</span> === | ||
| Line 15: | Line 39: | ||
Tabulation_setPdfMargin(Diagram_PdfFooter_Margin_Bottom, 100); | Tabulation_setPdfMargin(Diagram_PdfFooter_Margin_Bottom, 100); | ||
</source> | </source> | ||
| + | |||
| + | [[category:Diagram/report generating CGScript functions]] | ||
| + | |||
| + | |||
| + | {{note}} ''This function should be paired with function [http://wiki.catglobe.com/index.php/Tabulation_setShowResultAsPdf Tabulation_setShowResultAsPdf].'' | ||
| + | |||
| + | '''Availability''' | ||
| + | |||
| + | Version 6.0 | ||
Latest revision as of 11:07, 24 June 2016
SetMarginPoints
Please write a description and submit to code to autogen it next time
Syntax
SetMarginPoints(array emails);
Arguments
emails: array. Array of emails.
There are 2 ways of using array emails:
The first way: Each email is an EmailBlacklist object
The second way: Each email is an array with pair of email and comment {email, comment}
Return type
Number. Number of emails added to Blacklist
Tabulation_setPdfMargin
Sets a given margin in the Pdf report
Syntax
Tabulation_setPdfMargin(marginType,margin)
Arguments
- marginType: A enumeration for the margin to be set. Choose between the following:
Diagram_PdfHeader_Margin_Top
Diagram_PdfHeader_Margin_Bottom
Diagram_PdfFooter_Margin_Top
Diagram_PdfFooter_Margin_Bottom
- margin: The value the margin should have. Valid value: 0-100
Examples
//Set the margins on the header or footer:
//Tabulation_SetPDFMargin(marginType, margin)
// Diagram_PdfHeader_Margin_Top / Diagram_PdfHeader_Margin_Bottom
// Diagram_PdfFooter_Margin_Top / Diagram_PdfFooter_Margin_Bottom
//Needs a DCS
Tabulation_setPdfMargin(Diagram_PdfHeader_Margin_Top , 100);
Tabulation_setPdfMargin(Diagram_PdfFooter_Margin_Bottom, 100);
Note: This function should be paired with function Tabulation_setShowResultAsPdf.
Availability
Version 6.0
