UIOption PropertyUIOption Property*
*Contents  *Index  *Topic Contents
*Previous Topic: ThisParticipantName Property
*Next Topic: Width Property

UIOption Property

Contains flags that control the appearance of the default user interface. This property is a bitmask.

Syntax

object.UIOption[=value]

Parameters

objectRequired. An object expression that evaluates to a Chat control.
valueOptional. A short integer expression that equals the sum of the desired user interface option values. Can include the following option values.
1Set this value to display the Send button. Must set the Send text box (value=16) in order to set the Send button.
2Set this value to display the Whisper button. Must set the Send button (value=1) in order to set the Whisper button.
4Set this value to display the Participant list box.
8Set this value to display the History text box. This window displays all messages that have been received.
16Set this value to display the Send text box. The user composes messages in this text box before sending them.
32Set this value to notify members in the History text box when a new user joins the chat.
64Set this value to notify members in the History text box when a user leaves the chat.
128Set this value to allow the Chat control to display a dialog box that notifies the user when a member's status (host, participant, or spectator) changes, when a member's alias (nickname) changes, and when the user has been kicked by a host.
256Set this value to insert a blank line between messages in the History text box.
512Set this value to allow the Chat control to display error dialog boxes. When an OnError event is triggered, a dialog box containing the error message will appear.
1024Set this value to allow the user to resize the control.
2048Set this value to allow any URLs appearing in the History text box to be clickable.

Return Value

Returns the sum of the option values currently selected.

Remarks

To set a Chat control's user interface so that it includes a Send text box, Send button, Whisper button, History text box, and Participant list box, this property must be set to the sum of the option values. In this case, the sum would equal 31 (16 + 1 + 2 + 8 + 4 = 31). To set the control to have all options, the sum would equal 4095 (1 + 2 + 4 + 8 + 16 + 32 + 64 + 128 + 256 + 512 + 1024 + 2048 = 4095).

See Also

Appearance, BackColor, BorderStyle, History, MaxHistoryLength, MaxMessageLength


Up Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.