WPTools Manual



Search


(press enter to search)

Class TWPRichText

Hierarchy

System.TObject | System.Classes.TPersistent | System.Classes.TComponent | Vcl.Controls.TControl | Vcl.Controls.TWinControl | Vcl.Controls.TCustomControl | WPRTEDefs.TWPCustomRTFControl | WPCTRMemo.TWPCustomRtfEdit | WPCTRRich.TWPCustomRichText | TWPRichText

Description

The class TWPRichText is usually utilized 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, for printing and to interface with the TWPToolbar and the TWPRuler. The TWPRichText is not designed to be threadsave, for such use the class TWPCustomRtfEdit.   If you need a readonly preview component, you can use the Class TWPPreview. 

>

Properties

Property AcceptFiles : Boolean

Property AcceptFilesOptions : TWPAcceptFilesOptions

Property ActionList : TCustomActionList

Property Align : TAlign

Property AllowMultiView : Boolean

Property Anchors : TAnchors

Property AsWebpage : TWPWebPageFormat

Property AutomaticTextAttr : TCharacterAttr

Property AutoZoom : TWPAutoZoom

Property AutoZoomMin : Integer

Property BevelEdges : TBevelEdges

Property BevelKind : TBevelKind

Property BookmarkTextAttr : TCharacterAttrTags

Property BorderStyle : TBorderStyle

Property ClickableCodes : TWPTextObjTypes

Property ClipboardOptions : TWPClipboardOptions

Property ClipboardOptionsEx : TWPClipboardOptionsEx

Property ColorDesktop : TColor

Property ColorDesktopTo : TColor

Property Constraints : TSizeConstraints

Property Ctl3D : Boolean

Property DefaultIOFormat : string

Property DeskGradientHorizontal : Boolean

Property DragCursor : TCursor

Property DragMode : TDragMode

Property EditBoxModes : TWPEditBoxModes

Property EditOptions : TWPEditOptions

Property EditOptionsEx : TWPEditOptionsEx

Property EditOptionsEx2 : TWPEditOptionsEx2

Property EditOptionsEx3 : TWPEditOptionsEx3

Property Enabled : Boolean

Property FieldObjectTextAttr : TCharacterAttr

Property Font : TWPFont

Property FormatOptions : TWPFormatOptions

Property FormatOptionsEx : TWPFormatOptionsEx

Property FormatOptionsEx2 : TWPFormatOptionsEx2

Property FormatOptionsEx3 : TWPFormatOptionsEx3

Property FormCompletion : Boolean

Property GraphicPopupMenu : TPopupMenu

Property HandleRichEditMsg : Boolean

Property Header : TTextHeader

Property HiddenTextAttr : TCharacterAttr

Property HideTableBorders : TWPHideTableBordersMode

Property HyperLinkCursor : TCursor

Property HyperlinkTextAttr : TCharacterAttrTags

Property InsertPointAttr : TCharacterAttrTags

Property LabelDef : TWPLabelDef

Property LayoutMode : TWPLayoutMode

Property OneClickHyperlink : Boolean

Property PageColumns : Integer

Property PaperColor : TColor

Property ParentColor : Boolean

Property ParentShowHint : Boolean

Property PopupMenu : TPopupMenu

Property PrintParameter : TWPPrintParameter

Property ProtectedProp : TProtectProp

Property ProtectedTextAttr : TCharacterAttr

Property Readonly : Boolean

Property Resizing : Integer

Property RTFText : TWPRTFBlobContents

Property RTFVariables : TWPRTFExtraDataCollection

Property ScrollBars : TScrollStyle

Property SecurityOptions : TWPSecurityModes

Property ShowHint : Boolean

Property ShowMergeFieldNames : Boolean

Property SPANObjectTextAttr : TCharacterAttrTags

Property SpellCheckStrategie : TWPSpellCheckStrategie

Property SpellIgnoredForObj : TWPTextObjTypes

Property TabOrder : TTabOrder

Property TabStop : Boolean

Property TextLoadFormatClipboard : string

Property TextObjectCursor : TCursor

Property TextSaveFormatClipboard : string

Property Transparent : Boolean

Property ViewOptions : TWPViewOptions

Property ViewOptionsEx : TWPViewOptionsEx

Property ViewOptionsEx2 : TWPViewOptionsEx2

Property Visible : Boolean

Property VRuler : TWPVertRuler

Property WantReturns : Boolean

Property WantTabs : Boolean

Property WordWrap : Boolean

Property WPDataSetAdapter : TWPDataSetAbstractAdapter

Property WPDialogCollection : TWPDialogCollection

