TRichView.DocObjects

A collection of objects that can be stored in RVF files or streams.

type // defined in RVDocParams unit
TRVDocObjectCollection = class (TOwnedCollection);
TRVDocObject = class (TCollectionItem);
property DocObjects: TRVDocObjectCollection;

(introduced in version 17)

TRVDocObjectCollection is a collection of items inherited from TRVDocObject. Items of this collection may have different type.

All published properties of items can be saved and loaded.

If rvfoSaveDocObjects is in RVFOptions, these objects are saved in RVF.

If rvfoLoadDocObjects is in RVFOptions, methods for loading RVF load these objects. Methods for inserting RVF ignore these objects.

Method TRichView.Clear clears DocObjects.

There is one more property allowing to save custom data in RVF: DocProperties.

Document objects implemented by TRichView and ReportWorkshop

▪TRVMathDocObject defines default properties for items displaying mathematical expressions.

▪TRVSVGPathsDocObject contains a collection of named SVG paths for use in ReportWorkshop.

▪TRVReportDocObject (implemented in ReportWorkshop) has properties controlling report generation for a document.

Example

Define your own classes:

type
TMyDocObjectA = class (TRVDocObject)
...

published

property A: String ...

end;

TMyDocObjectB = class (TRVDocObject)
...

published

property B: Integer ...

end;

Adding:

var
  ObjA: TMyDocObjectA;
  ObjB: TMyDocObjectB;
...
  ObjA := TMyDocObjectA.Create(MyRichView.DocObjects);
  ObjA.A := 'Hello';
  ObjB := TMyDocObjectB.Create(MyRichView.DocObjects);
  ObjB.B := 1;