TWPFormatOptions Type

Unit
WPRTEDefs

Declaration

TWPFormatOptions = set of (
    // This flags change the display of tables
    wpDisableAutosizeTables, // - we suggest to enable this flag. Otherwise tables importaed form RTF can look wrong
    wpNoMinimumCellPadding, // Do not add a one pixel padding to all cells
    wpfDontBreakTables, // do not break tables at all. Also see wpKeepTogetherAdjacentTables in FormatOptionsEx
    wpfDontBreakTableRows, // do not break table rows
    wpDontClipCells, // do not clip cells if absolute row heights are used
    wpfIgnoreMinimumRowheight, // Do not use the row height property
    wpfIgnoreMaximumRowheight, // Do not use the row maximum height property
    wpTableRowIndicator, // must be combined with EditOptionsEx : AllowCursorInRow
    // -------------------------------------------------------------------------
    // This flags conmtrol the layout
    wpfIgnoreKeep, // The WPAT_ParKeep property is ignored (do not break par)
    wpfIgnoreKeepN, // The WPAT_ParKeepN property is ignored (do not break adjacent par). Also see FormatOptionEx  wpfDontIgnoreKeepNInTable
    wpfKeepOutlineWithNext, // Text which uses the WPAT_ParIsOutline property is kept with the next text
    wpfAvoidWidows, // Avoid single lines on old page
    wpfAvoidOrphans, // Avoid single lines on new page
    wpfCenterOnPageVert, // Center text on all pages
    wpfHangingIndentWithTab, // V5: first tab in paragraph jumps to indent first (this always happens if no tabs are set!)
    // the left indent will be handled as first tabstop not only if the tab is the
    // first character but also if the text before the tab fits into the first indent. (="Word" like)
    wpfDontTabToIndentFirst, // V5: The oposite to wpfHangingIndentWithTab
    wpJustifySoftLinebreaks, // Justify \n
    wpJustifyHardLinebreaks, // Justify \r
    wpUseHyphenation, // Use soft hyphens in the text (inserted with Ctrl + '-')
    wpFooterMinimumDistanceToText, // The footer texts start after the body text (WPTools 4 and <5.14 did it so)
    // -------------------------------------------------------------------------
    // This flags control the display of codes.
    // IMPORTANT: You need to call ReformatAll(true,true) after you have changed this flags:
    wpShowBookmarkCodes, // display bookmark tags
    wpShowHyperlinkCodes, // display hyperlinks tags
    wpShowSPANCodes, // display SPAN tags
    wpShowInvisibleText, // show text which would be otherwise hidden
    // -------------------------------------------------------------------------
    // Experimental flags
    wpfHideEmptyParElements, // reserved: Can be used when editing HTML files with nested DIV elements
    wpfXMLOutlineMode, // Debugging mode: Show paragraph tree similar XML in IE
    wpWriteRightToLeft, // activate RTL writing
    wpAutoWriteRightToLeft, // reserved for future
    // -------------------------------------------------------------------------
    // Troubleshooting flags
    wpUseAbsoluteFontHeight, // Calculate the height of the text using the font size alone
    wpfAlwaysFormatWithScreenRes, // .. even if RM600 is defined in WPCtrMemo
    wpDisableSpeedReformat, // format only the current page and the next page on regular input
    wpDontAdjustFloatingImagePosition // do not adjust image position to keep it on the page
    // note that it is not possible to click on an image which is outside of the page!
    );

Description
Options to change the way the text is formatted. If changed for one RTF-Engine all other RTF-Engines which use the same RTFData object will be affected, too.
You need to call ReformatAll(true,true) to update the text.
Using wpfDontBreakTables you can make sure all tables are, if they are smaller than a page, positioned, not splitted by a soft page break.
wpfCenterOnPageVert centers the text on the page - it does not change the position of header and footer.
wpfAvoidWidows makes sure that a page break does not break a paragraph between the first and the second line. wpfAvoidOrphans works similar but makes sure that the page break does not come before the last line.

Note: The RTL support is only experimental in WPTools 5.


Copyright (C) by WPCUBED GmbH - Munich
http://www.wpcubed.com