C# Class SIL.FieldWorks.Common.UIAdapters.TMAdapter

Adds a new menu item to a context menu specified by contextMenuName and inserts it before the item specified by insertBeforeItem. If insertBeforeItem is null, then the new menu item is added to the end of parentItemName's menu collection.

Adds a new menu item to a context menu specified by contextMenuName and inserts it before the item specified by insertBeforeItem. If insertBeforeItem is null, then the new menu item is added to the end of parentItemName's menu collection. This overload allows new menu items to be added as submenus to menus at the top level of the context menu. The parentMenuName can be the name of a menu item at any level within the hierarchy of the menus on the context menu.

Adds a new submenu item to the menu specified by parentItemName and inserts it before the item specified by insertBeforeItem. If insertBeforeItem is null, then the new submenu item is added to the end of parentItemName's menu collection.

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Gets the control contained within a control container toolbar item.

Gets the properties of a toolbar.

Loads a TMItemProperties object with several properties from a toolbar item.

Allows an application to force the hiding of a toolbar item's popup control.

Allows an application to hide a toolbar.

Determines whether the specified Keys is a shortcut for a toolbar or menu item.

Pops-up a menu so it shows like a context menu. If the item doesn't have any sub items, then this command is ignored.

Pops-up a menu so it shows like a context menu. If the item doesn't have any sub items, then this command is ignored.

Removes the specified item from the specified parent menu.

Removing submenu items on a menu, while leaving the parent menu intact has not been tested (and is not currently needed).

Removes all the subitems of the specified menu.

Causes the adapter to save toolbar settings (e.g. user placement of toolbars).

Sets the properties of the main menu bar. object.

Sets properties for a menu bar or toolbar.

Sets the context menu for a specified control.

Sets some of a toolbar item's properties. Note: if the Update property in the TMItemProperties object hasn't been set to true, no updating will occur.

Sets the adapter's parent form. This will not cause docking sites to be added to the form and DotNetBar manager. This solves TE-6793

Causes the adapter to show it's dialog for customizing toolbars.

Allows an application to show a toolbar.

This is a helper method for the HandleMenuPopups and HandleItemUpdates methods. It accepts a single DNB item and calls it's update handler, if there is one.

This is a helper method for the HandleMenuOpening and HandleItemUpdates methods. It calls the update handler for the specified ToolStripItem item.

Calls the update handlers for collection.

Loads a named assembly.

Gets an attribute's value from the specified node.

Gets an item's command handling message from the appropriate hash table entry.

Gets an item's command handling message from the appropriate hash table entry.

Gets a toolbar item with the specified name. If the item exists, then return the one found in the DNB manager. Otherwise, create a new one.

Gets a toolbar item with the specified name. If the item exists, return it. Otherwise, create a new one.

Handles the building window list.

Handles the Disposed event of the m_msgMediator control.

Send a message to anyone who cares that the drop down is closing.

Reads the commands section of a definition file.

Skips over white space and any other junk that's not considered an element or end element.

Read the information for a single menu item from the specified node.

Read the information for a single menu item from the specified node.

Locate the toolbars when their parent form is shown.

Finds the item specified by refItemName and Adds the specified item to the ref. item's collection of sub items.

Finds the item specified by refItemName and Adds the specified item to the ref. item's collection of sub items.

At this point, the item passed to this method has not been added to any toolbar or menu. Before doing so, we need to add it to the DNB Manager because that internally (to the DNB manager) assigns the item to its category and makes it available for customization purposes through DNB's customize dialog. But, only add an item if there is a category for the item and if the item is not a ControlContainerItem. We don't allow ControlContainerItems because it appears DotNetBar's customize dialog doesn't allow dragging new copies of ControlContainerItems to user-defined toolbars. And if they don't allow that, I don't want them in the list appearing like they should be able to be dragged to new toolbars. This means a DotNetBar manager may only have one (visible - See comments in HandleControlContainerLoadRequests) instance of application-defined toolbar items.

This method gets the combobox items and fires the InitializeComboItem event in case the application wants to initialize the combo box.

If the toolbar has a settings file (i.e. a file that was saved when the application was last closed) then restore the toolbar from it.

Initialize list of available toolbars.

Determines whether or not a menu should be allowed to be popped-up (See TE-6553).

Determines whether or not a menu should be allowed to be popped-up (See TE-6553).

Checks if the current adapter assembly version has changed since the last time the application was run.

This method checks the date and time of the TM definition files to see if they are newer than they were the last time the application was run. If one or more of them are newer, then all the toolbar settings files written by DotNetBar are deleted so the toolbars will be completely reconstructed from the TM definition files.

Clear out the window list after it's parent closes.

Creates one of three different types of drop-down toolbar items.

