Table of Contents

Class OutlookBar

Namespace
HeBianGu.Control.OutlookBar
Assembly
HeBianGu.Control.OutlookBar.dll
[TemplatePart(Name = "PART_MinimizedContainer")]
public class OutlookBar : HeaderedItemsControl, IAnimatable, ISupportInitialize, IFrameworkInputElement, IInputElement, IQueryAmbient, IContainItemStorage, IAddChild, IKeyTipControl
Inheritance
OutlookBar
Implements
Inherited Members
Extension Methods

Constructors

OutlookBar() 

public OutlookBar()

Fields

ButtonHeightProperty 

public static readonly DependencyProperty ButtonHeightProperty

Field Value

DependencyProperty

CanResizeProperty 

public static readonly DependencyProperty CanResizeProperty

Field Value

DependencyProperty

CollapsedEvent 

public static readonly RoutedEvent CollapsedEvent

Field Value

RoutedEvent

CollapsedSectionContentProperty 

public static readonly DependencyProperty CollapsedSectionContentProperty

Field Value

DependencyProperty

DockPositionProperty 

public static readonly DependencyProperty DockPositionProperty

Field Value

DependencyProperty

ExpandedEvent 

public static readonly RoutedEvent ExpandedEvent

Field Value

RoutedEvent

IsButtonSplitterVisibleProperty 

public static readonly DependencyProperty IsButtonSplitterVisibleProperty

Field Value

DependencyProperty

IsCloseButtonVisibleProperty 

public static readonly DependencyProperty IsCloseButtonVisibleProperty

Field Value

DependencyProperty

IsMaximizedProperty 

public static readonly DependencyProperty IsMaximizedProperty

Field Value

DependencyProperty

IsOverflowVisibleProperty 

public static readonly DependencyProperty IsOverflowVisibleProperty

Field Value

DependencyProperty

IsPopupVisibleProperty 

public static readonly DependencyProperty IsPopupVisibleProperty

Field Value

DependencyProperty

MaxNumberOfButtonsProperty 

public static readonly DependencyProperty MaxNumberOfButtonsProperty

Field Value

DependencyProperty

MaximizedSectionsProperty 

public static readonly DependencyProperty MaximizedSectionsProperty

Field Value

DependencyProperty

MinimizedSectionsProperty 

public static readonly DependencyProperty MinimizedSectionsProperty

Field Value

DependencyProperty

MinimizedWidthProperty 

public static readonly DependencyProperty MinimizedWidthProperty

Field Value

DependencyProperty

NavigationPaneTextProperty 

public static readonly DependencyProperty NavigationPaneTextProperty

Field Value

DependencyProperty

OptionButtonsProperty 

public static readonly DependencyProperty OptionButtonsProperty

Field Value

DependencyProperty

OverflowMenuItemsProperty 

public static readonly DependencyProperty OverflowMenuItemsProperty

Field Value

DependencyProperty

OverflowMenuProperty 

public static readonly DependencyProperty OverflowMenuProperty

Field Value

DependencyProperty

PopupClosedEvent 

public static readonly RoutedEvent PopupClosedEvent

Field Value

RoutedEvent

PopupOpenedEvent 

public static readonly RoutedEvent PopupOpenedEvent

Field Value

RoutedEvent

PopupWidthProperty 

public static readonly DependencyProperty PopupWidthProperty

Field Value

DependencyProperty

SectionContentProperty 

public static readonly DependencyProperty SectionContentProperty

Field Value

DependencyProperty

SelectedSectionChangedEvent 

public static readonly RoutedEvent SelectedSectionChangedEvent

Field Value

RoutedEvent

SelectedSectionIndexProperty 

public static readonly DependencyProperty SelectedSectionIndexProperty

Field Value

DependencyProperty

SelectedSectionProperty 

public static readonly DependencyProperty SelectedSectionProperty

Field Value

DependencyProperty

ShowButtonsProperty 

public static readonly DependencyProperty ShowButtonsProperty

Field Value

DependencyProperty

ShowSideButtonsProperty 

public static readonly DependencyProperty ShowSideButtonsProperty

Field Value

DependencyProperty

Properties

ButtonHeight

Gets or sets the height of the section buttons.

public double ButtonHeight { get; set; }

Property Value

double

CanResize

Gets or sets wether the width of the OutlookBar can be manually resized by a gripper at the right (or left).

public bool CanResize { get; set; }

Property Value

bool

CloseCommand

Close the OutlookBar

public static RoutedUICommand CloseCommand { get; }

Property Value

RoutedUICommand

CollapseCommand

Toggles the IsExpanded property.

public static RoutedUICommand CollapseCommand { get; }

Property Value

RoutedUICommand

DockPosition

Gets or sets how to align template of the OutlookBar. Currently, only Left or Right is supported!

public HorizontalAlignment DockPosition { get; set; }

Property Value

HorizontalAlignment

Remarks

This property has been renamed from Dock to DockPosition due to a suggestion from maze6210: http://www.codeplex.com/odyssey/WorkItem/View.aspx?WorkItemId=1075

IsButtonSplitterVisible

Gets or sets whether the splitter for the section buttons is visible

public bool IsButtonSplitterVisible { get; set; }

Property Value

bool

IsCloseButtonVisible

Gets or sets wether the close button is visible.

public bool IsCloseButtonVisible { get; set; }

Property Value

bool

IsMaximized

Gets or sets whether the Outlookbar is Maximized or Minimized.

public bool IsMaximized { get; set; }

Property Value

bool

IsOverflowVisible

Gets or sets whether the overflow menu of the available sections is visible.

public bool IsOverflowVisible { get; set; }

