SapEvent Properties 

The following table summarizes the properties of the SapEvent object.

Property

Type

Description

Application

SapEvent

Returns this event object. (EXE only).

Client

BSTR

SAP client number for this session.

ColumnDimension

short

Number of columns in a dynpro screen. Read/write.

ColumnListDimension

short

Number of columns in a list screen. Read/write (currently write-only).

Connected

BOOL

TRUE if connected to an SAP server; FALSE otherwise.

Controls

SapControls

Controls collection for this event.

CPU

BSTR

Name of CPU running current session.

CursorColumn

short

Column of current cursor position. Read/write.

CursorRow

short

Row of current cursor position. Read/write.

Database

BSTR

Name of database of current session.

DataColumns

short

Columns of underlying data in step loop or list.

DataColumnScreenSize

short

Number of columns of data that are shown on screen in step loop or list.

DataColumnStart

short

Starting data column in step loop or list.

DataRows

short

Rows of underlying data in step loop or list.

DataRowScreenSize

short

Number of rows of data that are shown on screen in step loop or list.

DataRowStart

short

Starting data row in step loop or list.

DiagVersion

short

Version of DIAG software.

DialogDismissedFlag

BOOL

TRUE if dialog dismissed flag is set.

DynproInfoFlag

BOOL

TRUE if ProgramName and ScreenName properties are available for this event.

EndOfSessionFlag

BOOL

TRUE if end of session flag is set, indicating that session is being disconnected.

FullName

BSTR

File specification of the application. EXE only.

GetAllMenus

BOOL

TRUE if all submenus are fetched at once. Read/write.

GetNotSend

BOOL

When doing manual GetEvent calls, GetEvent and SendEvent calls generally must alternate. GetNotSend is TRUE if the server is expecting a GetEvent next; FALSE if it is expecting a SendEvent.

HowToGet

SapGetType

Set automatic or manual GetEvent calls. Read/write.

KeyToSend

long

The Windows Virtual-Key value for the key to be sent. Read/write.

Keys

LPDISPATCH

Keys collection for this event.

MenuEntriesFlag

BOOL

TRUE if this event is a menu message.

MenuFlag

BOOL

TRUE if menu structure is active.

Menus

SapMenus

Menus collection for this event.

MenuToSend

long

Menu number to be sent. Read/write.

Message

BSTR

SAP message. In the SAPGUI, this is displayed in the status line. Use of messages differs across R/3 applications, as does the use of indications for informational, warning, or error messages. Sometimes messages will appear in modal dialog boxes, not just here.

MessageFlag

BOOL

TRUE if event contains a message.

MessageHelpFlag

BOOL

TRUE if message help will be requested. Read/write.

ModalHeight

short

Height of modal dialog box, in character units. 0 if not modal.

ModalLeft

short

Leftmost position of modal dialog box, in character units. 0 if not modal.

ModalTop

short

Topmost position of modal dialog box, in character units. 0 if not modal.

ModalWidth

short

Width of modal dialog box, in character units. 0 if not modal.

ModeNumber

short

Mode or session number.

Name

BSTR

Name of the application. EXE only. Default property for EXE.

OKCode

BSTR

OK Code to be sent to the application. Read/write.

OKCodeFlag

BOOL

TRUE if received event contains an OK Code.

OKHelpFlag

BOOL

TRUE if help for OK Code box will be requested. Read/write.

Parent

LPDISPATCH

For EXE, returns this SapEvent. For OCX, returns OLE control container.

PFKeyFlag

BOOL

TRUE if event contains keys information.

ProgramName

BSTR

Name of current SAP program. Only available if DynproInfoFlag property is TRUE.

R2

BOOL

TRUE if connected to an R/2 system via the CUA gateway.

RfcFlag

BOOL

TRUE if RFC flag is on.

RowDimension

short

Number of rows in a dynpro screen. Read/write.

RowListDimension

short

Number of rows in a list screen. Read/write (currently write-only).

ScreenFlag

BOOL

True if the event contains a screen with controls information.

ScreenModal

long

1 if screen is a modal dialog box; 0 otherwise.

ScrollColumnToSend

long

New starting data column for horizontal scroll. Read/write.

ScrollRowToSend

long

New starting data row for vertical scroll. Read/write.

ScreenName

BSTR

Name of current SAP screen. Only available if DynproInfoFlag property is TRUE.

SendMenuFlag

BOOL

TRUE if menu event will be sent. Automatically set when MenuToSend property is set, but may also be set manually. Read/write.

SendOKCodeFlag

BOOL

TRUE if OK code will be sent. Automatically set when OKCode property is set, but may also be set manually. Read/write.

SendPFKeyFlag

BOOL

TRUE if PF key will be sent. Automatically set when KeyToSend property is set, but may also be set manually. Read/write.

SetCursorPositionFlag

BOOL

TRUE if new cursor position will be sent. Automatically set when CursorColumn or CursorRow property is set, but may also be set manually. Read/write.

SetSizeFlag

BOOL

TRUE if screen size will be reset. Automatically set when RowDimension, RowListDimension, ColumnDimension, or ColumnListDimension properties are set, but may also be set manually. Read/write.

Size

long

Size of current event in bytes.

StaticInfoFlag

BOOL

TRUE if static information (CPU, Database, DiagVersion, ModeNumber) is available.

TerminalClearFlag

BOOL

TRUE if terminal clear flag is set.

Title

BSTR

Title of screen as it appears in the Windows title bar.

TitleFlag

BOOL

TRUE if Title property contains screen title.

Username

BSTR

SAP user name for this session.

V3

BOOL

TRUE if session is connected to an SAP System running version 3.0 or later.

Visible

BOOL

TRUE if the OLE Automation server user interface is visible on the screen. Read/write. EXE only.

See Also

SapEvent Methods

SapEvent Events