Report

_RG_DBReport, _RG_ManageSharedReports, _RG_NewBlankReport, _RG_NewReportFromTemplate, _RG_NewTemplate, _RG_Open, _RG_OpenReportReadOnly, _RG_Print, RG_CloseWindow, RG_CopyCurrentImage, RG_ExportToImage, RG_ExportToPDF, RG_GetROIDByCustomID, RG_GetROIDs, RG_InitUndoManager, RG_MeasExport, RG_NewReportFromTemplate, RG_Open, RG_OpenFromBinBuffer, RG_OpenReportReadOnly, RG_Print, RG_SaveToFile, RG_ScriptDS_SetROAttribute_Double, RG_ScriptDS_SetROAttribute_RGBA, RG_ScriptDS_SetROAttribute_String, RG_ScriptDS_SetROAttribute_Uint, RG_SetGraphData, RG_SetROAttribute_Double, RG_SetROAttribute_ISize, RG_SetROAttribute_RGBA, RG_SetROAttribute_String, RG_SetROAttribute_Uint, RG_SetTableCellROAttribute_Double, RG_SetTableCellROAttribute_RGBA, RG_SetTableCellROAttribute_String, RG_SetTableCellROAttribute_Uint

RG_CloseWindow

Description 

 RG_CloseWindow();

This function closes current Report Generator window.

RG_CopyCurrentImage

This function runs the File > Report > Send Current Image to Report command.

Description 

 RG_CopyCurrentImage();

The function transfers the current image to the center of the current report or report template.

RG_ExportToImage

Description 

 RG_ExportToImage(
   char *RG_ImageFile,
   int  RG_Quiet
);

Exports a report from the Report Generator into an image format.

Parameters

char *RG_ImageFile

Path to the newly created image file including its suffix.

int RG_Quiet

0

Report warning messages are shown.

1

Suppresses report warning messages.

RG_ExportToPDF

Description 

 RG_ExportToPDF(
   char  RG_PDFFile
);

This function exports the current report to a pdf file.

Parameters

char RG_PDFFile

Name of the pdf file. If you pass an empty string, Report will show the window for entering it.

Note

This function is called from the Export to PDF... command (Report Generator window, File menu).

RG_GetROIDByCustomID

Description 

 RG_GetROIDByCustomID(
   char *RG_CustomROID
);

Returns the ID of the report object with the specified custom ID.

Parameters

char *RG_CustomROID

Custom ID of the report object.

See Also 
RG_SetROAttribute_String, RG_SetROAttribute_Double, RG_SetROAttribute_Uint, RG_SetROAttribute_ISize, RG_SetROAttribute_RGBA, RG_SetTableCellROAttribute_String, RG_SetTableCellROAttribute_Double, RG_SetTableCellROAttribute_Uint, RG_SetTableCellROAttribute_RGBA, RG_GetROIDs

RG_GetROIDs

Description 

 RG_GetROIDs(
   int *RG_TROIDBuffer,
   dword  RG_TROIDBufSizePtr,
   char *RG_ROClassName
);

Returns a list of IDs of report objects having the specified type (class name of an object).

Parameters

int *RG_TROIDBuffer

Integer array.

dword RG_TROIDBufSizePtr

Pointer to the array size.

char *RG_ROClassName

Name of the class (e.g. “CROTextBox”, “CROTable”, “CROPicture”, “CRORectangle”, “CROBarcode”).

See Also 
RG_SetROAttribute_String, RG_SetROAttribute_Double, RG_SetROAttribute_Uint, RG_SetROAttribute_ISize, RG_SetROAttribute_RGBA, RG_SetTableCellROAttribute_String, RG_SetTableCellROAttribute_Double, RG_SetTableCellROAttribute_Uint, RG_SetTableCellROAttribute_RGBA, RG_GetROIDByCustomID

RG_InitUndoManager

Description 

 RG_InitUndoManager();

Deletes all undo steps in the Report Generator. Typically used at the end of a macro.

RG_MeasExport

Description 

 RG_MeasExport(
   int  RG_MeasType
);

This function creates a report of a specified measurement type (the Report module required).

Parameters

int RG_MeasType

Specify measurement type:

0

Object measurement

1

Field measurement

2

Interactive measurement

3

ROI measurement

4

Object Stats measurement

5

Binary in ROI measurement

RG_NewReportFromTemplate

Interactive command to this function: File > Report > New Report from Template > Browse

Description 

 RG_NewReportFromTemplate(
   char  RG_Template
);

