Difference between revisions of "SetTotal"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
[[Category:Include total functions]]
+
{{HelpFiles}}  
{{HelpFiles}}
 
  
=====setTotal=====
+
===== setTotal =====
  
Enables or disables the total row which can be shown for table diagrams.
+
Enables or disables the total row which can be shown for table diagrams.  
  
'''Syntax'''
+
'''Syntax'''  
  
setTotal(''enabled'')
+
setTotal(''enabled'')  
  
'''Arguments'''
+
'''Arguments'''  
  
''enabled:'' Is a boolean expression. If true the row will be included, if false the row will not be included
+
''enabled:'' Is a boolean expression. If true the row will be included, if false the row will not be included  
  
'''Return type'''
+
'''Return type'''  
  
empty
+
empty  
  
'''Examples'''
+
'''Examples'''  
  
''setTotal(true);''
+
''setTotal(false);''
  
'''Availability'''
+
''bool b = getTotal();''
  
Version 5.4
+
''if (b) print("Total row is enabled and can be shown for table diagrams.");''
__NOTOC__
+
 
<!-- imported from file: 4208.htm-->
+
''else print("Total row is disabled and cannot be shown for table diagrams.");''
 +
 
 +
''//Result: Total row is disabled and cannot be shown for table diagrams. ''
 +
 
 +
'''Availability'''
 +
 
 +
Version 5.4 __NOTOC__ <!-- imported from file: 4208.htm-->  
 +
 
 +
[[Category:Include_total_functions]]

Revision as of 12:53, 26 December 2011



setTotal

Enables or disables the total row which can be shown for table diagrams.

Syntax

setTotal(enabled)

Arguments

enabled: Is a boolean expression. If true the row will be included, if false the row will not be included

Return type

empty

Examples

setTotal(false);

bool b = getTotal();

if (b) print("Total row is enabled and can be shown for table diagrams.");

else print("Total row is disabled and cannot be shown for table diagrams.");

//Result: Total row is disabled and cannot be shown for table diagrams.

Availability

Version 5.4