TWPRichText Component
Properties Events

Unit
WPCTRRich

Declaration
TWPRichText = class(TWPCustomRichText)

Hierarchy
TWPCustomRTFControl <--TWPCustomRtfEdit <--TWPCustomRichText <--TWPRichText

Subclasses
None

Description
WPTools is a word processing component for Borland Delphi and C++Builder.
It loads and saves RTF files. Its RTF implementation is one of the most complete on the component market (header/footer, paragraph styles, optional footnote support, table header rows).
It also loads and saves HTML files with different options. You can set this options in the "formatstrings", thats an additional parameter passed to SaveToFile or AsANSIString.
The WPTools "premium" edition also does columns, text boxes and footnotes. It also includes a special XML reader and writer unit.
But WPTools does not only serve to edit text, it is a powerful toolset for mass mailing and, optional, RTF reports.


The class TWPRichText is usually used as an editor. It inherits most of its functionality from the class TWPCustomRtfEdit but also adds useful functions.
Much of the introduced methods have been created to either support the graphic user interface or to make it easier to upgrade projects which used to work with a previous version of WPTools.
Note
If you only need an invisible 'working horse' to process the formatted text, especially within a multi threaded environment, we recommend to create an instance of the TWPCustomRtfEdit class in code (using 'CreateDynamic') and avoid the linking of the unit WPCtrRich. This can help to reduce the application file size.


Introduced Properties
AcceptFiles 
AcceptFilesOptions 
ActionList 
AfterImageSaving 
AllowMultiView 
AsWebpage 
AutomaticTextAttr 
AutoZoom 
BeforeInitializePar 
BookmarkTextAttr 
BorderStyle 
ClickableCodes 
ClipboardOptions 
ColorDesktop 
ColorDesktopTo 
DefaultIOFormat 
DeskGradientHorizontal 
EditBoxModes 
EditOptions 
EditOptionsEx 
FieldObjectTextAttr 
Font 
FormatOptions 
FormatOptionsEx 
FormatOptionsEx2 
FormCompletion 
GraphicPopupMenu 
HandleRichEditMsg 
Header 
HiddenTextAttr 
HideTableBorders 
HyperLinkCursor 
HyperLinkEvent 
HyperlinkTextAttr 
InsertPointAttr 
 LabelDef 
LayoutMode The central property to change the way the engine displays the pages.
OnCheckProtection 
OnCustomLinePaintAfter 
OnCustomLinePaintBefore 
OneClickHyperlink 
OnEditFieldFocus 
OnEditFieldGetSize 
OnGetSpecialText 
OnMeasureTextPage 
OnPrepareImageforSaving 
OnPrepareParForPaint 
OnRequestHTTPImage 
OnRequestHTTPString 
OnRequestStyle 
PageColumns 
PaperColor 
PrintParameter 
ProtectedProp 
ProtectedTextAttr 
Readonly 
Resizing 
RTFText 
RTFVariables 
ScrollBars 
SecurityOptions 
ShowMergeFieldNames 
SPANObjectTextAttr 
SpellCheckStrategie 
SpellIgnoredForObj 
TextLoadFormatClipboard 
TextObjectCursor 
TextSaveFormatClipboard 
Transparent 
ViewOptions 
ViewOptionsEx 
VRuler 
WantReturns 
WantTabs 
WordWrap 
WPDataSetAdapter 
WPDialogCollection 
WPGutter 
WPRTFPropsComponent 
WPRuler 
WPTextObjectClasses 
WPToolBar 
WriteObjectMode 
XBetween 
XOffset 
YBetween 
YOffset 
YOffsetNormal 
Zooming 

Introduced Events
AfterCompleteWordEvent 
AfterCopyToClipboard 
AfterDelayedUpdate 
AfterExecuteAction 
AfterLoadText 
AfterObjectSelection 
BeforeChange 
BeforeCopyText 
BeforeCutText 
BeforeDestroyPaintPage 
BeforeDropText 
BeforeEditBoxNeedFocus 
BeforeObjectSelection 
BeforeOverwriteFile 
BeforePaintLayer 
BeforePasteImage 
BeforePasteText 
OnActivateHint 
OnActivatingHotStyle 
OnCalcPageNr 
OnChange 
OnChangeCursorPos 
OnChangeLastFileName 
OnChangeSelection 
OnChangeViewMode 
OnChangeZooming 
OnCharacterAttrChange 
OnClear 
OnClick 
OnClickCreateHeaderFooter 
OnClickHotText 
OnClickPage 
OnClickText 
OnDblClick 
OnDeactivateHotStyle 
OnDelayedUpdate 
OnDropFile 
OnEditBoxChangeHeight 
OnEditBoxChangeWidth 
OnEditFieldCheckInputString 
OnEditStateChanged 
OnGetAttributeColor 
OnGetPageGapText 
OnInitializedRTFData This event can be used to assign the same TWPRTFProps object to different editors.
OnInitializeRTFDataObject 
OnInternPaintPar 
OnLeaveRTFDataBlock 
OnMailMergeGetText This event is triggered when the MergeText or MergeEnumFields procedure is used.
You can use the provided parameter inspname to select the required result string for the property Contents.StringValue.

Contents.StringValue := Table1.FieldByName(inspname).AsString;
OnMouseDownWord 
OnNewRTFDataBlock 
OnOpenDialog 
OnPaintDesktopBackground 
OnPaintExternPage 
OnPaintPageHint 
OnPaintTextFrameRect 
OnPaintWatermark 
OnPrintPage 
OnQueryDrag 
OnResize 
OnSearchReplaceMessage 
OnSetupPrinterEvent 
OnTestForLinkEvent 
OnTextObjectClick 
OnTextObjectDblClick 
OnTextObjectMouseDown 
OnTextObjectMouseMove 
OnTextObjectMouseUp 
OnTextObjectMove 
OnTextObjectMovePosition 
OnTextObjectPaint Error in DocComment
OnTextObjGetTextEx 
OnUndoStateChanged 
OnUpdateExternScrollbar 
OnWorkOnTextChanged 


HTML generated by Time2HELP
http://www.time2help.com