[ContentProperty("Items")]
[Handler(MenuBar.IHandler)]
public class MenuBar : Menu, ISubmenu, IBindableWidgetContainer
Menu bar for a form
Constructors
Properties
AboutItem
#Gets or sets the item to show an about dialog for the application
Remarks: This allows you to set an item to show an about dialog for the application. OS X will place this in the Application menu, other platforms place this at the bottom of the Help menu.
Value: The about item on the menu.
ApplicationItems
#Gets the item collection for the ApplicationMenu, to easily add items declaratively/programatically.
Value: The application items collection.
See Also: ApplicationMenu
Bindings
Gets the collection of bindings that are attached to this widget
Remarks: This can sometimes be useful to get the platform-specific object. Some handlers may not have any backing object for its functionality, so this may be null. It is more preferred to use the Widget.Handler and cast that to the platform-specific handler class which can give you additional methods and helpers to do common tasks. For example, the Application object's handler for OS X has a AddFullScreenMenuItem property to specify if you want full screen support in your app.
DataContext
Gets or sets the data context for this widget for binding
Remarks: Subclasses may override the standard behaviour so that hierarchy of widgets can be taken into account. For example, a Control may return the data context of a parent, if it is not set explicitly.
Implements: DataContext
HelpItems
#Gets the item collection for the HelpMenu, to easily add items declaratively/programatically.
Value: The help items collection.
IncludeSystemItems
#Gets or sets which system items will be automatically included with the menu.
Remarks: Some operating systems, such as OS X require you to create your own standard items to enable the ability to do things such as close a window, cut/paste, hide apps, quit an app, etc. By default, the menu will be merged with your custom menu so that all of these system functions will work. For Quit and About menu items, use the QuitItem and AboutItem instead so that they are placed in the correct/expected location on every platform.
Value: The include system items.
IsDataContextChanging
Gets a value indicating that the BindableWidget.DataContext property is changing.
Remarks: This can be used to determine when to allow certain logic during the update of the data context. It is used to disable binding setters on the model when the data context changes so that a binding does not cause the view model to be updated when the state hasn't been fully set yet.
Value:
true if the DataContext is currently changing, false otherwise.Implements: IsDataContextChanging
IsDisposed
Gets or sets a value indicating whether this Widget has been disposed.
Remarks: When the widget is disposed, it can no longer be used.
Value:
true if this instance has been disposed; otherwise, false.NativeHandle
public nint NativeHandle { get; }
Gets the native platform-specific handle for integration purposes
Value: The native handle.
Parent
Gets or sets the parent widget which this widget has been added to, if any
Remarks: When implementing child widgets that can participate in the context based binding (MVVM), You can set this to the parent widget when it is added or removed to it (usually via a collection). Note that you should typically provide a
public new [ParentWidget] Parent { get; } property so that consumers of your API cannot set the parent to an invalid value.Value: The parent widget, or null if there is no parent
Parents
Gets an enumeration of all parent widgets in the heirarchy by traversing the BindableWidget.Parent property.
inherited fromWidget
Remarks: This gets set to the current Platform.Instance during the construction of the object
QuitItem
#Gets or sets the quit item for the application.
Remarks: This allows you to set the quit item for the application. Some platforms (OS X) may add a quit item to the menu even if one is not defined as it is standard practice to allow users to quit the application with a menu item. This will be in the File menu for most platforms, and the Application menu for OS X.
Value: The quit item on the menu.
Remarks: Styles allow you to attach custom platform-specific logic to a widget. In your platform-specific assembly, use Add{H} to add the style logic with the same id.
Example:
// in your UI
var control = new Button { Style = "mystyle" };
// in your platform assembly
using Eto.Mac.Forms.Controls;
Styles.AddHandler<ButtonHandler>("mystyle", handler => {
// this is where you can use handler.Control to set properties, handle events, etc.
handler.Control.BezelStyle = NSBezelStyle.SmallSquare;
});SystemCommands
#Gets the system commands for the menu.
Remarks: These system commands are used for any of the items added when IncludeSystemItems is set to anything other than MenuBarSystemItems.None. You can modify this collection to remove items from the system menu, or update which items should be used instead. This is only needed for advanced scenarios and should not be required to be used in normal circumstances.
Value: The system commands.
Methods
Dispose
public void Dispose()
Disposes of this widget, supressing the finalizer
Parameters:
| disposing (bool) | True if the caller called Widget.Dispose() manually, false if being called from a finalizer |
FindParent<T>
Finds a control in the parent hierarchy with the specified type and Widget.ID if specified
Parameters:
| id (string = null) | Identifier of the parent control to find, or null to ignore |
Returns: The parent if found, or null if not found
FindParent
Finds a control in the parent hierarchy with the specified type and Widget.ID if specified
GetCallback
Gets an instance of an object used to perform callbacks to the widget from handler implementations
Remarks: The callback should implement the parent class' Widget.ICallback interface so that there only needs to be a single callback for the entire hierarchy. This should return a static instance to avoid having overhead for each instance of your control.
Returns: The callback instance to use for this widget
Initialize
protected void Initialize()
Initializes the widget handler
Remarks: This is typically called from the constructor after all of the logic is completed to construct the object. If your handler interface has the AutoInitializeAttribute set to false, then you are responsible for calling this method in your constructor after calling the creation method on your custom handler.
inherited fromBindableWidget
Remarks: Implementors may override this to fire this event on child widgets in a heirarchy. Alternatively, implement IBindableWidgetContainer for your widget and this will trigger any events on the children automatically. This allows a control to be bound to its own BindableWidget.DataContext, which would be set on one of the parent control(s).
Parameters:
| e (EventArgs) | Event arguments |
OnLoad
#Called when the menu is assigned to a control/window
Parameters:
| e (EventArgs) | Event arguments |
Overrides: Menu.OnLoad
OnPreLoad
#Called before the menu is assigned to a control/window
Parameters:
| e (EventArgs) | Event arguments |
Overrides: Menu.OnPreLoad
inherited fromWidget
OnUnLoad
#Called when the menu is removed from a control/window
Parameters:
| e (EventArgs) | Event arguments |
Overrides: Menu.OnUnLoad
ToString
Gets a string that represents the current object with its ID if specified.
Returns: A string value indicating the type and ID (if specified) of this widget.
Overrides: Object.ToString
Unbind
public virtual void Unbind()
Unbinds any bindings in the BindableWidget.Bindings collection and removes the bindings
Remarks: When you implement IBindableWidgetContainer, this will also unbind any of its children.
UpdateBindings
Updates all bindings in this widget
Remarks: When you implement IBindableWidgetContainer, this will also update bindings for all of its children.
Parameters:
| mode (BindingUpdateMode = BindingUpdateMode.Source) |
Events
inherited fromBindableWidget
Remarks: This may be fired in the event of a parent in the hierarchy setting the data context. For example, the Container widget fires this event when it's event is fired.
Implements: DataContextChanged
inherited fromWidget