This function generates a report from the specified template. This function cannot be used for creating database reports or file listings.

Parameters

char RG_Template

Template file name (*.rtt)

Note

This function is called from the New Report from Template command (Report menu). There is also an interactive function _RG_NewReportFromTemplate.

See Also 
_RG_NewReportFromTemplate

RG_Open

This function runs the File > Report > Recent Files command.

Interactive command to this function: File > Report > Open

Description 

 RG_Open(
   char  RG_Filename
);

This function opens the specified report, report template or exported PDF document.

Parameters

char RG_Filename

Name of the report (*.rpt), report template (*.rtt) or PDF document (*.pdf), which will be opened. It must include full path.

Note

This function is called from the Open... command (Report menu). An interactive equivalent is the _RG_Open function.

See Also 
_RG_Open

RG_OpenFromBinBuffer

Description 

 RG_OpenFromBinBuffer(
   byte *RG_DataBuffer,
   dword *RG_BufferSize
);

Defines the buffer for the Report Generator.

Parameters

byte *RG_DataBuffer

Report generator data buffer.

dword *RG_BufferSize

RGB color of the ROI.

RG_OpenReportReadOnly

Description 

 RG_OpenReportReadOnly(
   char *RG_Filename
);

This function opens a report (*.rpt) in read-only mode.

Parameters

char *RG_Filename

Name of the file which will be saved (path to the *.rpt / *.rtt / *.pdf file). If you pass an empty string, Report will show the window for entering it.

RG_Print

Description 

 RG_Print();

This function prints the current report on the default printer.

Note

If you want to select for printing other printer than default, use the _RG_Print function.

See Also 
_RG_Print

RG_SaveToFile

Description 

 RG_SaveToFile(
   char *RG_Filename
);

This function saves current the report or the report template to the specified file. Reports should be stored with the RPT extension, while report templates with the RTT extension. If you disobey this rule, correct extension will be added automatically.

Parameters

char *RG_Filename

Name of the file which will be saved (path to the *.rpt / *.rtt / *.pdf file). If you pass an empty string, Report will show the window for entering it.

Note

This function is called from the Save As... command (Report Generator window, File menu).

See Also 
RG_Open

RG_ScriptDS_SetROAttribute_Double

Description 

 RG_ScriptDS_SetROAttribute_Double(
   char *RG_AttrName,
   double  RG_AttrValDouble
);

Sets the data source double type report object attributes used in a macro data source.

RG_AttrName is the name of the attribute (e.g. “line-width” in pixels, “font-size” in points).

Parameters

char *RG_AttrName

Name of the attribute.

double RG_AttrValDouble

Double value of the attribute.

See Also 
RG_ScriptDS_SetROAttribute_String, RG_ScriptDS_SetROAttribute_Uint, RG_ScriptDS_SetROAttribute_RGBA

RG_ScriptDS_SetROAttribute_RGBA

Description 

 RG_ScriptDS_SetROAttribute_RGBA(
   char *RG_AttrName,
   int  RG_AttrValRed,
   int  RG_AttrValGreen,
   int  RG_AttrValBlue,
   int  RG_AttrValAlpha
);

Sets the data source color type report object attributes used in a macro data source.

RG_AttrName is the name of the attribute (e.g. “color” for the color of main features such as lines, “bgcolor” for the background/filling color, “text-color” for the color of the text).

Parameters

char *RG_AttrName

Name of the attribute.

int RG_AttrValRed

Red color value. Color range is <0;255>.

int RG_AttrValGreen

Green color value. Color range is <0;255>.

int RG_AttrValBlue

Blue color value. Color range is <0;255>.

int RG_AttrValAlpha

Alpha channel value.

0

Transparency

1-255

Full alpha

See Also 
RG_ScriptDS_SetROAttribute_String, RG_ScriptDS_SetROAttribute_Double, RG_ScriptDS_SetROAttribute_Uint

RG_ScriptDS_SetROAttribute_String

Description 

 RG_ScriptDS_SetROAttribute_String(
   char *RG_AttrName,
   char *RG_AttrValString
);

Sets the data source string type report object attributes used in a macro data source.

RG_AttrName is the name of the attribute (e.g. “plain-text” for the text content).

Parameters

char *RG_AttrName

Name of the attribute.

char *RG_AttrValString

String value of the attribute.

See Also 
RG_ScriptDS_SetROAttribute_Double, RG_ScriptDS_SetROAttribute_Uint, RG_ScriptDS_SetROAttribute_RGBA

