Class AuiNotebook

Namespace: Alternet.UI

Assembly: Alternet.UI.dll

Notebook control, managing multiple windows with associated tabs. Used with AuiManager.

[ControlCategory("Containers")]
public class AuiNotebook : Control, IBaseObject, IDisposableObject, IInputElement, ISupportInitialize, IFocusable, IWin32Window, ITextProperty, IComponent, IDisposable

Inheritance: object

BaseObject

DisposableObject

DispatcherObject

DependencyObject

UIElement

FrameworkElement

Control

AuiNotebook

Implements: IBaseObject

IDisposableObject

IInputElement

ISupportInitialize

IFocusable

IWin32Window

ITextProperty

IComponent

IDisposable

Extension Methods: UixmlPortObjectExtensions.Bind(DependencyObject, DependencyProperty, Binding, object?)

Remarks

Example of how a AuiNotebook can look:

AuiNotebook

Properties

ControlKind: Returns control identifier.

CreateStyle: Defines visual style and behavior of the AuiNotebook control.

DefaultCreateStyle: Defines default visual style for the newly created AuiNotebook controls.

EventOldSelection: Gets index of the previously selected page passed in some event handlers.

EventSelection: Gets index of the currently selected page passed in the event handlers.

Pages: Gets the collection of tab pages in this control.

Methods

AddPage(Control, string, bool, ImageSet?): Adds a new page.

AdvanceSelection(bool): Selects next or previous page.

ChangeSelection(Control?): Changes selected page to the page which contains control.

ChangeSelection(int?): Changes the selection for the given page, returning the previous selection.

Clear(): Deletes all pages.

FindPage(Control?): Returns the page index for the specified control.

GetHeightForPageHeight(int): Gets the height of the notebook for a given page height.

GetPageCount(): Returns the number of pages in the notebook.

GetPageText(int): Returns the tab label for the page.

GetPageToolTip(int): Returns the tooltip for the tab label of the page.

GetSelection(): Returns the currently selected page index.

GetTabCtrlHeight(): Returns the height of the tab control.

InsertPage(int, Control, string, bool, ImageSet?): Inserts a new page at the specified position.

OnAllowTabDrop(EventArgs): Occurs when application needs to query whether to allow a tab to be dropped. This event must be specially allowed.

OnBeginDrag(EventArgs): Called when dragging is about to begin.

OnBgDoubleClick(EventArgs): Called when the mouse button is double clicked on the tabs background area.

OnDragDone(EventArgs): Called to notify that the tab has been dragged.

OnDragMotion(EventArgs): Called during a drag and drop operation.

OnEndDrag(EventArgs): Called when dragging has ended.

OnPageButton(EventArgs): Called when the window list button has been pressed.

OnPageChanged(EventArgs): Called when the page selection was changed.

OnPageChanging(EventArgs): Called when the page selection is about to be changed. This event can be vetoed.

OnPageClose(EventArgs): Called when a page is about to be closed.

OnPageClosed(EventArgs): Occurs when a page has been closed.

OnTabMiddleMouseDown(EventArgs): Called when the middle mouse button is pressed on a tab.

OnTabMiddleMouseUp(EventArgs): Called when the middle mouse button is released on a tab.

OnTabRightMouseDown(EventArgs): Called when the right mouse button is pressed on a tab.

OnTabRightMouseUp(EventArgs): Called when the right mouse button is released on a tab.

RemovePage(int): Removes a page, without deleting the attached control.

SetMeasuringFont(Font?): Sets the font for measuring tab labels.

SetNormalFont(Font?): Sets the font for drawing unselected tab labels.

SetPageBitmap(int, ImageSet?): Sets the bitmap for the page.

SetPageText(int, string): Sets the tab label for the page.

SetPageToolTip(int, string): Sets the tooltip displayed when hovering over the tab label of the page.

SetSelectedFont(Font?): Sets the font for drawing selected tab labels.

SetSelection(int): Sets the page selection.

SetTabCtrlHeight(int): Sets the tab height.

SetUniformBitmapSize(int, int): Ensures that all tabs have the same height, even if some of them don't have bitmaps.

ShowWindowMenu(): Shows the window menu for the active tab control associated with this notebook, and returns true if a selection was made.

Split(int, GenericDirection): Performs a split operation programmatically.

Events

AllowTabDrop: Occurs when application needs to query whether to allow a tab to be dropped. This event must be specially allowed.

BeginDrag: Occurs when dragging is about to begin.

BgDoubleClick: Occurs when the mouse button is double clicked on the tabs background area.

DragDone: Occurs to notify that the tab has been dragged.

DragMotion: Occurs during a drag and drop operation.

EndDrag: Occurs when dragging has ended.

PageButton: Occurs when the page button has been pressed.

PageChanged: Occurs when the page selection was changed.

PageChanging: Occurs when the page selection is about to be changed. This event can be vetoed.

PageClose: Occurs when a page is about to be closed.

PageClosed: Occurs when a page has been closed.

TabMiddleMouseDown: Occurs when the middle mouse button is pressed on a tab.

TabMiddleMouseUp: Occurs when the middle mouse button is released on a tab.

TabRightMouseDown: Occurs when the right mouse button is pressed on a tab.

TabRightMouseUp: Occurs when the right mouse button is released on a tab.