Home > Language Reference > Functions > System functions

InputArea Property

Sets or retrieves the current state of the dynamic input area.

Syntax

Public Property Get InputArea() As HbInputArea
Public Property Let InputArea(ByVal
eState As HbInputArea)

ParameterDescription
eStateNew state of the dynamic input area.

Remarks

The InputArea property sets or retrieves the current state of the dynamic input area, if any. This property is typically used to open or close the input area at the time a form is entered; however, this practice is discouraged, as it is probably better to let the user decide whether the input area is opened or closed. Automatically changing the DIA state in too many instances can result in a jumpy user interface that produces bad user experience.

This property can take a combination of constants from the three following groups:

ConstantValueDescription
hbDiaUp&H0001The dynamic input area is opened.
hbDiaDown&H0002The dynamic input area is closed.
ConstantValueDescription
hbDiaPortrait&H0010The screen orientation is vertical.
hbDiaLandscape&H0020The screen orientation is horizontal.
ConstantValueDescription
hbDiaAreaLocked&H0100The trigger the user can tap to open or close the input area is disabled.
hbDiaOrientationLocked&H0200The trigger the user can tap to rotate the screen is disabled.

When affecting a new value to this property, you can omit one of the two first groups of constant. This will instruct the system to leave the other parameter unchanged. For example, the following will switch the device to the landscape mode without changing the input area state:

InputArea = hbDiaLandscape

Note that all devices may not support all of these constants. In that case, affecting a value to this property has simply no effect, and notably does not cause any runtime error.

System requirements

SystemMinimal versionRemarks
Palm OSPalm OS 4.0Only effective on devices having a collapsible input area.
Windows CEWindows CE 3.0-