VSFlexGridFunctions

Last Updated:

Functions and Actions for VSFlexGrid objects.

This serves as an example of a new core library servicing a custom component.

[How To Read This Reference]
ClickCell
RC
Attempts to perform a single Click on a table cell.
SelectCell
RC
Attempts to perform a Select on a table cell.
VerifyValuesToFile
RC
Verify the string values of a grid block to a file benchmark.

VSFlexGridFunctions::ClickCell
RC

Attempts to perform a single Click on a table cell.

The cell to Click is provided in separate row and col parameters. Missing parameters indicate index=1. The indexes are 1-based. That is, the first row is row 1. The first col is col 1.

Logical Cells are those data cells viewable to the user. They do not include hidden or fixed cells. Thus, the first top left cell for real grid data is considered cell 1,1.

The grid will remain in edit mode if edit mode goes active.



Fields: [ ]=Optional with Default Value
  1. [ row = ]
    The 1-based logical row to select.

    If no row is provided then row=1 is assumed.

  2. [ col = ]
    The 1-based logical col to select.

    If no col is provided then col=1 is assumed.

Examples:
[How To Read This Reference]

VSFlexGridFunctions::SelectCell
RC

Attempts to perform a Select on a table cell.

The cell to Select is provided in separate row and col parameters. Missing parameters indicate index=1. The indexes are 1-based. That is, the first row is row 1. The first col is col 1.

Logical Cells are those data cells viewable to the user. They do not include hidden or fixed cells. Thus, the first top left cell for real grid data is considered cell 1,1.

We will ESCAPE out of edit mode if edit mode goes active.



Fields: [ ]=Optional with Default Value
  1. [ row = ]
    The 1-based logical row to select.

    If no row is provided then row=1 is assumed.

  2. [ col = ]
    The 1-based logical col to select.

    If no col is provided then col=1 is assumed.

Examples:
[How To Read This Reference]

VSFlexGridFunctions::VerifyValuesToFile
RC

Verify the string values of a grid block to a file benchmark.

Grid rows and cols are considered 1-based. You can specify a subset of the grid by providing the optional values for rowMin, rowMax, colMin, colMax. The benchmark and the actual will be stored as TAB delimited files. Typically, benchmarks are stored in the Datapool\Bench directory.

Fields: [ ]=Optional with Default Value
  1. BenchmarkFile
    The name of the file used as the comparison benchmark.

    The name of the file used as the comparison benchmark.
    Typically, benchmarks are stored in the Datapool\Bench directory. In that event, only the filename.ext is needed. Benchmarks and captures will be TAB delimited files.


  2. [ rowMin = 1 ]
    The first row to include in the capture and compare.

    By default, the first row of the grid is used.

  3. [ rowMax = ]
    The last row to include in the capture and compare.

    By default, the last row of the entire grid is used.

  4. [ colMin = 1 ]
    The first col to include in the capture and compare.

    By default, the first col of the grid is used. Columns can also be specified by full or partial column header text.

  5. [ colMax = ]
    The last col to include in the capture and compare.

    By default, the last col of the entire grid is used. Columns can also be specified by full or partial column header text.

Examples:
[How To Read This Reference]