Property Value

bool

IsPopupVisible

Gets or sets whether the popup panel is visible.

public bool IsPopupVisible { get; set; }

Property Value

bool

LogicalChildren

Gets an enumerator to the logical child elements of the HeaderedItemsControl.

protected override IEnumerator LogicalChildren { get; }

Property Value

IEnumerator

An enumerator. The default is null.

MaxNumberOfButtons

Gets or sets how many buttons are completely visible.

public int MaxNumberOfButtons { get; set; }

Property Value

int

MinimizedWidth

Gets or sets the width when IsExpanded is set to false.

public double MinimizedWidth { get; set; }

Property Value

double

NavigationPaneText

Gets or sets the text or content that is displayed on the minimized OutlookBar at the Button to open up the Navigation Pane.

public object NavigationPaneText { get; set; }

Property Value

object

OptionButtons 

[Bindable(true)]
public Collection<ButtonBase> OptionButtons { get; }

Property Value

Collection<ButtonBase>

OverflowMenuItems

Gets or sets the default items for the overflow menu.

[Bindable(true)]
public Collection<object> OverflowMenuItems { get; }

Property Value

Collection<object>

PopupWidth

Gets or sets the with of the popup window.

public double PopupWidth { get; set; }

Property Value

double

ResizeCommand

Start to resize the Width of the OutlookBar (used for the xaml template to initiate resizing).

public static RoutedUICommand ResizeCommand { get; }

Property Value

RoutedUICommand

Sections

Gets the collection of sections.

[Bindable(true)]
public Collection<OutlookSection> Sections { get; }

Property Value

Collection<OutlookSection>

SelectedSection

Gets or sets the selected section.

public OutlookSection SelectedSection { get; set; }

Property Value

OutlookSection

SelectedSectionIndex

Gets or sets the index of the selected section.

public int SelectedSectionIndex { get; set; }

Property Value

int

ShowButtons

Gets or sets whether the section buttons are visible.

public bool ShowButtons { get; set; }

Property Value

bool

ShowPopupCommand

Shows the popup window.

public static RoutedUICommand ShowPopupCommand { get; }

Property Value

RoutedUICommand

ShowSideButtons

Gets or sets whether to show the SideButtons when IsExpanded is set to false.

public bool ShowSideButtons { get; set; }

Property Value

bool

SideButtons

Gets the buttons on the side when IsExpanded is set to false and ShowSideButtons is set to true.

public Collection<OutlookSection> SideButtons { get; }

Property Value

Collection<OutlookSection>

StartDraggingCommand

Starts dragging the splitter for the visible section buttons (used for the xaml template).

public static RoutedUICommand StartDraggingCommand { get; }

Property Value

RoutedUICommand

Methods

ApplySections()

Determine the collection of MinimizedSections and MaximizedSections depending on the MaxVisibleButtons Property.

protected virtual void ApplySections()

GetLogicalChildren() 

protected virtual IEnumerable GetLogicalChildren()

Returns

IEnumerable

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate().

public override void OnApplyTemplate()

OnInitialized(EventArgs)

Raises the Initialized event. This method is invoked whenever IsInitialized is set to true internally.

protected override void OnInitialized(EventArgs e)

Parameters

e EventArgs

The RoutedEventArgs that contains the event data.

OnMaximizedChanged(bool)

Occurs when the IsMaximized property has changed.

protected virtual void OnMaximizedChanged(bool isExpanded)

Parameters

isExpanded bool

OnOverflowMenuCreated(Collection<object>) 

protected virtual void OnOverflowMenuCreated(Collection<object> menuItems)

Parameters

menuItems Collection<object>

OnOverflowVisibleChanged(bool)

Occurs when the IsOverflowVisible has changed.

protected virtual void OnOverflowVisibleChanged(bool newValue)

Parameters

newValue bool

OnPopupClosed(object, EventArgs) 

protected virtual void OnPopupClosed(object sender, EventArgs e)

Parameters

sender object
e EventArgs

OnPopupOpened(object, EventArgs) 

protected virtual void OnPopupOpened(object sender, EventArgs e)

Parameters

sender object
e EventArgs

OnPopupVisibleChanged(bool)

Occurs when the IsPopupVisible has changed.

protected virtual void OnPopupVisibleChanged(bool isPopupVisible)

Parameters

isPopupVisible bool

OnSelectedSectionChanged(OutlookSection, OutlookSection)

Occurs when the SelectedSection has changed.

protected virtual void OnSelectedSectionChanged(OutlookSection oldSection, OutlookSection newSection)

Parameters

oldSection OutlookSection
newSection OutlookSection

Events

Collapsed

Occurs after the OutlookBar has collapsed.

public event RoutedEventHandler Collapsed

Event Type

RoutedEventHandler

Expanded

Occurs after the OutlookBar has expanded.

public event RoutedEventHandler Expanded

Event Type

RoutedEventHandler

OverflowMenuCreated 

public event EventHandler<OverflowMenuCreatedEventArgs> OverflowMenuCreated

Event Type

EventHandler<OverflowMenuCreatedEventArgs>

PopupClosed

Occurs after the Popup has closed.

public event RoutedEventHandler PopupClosed

Event Type

RoutedEventHandler

PopupOpened

Occurs after the Popup has opened.

public event RoutedEventHandler PopupOpened

Event Type

RoutedEventHandler

SelectedSectionChanged

Occurs when the SelectedSection has changed.

public event RoutedPropertyChangedEventHandler<OutlookSection> SelectedSectionChanged

Event Type

RoutedPropertyChangedEventHandler<OutlookSection>
Edit this page