WireLess Studio Widgets Developer's Guide

ModifyDisplayMode

This method adds an removes display modes on a WS_FIELD widget.

The display modes affect the way in which the text is displayed on the widget.

Parameters

sObjectName

The name of the target widget.

usObjectId

The id of the target widget.

lRemove

The modes to be removed from the widget display modes.

lAdd

The modes to be added to the widget display modes.

Return Value

On success, ModifyDisplayMode returns TRUE, FALSE otherwise. To get extended information, call WStError::GetLastErrorCode.

Remarks

Modes to be added or removed can be combined by using the bitwise OR ( | ) operator.

The available display modes are:

• WS_FIELD_DM_ECHO_ASTERISK: Replaces each character typed on the widget for an asterisk (*).
• WS_FIELD_DM_MULTILINE: Allows to write multiple lines on the widget.

WS_FIELD_DM_ECHO_ASTERISK and WS_FIELD_DM_MULTILINE are not compatible. If both modes are added, only WS_FIELD_DM_MULTILINE will be activated.

The display modes can be found on the WSFieldConstants enumeration.

Example

using WirelessStudioOleWidgets;
WStWidget oWidget = new WStWidget();
WStFactory oFactory = new WStFactory();
short iFieldId = 33;
oFactory.CreateWidgetById((short)WSTFactoryConstants.WS_FIELD, iFieldId, "", 0,0, 50, 50, "123");

/* Using the WS_FIELD_DM_ECHO_ASTERISK display mode, the WS_FIELD widget replaces the string "123" for "***" */
oWidget.ModifyDisplayModeById(iFieldId, 0, (short)WSFieldConstants.WS_FIELD_DM_ECHO_ASTERISK);

Public wsWidget As New WStWidget
...
Case "passwordCheckBox"
	If wsForm.GetLastEventIntValue() = WS_STATE_CHECKED Then
		wsWidget.ModifyDisplayModeByName "field", 0, WS_FIELD_DM_ECHO_ASTERISK
	Else
		wsWidget.ModifyDisplayModeByName "field", WS_FIELD_DM_ECHO_ASTERISK, 0
	End If
...

See also

ModifyInputMode | ModifyInputDevices | ModifyLenCtrlMode | SetKeyboardMode | SetScannerConfigFile | SetMaxLength | GetLastInputType | GetLastBarcodeType

WStWiget class reference | WStForm class reference | WStFactory class reference | WStError class reference