JCL Help:TJclTabSet.Optimize@string@SizeInt

From Project JEDI Wiki
Jump to navigationJump to search


Summary

Expands tabs to spaces in the provided string.


Pascal

 public function Optimize(const S: string; Column: SizeInt): string; overload;


Parameters

Parameters Description
const S: string The string to expand tabs in.
Column: SizeInt The starting column to use when expanding the tabs.


Return Value

Any tab and/or space character sequences in S will have been reduced to their shortest form; no other item in the string is modified.


Description

Optimize reduces tab and space character sequences in the provided string into an optimized (shortest) sequences of tab and space characters while preserving the formatting. Optimize will assume the string starts at the provided column.
Multi-line strings, ie. strings containing one or more newline sequences (eg. CrLf, but also single Cr of Lf characters are treated as newlines), are handled properly, with all but the first line starting at column 0 (zero-based set to True) or 1 (zero-based set to False).
The reverse operation (expand sequences of tab characters into spaces) can be achieved by the Expand method.


See Also

TJclTabSet TJclTabSet.OptimalFillInfo TJclTabSet.Optimize@string


About

Donator

Marcel Bestebroer


Notes

This method is nil-safe; when invoked on a nil-reference, this method will assume a tab width of two on a zero-based tab set.


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