Property WPGutter : TWPCustomGutter

Property WPRTFPropsComponent : TWPRTFProps

Property WPRuler : TWPRuler

Property WPTextObjectClasses : TWPTextObjectClasses

Property WPToolBar : TWPCustomToolCtrl

Property WriteObjectMode : TWPObjectWriteRTFModeGlobal

Property XBetween : Integer

Property XOffset : Integer

Property YBetween : Integer

Property YOffset : Integer

Property YOffsetNormal : Integer

Property Zooming : Integer

Events

AfterCompleteWordEvent : TWPAfterCompleteWordEvent= TWPAfterCompleteWordEvent

>

AfterCopyToClipboard : TWPAfterCopyToClipboardEvent= TWPAfterCopyToClipboardEvent

>

AfterDelayedUpdate : TWPOnDelayedUpdate= TWPOnDelayedUpdate

>

AfterExecuteAction : TNotifyEvent= procedure (Sender : TObject) of Object

>

AfterImageSaving : TWPAfterImageSaving= TWPAfterImageSaving

>

AfterLoadText : TNotifyEvent= procedure (Sender : TObject) of Object

>

AfterObjectSelection : TNotifyWPTextObjEvent= TNotifyWPTextObjEvent

>

AfterPaintDesktopBackground : TWPOnPaintDesktopBackground= procedure(Sender: TObject; Canvas : TCanvas; R : TRect) of object;

>

AfterPasteImage : TWPOnAfterPasteImage= TWPOnAfterPasteImage

>

BeforeChange : TWPBeforeChangeEvent= TWPBeforeChangeEvent

>

BeforeCopyText : TOnBeforeCopyEvent= TOnBeforeCopyEvent

>

BeforeCutText : TOnBeforeCopyEvent= TOnBeforeCopyEvent

>

BeforeDestroyPaintPage : TWPBeforeDestroyPaintPage= procedure( Sender: TObject; RTF - Engine RTFEngine: TWPRTFEngineEdit; var ExternPageRef: TObject; var WatermarkRef: TObject) of object;

>

BeforeDropText : TWPOnBeforeDropText= TWPOnBeforeDropText

>

BeforeEditBoxNeedFocus : TWPAbortNotifyEvent= TWPAbortNotifyEvent

>

BeforeInitializePar : TWPInitializeParEvent= procedure(Sender: TObject; RTFEngine: TWPRTFEngineBasis; RTFDataBlock: TWPRTFDataBlock; Par: TParagraph) of object;

>

BeforeObjectSelection : TNotifyWPTextObjEventIgnore= TNotifyWPTextObjEventIgnore

>

BeforeOverwriteFile : TWPBeforeOverwriteFile= TWPBeforeOverwriteFile

>

BeforePaintLayer : TWPInternBeforePaintLayerEvent= TWPInternBeforePaintLayerEvent

>

BeforePasteImage : TWPOnBeforePasteImage= TWPOnBeforePasteImage

>

BeforePasteText : TWPOnBeforePaste= TWPOnBeforePaste

>

HyperLinkEvent : THyperLinkEvent= THyperLinkEvent

>

OnActivateHint : TWPActivateHintEvent= TWPActivateHintEvent

>

OnActivatingHotStyle : TWPActivatingHotStyle= procedure(Sender: TObject; par: TParagraph; posinpar: Integer) of object;

>

OnCalcPageNr : TWPOnCalcPageNr= procedure( Sender: TWPRTFEngineEdit; TextObject: TWPTextObj; RTFPageNr, PaintPageNr: Integer; var PrintedPageNr: Integer) of object;

>

OnChange : TNotifyEvent= procedure (Sender : TObject) of Object

>

OnChangeCursorPos : TNotifyEvent= procedure (Sender : TObject) of Object

>

OnChangeLastFileName : TNotifyEvent= procedure (Sender : TObject) of Object

>

OnChangeSelection : TNotifyEvent= procedure (Sender : TObject) of Object

>

OnChangeViewMode : TNotifyEvent= procedure (Sender : TObject) of Object

>

OnChangeZooming : TNotifyEvent= procedure (Sender : TObject) of Object

>

OnCharacterAttrChange : TWPNotifyAttrEvent= TWPNotifyAttrEvent

>

OnCheckProtection : TWPCheckProtectedEvent= TWPCheckProtectedEvent

>

OnClear : TNotifyEvent= procedure (Sender : TObject) of Object

>

OnClick : TWPCustomRtfEditClick= TWPCustomRtfEditClick

>

OnClickCreateHeaderFooter : TWPClickCreateHeaderFooterEvent= TWPClickCreateHeaderFooterEvent