RG_ScriptDS_SetROAttribute_Uint

Description 

 RG_ScriptDS_SetROAttribute_Uint(
   char *RG_AttrName,
   dword  RG_AttrValUint
);

Sets the integer or boolean type report object attributes used in a macro. In case of the boolean values use 1 for true and 0 for false.

RG_AttrName is the name of the attribute. For example:

  • “visible” (boolean): visibility of the whole report object

  • “locked” (boolean): is the user allowed to manipulate the report object

  • “read-only” (boolean): is the text within the text box report object for reading only (note that it is still possible to move or resize text boxes which are read-only)

  • “word-wrap” (boolean): is the text content word-wrapped rather than clipped

Parameters

char *RG_AttrName

Name of the attribute.

dword RG_AttrValUint

Integer value of the attribute.

See Also 
RG_ScriptDS_SetROAttribute_String, RG_ScriptDS_SetROAttribute_Double, RG_ScriptDS_SetROAttribute_RGBA

RG_SetGraphData

Description 

 RG_SetGraphData(
   char *RG_GraphTitle,
   int  RG_DataCount,
   double *RG_DoubleData
);

Sets the data for the graph in the report or template opened in the Report Generator. The graph should be already prepared for the value range of the data, by setting minimum and maximum values, bin size, etc. This function only sets the data. The graph is identified by its title.

Parameters

char *RG_GraphTitle

Title of the graph, in which the data are to be set.

int RG_DataCount

Number of values in RG_DoubleData array.

double *RG_DoubleData

Data to be set to the graph. The size of this array is determined by RG_DataCount parameter.

RG_SetROAttribute_Double

Description 

 RG_SetROAttribute_Double(
   int  RG_ROID,
   char *RG_AttrName,
   double  RG_AttrValDouble
);

Sets double type report object attributes used in a macro.

RG_AttrName is the name of the attribute (e.g. “line-width” in pixels, “font-size” in points).

Parameters

int RG_ROID

ID of the report object.

char *RG_AttrName

Name of the attribute.

double RG_AttrValDouble

Double value of the attribute.

See Also 
RG_SetROAttribute_String, RG_SetROAttribute_Uint, RG_SetROAttribute_RGBA, RG_SetROAttribute_ISize, RG_SetTableCellROAttribute_String, RG_SetTableCellROAttribute_Double, RG_SetTableCellROAttribute_Uint, RG_SetTableCellROAttribute_RGBA, RG_GetROIDs, RG_GetROIDByCustomID

RG_SetROAttribute_ISize

Description 

 RG_SetROAttribute_ISize(
   int  RG_ROID,
   char *RG_AttrName,
   int  RG_IWidth,
   int  RG_IHeight
);

Sets the integer size type report object attributes used in a macro.

RG_AttrName is the name of the attribute (e.g. “table-size”).

Parameters

int RG_ROID

ID of the report object.

char *RG_AttrName

Name of the attribute.

int RG_IWidth

Report object width.

int RG_IHeight

Report object height.

See Also 
RG_SetROAttribute_String, RG_SetROAttribute_Double, RG_SetROAttribute_Uint, RG_SetROAttribute_RGBA, RG_SetTableCellROAttribute_String, RG_SetTableCellROAttribute_Double, RG_SetTableCellROAttribute_Uint, RG_SetTableCellROAttribute_RGBA, RG_GetROIDs, RG_GetROIDByCustomID

RG_SetROAttribute_RGBA

Description 

 RG_SetROAttribute_RGBA(
   int  RG_ROID,
   char *RG_AttrName,
   int  RG_AttrValRed,
   int  RG_AttrValGreen,
   int  RG_AttrValBlue,
   int  RG_AttrValAlpha
);

Sets the color type report object attributes used in a macro.

RG_AttrName is the name of the attribute (e.g. “color” for the color of main features such as lines, “bgcolor” for the background/filling color, “text-color” for the color of the text).

Parameters

int RG_ROID

ID of the report object.

char *RG_AttrName

Name of the attribute.

int RG_AttrValRed

Red color value. Color range is <0;255>.

int RG_AttrValGreen

Green color value. Color range is <0;255>.

int RG_AttrValBlue

Blue color value. Color range is <0;255>.

int RG_AttrValAlpha

Alpha channel value.

0

Transparency

1-255

Full alpha

