Share this page

# sapgui_grid_set_column_order

Grid Functions

Sets the order of grid columns.

    int sapgui_grid_set_column_order( const char *description, const char *gridID, const char *row, const char *columns, [args,] LAST );

description | User entered text to aid in understanding script
gridID | Object ID Strings
columns | A comma separated list of Grid column identifiers. The list must be terminated with either an optional arguments clause or with LAST. Grid column identifier: The column identifier string is inserted in the script during recording. This string is the field name defined in the SAP data dictionary. This identifier cannot be replaced with a column number.
args | Optional Arguments
LAST | A marker indicating the end of the argument list. Not required if Optional Arguments are used.

sapgui_grid_set_column_order emulates a user dragging a column to a new position in the grid.

The "columns" list must contain each column ID in the grid exactly once.

## Return Values

This function returns LR_PASS (0) on success or LR_FAIL (1) on failure.

## Parameterization

You can parameterize all string (char type) arguments.

## Example

The following example shows the use of sapgui_grid_set_column_order.

        // Run the sample

        sapgui_set_ok_code("/nme51n", LAST );
        sapgui_press_button("ENTER",
            "tbar[0]/btn[0]", LAST );

        // Drag a column to a new position

        sapgui_grid_set_column_order("(CtrlGrid)", "usr/subSUB0:SAPLMEGUI:0016/subSUB2:SAPLMEVIEWS:1100/subSUB2:SAPLMEVIEWS:1200/subSUB1:SAPLMEGUI:3212/cntlGRIDCONTROL/shellcont/shell",
            "STATUSICON",
            "BNFPO",
            "MENGE",
            "KNTTP",
            "EPSTP",
            "MATNR",
            "TXZ01",
            "MEINS",
            "ELPEI",
            "EEIND",
            "WGBEZ",
            "NAME1",
            "LGOBE",
            "EKGRP",
            "AFNAM",
            "BEDNR",
            "LIFNR",
            "FLIEF",
            "RESWK",
            "EKORG",
            "KONNR",
            "KTPNR",
            "INFNR",
            "EMATN",
            BEGIN_OPTIONAL,
                "AdditionalInfo=sapgui1013",
            END_OPTIONAL);
    sapgui_grid_set_column_order("(CtrlGrid)",
    "usr/subSUB0:SAPLMEGUI:0016/subSUB2:SAPLMEVIEWS:1100/subSUB2:SAPLMEVIEWS:1200/subSUB1:SAPLMEGUI:3212/cntlGRIDCONTROL/shellcont/shell",
            "STATUSICON",
            "BNFPO",
            "MATNR",
            "MENGE",
            "KNTTP",
            "EPSTP",
            "TXZ01",
            "MEINS",
            "ELPEI",
            "EEIND",
            "WGBEZ",
            "NAME1",
            "LGOBE",
            "EKGRP",
            "AFNAM",
            "BEDNR",
            "LIFNR",
            "FLIEF",
            "RESWK",
            "EKORG",
            "KONNR",
            "KTPNR",
            "INFNR",
            "EMATN",
            LAST );

Tips to improve your search results... VuGen Function Reference Version 26.1 Function Reference 26.1 All View Local Help Center View Online Help Center Version: