Class SuperState
The client's superstate Holds the view state of the web client
Inherited Members
Namespace: SuperOffice.Cache
Assembly: SuperOffice.DCF.dll
Syntax
public class SuperState
Constructors
SuperState()
Default constructor
Declaration
public SuperState()
Properties
BatchTaskTimeStamp
TimeStamp for the last time the invitations dialog was shown
Declaration
public DateTime BatchTaskTimeStamp { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime |
Current
The history list, ordered by the entity key Used for all history elements such as entities and lists
Declaration
public Dictionary<string, List<HistoryItem>> Current { get; set; }
Property Value
| Type | Description |
|---|---|
| Dictionary<String, List<HistoryItem>> |
CurrentMainPage
The current main page.
Declaration
public PageState CurrentMainPage { get; }
Property Value
| Type | Description |
|---|---|
| PageState |
CurrentMainPageId
The id of the current main page. This is used to remember what the main page is when running inside dialogs
Declaration
public string CurrentMainPageId { get; set; }
Property Value
| Type | Description |
|---|---|
| String |
CurrentPage
The page that is active for the current request
Declaration
public PageState CurrentPage { get; set; }
Property Value
| Type | Description |
|---|---|
| PageState |
CurrentTriggers
The list of current types that the superstate depends on
Declaration
public List<string> CurrentTriggers { get; set; }
Property Value
| Type | Description |
|---|---|
| List<String> |
HistorySaveTimeStamp
TimeStamp for the last history save
Declaration
public DateTime HistorySaveTimeStamp { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime |
MainPageHeight
The pixel height of the main page
Declaration
public int MainPageHeight { get; set; }
Property Value
| Type | Description |
|---|---|
| Int32 |
MainPageWidth
The pixel width of the main page
Declaration
public int MainPageWidth { get; set; }
Property Value
| Type | Description |
|---|---|
| Int32 |
MiniPanelDictionary
Dictionary of all current Main panel vs MiniPanel combinations The key will match the SuperOffice.Data.MainView enumeration for known main views The value will match the SuperOffice.Data.MiniPanel enumeration for known mini panels
Declaration
public Dictionary<string, string> MiniPanelDictionary { get; set; }
Property Value
| Type | Description |
|---|---|
| Dictionary<String, String> |
PageHasChanged
The client's superstate Holds the view state of the web client
Declaration
public bool PageHasChanged { get; set; }
Property Value
| Type | Description |
|---|---|
| Boolean |
Pages
The collection of all active pages
Declaration
public Dictionary<string, PageState> Pages { get; set; }
Property Value
| Type | Description |
|---|---|
| Dictionary<String, PageState> |
Params
Custom parameters collection used to store miscellaneous superstate and layout data
Declaration
public Dictionary<string, string> Params { get; set; }
Property Value
| Type | Description |
|---|---|
| Dictionary<String, String> |
PeriodicHistorySave
The time period (in minutes) between each history save
Declaration
public int PeriodicHistorySave { get; set; }
Property Value
| Type | Description |
|---|---|
| Int32 |
PeriodicShowInvitations
The time period (in minutes) between each check for new invitations
Declaration
public int PeriodicShowInvitations { get; set; }
Property Value
| Type | Description |
|---|---|
| Int32 |
PreviousPage
The previous page state
Declaration
public PageState PreviousPage { get; set; }
Property Value
| Type | Description |
|---|---|
| PageState |
RequestedCurrentList
The active current value. Current values often set other current values as well. This is the current that started the avalanche
Declaration
public string RequestedCurrentList { get; set; }
Property Value
| Type | Description |
|---|---|
| String |
ShowInvitationsTimeStamp
TimeStamp for the last time the invitations dialog was shown
Declaration
public DateTime ShowInvitationsTimeStamp { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime |
WebAppUsage
The client's superstate Holds the view state of the web client
Declaration
public Dictionary<string, WebAppUsage> WebAppUsage { get; set; }
Property Value
| Type | Description |
|---|---|
| Dictionary<String, WebAppUsage> |
WindowsPosSize
Dictionary of all the current window positions and sizes
Declaration
public Dictionary<string, WindowPosSize> WindowsPosSize { get; set; }
Property Value
| Type | Description |
|---|---|
| Dictionary<String, WindowPosSize> |