See Also 
RG_SetROAttribute_String, RG_SetROAttribute_Double, RG_SetROAttribute_Uint, RG_SetROAttribute_ISize, RG_SetTableCellROAttribute_String, RG_SetTableCellROAttribute_Double, RG_SetTableCellROAttribute_Uint, RG_SetTableCellROAttribute_RGBA, RG_GetROIDs, RG_GetROIDByCustomID

RG_SetROAttribute_String

Description 

 RG_SetROAttribute_String(
   int  RG_ROID,
   char *RG_AttrName,
   char *RG_AttrValString
);

Sets the string type report object attributes used in a macro.

RG_AttrName is the name of the attribute (e.g. “plain-text” for the text content).

Parameters

int RG_ROID

ID of the report object.

char *RG_AttrName

Name of the attribute.

char *RG_AttrValString

String value of the attribute.

See Also 
RG_SetROAttribute_Double, RG_SetROAttribute_Uint, RG_SetROAttribute_ISize, RG_SetROAttribute_RGBA, RG_SetTableCellROAttribute_String, RG_SetTableCellROAttribute_Double, RG_SetTableCellROAttribute_Uint, RG_SetTableCellROAttribute_RGBA, RG_GetROIDs, RG_GetROIDByCustomID

RG_SetROAttribute_Uint

Description 

 RG_SetROAttribute_Uint(
   int  RG_ROID,
   char *RG_AttrName,
   dword  RG_AttrValUint
);

Sets integer or boolean type report object attributes used in a macro. In case of boolean values use 1 for true and 0 for false.

RG_AttrName is the name of the attribute. For example:

  • “visible” (boolean): visibility of the whole report object

  • “locked” (boolean): is the user allowed to manipulate the report object

  • “read-only” (boolean): is the text within the text box report object for reading only (note that it is still possible to move or resize text boxes which are read-only)

  • “word-wrap” (boolean): is the text content word-wrapped rather than clipped

Parameters

int RG_ROID

ID of the report object.

char *RG_AttrName

Name of the attribute.

dword RG_AttrValUint

Integer value of the attribute.

See Also 
RG_SetROAttribute_String, RG_SetROAttribute_Double, RG_SetROAttribute_ISize, RG_SetROAttribute_RGBA, RG_SetTableCellROAttribute_String, RG_SetTableCellROAttribute_Double, RG_SetTableCellROAttribute_Uint, RG_SetTableCellROAttribute_RGBA, RG_GetROIDs, RG_GetROIDByCustomID

RG_SetTableCellROAttribute_Double

Description 

 RG_SetTableCellROAttribute_Double(
   int  RG_ROID,
   int  RG_IColumn,
   int  RG_IRow,
   char *RG_AttrName,
   double  RG_AttrValDouble
);

Sets the double type report object attributes to a table cell.

RG_AttrName is the name of the attribute (e.g. “line-width” in pixels, “font-size” in points).

Parameters

int RG_ROID

ID of the table report object.

int RG_IColumn

Column position.

int RG_IRow

Row position.

char *RG_AttrName

Name of the attribute.

double RG_AttrValDouble

Double value of the attribute.

See Also 
RG_SetROAttribute_String, RG_SetROAttribute_Double, RG_SetROAttribute_Uint, RG_SetROAttribute_ISize, RG_SetROAttribute_RGBA, RG_SetTableCellROAttribute_String, RG_SetTableCellROAttribute_Uint, RG_SetTableCellROAttribute_RGBA, RG_GetROIDs, RG_GetROIDByCustomID

RG_SetTableCellROAttribute_RGBA

Description 

 RG_SetTableCellROAttribute_RGBA(
   int  RG_ROID,
   int  RG_IColumn,
   int  RG_IRow,
   char *RG_AttrName,
   int  RG_AttrValRed,
   int  RG_AttrValGreen,
   int  RG_AttrValBlue,
   int  RG_AttrValAlpha
);

Sets the color type report object attributes to a table cell.

Parameters

int RG_ROID

ID of the table report object.

int RG_IColumn

Column position.

int RG_IRow

Row position.

char *RG_AttrName

Name of the attribute.

int RG_AttrValRed

Red color value. Color range is <0;255>.

int RG_AttrValGreen

Green color value. Color range is <0;255>.

int RG_AttrValBlue

Blue color value. Color range is <0;255>.

int RG_AttrValAlpha

Alpha channel value.

0

Transparency

1-255

Full alpha

