eDocEngine VCL Professional Help » Symbol Reference » Namespaces of Helper Classes » gtCstDocEng Namespace » TgtCustomDocumentEngine Class

Gnostice eDocEngine VCL Developer Guide
TgtCustomDocumentEngine Class

This is a base class for eDocEngine components.

Pascal
public TgtCustomDocumentEngine = class(TgtBaseComponent, IgtDocumentEngine);
C++
public: class TgtCustomDocumentEngine : public TgtBaseComponent, public IgtDocumentEngine;

gtCstDocEng

Properties
 
Name 
Description 
 
Indicates information about the component. 
 
Indicates version number of the component. 
IgtDocumentSettings Interface
 
Name 
Description 
 
Specifies background color of the document. 
 
Specifies background image of the document. 
 
Specifies position of background image. 
 
Specifies brush used to fill various page elements in the document. 
 
Specifies default font used for rendering text in the document. 
 
Specifies generic document information properties for all engines. 
 
Specifies text identifying the output format. 
 
Specifies file extension for the output document. 
 
Specifies filename of the document. 
 
Font 
Specifies default font used for text elements in the document. 
 
Specifies border settings for images and text boxes in the document. 
 
Specifies image settings for the document. 
 
Page 
Specifies page settings. 
 
Specifies settings for page borders. 
 
Pen 
Specifies pen used to stroke page elements in the document. 
 
Specifies document creation settings of the engine. 
 
Specifies settings for tables. 
 
Specifies text formatting settings. 
TgtCustomDocumentEngine Class
 
Name 
Description 
 
Specifies whether the engine should continue rendering the document. 
 
Specifies whether the engine should automatically generate new pages to accommodate text that overflows the current page. 
 
Provides access to the TMetafileCanvas object of the engine. 
 
Indicates number of the current page in the document. 
 
Specifies e-mail adaptor component to be used for automatic emailing of generated documents. 
 
Specifies settings with which the engine needs to e-mail the output document. 
 
Indicates current status of the engine. 
 
Specifies text identifying the output format. 
 
Specifies file extension for the output document. 
 
Specifies horizontal pixel density of the output document. 
 
Specifies vertical pixel density of the output document. 
 
Specifies the set of page elements that the engine needs to render. 
 
Specifies default measurement unit for page-level rendering operations. 
 
Occurs when the engine's e-mail component connects to its SMTP server. 
 
Occurs when the engine's e-mail component disconnects from its SMTP server. 
 
Occurs when the engine's e-mail component has successfully sent an e-mail. 
 
Indicates number of pages in the document. 
 
Specifies the page range that needs to be created. 
 
Specifies position of the origin (top-left corner) of the coordinate space on a page for rendering content. 
 
Specifies engine settings. 
 
Specifies an "engine setup" dialog box. 
 
Specifies stream containing the document. 
Methods
IgtDocumentSettings Interface
 
Name 
Description 
 
Returns current background color of the document. 
 
Returns current position of background image for the document. 
 
Returns current background image of the document. 
 
Returns current brush used to filling page elements in the document. 
 
Returns default font used in the document. 
 
Returns current document information properties of the document. 
 
Returns string containing the description metadata for the current document. 
 
Returns current file extension of the current document. 
 
Returns file name of the document. 
 
Returns current font used to render text in the document. 
 
Returns current border settings used for images and text boxes in the document. 
 
Returns current image settings for the document. 
 
Returns current page settings for the document. 
 
Returns current border settings for pages in the document. 
 
Returns pen used to stroke page elements on the document. 
 
Returns current engine settings. 
 
Returns current table settings. 
 
Returns current text formatting settings for text rendered on the document. 
 
Sets specified color for the background of the document. 
 
Sets specified position for the background image of the document. 
 
Sets specified image for the background of the document. 
 
Sets specified brush for text rendering operations on the document. 
 
Sets specified font for text elements in the document. 
 
Sets specified document information properties for the document. 
 
Sets specified text string as the description of the document. 
 
Sets specified extension for the document. 
 
Sets specified file name for the document. 
 
Sets specified default font for the document. 
 
Sets specified border for images and text boxes in the document. 
 
Sets specified image settings for the document. 
 
Sets specified page settings for the document. 
 
Sets specified border settings for pages in the document. 
 
