JCL Help:TJclTabSet.OptimalFillInfo

From Project JEDI Wiki
Jump to navigationJump to search


Summary

Determines the optimal number of tab and space characters needed to fill the room between two columns.


Pascal

 public procedure OptimalFillInfo(StartColumn: SizeInt; TargetColumn: SizeInt; out TabsNeeded: SizeInt; out SpacesNeeded: SizeInt);


Parameters

Parameters Description
TargetColumn: SizeInt The required column to end at.
out TabsNeeded: SizeInt Will hold the amount of tab characters needed to get to the destination column.
out SpacesNeeded: SizeInt Will hold the amount of space characters needed to get to the destination column.


Exceptions

ArgumentOutOfRangeException The StartColumn parameter is less than 0 (zero-based) or 1 (not zero-based).
 - or -

The TargetColumn parameter is less than the StartColumn parameter.


Description

OptimalFillInfo will determine the ideal amount of tab characters and/or space characters required to get from the first provided column to the second.


Examples

Note:This example assumes a tab set instance set up as in the example given in the TJclTabSet help.
tabs.OptimalFillInfo(5, 21, TabsNeeded, SpacesNeeded);
// TabsNeeded will be 2 (taking us only to column 20), SpacesNeeded will be 1.


See Also

TJclTabSet TJclTabSet.Optimize@string


About

Donator

Marcel Bestebroer


Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page