[This is preliminary documentation and is subject to change.]
This enumerates the values used as initial header items in Messages.
Declaration Syntax| C# |
public enum MessageType
Members| Member | Description |
|---|---|
| Reserved_1 | This MessageType is reserved. |
| GetCredentials | Deprecated. |
| AskConnectionDetails | Messages of this type contain a UserInterface.AskConnectionDetails
call. |
| Exit | Messages of this type contain a UserInterface.Exit call. |
| Show | Messages of this type contain a UserInterface.Show call.
|
| ShowModal | Messages of this type contain a UserInterface.ShowModal
call. |
| ShowModalButtons | Messages of this type contain a UserInterface.ShowModalButtons
call. |
| SetFocusTo | Messages of this type contain a UserInterface.SetFocusTo
call. |
| SetStatus | Messages of this type contain a UserInterface.SetStatus call.
|
| GetStatus | Messages of this type contain a UserInterface.GetStatus call. |
| RefreshAllPanes | Messages of this type contain a UserInterface.RefreshAllPanes
call. |
| ShowMessageBox | Messages of this type contain one of the Inform, Warn, UserConfirms
or AskRetry calls of the UserInterface class. |
| ReportError | Messages of this type contain a UserInterface.ReportError
call. |
| AskString | Messages of this type contain a UserInterface.AskString call.
|
| ChooseOne | Messages of this type contain a UserInterface.ChooseOne call.
|
| ChooseSeveral | Messages of this type contain a UserInterface.ChooseSeveral call.
|
| SelectObjects | Messages of this type contain a UserInterface.SelectObjects call.
|
| GetTextFile | Messages of this type contain a UserInterface.GetTextFile
call. |
| GetFile | Messages of this type contain a UserInterface.GetFile
call. |
| Beep | Messages of this type contain a UserInterface.Beep call. |
| CreateWindow | Messages of this type contain a UserInterface.CreateWindow
call. |
| ShowWindow | Messages of this type contain a UserInterface.ShowWindow
call. |
| ShowWindowModal | Messages of this type contain a UserInterface.ShowWindowModal
call. |
| HideWindow | Messages of this type contain a UserInterface.HideWindow call.
|
| CloseWindow | Messages of this type contain a UserInterface.CloseWindow call.
|
| MainWindowGet | Messages of this type contain a UserInterface.MainWindow property
access. |
| WindowShow | Messages of this type contain an IPWindow.Show call |
| WindowAddUnnamedTab | Messages of this type contain an IPWindow.AddTab(string) call
|
| WindowAddTab | Messages of this type contain an IPWindow.AddTab(string,string)
call |
| WindowSplitUnnamedPane | Messages of this type contain an IPWindow.SplitPane(string,PaneType)
call |
| WindowSplitPane | Messages of this type contain an IPWindow.SplitPane(string,string,string,PaneType)
call |
| WindowRemovePane | Messages of this type contain an IPWindow.RemovePane call |
| WindowSetFocus | Messages of this type contain an IPWindow.SetFocus(Persistent)
call |
| WindowSetListFocus | Messages of this type contain an IPWindow.SetFocus(Persistent,IPersistateList)
call |
| WindowSetPaneFocus | Messages of this type contain anIPWindow.SetFocus(string) call
|
| WindowWorkspaceGet | Messages of this type contain an IPWindow.Workspace property get access.
|
| WindowWorkspaceSet | Messages of this type contain an IPWindow.Workspace property set access.
|
| WindowSelectContainer | Messages of this type contain an IPWindow.SelectContainer call
|
| WindowLayoutStyleGet | Messages of this type contain an IPWindow.LayoutStyle property get access.
|
| WindowLayoutStyleSet | Messages of this type contain an IPWindow.LayoutStyle property set access.
|
| WindowGetPane | Messages of this type contain anIPWindow.GetPane call.
|
| GetObject | Messages of this type contain a GetObject object retrieval call.
|
| GetObjects | Messages of this type contain a GetObjects object retrieval call.
|
| GetSelectedObjects | Messages of this type contain a GetSelectedObjects object
retrieval call. |
| CountAssociationsTo | Messages of this type contain a CountAssociationsTo object
retrieval call. |
| GetAssociatorsTo | Messages of this type contain a GetAssociatorsTo object retrieval
call. |
| GetAssociatorsOfType | Messages of this type contain a GetAssociatorsTo{T} object
retrieval call. |
| CreateSession | Messages of this type start a new Session.
|
| Execute | Messages of this type contain an OperationExecution. |
| ExitSession | Messages of this type contain an exit operation execution.
|
| CallReturn | Messages of this type contain a return value from a method call.
|
| ErrorReturn | Messages of this type contain an error message return value.
|
| ObjectValue | Messages of this type contain a Persistent object
value. |
| ExecuteReturn | Messages of this type contain a return from execute call, including
details of object and list mutations. |
| Propagation | Messages of this type contain object and list mutations propagated
from Server to Viewer. |
| OpenRequest | Messages of this type are empty, and are used to leave open
request contexts in the server. |
| Ack | Messages of this type are an empty acknowledgement to a
non synchronous request or OpenRequest message. |
| Ping | Messages of this type are empty, and test server availability.
|
| TopValue | This value is used for validation, and is equal to highest
ordinal. |
RemarksThe
remainder of each message is interpreted according to this type.