Graphics Editor (GEDI)
- GEDI, basics
- The catalog window
- The Script Editor
  - The File menu
  - The Edit menu
  - The View menu
  - The Tools menu
  - The Project Documentation menu
  - The High Speed Programming menu
  - Script Editor Extensions
    - seAddCompletionItem()
      Allows to add new auto-complete suggestions for the script editor.
    - seGetCompletionItem()
      The function returns a list of all user-defined completion items.
    - seGetCursorPos()
      Returns the current cursor position in the script editor.
    - seGetLine()
      Returns the code text from a specific line number in the script editor.
    - seGetScriptFileName()
      Returns the name of the file in which the script is located.
    - seGetSelectedText()
      Fetches the text selected in the script editor.
    - seGetSelectedTextPos()
      Returns the selected text coordinates in the script editor.
    - seInsertLine()
      Inserts a new line with the corresponding line number and a specific text into the script editor.
    - seLoadCoverageReport()
      The function loads a coverage report (an xml file).
    - seRemoveLine()
      Removes a specific code line in the script editor.
    - seSetCursorPos()
      Sets the cursor on a specific position in the script editor.
    - seSetLine()
      Inserts a text in a specific line in the script editor. If a text already exists in this line, it will be replaced.
    - seSetLines()
      Inserts multiple lines of text in the selected lines in the script editor. The text already in the lines will be replaced.
    - "autoAddBrace"
      The attribute "autoAddBrace" sets if closing curly braces are added automatically.
- The Property Sheet
- Creating graphics objects
- Simple graphics objects
- Complex graphics objects
- Simple Configuration, basics
- ScriptWizard
- Version control, basics
- Style Sheets, basics
- STD_symbols, basics
- Expandability of GEDI
- Simple Symbols, basics
- Layout management
- Object-Oriented Panel References

seLoadCoverageReport()

The function loads a coverage report (an xml file).

Synopsis

int seLoadCoverageReport(string coverageReportPath);

Parameters


Parameter	Description
coverageReportPath	Path to the coverage report, e.g. seLoadCoverageReport(makeNativePath(PROJ_PATH + LOG_REL_PATH + "coverageExample.xml"));

Return value

The function returns 0 when it was successfully executed and otherwise -1.

Description

The function loads a coverage report (an xml file). The file must be located in the WinCC_OA_Proj/log directory. In order to open a coverage report, you can use, for example, the function moduleAddAction() - see example below.

EXAMPLE

In the following example, the coverage report for the script covReport.ctl is opened by using a new button "Load Coverage Example".

Figure: A report in the WinCC_OA_Proj/log directory

The report is opened via the "Load Coverage Example" button. In the following script the report is loaded via the function seLoadCoverageReport() and the button "Load Coverage Report" is created for the script editor.

main()


{


  int tb  = moduleAddToolBar("toolbar_loadCoverageExample");


  moduleAddAction("Load Coverage Example", "", "", -1, tb, "loadCoverageExample");


}


void loadCoverageExample()


{


  seLoadCoverageReport(makeNativePath(PROJ_PATH + LOG_REL_PATH + "coverageExample.xml"));


}

The file with the suffix _ext.ctl, e.g. loadCoverageExample_ext.ctl. must be located in the WinCC_OA_Proj/scripts/scriptEditor directory.

Figure: WinCC_OA_Proj/scriptEditor/loadCoverageExample_ext.ctl.

You can open the report by using the button - see figure below:

Assignment

Script Editor Extensions

Availability

UI