See Also 
RG_SetROAttribute_String, RG_SetROAttribute_Double, RG_SetROAttribute_Uint, RG_SetROAttribute_ISize, RG_SetROAttribute_RGBA, RG_SetTableCellROAttribute_String, RG_SetTableCellROAttribute_Double, RG_SetTableCellROAttribute_Uint, RG_GetROIDs, RG_GetROIDByCustomID

RG_SetTableCellROAttribute_String

Description 

 RG_SetTableCellROAttribute_String(
   int  RG_ROID,
   int  RG_IColumn,
   int  RG_IRow,
   char *RG_AttrName,
   char *RG_AttrValString
);

Sets the string type report object attributes to a table cell.

RG_AttrName is the name of the attribute (e.g. “plain-text” for the text content).

Parameters

int RG_ROID

ID of the table report object.

int RG_IColumn

Column position.

int RG_IRow

Row position.

char *RG_AttrName

Name of the attribute.

char *RG_AttrValString

String value of the attribute.

See Also 
RG_SetROAttribute_String, RG_SetROAttribute_Double, RG_SetROAttribute_Uint, RG_SetROAttribute_ISize, RG_SetROAttribute_RGBA, RG_SetTableCellROAttribute_Double, RG_SetTableCellROAttribute_Uint, RG_SetTableCellROAttribute_RGBA, RG_GetROIDs, RG_GetROIDByCustomID

RG_SetTableCellROAttribute_Uint

Description 

 RG_SetTableCellROAttribute_Uint(
   int  RG_ROID,
   int  RG_IColumn,
   int  RG_IRow,
   char *RG_AttrName,
   dword  RG_AttrValUint
);

Sets integer or boolean type report object attributes used in a macro. In case of boolean values use 1 for true and 0 for false.

RG_AttrName is the name of the attribute. For example:

  • “visible” (boolean): visibility of the whole report object

  • “locked” (boolean): is the user allowed to manipulate the report object

  • “read-only” (boolean): is the text within the text box report object for reading only (note that it is still possible to move or resize text boxes which are read-only)

  • “word-wrap” (boolean): is the text content word-wrapped rather than clipped

Parameters

int RG_ROID

ID of the table report object.

int RG_IColumn

Column position.

int RG_IRow

Row position.

char *RG_AttrName

Name of the attribute.

dword RG_AttrValUint

Integer value of the attribute.

See Also 
RG_SetROAttribute_String, RG_SetROAttribute_Double, RG_SetROAttribute_Uint, RG_SetROAttribute_ISize, RG_SetROAttribute_RGBA, RG_SetTableCellROAttribute_String, RG_SetTableCellROAttribute_Double, RG_SetTableCellROAttribute_RGBA, RG_GetROIDs, RG_GetROIDByCustomID

_RG_DBReport

Description 

 _RG_DBReport(
   int  RG_Index
);

This function starts creating a database report or file listing or report template based on the selection of the Organizer layout.

Parameters

int RG_Index

Index of the organizer pane used for creating report or report template.

0

Left pane

1

Right pane

Note

This function is for internal use only.

_RG_ManageSharedReports

This function runs the File > Report > Manage Shared Reports command.

Description 

 _RG_ManageSharedReports();

_RG_NewBlankReport

This function runs the File > Report > New Blank Report command.

Description 

 _RG_NewBlankReport();

This function creates a new report. The function opens the Report Generator window.

See Also 
_RG_NewReportFromTemplate, _RG_NewTemplate

_RG_NewReportFromTemplate

This function runs the File > Report > New Report from Template > Browse command.

Description 

 _RG_NewReportFromTemplate();

This function creates a report from a template. The function opens the Select template window.

See Also 
_RG_NewBlankReport, _RG_NewTemplate

_RG_NewTemplate

This function runs the File > Report > New Template command.

Description 

 _RG_NewTemplate();

This function _RG_NewTemplate creates a new report template. The function opens the Report Generator window with a new untitled template.

See Also 
_RG_NewBlankReport, _RG_NewReportFromTemplate

_RG_Open

This function runs the File > Report > Open command.

Description 

 _RG_Open();

This function opens a report or report template. The function displays the Open dialog box.

See Also 
_RG_NewBlankReport, _RG_NewReportFromTemplate, _RG_NewTemplate

_RG_OpenReportReadOnly

Description 

 _RG_OpenReportReadOnly();

This function opens a standard dialog where it is possible to select a report (*.rpt) to open. This report will be read-only.

_RG_Print

Description 

 _RG_Print();

This function prints the current report. The function displays the Print dialog box.

See Also 
RG_Print

Copyright 1991-2024 Laboratory Imaging s.r.o.