SapControl Properties 

Application

SapEvent

Returns top-level event object. EXE only.

Area

short

Screen area ID.

Block

short

Block ID within a step loop.

Bottom

long

Bottom position of the control on the screen, in character units.

ChildIndex

short

Index of first child of this control.

ColorNumber

short

Number of control color. Used with lists together with the Intensive and Inverse properties to determine the background colors of controls. Also used to specify an icon background color.

Container

short

Container ID for a manager. For non-manager controls, the container ID for the controlís parent manager.

DataElement

BSTR

Data element; available only after GetEventFull().

DataElement

   

Supplement

BSTR

Data element supplement; available only after GetEventFull method.

FieldName

BSTR

Name of field associated with this control; available only when the HasFieldNames property is TRUE.

Flags

short

Flags indicated whether control is selected and/or modified. The same information is also available using the Modified, Selected, and HasFieldNames properties. Read/write.

Group

short

Group ID for radio buttons. Radio buttons with the same area, block, and group IDs are in the same group and are mutually exclusive.

Has3D

BOOL

TRUE if control is marked with a 3D style.

HasFieldNames

BOOL

TRUE if the control has its FieldName and TableName properties set.

HasIcon

BOOL

TRUE if the control contains an icon.

Height

long

Height of the control on the screen, in character units.

HotSpot

BOOL

TRUE if control is a hotspot, allowing single- rather than double-clicking.

IconCode

BSTR

The icon code contained between @ characters, not including the quick info string. Usually a two-character code, ranging from "00" to "5C" in 3.1G, but may also be the 6-character icon name.

IconName

BSTR

Root name of the bitmap file for the icon. For example, the OK icon, with a value of "@01@", returns "S_OKAY". This is the same as the "internal format" listed by the details button with the ICON transaction. Empty if the control has no icon.

IconQuickInfo

BSTR

Quick info (i.e., tooltip) associated with the icon. Empty if the control has no icon.

IconText

BSTR

Text that follows the icon in the control. Empty if the control has no icon.

Intensive

BOOL

TRUE if control value is displayed in an intensive color. In R/3, the choice of intensive color is user-selectable and can differ among control types.

Inverse

BOOL

TRUE if control value is displayed in an inverse (or dimmed) color. In R/3, the choice of inverse color is user-selectable, and is restricted to use within lists.

Left

long

Leftmost position of the control on the screen, in character units.

Modified

BOOL

TRUE if the control has been modified. This property is set by the other read/write properties, but may also be set manually. Read/write.

Name

BSTR

Text name of the control.

NextIndex

short

Index of the next peer of this control.

Parent

SapControls

Returns parent controls collection.

ParentIndex

short

Index of the parent of this control. -1 if no parents.

ProportionalFont

BOOL

TRUE if the control value is displayed using a proportional font; FALSE if displayed using a fixed-width font.

ReadOnly

BOOL

TRUE if the control is marked with a read-only style. Valid for control types that can be edited.

Right

long

Rightmost position of the control on the screen, in character units.

Selected

BOOL

TRUE if the control (a radio button or check box) has been selected. Read/write.

Style

long

Flags indicating the visual style of the control. See the description of the dwStyle member of the IT_CTRL data structure in the GUI Library for a list of flag values. Currently, only a limited set of flags are available directly through separate properties.

SymbolFont

BOOL

TRUE if the control value is displayed using the symbol font; FALSE if displayed using a text font.

TableControlInfo

SapTableControlInfo

Returns table control info object for SapTable control; NULL if control is not a SapTable.

TableName

BSTR

Name of the table associated with this control; available only when the HasFieldNames property is TRUE.

Top

long

Top position of the control on the screen, in character units.

Type

SapControlType

Control type.

UppercaseInput

BOOL

TRUE if an editable control converts all input into uppercase.

Value

BSTR

The value of the control, represented as a text string. Read/write. Default property.

Visible

BOOL

TRUE if this control is visible on the screen.

Width

long

Width of the control on the screen, in character units.