UserLock API
Public Member Functions | Properties | List of all members
Message Class Reference

Customizable message. More...

Inherits UlServerComponent.

Public Member Functions

 Message (string messageId, UserLockServer userLockServer)
 Create an instance of a customizable message and get its value from the UserLock server More...
 
override void GetInfo ()
 Refresh the message from the server. More...
 
override void SetInfo ()
 Update the message to the server. More...
 

Properties

string MessageId [get]
 Id of the message. More...
 
string Value [get, set]
 Content of the message. More...
 

Detailed Description

Customizable message.

Example: Modify the message CLOSE_PREVIOUS_SESSIONS

UserLockServer userLockServer = new UserLockServer(".")
Message myMessage = new Message("CLOSE_PREVIOUS_SESSIONS", userLockServer);
myMessage.Value = @"The new message.";
myMessage.SetInfo(); // Update the message on the server

Constructor & Destructor Documentation

Message ( string  messageId,
UserLockServer  userLockServer 
)

Create an instance of a customizable message and get its value from the UserLock server

Parameters
messageIdMessage ID
userLockServerInstance of the class UserLockServer

Member Function Documentation

override void GetInfo ( )

Refresh the message from the server.

override void SetInfo ( )

Update the message to the server.

Property Documentation

string MessageId
get

Id of the message.

string Value
getset

Content of the message.