Oleander Types

TOleanderFieldTypes
Declaration
TOleanderFieldTypes = set of TFieldType;
Description

Set of the Delphi TFieldtype to hold the supported and unsupported fields in Oleander.

 

TOleanderFormatStringEvent
Declaration
TOleanderFormatStringEvent = procedure(sender: TObject; 
var source: string; 
identifier: TOleanderIdentifier) of object;
Description

The TOleanderFormatStringEvent type defines the method that is called in the string formating events. It is used in the AfterFormatString and the BeforeFormatString event.

Source is the string that should be formated. Identifier is the corresponding identifier that defines the Datatype and Mask.

 

TOleanderGotoPosition
Declaration
TOleanderGotoPosition = (ogpStart, ogpEnd);
Description

TOleanderWorkdoc type defines the possible values for the APos parameter of the GotoIdentifier method of the OleanderPrinter object.

ogpStart: Go to the start of the identifier range

ogpEnd: Go to the end of the identifier range

 

TOleanderIdentifierCheckEvent
Declaration
TOleanderIdentifierCheckEvent = procedure(Sender: TObject; 
const Identifier: TOleanderIdentifier; var Ok: boolean) of object;
Description

The TOleanderIdentifierCheckEvent type defines the method that is called during the check of the identifiers found in the document. It is used in the OnIdentifierCheck event.

Identifier is the identifier currently checked and unknown to the controller.

Ok is initially False and should be set to True, if the application could handle the identifier during print.

 

TOleanderIdentifierType
Declaration
TOleanderIdentifierType = (oitHeaderFooter, oitBody);
Description

TOleanderIdentifierType type defines the possible values for the IdentifierType property of the TOleanderIdentifier object.

oitHeaderFooter: The identifier is positioned in either the header or the footer of the document and will be processed only once during the start.

oitBody: The identifier is positioned in the body of the document and will be processed for every record of the group it is in.

 

TOleanderIdentifierValueEvent
Declaration
TOleanderIdentifierValueEvent = procedure(Sender: TObject; 
const Identifier: TOleanderIdentifier; var S: string) of object;
Description

The TOleanderIdentifierValueEvent type defines the method that is called when an identifier unknwon to Oleander has to be printed. It is used in the OnIdentifierValue event.

Identifier is the identifier that should be printed and is unknown to the controller.

S should receive the value that identifier stands for. Initially it is empty.

 

TOleanderInsertTextEvent
Declaration
TOleanderInsertTextEvent = procedure(sender: TObject; 
var source: string) of object;
Description

The TOleanderInsertTextEvent type defines the method that is called when Oleander inserts text into the OLE server application. It is used in the BeforeInsertText and the AfterInserttext event.

Source is the string that is to be inserted in the OLE server at the current position.

 

TOleanderPrintEvent
Declaration
TOleanderPrintEvent = procedure(Sender: TObject; 
Identifier: TOleanderIdentifier; Datasource: TDatasource) of object;
Description

The TOleanderPrintEvent type defines the method that is called when Oleander prints groups, records or fields. It is used in the BeforePrintGroup, BeforePrintRecord, BeforePrintField, AfterPrintGroup, AfterPrintRecord and AfterPrintField events.

Identifier is the identifier currently printed. It can be a field or a group.

Datasource is the datasource currently in use by Oleander.

 

TOleanderViewmode
Declaration

TOleanderViewmode = (ovmOutline, ovmNormal);

Description

The TOleanderViewmode type defines the possible values for the AViewmode parameter of the SetViewmode method.

ovmOutline: Switch the document to a "non formated" viewmode.

ovmNormal: Switch the document to a "formated" viewmode.

 

TOleanderWordbasicDialect
Declaration
TOleanderWordbasicDialect = (wbdGerman, wbdEnglish);
Description

The TOleanderWordbasicDialect type defines the possible values for the WordbasicDialect property of the TOleanderWord7 object.

wbdGerman: The installed WinWord7 is the german version.

wbdEnglish: The installed WinWord7 is the english version.

 

TOleanderWorkdoc
Declaration
TOleanderWorkdoc = (owdRunning, owdOriginal, owdTemp);
Description

TOleanderWorkdoc type defines the possible values for the ADoc parameter of the SelectDoc method of the OleanderPrinter object.

owdRunning: The current document found in a running OLE server

owdOriginal: The original document containing the print layout and identifiers

owdTemp: The result document created by Oleander