Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
cfl_function_-_calculatelayoutonsheet [2019/02/06 10:25]
kcifreo
cfl_function_-_calculatelayoutonsheet [2019/07/15 19:32] (current)
admin
Line 1: Line 1:
-The **CalculateLayoutOnSheet** function is used determine how to layout prints, signs, or other dimensional items on a Sheet (of defined width and length). This is commonly used to determine the number of sheets that will actually be required to produce the item.+The **CalculateLayoutOnSheet** function is used to determine how to layout prints, signs, or other dimensional items on a Sheet (of defined width and length). This is commonly used to determine the number of sheets that will actually be required to produce the item.
  
 While it is possible to calculate these manually, doing so was complex. The need for this calculation occurred often enough to warrant this specialized function. While it is possible to calculate these manually, doing so was complex. The need for this calculation occurred often enough to warrant this specialized function.
  
 See Also [[:​cfl_function_-_calculatelayoutonroll|]] and [[:​how-to_use_the_calculatelayoutonsheet_function_for_layout_calculations|]]. See Also [[:​cfl_function_-_calculatelayoutonroll|]] and [[:​how-to_use_the_calculatelayoutonsheet_function_for_layout_calculations|]].
 +\\ \\
  
 ==== Function Usage ==== ==== Function Usage ====
Line 12: Line 13:
 These are complex functions that perform many calculations and can return many different values from the calculation. If the calculation perform without any errors, the function returns True. If there are any errors (such as division by zero), the function returns False and the error message is returned as one of the variable properties. These are complex functions that perform many calculations and can return many different values from the calculation. If the calculation perform without any errors, the function returns True. If there are any errors (such as division by zero), the function returns False and the error message is returned as one of the variable properties.
  
-\\ +\\ \\ 
-**Function Parameters ​**+==== Function Parameters ​====
  
 Many of the parameters have default values and are not required, but a comma is still required to keep the parameter position intact if any parameters later in the list are passed. The list of passed values follows: Many of the parameters have default values and are not required, but a comma is still required to keep the parameter position intact if any parameters later in the list are passed. The list of passed values follows:
Line 42: Line 43:
 The values calculated by the layout function will be written into the "​property bag" for the variable specified as the first function parameter. These values can then be accessed by name using the GetVariablePropertyValue() or GetVariablePropertyText() function. The values calculated by the layout function will be written into the "​property bag" for the variable specified as the first function parameter. These values can then be accessed by name using the GetVariablePropertyValue() or GetVariablePropertyText() function.
  
-\\ +\\ \\ 
-**Variable Properties Set**+==== Variable Properties Set =====
  
 \\ \\
Line 65: Line 66:
 |ErrorMessage||If an error occurs during the calculation,​ the formula will sets the specified VariableProperty reference to False and the error message will be returned here. When there is no error in the calculation,​ this will set the specified VariableProperty reference to an empty (blank) string.|| |ErrorMessage||If an error occurs during the calculation,​ the formula will sets the specified VariableProperty reference to False and the error message will be returned here. When there is no error in the calculation,​ this will set the specified VariableProperty reference to an empty (blank) string.||
  
-\\+