>

OnClickHotText : TWPClickHotTextEvent= TWPClickHotTextEvent

>

OnClickPage : TOnClickPageEvent= TOnClickPageEvent

>

OnClickText : TWPClickTextEvent= TWPClickTextEvent

>

OnCustomLinePaintAfter : TWPVirtPagePaintEvent= TWPVirtPagePaintEvent = procedure(Sender: TObject; RTFEngine: TWPRTFEngineBasis; param: TWPVirtPagePaintParam; EndOfPageRun: Boolean) of object;

>

OnCustomLinePaintBefore : TWPVirtPagePaintEvent= TWPVirtPagePaintEvent = procedure(Sender: TObject; RTFEngine: TWPRTFEngineBasis; param: TWPVirtPagePaintParam; EndOfPageRun: Boolean) of object;

>

OnDblClick : TWPCustomRtfEditClick= TWPCustomRtfEditClick

>

OnDeactivateHotStyle : TWPDeactivateHotStyle= procedure(Sender: TObject) of object;

>

OnDelayedUpdate : TWPOnDelayedUpdate= TWPOnDelayedUpdate

>

OnDragDrop : TDragDropEvent= TDragDropEvent

>

OnDragOver : TDragOverEvent= TDragOverEvent

>

OnDropFile : TWPOnDropFileEvent= TWPOnDropFileEvent

>

OnEditBoxChangeHeight : TWPChangeBoxEvent= TWPChangeBoxEvent

>

OnEditBoxChangeWidth : TWPChangeBoxEvent= TWPChangeBoxEvent

>

OnEditFieldCheckInputString : TWPEditFieldCheckInputStringEvent= procedure( Sender : TObject; field : TWPTextObj; var text : WideString; var abort : Boolean) of Object;

>

OnEditFieldFocus : TWPEditFieldFocusEvent= TWPEditFieldFocusEvent

>

OnEditFieldGetSize : TWPEditFieldGetSize= TWPEditFieldGetSize

>

OnEditStateChanged : TEditStateEvent= TEditStateEvent

>

OnEndDrag : TEndDragEvent= TEndDragEvent

>

OnEnter : TNotifyEvent= procedure (Sender : TObject) of Object

>

OnExit : TNotifyEvent= procedure (Sender : TObject) of Object

>

OnGetAttributeColor : TWPGetAttrColorEvent= procedure( Sender: TObject; var CharStyle: TCharacterAttr; par: TParagraph; posinpar: Integer) of object;

>

OnGetPageGapText : string= string

>

OnGetSpecialText : TWPOnGetSpecialTextEvent= TWPOnGetSpecialTextEvent

>

OnInitializedRTFData : TWPOnInitializeRTFDataObjectEvent= TWPOnInitializeRTFDataObjectEvent

>

OnInitializeRTFDataObject : TWPOnInitializeRTFDataObjectEvent= TWPOnInitializeRTFDataObjectEvent

>

OnInternPaintPar : TWPInternPaintParEvent= TWPInternPaintParEvent

>

OnKeyDown : TKeyEvent= TKeyEvent

>

OnKeyPress : TKeyPressEvent= TKeyPressEvent

>

OnKeyUp : TKeyEvent= TKeyEvent

>

OnLeaveRTFDataBlock : TWPLeaveRTFDataBlockEvent= TWPLeaveRTFDataBlockEvent

>

OnMailMergeGetText : TWPMailMergeGetTextEvent= TWPMailMergeGetTextEvent

>

OnMeasureTextPage : TWPMeasurePageEvent= procedure(Sender: TObject; PageInfo: TWPMeasurePageParam) of object;

>

OnMouseDown : TMouseEvent= TMouseEvent

>

OnMouseDownWord : TWPMouseDownRightEvent= TWPMouseDownRightEvent

>

OnMouseMove : TMouseMoveEvent= TMouseMoveEvent

>

OnMouseUp : TMouseEvent= TMouseEvent

>

OnNewRTFDataBlock : TWPNewRTFDataBlockEvent= TWPNewRTFDataBlockEvent

>

OnOpenDialog : TWPCustomRtfEditDialogEvent= TWPCustomRtfEditDialogEvent

>

OnPaint : TNotifyEvent= procedure (Sender : TObject) of Object

>

OnPaintDesktopBackground : TWPOnPaintDesktopBackground= procedure(Sender: TObject; Canvas : TCanvas; R : TRect) of object;

>

OnPaintExternPage : TWPOnPaintExternPageEvent= procedure( Sender: TObject; RTFEngine: TWPRTFEnginePaint; prCanvas: TCanvas; xoff, yoff: Integer; r: TRect; PaintPageNr: Integer; ExternPageRef: TObject; DestXRes, DestYRes: Integer) of object;