Sets specified pen for stroking page elements in the document. 
 
Sets specified settings for the engine. 
 
Sets specified table settings for the document. 
 
Sets specified text formatting for the document. 
IgtDocumentEngine Interface
 
Name 
Description 
 
Adds specified image as a reusable resource for the document. 
 
Arc 
 
 
Begins document creation. 
 
Begins content creation for the document footer. 
 
Begins content creation for the document footer. 
 
Begins a new paragraph. 
 
Begins stamping operations. 
 
Begins table creation. 
 
Begins creating a watermark. 
 
Draws a segment of a circle covered a specified chord. 
 
Removes any "engine states" stored in memory. 
 
Removes any previously created footer. 
 
Removes any previously created footer. 
 
Removes any previous stamp. 
 
Clears any previously created watermark. 
 
Renders specified image at specified location. 
 
Renders specified image with specified dimensions in the specified column of the current table. 
 
Renders specified image in the image resource list within the specified rectangular area on the current page. 
 
Renders specified image inside specified rectangle on the page. 
 
Renders specified JPEG image in specified area with specified dimensions. 
 
Draws specified JPEG image in specified area on the page. 
 
Renders the content of a specified rich text edit control on a specified rectangular area on the current page. 
 
Renders an ellipse within the specified rectangular area. 
 
Ends current document creation and saves the output to file or stream. 
 
Ends current footer creation. 
 
Ends current header creation. 
 
Ends current paragraph. 
 
Ends current stamp creation. 
 
Ends current table creation. 
 
Ends current watermark creation. 
 
Exports a rich text format (RTF) document from a specified file to a specified rectangular area on the current page. 
 
Exports a rich text format (RTF) document from a specified stream to a specified rectangular area on the current page. 
 
Renders specified HTML-formatted string at specified location. 
 
Line 
Draws a line from specified points. 
 
Creates a new page in the current document. 
 
Creates a new row in the current table. 
 
Creates a new row with specified height in the current table. 
 
Pie 
Draws a pie section. 
 
Renders specified metafile, beginning at specified position on the current page. 
 
Renders specified metafile, beginning at the top-left corner of the page. 
 
Renders specified metafile at specified rectangular area on the page. 
 
Draws a "poly" B├ęzier curve with specified points. 
 
Renders a polygon with specified points. 
 
Draws a polyline with specified vertices. 
 
Draws a rectangle with specified corners. 
 
Restores specified state of saved engine settings. 
 
Draws a rectangle with soft rounded corners. 
 
Returns a number indicating the saved state of the current settings of engine. 
 
 
 
Sets specified angle of rotation for rendered text. 
 
Sets specified page as the current page. 
 
Renders specified text box. 
 
Renders specified text at specified location or cell. 
 
Renders specified text at specified location or cell and wraps it if specified or required. 
 
Renders text in specified column of the current table. 
 
Render text at current location in the current paragraph. 
 
Renders specified text vertically from specified location. 
 
Renders specified text at specified location limited to specified rectangular area. 
 
Returns the size of specified WideString in specified font. 
TgtCustomDocumentEngine Class
 
Name 
Description 
 
Renders specified JPEG image in specified area with specified dimensions. 
 
Renders JPEG image from specified file at specified location. 
 
Renders the content of a specified rich text edit control on a specified rectangular area on the current page. 
 
 
 
 
 
Returns height (in current measurement units) of specified text in current font
 
Returns width (in current measurement units) of specified text in current font
Events
TgtCustomDocumentEngine Class
 
Name 
Description 
 
Occurs after the engine begins creating a new document. 
 
Occurs after the engine begins creating a new page in the current document. 
 
Occurs after the engine completes rendering a document. 
 
Occurs after the engine completes rendering a page in the current document. 
 
Occurs before the engine begins creating a new document. 
 
Occurs before the engine begins a new page in the current document. 
 
Occurs before the engine completes rendering the current document. 
 
Occurs before the engine completes rendering the current page. 
 
Occurs when the engine encounters a placeholder variable in text that is meant to be rendered on a document. 
 
Occurs when the engine is about to render a table cell on the current document. 
 
Occurs when the engine is about to send the output document as an attachment to specified e-mail recipients. 
 
Occurs when an e-mail error is encountered by the engine. 
 
Occurs when the engine encounters an error condition.