Difference between revisions of "Tabulation setFooterText"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
[[Category:Text setting functions]]
+
{{HelpFiles}}  
{{HelpFiles}}
 
  
=====Tabulation_setFooterText=====
+
===== Tabulation_setFooterText =====
  
Set footer text to PDF file
+
Set footer text to PDF file  
  
'''Syntax'''
+
'''Syntax'''  
  
Tabulation_setFooterText(text);
+
Tabulation_setFooterText(text);  
  
'''Arguments'''
+
'''Arguments'''  
  
text: is string. It is the footer user wants to set.
+
text: is string. It is the footer user wants to set.  
  
'''Return value'''
+
'''Return value'''  
  
empty
+
empty  
  
'''Example'''
+
'''Example'''  
  
<nowiki>array groups = {{1, "Read"}, {2, "Write"}};</nowiki>
+
''<nowiki>array groups = {{1, "Read"}, {2, "Write"}};</nowiki> ''
  
number a = createFrequenceDiagram("Single");
+
''number a = createFrequenceDiagram("Single"); ''
  
number reportUniqueId = Tabulation_saveAsReport("test test", 15707010, groups, true);
+
''number reportUniqueId = Tabulation_saveAsReport("test test", 15707010, groups, true); ''
  
Tabulation_setPDFPrintingDirection(Diagram_PdfLayoutDirection_Landscape);
+
''Tabulation_setPDFPrintingDirection(Diagram_PdfLayoutDirection_Landscape); ''
  
Tabulation_setFooterText("Winner");
+
''Tabulation_setFooterText("Winner"); ''
  
Tabulation_setShowResultAsPdf(true);
+
''Tabulation_setShowResultAsPdf(true); ''
  
'''Availability'''
+
''//Result: Footer text of PDF file is "Winner" ''
  
Version 5.7
+
{{note}} ''This function should be paired with function [http://wiki.catglobe.com/index.php/Tabulation_setShowResultAsPdf Tabulation_setShowResultAsPdf]. ''
__NOTOC__
+
 
<!-- imported from file: 7534.htm-->
+
'''Availability'''
 +
 
 +
Version 5.7 __NOTOC__ <!-- imported from file: 7534.htm-->  
 +
 
 +
[[Category:Text_setting_functions]]

Revision as of 10:00, 29 December 2011



Tabulation_setFooterText

Set footer text to PDF file

Syntax

Tabulation_setFooterText(text);

Arguments

text: is string. It is the footer user wants to set.

Return value

empty

Example

array groups = {{1, "Read"}, {2, "Write"}};

number a = createFrequenceDiagram("Single");

number reportUniqueId = Tabulation_saveAsReport("test test", 15707010, groups, true);

Tabulation_setPDFPrintingDirection(Diagram_PdfLayoutDirection_Landscape);

Tabulation_setFooterText("Winner");

Tabulation_setShowResultAsPdf(true);

//Result: Footer text of PDF file is "Winner"

Note Note: This function should be paired with function Tabulation_setShowResultAsPdf.

Availability

Version 5.7