Property | Type | Description | |
---|---|---|---|
kDefaultTreeBarWidth | int | ||
m_adapters | Set |
||
m_bar | System.Windows.Forms.StatusBar | ||
m_largeImages | ImageCollection | ||
m_mainContentControl | |||
m_mainSplitContainer | XCore.CollapsingSplitContainer | ||
m_mediator | XCore.Mediator | ||
m_menuBarAdapter | IUIAdapter | ||
m_menusChoiceGroupCollection | XCore.ChoiceGroupCollection | ||
m_persistWindowSize | bool | ||
m_rebarAdapter | IUIAdapter | ||
m_sidebar | |||
m_sidebarAdapter | IUIAdapter | ||
m_sidebarChoiceGroupCollection | XCore.ChoiceGroupCollection | ||
m_smallImages | ImageCollection | ||
m_statusPanels | StatusBarPanel>.Dictionary | ||
m_toolbarsChoiceGroupCollection | XCore.ChoiceGroupCollection | ||
m_windowConfigurationNode |
Property | Type | Description | |
---|---|---|---|
BootstrapPart1 | void | ||
FindControl | |||
GetAdapterAssembly | |||
GetContextMenuNodeFromMenuId | |||
InitializeComponent | void | ||
IsFunctionKey | bool | ||
LoadDefaultProperties | void | ||
LoadListeners | void | ||
LoadResources | void | ||
MoveToNextPane | |||
OnMainSplitterMoved | void | ||
OnSecondarySplitterMoved | void | ||
RestoreWindowSettings | void | ||
ResumeLayoutAll | void | ||
SaveSplitterDistance | int | ||
SetApplicationName | void | ||
SetInitialContentObject | void | ||
SetSizingGripState | void | ||
SetSplitContainerDistance | void | ||
SetToolDefaultProperties | void | ||
ShutDownPart1 | void | ||
ShutDownPart2 | void | ||
SuspendLayoutAll | void | ||
SynchronizedOnIdleTime | void | ||
UpdateSidebarAndRecordBarDisplay | void | ||
WidgetUpdateTimer_Tick | void | ||
XWindow_Activated | void | ||
XWindow_KeyDown | void | ||
XWindow_KeyUp | void | ||
XWindow_Move | void | ||
XWindow_Resize | void |
Method | Description | |
---|---|---|
AddLargeImageList ( |
||
AddSmallImageList ( |
Note that the first image of the first list is the default image for cases where the specified image is not declared war is not found. this method allows the containing application or a subclass to directly add images. We might want to retire this as unnecessary since images can now be added via the configuration file. |
|
CheckDisposed ( ) : void |
Check to see if the object has been disposed. All public Properties and Methods should call this before doing anything else.
|
|
ClearRecordBarList ( ) : void | ||
FocusedControl ( ) : |
The control currently in focus.
|
|
GetChoiceGroupForMenu ( string menuId ) : XCore.ChoiceGroup |
get the choice group corresponding to a menuid
|
|
GetMessageTargets ( ) : IxCoreColleague[] |
return an array of all of the objects which should 1) be queried when looking for someone to deliver a message to 2) be potential recipients of a broadcast
|
|
GetToolIdFromControlConfiguration ( |
given a control configuration node, find the (parent) tool id.
|
|
GetWindowsFormsContextMenu ( string menuId ) : |
regardless of the adapter, this returns a standard Windows forms context menu for cases where the caller really needs to access the contents of the menu, for example when turning the menu into hyperlinks. note that this menu will not actually do anything; the caller will have to hook the items up to real events.
|
|
Init ( XCore.Mediator mediator, |
Initialize this has an IxCoreColleague
|
|
LoadConfigurationWithIncludes ( string configurationPath ) : |
Loads the configuration file at the specified path and resolves any nodes that need to get included from other files indicated by internal relative paths.
|
|
LoadConfigurationWithIncludes ( string configurationPath, bool skipMissingFiles ) : |
Loads the configuration file at the specified path and resolves any nodes that need to get included from other files indicated by internal relative paths.
|
|
LoadUI ( Stream configStream ) : void |
Loads the UI from an XML document embedded in a stream
|
|
LoadUI ( string configurationPath ) : void |
Loads the UI from an XML file
|
|
OnCloseWindow ( object sender ) : bool |
Handles "Close" menu command.
|
|
OnPrepareToRefresh ( object sender ) : bool |
Called through FwXWindow.OnMasterRefresh (and perhaps eventually others), gives the window a chance to save anything in progress before the Refresh updates the cache. Possibly this should be allowed to fail and abort the Refresh, if PrepareToGoAway fails?
|
|
OnPropertyChanged ( string name ) : void |
Receives the broadcast message "PropertyChanged"
|
|
OnSetInitialContentObject ( object windowConfigurationNode ) : bool |
this is called by xWindow just before it sets the initial control which will actually take over the content area. if no listener response to this message first, then this is called and we determine the controlled by looking at the " this handler relies on the configuration file having a |
|
OnShowNotification ( object notificationText ) : bool | ||
ResumeIdleProcessing ( ) : void |
See SuspentIdleProcessing.
|
|
ResumeWindowSizePersistence ( ) : void |
See SuspentWindowSizing.
|
|
SaveSettings ( ) : void |
Saves the property table (global) settings Subclasses can override to save local settings.
|
|
ShowContextMenu ( string menuId, Point location, XCore.TemporaryColleagueParameter temporaryColleagueParam, XCore.MessageSequencer sequencer ) : void |
Get a context menu for the specified menu id, and in addition.
|
|
ShowContextMenu ( string menuId, Point location, XCore.TemporaryColleagueParameter temporaryColleagueParam, XCore.MessageSequencer sequencer, Action |
Get a context menu for the specified menu id, and in addition.
|
|
SuspendIdleProcessing ( ) : void |
Call this for the duration of a block of code where we don't want idle events. (Note that various things outside our control may pump events and cause the timer that fires the idle events to be triggered when we are not idle, even in the middle of processing another event.) Call ResumeIdleProcessing when done.
|
|
SuspendWindowSizePersistence ( ) : void |
Call this for the duration of a block of code outside of xWindow that might update the size of the window (OnCreateHandle, for instance) without regard to the Mediator PropertyTable. Call ResumeWindowSizing when done.
|
|
UpdateControls ( ) : void |
Update controls to a suitable state. This is done regularly during idle time while the window is active. Ideally it should be done once at startup (otherwise the toolbar may not appear, LT-12845) at startup, even if the window does NOT become active.
|
|
XWindow ( ) : System |
Initializes a new instance of the XCoreMainWnd class.
|
Method | Description | |
---|---|---|
ChangeContentObjectIfPossible ( string contentAssemblyPath, string contentClass, |
Create and install an object to fill the content area of the window, after asking the current content object if it is willing to go away.
|
|
CreateStatusBar ( |
||
DiscardProperties ( ) : void |
If we don't RestoreProperties we may need to discard some information. For example if we are discarding a saved filter we need to discard the saved object sequences.
|
|
Dispose ( bool disposing ) : void |
Clean up any resources being used.
|
|
LoadStringTableIfPresent ( string configurationPath ) : void |
Create our string localization object, based on the directory containing the configuration file for this application.
|
|
LoadUIFromXmlDocument ( |
Load UI from an XML document
|
|
MakeGroupSet ( |
||
MakeMajorUIPortion ( |
sets up either the menubar, toolbar collection, or sidebar
|
|
MakeMajorUIPortion ( |
sets up either the menubar, toolbar collection, or sidebar
|
|
OnHandleCreated ( |
||
OnKeyDown ( |
||
OnLayout ( System.Windows.Forms.LayoutEventArgs levent ) : void | ||
OnListBarSelect ( object sender, |
||
OnLoad ( |
||
OnResize ( |
||
OnShown ( |
||
OnTreeBarAfterSelect ( object sender, |
||
RestoreProperties ( ) : void |
Restore properties persisted for the mediator.
|
|
UpdateCaptionBar ( ) : void |
Show the document name and application name in the caption bar.
|
|
WarmBootPart1 ( ) : void |
Start the window almost from scratch. This is needed to fix the full refresh behavior of wiping out everything in the caches.
|
|
WarmBootPart2 ( ) : void |
Start the window almost from scratch. This is needed to fix the full refresh behavior of wiping out everything in the caches. Callers may need to stuff things in the Mediator or its PropertyTable. They should do that between calling WarmBootPart1 and this method.
|
|
WndProc ( Message &m ) : void | ||
XWindow_Closing ( object sender, System e ) : void |
Method | Description | |
---|---|---|
BootstrapPart1 ( ) : void | ||
FindControl ( |
||
GetAdapterAssembly ( ) : |
||
GetContextMenuNodeFromMenuId ( string menuId ) : |
||
InitializeComponent ( ) : void | ||
IsFunctionKey ( Keys keys ) : bool | ||
LoadDefaultProperties ( |
||
LoadListeners ( |
||
LoadResources ( |
||
MoveToNextPane ( bool fForward ) : |
Move focus to next/previous pane. 'Pane' here means: 1. the Sidebar (m_sidebar), 2. the record list, (if showing at all, m_recordBar), 3. the first or second control of a MultiPane, or a parent MultiPane. 4. the main content control, if is not a MultiPane, or 'focusedControl' is not contained in a MultiPane.
|
|
OnMainSplitterMoved ( object sender, System.Windows.Forms.SplitterEventArgs e ) : void |
Note: The CollapsingSplitContainer class has its own event handler, which will be run, along with this one.
|
|
OnSecondarySplitterMoved ( object sender, System.Windows.Forms.SplitterEventArgs e ) : void |
Note: The CollapsingSplitContainer class has its own event handler, which will be run, along with this one.
|
|
RestoreWindowSettings ( bool wasCrashDuringPreviousStartup ) : void | ||
ResumeLayoutAll ( ) : void | ||
SaveSplitterDistance ( XCore.CollapsingSplitContainer splitContainer ) : int | ||
SetApplicationName ( ) : void | ||
SetInitialContentObject ( |
||
SetSizingGripState ( ) : void |
Add/Remove sizing grip from the status bar. See LT-9851. It seems there is a bug in the way that Windows draws the size grip on the status bar at 120dpi. It overlaps the the adjacent StatusBarPanel and can cut off text, so we draw it ourself.
|
|
SetSplitContainerDistance ( XCore.CollapsingSplitContainer splitCont, int pixels ) : void | ||
SetToolDefaultProperties ( |
||
ShutDownPart1 ( ) : void |
This is the first of two parts in doing a warm boot/shut down. It is called before calling the base Dispose method in the Dispose system.
|
|
ShutDownPart2 ( ) : void |
This is the second of two parts in doing a warm boot/shut down. It is called after calling the base Dispose method in the Dispose system.
|
|
SuspendLayoutAll ( ) : void | ||
SynchronizedOnIdleTime ( ) : void | ||
UpdateSidebarAndRecordBarDisplay ( bool suspendAndResumeLayout ) : void |
handle the visibility and sizing of the sidebar and tree bars, along with their splitters.
|
|
WidgetUpdateTimer_Tick ( object sender, System e ) : void | ||
XWindow_Activated ( object sender, System e ) : void | ||
XWindow_KeyDown ( object sender, System e ) : void | ||
XWindow_KeyUp ( object sender, System e ) : void | ||
XWindow_Move ( object sender, |
||
XWindow_Resize ( object sender, |
public AddLargeImageList ( |
||
images | ||
labels | string | |
return | void |
public AddSmallImageList ( |
||
images | ||
labels | string | |
return | void |
protected ChangeContentObjectIfPossible ( string contentAssemblyPath, string contentClass, |
||
contentAssemblyPath | string | |
contentClass | string | |
contentClassNode | ||
return | void |
protected CreateStatusBar ( |
||
windowConfigurationNode | ||
return | void |
protected Dispose ( bool disposing ) : void | ||
disposing | bool | |
return | void |
public static FocusedControl ( ) : |
||
return |
public GetChoiceGroupForMenu ( string menuId ) : XCore.ChoiceGroup | ||
menuId | string | |
return | XCore.ChoiceGroup |
public GetMessageTargets ( ) : IxCoreColleague[] | ||
return | IxCoreColleague[] |
public static GetToolIdFromControlConfiguration ( |
||
configurationNode | ||
return | string |
public GetWindowsFormsContextMenu ( string menuId ) : |
||
menuId | string | |
return |
public Init ( XCore.Mediator mediator, |
||
mediator | XCore.Mediator | |
configurationParameters | ||
return | void |
public static LoadConfigurationWithIncludes ( string configurationPath ) : |
||
configurationPath | string | |
return |
public static LoadConfigurationWithIncludes ( string configurationPath, bool skipMissingFiles ) : |
||
configurationPath | string | |
skipMissingFiles | bool | if true, missing files are skipped rather than throwing exception |
return |
protected LoadStringTableIfPresent ( string configurationPath ) : void | ||
configurationPath | string | |
return | void |
public LoadUI ( Stream configStream ) : void | ||
configStream | Stream | Stream with XML document |
return | void |
public LoadUI ( string configurationPath ) : void | ||
configurationPath | string | Path and name of an XML file |
return | void |
protected LoadUIFromXmlDocument ( |
||
configuration | ||
configurationPath | string | |
return | void |
protected MakeGroupSet ( |
||
m_windowConfigurationNode | ||
adapter | IUIAdapter | |
elementName | string | |
return | XCore.ChoiceGroupCollection |
protected MakeMajorUIPortion ( |
||
adaptorAssembly | ||
m_windowConfigurationNode | ||
elementName | string | |
adapterClass | string | |
control | System | |
return | XCore.ChoiceGroupCollection |
protected MakeMajorUIPortion ( |
||
adaptorAssembly | ||
m_windowConfigurationNode | ||
elementName | string | |
adapterClass | string | |
control | System | |
adapter | IUIAdapter | |
return | XCore.ChoiceGroupCollection |
public OnCloseWindow ( object sender ) : bool | ||
sender | object | |
return | bool |
protected OnHandleCreated ( |
||
e | ||
return | void |
protected OnKeyDown ( |
||
e | ||
return | void |
protected OnLayout ( System.Windows.Forms.LayoutEventArgs levent ) : void | ||
levent | System.Windows.Forms.LayoutEventArgs | |
return | void |
protected OnListBarSelect ( object sender, |
||
sender | object | |
e | ||
return | void |
public OnPrepareToRefresh ( object sender ) : bool | ||
sender | object | |
return | bool |
public OnPropertyChanged ( string name ) : void | ||
name | string | |
return | void |
protected OnResize ( |
||
e | ||
return | void |
public OnSetInitialContentObject ( object windowConfigurationNode ) : bool | ||
windowConfigurationNode | object | |
return | bool |
public OnShowNotification ( object notificationText ) : bool | ||
notificationText | object | |
return | bool |
protected OnTreeBarAfterSelect ( object sender, |
||
sender | object | |
e | ||
return | void |
public ResumeWindowSizePersistence ( ) : void | ||
return | void |
public ShowContextMenu ( string menuId, Point location, XCore.TemporaryColleagueParameter temporaryColleagueParam, XCore.MessageSequencer sequencer ) : void | ||
menuId | string | |
location | Point | |
temporaryColleagueParam | XCore.TemporaryColleagueParameter | |
sequencer | XCore.MessageSequencer | |
return | void |
public ShowContextMenu ( string menuId, Point location, XCore.TemporaryColleagueParameter temporaryColleagueParam, XCore.MessageSequencer sequencer, Action |
||
menuId | string | |
location | Point | |
temporaryColleagueParam | XCore.TemporaryColleagueParameter | |
sequencer | XCore.MessageSequencer | |
adjustMenu | Action |
|
return | void |
public SuspendWindowSizePersistence ( ) : void | ||
return | void |
protected XWindow_Closing ( object sender, System e ) : void | ||
sender | object | |
e | System | |
return | void |
protected static int kDefaultTreeBarWidth | ||
return | int |
protected StatusBar,System.Windows.Forms m_bar | ||
return | System.Windows.Forms.StatusBar |
protected Control,System.Windows.Forms m_mainContentControl | ||
return |
protected CollapsingSplitContainer,XCore m_mainSplitContainer | ||
return | XCore.CollapsingSplitContainer |
protected ChoiceGroupCollection,XCore m_menusChoiceGroupCollection | ||
return | XCore.ChoiceGroupCollection |
protected Control,System.Windows.Forms m_sidebar | ||
return |
protected ChoiceGroupCollection,XCore m_sidebarChoiceGroupCollection | ||
return | XCore.ChoiceGroupCollection |
protected Dictionary |
||
return | StatusBarPanel>.Dictionary |
protected ChoiceGroupCollection,XCore m_toolbarsChoiceGroupCollection | ||
return | XCore.ChoiceGroupCollection |