Creates a normal (in the sense that it's not a combo box, custom control, drop-down item, etc.) toolbar item.

Deletes the toolbar settings files created by DotNetBar in the SaveSettings method.

Search recursively through the a menu and any submenus for the specified menu name.

Format a date/time in our custom format

Gets a custom control and return it in a returned ToolStripControlHost.

Get the date/time for a file in UTC. We do this to get the date/time in a consistent format without milliseconds.

Loads a TMItemProperties object with several properties from a toolbar item.

Loads a TMItemProperties object with several properties from a toolbar item.

Examines the XML definition files to find which one (if any) have the prefix used for storing toolbar settings.

Returns a display style read from a toolbar item node.

This method gets called by the DotNetBar manager when it needs a control to load into a ControlContainerItem. The adapter then, fires the LoadControlContainerItem event to allow applications to give the adapter an application-defined control.

This method gets called whenever a customize menu (i.e. the menu that pops-up when clicking or hovering over the "Add or Remove Buttons" item) opens or closes. When the menu opens, a flag is set so item updates are not performed (in the HandleItemUpdates method). I found that when the menu popped-up and HandleItemUpdates iterated through the items, sometimes the iterating through the items seemed to grab some of the items on the customize menu. Iterating through the items the way I did in HandleItemUpdates should never have returned items that show up on the customize menu, but it happened and I think there's a DNB bug. This works around it.

This gets called when the DotNetBar requests a localized version of a string for displaying in places like the dialog that lets the user configure toolbars (e.g. show/hide toolbars, add new ones, etc.).

This method handles clicks on toolbar/menu items.

While the system is idle (or about to become so), this method will go through all the toolbar items and make sure they are enabled properly for the current view. Then it will go through the menu items with shortcuts to make sure they're enabled properly. (This is only done every 0.75 seconds.)

Handles clicks on the drop-down portion of a popup button (i.e. a click on the arrow portion of a two-segmented toolbar button).

Handles the restoring visibility of ToolStripSeparators hidden in HideInitialSeparators.

When a menu item is popped-up, then cycle through the subitems and call update handlers.

Determines whether or not a menu should be allowed to be popped-up (See TE-6553).

When a popup menu is closed, begin showing tooltips again. Also, if there were items to remove from the menu, remove them from the menu.

When a menu item is popped-up, then cycle through the subitems and call update handlers.

Handles clicks on the drop-down portion of a popup button (i.e. a click on the arrow portion of a two-segmented toolbar button).

While the system is idle (or about to become so), this method will go through all the toolbar items and make sure they are enabled properly for the current view. Then it will go through the menu items with shortcuts to make sure they're enabled properly. (This is only done every 0.75 seconds.)

Trap this event so we can clear the toolbar list item when it closes.

This catches all item customize events and only cares about the ones where the user is adding custom toolbars. By default, when adding custom toolbars, the DotNetBar manager makes them floating and puts them in the upper left corner of the screen. I thought that was not very user friendly so I trap the addition of new toolbars and dock them to the top of the application window.

Clear out the window list after it's parent closes.

Goes through the collection of ToolStripItems in the specified drop-down and hides the first visible item if it's a ToolStripSeparator. If the second (or beyond) item is also visible and a ToolStripSeparator, then it/they won't be hidden. We have our limits. If that becomes a problem, then ENHANCE: to cover that problem.

Creates a DotNetBar manager.

This method initializes a toolbar or menu item's properties.

This method initializes a toolbar or menu item's properties.

Creates a ToolStripContainer control.

Compares the locations and visibility of two toolstrip objects.

This method gets the customize items for all the toolbars and subscribes to the ExpandChange event so we know when customize menus open and close.

Finds the item specified by refItemName and inserts the specified item before it in the collection to which refItemName belongs.

Finds the item specified by refItemName and inserts the specified item before it in the collection to which refItemName belongs.

Load tool bar settings from the registry, if available.

Positions the toolbars to the positions specified in the xml deffinition file. This method only gets called when tool bar locations and visibilities cannot be found in the registry.

Make a new toolbar and initialize it based on what's in the XML definition.

Make a new toolbar and initialize it based on what's in the XML definition.

Parse our custom date/time string. If the string is not valid, then return an empty date/time

Parses the specified shortcut key string.

Positions the toolbars to the positions specified in the xml deffinition file.

Builds all context menus, adding them to the DNB manager's list of context menus.

Get the images from the resource specified in the XML definition.

Recursively builds menus.

Reads the strings to localize what DotNetBar uses internally (e.g. on their customize toolbar dialog).

Iterates through the toolbar definitions to read the XML.

Remove a list of context menu sub items found in the tag property of the specified context menu.

Sets properties for a menu bar or toolbar.

Sets properties for a menu bar or toolbar.

Sets the properties for a ButtonItem type toolbar button.

Sets the items in the Items collection for a ComboBoxItem type toolbar item.

Sets the items in the Items collection for a ComboBoxItem type toolbar item.

Sets some of a menu/toolbar item's properties. Note: if the Update property in the TMItemProperties object hasn't been set to true, no updating will occur. Items that can be set are: Text, Category, Tooltip, Enabled, Visible, BeginGroup, Checked, Image, List, Tag, and CommandId;

Sets some of a menu/toolbar item's properties. Note: if the Update property in the TMItemProperties object hasn't been set to true, no updating will occur. Items that can be set are: Text, Category, Tooltip, Enabled, Visible, BeginGroup, Checked, Image, List, Tag, and CommandId;

Creates a DotNetBar docking site for a DotNetBar toolbar.