>

OnPaintPageHint : TWPPaintPageHintEvent= TWPPaintPageHintEvent

>

OnPaintTextFrameRect : TWPPaintTextFrameRect= procedure( Sender : TObject; Engine: TWPRTFEnginePaint; Canvas: TCanvas; PageNr : Integer; FrameNr : Integer; Page : TWPVirtPage; x1,y1,x2,y2 : Integer; Options : Pointer; var Done : Boolean ) of Object;

>

OnPaintWatermark : TWPOnPaintWatermarkEvent= procedure( Sender: TObject; RTFEngine: TWPRTFEnginePaint; toCanvas: TCanvas; PageRect: TRect; PaintPageNr: Integer; RTFPageNr: Integer; WaterMarkRef: TObject; XRes, YRes: Integer; CurrentZoom: Single; PaintMode: TWPPaintModes) of object;

>

OnPrepareImageforSaving : TWPPrepareImageforSavingEvent= TWPPrepareImageforSavingEvent

>

OnPrepareParForPaint : TWPInitializeParEvent= procedure(Sender: TObject; RTFEngine: TWPRTFEngineBasis; RTFDataBlock: TWPRTFDataBlock; Par: TParagraph) of object;

>

OnPrintPage : Boolean= Boolean

>

OnQueryDrag : TWPQueryDragEvent= TWPQueryDragEvent

>

OnRequestHTTPImage : TWPRequestHTTPImageEvent= TWPRequestHTTPImageEvent

>

OnRequestHTTPString : TWPRequestHTTPStringEvent= TWPRequestHTTPStringEvent

>

OnRequestStyle : TWPOnRequestStyleEvent= TWPOnRequestStyleEvent

>

OnResize : TNotifyEvent= procedure (Sender : TObject) of Object

>

OnSearchReplaceMessage : TWPSearchReplaceMessageEvent= TWPSearchReplaceMessageEvent

>

OnSetupPrinterEvent : TWPSetupPrinterEvent= TWPSetupPrinterEvent

>

OnStartDrag : TStartDragEvent= TStartDragEvent

>

OnTestForLinkEvent : TWPTestForLinkEvent= TWPTestForLinkEvent

>

OnTextObjectClick : TTextObjectClickEvent= TTextObjectClickEvent

>

OnTextObjectDblClick : TTextObjectClickEvent= TTextObjectClickEvent

>

OnTextObjectMouseDown : TTextObjectMouseEvent= TTextObjectMouseEvent

>

OnTextObjectMouseMove : TTextObjectMouseEvent= TTextObjectMouseEvent

>

OnTextObjectMouseUp : TTextObjectMouseEvent= TTextObjectMouseEvent

>

OnTextObjectMove : TTextObjectResizeEvent= TTextObjectResizeEvent

>

OnTextObjectMovePosition : TTextObjectResizeEvent= TTextObjectResizeEvent

>

OnTextObjectPaint : TWPTextObjectPaintEvent= procedure( Sender: TObject; pobj: TWPTextObj; toCanvas: TCanvas; XRes, YRes: Integer; X, Y, W, H, BASE: Integer; PageRef: TWPVirtPage; Modes: TWPTextObjectPaintModes; const CanvasExtraAttr: TWPPaintExtraParams; var ContinueMode: TWPTextObjectPaintResult) of object;

>

OnTextObjGetTextEx : TWPOnTextObjGetTextEvent= procedure( RefCanvas: TCanvas; TXTObject: TWPTextObj; var PrintString: WideString; var WidthInPix: Integer; var HeightInPix: Integer; var PaintObject: TWPTextObj; Xres, YRes: Integer) of object;

>

OnUndoStateChanged : TNotifyEvent= procedure (Sender : TObject) of Object

>

OnUpdateExternScrollbar : TWPUpdateExternScrollbar= TWPUpdateExternScrollbar

>

OnWorkOnTextChanged : TNotifyEvent= procedure (Sender : TObject) of Object

>

Used or referenced by

-Procedure WPCreateTableForm(Form:TWinControl; Sender:TControl; editor:TWPCustomRichText; AllowNestedTables:Boolean)
-Function TWPSuperMerge.GetEditor : TWPCustomRTFControl
-Procedure TWPCustomAttrDlg.ChangeApplied(aEditBox:TWPCustomRtfEdit)
-Procedure WPCreateTableForm(Form:TWinControl; Sender:TControl; editor:TWPCustomRichText; AllowNestedTables:Boolean)