Class GroupBar

Represents the GroupBar UI element.

Inheritance

System.Object

GroupBar

Implements

System.IDisposable

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

[SkinType(SkinVisualStyle = Skin.Office2010Silver, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2010SilverStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.VS2010, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/VS2010Style.xaml")]
[SkinType(SkinVisualStyle = Skin.Metro, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/MetroStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Transparent, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/TransparentStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2013, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2013Style.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2007Blue, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2007BlueStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2007Black, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2007BlackStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2007Silver, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2007SilverStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2010Blue, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2010BlueStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Default, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf;component/Controls/GroupBar/Themes/DefaultStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2003, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2003Style.xaml")]
[SkinType(SkinVisualStyle = Skin.ShinyBlue, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/ShinyBlueStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2010Black, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2010BlackStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.ShinyRed, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/ShinyRedStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.SyncOrange, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/SyncOrangeStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Blend, Type = typeof(GroupBar), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/BlendStyle.xaml")]
public class GroupBar : ItemsControl, IDisposable

Constructors

GroupBar()

Initializes a new instance of the GroupBar class.

Declaration

public GroupBar()

Fields

AddItemCommand

Command that is responsible for adding the GroupViewItem to the GroupView.

Declaration

public static RoutedUICommand AddItemCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

AddTabCommand

Command that is responsible for adding the GroupBarItem to the GroupBar.

Declaration

public static readonly RoutedUICommand AddTabCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

AfterSplitDownEvent

Identifies AfterSplitDown event.

Declaration

public static readonly RoutedEvent AfterSplitDownEvent

Field Value

Type	Description
System.Windows.RoutedEvent

AfterSplitUpEvent

Identifies AfterSplitUp event.

Declaration

public static readonly RoutedEvent AfterSplitUpEvent

Field Value

Type	Description
System.Windows.RoutedEvent

AllowCollapseProperty

Identifies the AllowCollapse dependency property.

Declaration

public static readonly DependencyProperty AllowCollapseProperty

Field Value

Type	Description
System.Windows.DependencyProperty

AllowDragandDropProperty

Declaration

public static readonly DependencyProperty AllowDragandDropProperty

Field Value

Type	Description
System.Windows.DependencyProperty

AnimationSpeedProperty

Identifies the AnimationSpeed dependency property.

Declaration

public static readonly DependencyProperty AnimationSpeedProperty

Field Value

Type	Description
System.Windows.DependencyProperty

AnimationTypeProperty

Identifies the AnimationType dependency property.

Declaration

public static readonly DependencyProperty AnimationTypeProperty

Field Value

Type	Description
System.Windows.DependencyProperty

BeforeSplitDownEvent

Identifies BeforeSplitDown event.

Declaration

public static readonly RoutedEvent BeforeSplitDownEvent

Field Value

Type	Description
System.Windows.RoutedEvent

BeforeSplitUpEvent

Identifies BeforeSplitUp event.

Declaration

public static readonly RoutedEvent BeforeSplitUpEvent

Field Value

Type	Description
System.Windows.RoutedEvent

ChangeListViewModeCommand

Command that is responsible for changing list view mode.

Declaration

public static readonly RoutedUICommand ChangeListViewModeCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

CollapseButtonBackgroundProperty

Identifies the CollapseButtonBackground dependency property.

Declaration

public static readonly DependencyProperty CollapseButtonBackgroundProperty

Field Value

Type	Description
System.Windows.DependencyProperty

CollapseButtonMouseOverBackgroundProperty

Identifies the CollapseButtonMouseOverBackground dependency property.

Declaration

public static readonly DependencyProperty CollapseButtonMouseOverBackgroundProperty

Field Value

Type	Description
System.Windows.DependencyProperty

CollapseButtonTemplateProperty

Identifies the CollapseButtonTemplate dependency property.

Declaration

public static readonly DependencyProperty CollapseButtonTemplateProperty

Field Value

Type	Description
System.Windows.DependencyProperty

CollapseButtonToolTipProperty

Identifies the CollapseButtonToolTip dependency property.

Declaration

public static readonly DependencyProperty CollapseButtonToolTipProperty

Field Value

Type	Description
System.Windows.DependencyProperty

CollapsedWidthProperty

Identifies the CollapsedWidth dependency property.

Declaration

public static readonly DependencyProperty CollapsedWidthProperty

Field Value

Type	Description
System.Windows.DependencyProperty

ContentRotationAngleProperty

Identifies ContentRotationAngle dependency property.

Declaration

public static readonly DependencyProperty ContentRotationAngleProperty

Field Value

Type	Description
System.Windows.DependencyProperty

CopyItemCommand

Command that is responsible for copping the GroupBarItem or the GroupViewItem.

Declaration

public static readonly RoutedUICommand CopyItemCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

CornerRadiusProperty

Identifies CornerRadius dependency property.

Declaration

public static readonly DependencyProperty CornerRadiusProperty

Field Value

Type	Description
System.Windows.DependencyProperty

CustomAnimationsProperty

Identifies CustomAnimations dependency property.

Declaration

public static readonly DependencyProperty CustomAnimationsProperty

Field Value

Type	Description
System.Windows.DependencyProperty

CutItemCommand

Command that is responsible for cutting the GroupBarItem or the GroupViewItem.

Declaration

public static readonly RoutedUICommand CutItemCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

DefaultItemImageProperty

Identifies DefaultItemImage dependency property.

Declaration

public static readonly DependencyProperty DefaultItemImageProperty

Field Value

Type	Description
System.Windows.DependencyProperty

DeleteItemCommand

Command that is responsible for deleting the GroupViewItem from the GroupView.

Declaration

public static RoutedUICommand DeleteItemCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

DeleteTabCommand

Command that is responsible for deleting the GroupBarItem from the GroupBar.

Declaration

public static RoutedUICommand DeleteTabCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

DragItemVisibilityProperty

Dependency property which has Dragitem visibility

Declaration

public static readonly DependencyProperty DragItemVisibilityProperty

Field Value

Type	Description
System.Windows.DependencyProperty

DragMarkerBrushProperty

Identifies DragMarkerBrush dependency property.

Declaration

public static readonly DependencyProperty DragMarkerBrushProperty

Field Value

Type	Description
System.Windows.DependencyProperty

ExpandButtonToolTipProperty

Identifies the ExpandButtonToolTip dependency property.

Declaration

public static readonly DependencyProperty ExpandButtonToolTipProperty

Field Value

Type	Description
System.Windows.DependencyProperty

FitContentProperty

Declaration

public static readonly DependencyProperty FitContentProperty

Field Value

Type	Description
System.Windows.DependencyProperty

FlowDirectionChangedEvent

Identifies FlowDirectionChanged event.

Declaration

public static readonly RoutedEvent FlowDirectionChangedEvent

Field Value

Type	Description
System.Windows.RoutedEvent

GroupBarHeaderStyleProperty

Dependency property which has group bar header style

Declaration

public static readonly DependencyProperty GroupBarHeaderStyleProperty

Field Value

Type	Description
System.Windows.DependencyProperty

GroupBarItemCursorTypeProperty

Identifies GroupBarItemCursorType dependency property.

Declaration

public static readonly DependencyProperty GroupBarItemCursorTypeProperty

Field Value

Type	Description
System.Windows.DependencyProperty

GroupBarItemHeaderTemplateProperty

Declaration

public static readonly DependencyProperty GroupBarItemHeaderTemplateProperty

Field Value

Type	Description
System.Windows.DependencyProperty

HeaderHeightProperty

Identifies HeaderHeight dependency property.

Declaration

public static DependencyProperty HeaderHeightProperty

Field Value

Type	Description
System.Windows.DependencyProperty

HorizontalOrientationStoryboardProperty

Identifies HorizontalOrientationStoryboard dependency property.

Declaration

public static readonly DependencyProperty HorizontalOrientationStoryboardProperty

Field Value

Type	Description
System.Windows.DependencyProperty

IsCloseButtonEnabledProperty

Identifies the IsCloseButtonEnabled dependency property.

Declaration

public static readonly DependencyProperty IsCloseButtonEnabledProperty

Field Value

Type	Description
System.Windows.DependencyProperty

IsCollapsedProperty

Identifies the IsCollapsed dependency property.

Declaration

public static readonly DependencyProperty IsCollapsedProperty

Field Value

Type	Description
System.Windows.DependencyProperty

IsDropDownOpenProperty

Identifies the IsDropDownOpen dependency property.

Declaration

public static readonly DependencyProperty IsDropDownOpenProperty

Field Value

Type	Description
System.Windows.DependencyProperty

IsEnabledContextMenuProperty

Identifies IsEnabledContextMenu dependency property.

Declaration

public static readonly DependencyProperty IsEnabledContextMenuProperty

Field Value

Type	Description
System.Windows.DependencyProperty

IsToolBarEnabledProperty

Identifies the IsToolBarEnabled dependency property.

Declaration

public static readonly DependencyProperty IsToolBarEnabledProperty

Field Value

Type	Description
System.Windows.DependencyProperty

ItemContentLengthProperty

Identifies ItemContentLength dependency property.

Declaration

public static DependencyProperty ItemContentLengthProperty

Field Value

Type	Description
System.Windows.DependencyProperty

ItemHeaderHeightProperty

Identifies ItemHeaderHeight dependency property.

Declaration

public static readonly DependencyProperty ItemHeaderHeightProperty

Field Value

Type	Description
System.Windows.DependencyProperty

m_closeButtonCommand

Command for the close button.

Declaration

public static readonly RoutedCommand m_closeButtonCommand

Field Value

Type	Description
System.Windows.Input.RoutedCommand

m_opendialogCommand

Declaration

public static readonly RoutedCommand m_opendialogCommand

Field Value

Type	Description
System.Windows.Input.RoutedCommand

m_popupCommand

Command for the popup.

Declaration

public static readonly RoutedCommand m_popupCommand

Field Value

Type	Description
System.Windows.Input.RoutedCommand

MoveDownCommand

Command that is responsible for moving down the GroupBarItem or the GroupViewItem.

Declaration

public static readonly RoutedUICommand MoveDownCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

MoveUpCommand

Command that is responsible for moving up the GroupBarItem or the GroupViewItem.

Declaration

public static readonly RoutedUICommand MoveUpCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

NavigationPaneTextProperty

Identifies NavigationPaneText dependency property.

Declaration

public static readonly DependencyProperty NavigationPaneTextProperty

Field Value

Type	Description
System.Windows.DependencyProperty

NavigationPopupSizeProperty

Identifies NavigationPopupSize dependency property.

Declaration

public static readonly DependencyProperty NavigationPopupSizeProperty

Field Value

Type	Description
System.Windows.DependencyProperty

OpenOptionsCommand

Command that makes application options open. Not implemented yet.

Declaration

public static RoutedCommand OpenOptionsCommand

Field Value

Type	Description
System.Windows.Input.RoutedCommand

OrientationChangedContentStoryboardProperty

Identifies OrientationChangedContentStoryboard dependency property.

Declaration

public static readonly DependencyProperty OrientationChangedContentStoryboardProperty

Field Value

Type	Description
System.Windows.DependencyProperty

OrientationChangedEvent

Identifies OrientationChanged event.

Declaration

public static readonly RoutedEvent OrientationChangedEvent

Field Value

Type	Description
System.Windows.RoutedEvent

OrientationChangingEvent

Identifies OrientationChanging event.

Declaration

public static readonly RoutedEvent OrientationChangingEvent

Field Value

Type	Description
System.Windows.RoutedEvent

OrientationProperty

Identifies Orientation dependency property.

Declaration

public static readonly DependencyProperty OrientationProperty

Field Value

Type	Description
System.Windows.DependencyProperty

OverFlowButtonStyleProperty

Declaration

public static readonly DependencyProperty OverFlowButtonStyleProperty

Field Value

Type	Description
System.Windows.DependencyProperty

OverFlowIndicatorContentProperty

Declaration

public static readonly DependencyProperty OverFlowIndicatorContentProperty

Field Value

Type	Description
System.Windows.DependencyProperty

OverFlowItemTemplateProperty

Declaration

public static readonly DependencyProperty OverFlowItemTemplateProperty

Field Value

Type	Description
System.Windows.DependencyProperty

PasteItemCommand

Command that is responsible for pasting the GroupBarItem or the GroupViewItem.

Declaration

public static readonly RoutedUICommand PasteItemCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

PopupResizeDirectionProperty

Identifies the PopupResizeDirection dependency property.

Declaration

public static readonly DependencyProperty PopupResizeDirectionProperty

Field Value

Type	Description
System.Windows.DependencyProperty

RenameItemCommand

Command that is responsible for renaming the GroupViewItem.

Declaration

public static RoutedUICommand RenameItemCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

RenameTabCommand

Command that is responsible for renaming the GroupBarItem.

Declaration

public static RoutedUICommand RenameTabCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

RotationAngleProperty

Identifies RotationAngle dependency property.

Declaration

public static readonly DependencyProperty RotationAngleProperty

Field Value

Type	Description
System.Windows.DependencyProperty

SaveOriginalStateProperty

Identifies the SaveOriginalState dependency property.

Declaration

public static readonly DependencyProperty SaveOriginalStateProperty

Field Value

Type	Description
System.Windows.DependencyProperty

SelectedContentProperty

Identifies SelectedContent dependency property.

Declaration

public static readonly DependencyProperty SelectedContentProperty

Field Value

Type	Description
System.Windows.DependencyProperty

SelectedHeaderProperty

Identifies SelectedHeader dependency property.

Declaration

public static readonly DependencyProperty SelectedHeaderProperty

Field Value

Type	Description
System.Windows.DependencyProperty

SelectedItemChangedEvent

Identifies SelectedItemChanged event.

Declaration

public static readonly RoutedEvent SelectedItemChangedEvent

Field Value

Type	Description
System.Windows.RoutedEvent

SelectedItemProperty

Identifies SelectedItem dependency property.

Declaration

public static readonly DependencyProperty SelectedItemProperty

Field Value

Type	Description
System.Windows.DependencyProperty

SelectedItemPropertyKey

Identifies SelectedItem dependency property key.

Declaration

protected static readonly DependencyPropertyKey SelectedItemPropertyKey

Field Value

Type	Description
System.Windows.DependencyPropertyKey

SelectedObjectChangedEvent

Identifies SelectedObjectChanged event.

Declaration

public static readonly RoutedEvent SelectedObjectChangedEvent

Field Value

Type	Description
System.Windows.RoutedEvent

SelectedObjectProperty

Identifies SelectedObject dependency property.

Declaration

public static readonly DependencyProperty SelectedObjectProperty

Field Value

Type	Description
System.Windows.DependencyProperty

SelectedTabChangedEvent

Identifies SelectedTabChanged event.

Declaration

public static readonly RoutedEvent SelectedTabChangedEvent

Field Value

Type	Description
System.Windows.RoutedEvent

SelectedTabProperty

Identifies SelectedTab dependency property.

Declaration

public static readonly DependencyProperty SelectedTabProperty

Field Value

Type	Description
System.Windows.DependencyProperty

SelectedTabPropertyKey

Identifies SelectedTab dependency property key.

Declaration

protected static readonly DependencyPropertyKey SelectedTabPropertyKey

Field Value

Type	Description
System.Windows.DependencyPropertyKey

ShowGripperProperty

Identifies the ShowGripper dependency property.

Declaration

public static readonly DependencyProperty ShowGripperProperty

Field Value

Type	Description
System.Windows.DependencyProperty

SortAscCommand

Command that is responsible for sorting GroupBarItem or GroupViewItem objects in ascending order.

Declaration

public static readonly RoutedUICommand SortAscCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

SortDesCommand

Command that is responsible for sorting GroupBarItem or GroupViewItem objects in descending order.

Declaration

public static readonly RoutedUICommand SortDesCommand

Field Value

Type	Description
System.Windows.Input.RoutedUICommand

SplitterDownCommand

Command that makes the splitter to go down.

Declaration

public static RoutedCommand SplitterDownCommand

Field Value

Type	Description
System.Windows.Input.RoutedCommand

SplitterUpCommand

Command that makes the splitter to go up.

Declaration

public static RoutedCommand SplitterUpCommand

Field Value

Type	Description
System.Windows.Input.RoutedCommand

StackItemHostHeightProperty

Identifies StackItemHostHeight dependency property.

Declaration

public static DependencyProperty StackItemHostHeightProperty

Field Value

Type	Description
System.Windows.DependencyProperty

StackItemHostVisibilityProperty

Identifies the StackItemHostVisibility dependency property. Used only in StackMode.

Declaration

public static readonly DependencyProperty StackItemHostVisibilityProperty

Field Value

Type	Description
System.Windows.DependencyProperty

StackVisibleItemsCountProperty

Declaration

public static readonly DependencyProperty StackVisibleItemsCountProperty

Field Value

Type	Description
System.Windows.DependencyProperty

TextAlignmentProperty

Identifies TextAlignmentProperty dependency property.

Declaration

public static readonly DependencyProperty TextAlignmentProperty

Field Value

Type	Description
System.Windows.DependencyProperty

VerticalOrientationStoryboardProperty

Identifies VerticalOrientationStoryboard dependency property.

Declaration

public static readonly DependencyProperty VerticalOrientationStoryboardProperty

Field Value

Type	Description
System.Windows.DependencyProperty

VisualModeChangedEvent

Identifies VisualModeChanged event.

Declaration

public static readonly RoutedEvent VisualModeChangedEvent

Field Value

Type	Description
System.Windows.RoutedEvent

VisualModeProperty

Identifies VisualMode dependency property.

Declaration

public static readonly DependencyProperty VisualModeProperty

Field Value

Type	Description
System.Windows.DependencyProperty

VisualStyleProperty

Identifies VisualStyle dependency property.

Declaration

public static readonly DependencyProperty VisualStyleProperty

Field Value

Type	Description
System.Windows.DependencyProperty

Properties

AllowCollapse

Gets or sets a value indicating whether [allow collapse].

Declaration

public bool AllowCollapse { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [allow collapse]; otherwise, `false`.

AllowDragandDrop

Declaration

public bool AllowDragandDrop { get; set; }

Property Value

Type	Description
System.Boolean

AnimationSpeed

Gets or sets the speed of the animation. This is a dependency property.

Declaration

public int AnimationSpeed { get; set; }

Property Value

Type	Description
System.Int32	Type: System.Int32 Default value is 300.

AnimationType

Gets or sets the type of animation to be applied. This is a dependency property.

Declaration

public AnimationsType AnimationType { get; set; }

Property Value

Type	Description
AnimationsType	Type: AnimationsType Default value is AnimationsType.Fade.

CollapseButtonBackground

Gets or sets the background of the collapse button. This is a dependency property.

Declaration

public Brush CollapseButtonBackground { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	Type: System.Windows.Media.Brush Default value is Brushes.Transparent.

CollapseButtonMouseOverBackground

Gets or sets the background of the collapse button when mouse is over it. This is a dependency property.

Declaration

public Brush CollapseButtonMouseOverBackground { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	Type: System.Windows.Media.Brush Default value is Brushes.Transparent.

CollapseButtonTemplate

Gets or sets the template to be applied to the collapse button. This is a dependency property.

Declaration

public ControlTemplate CollapseButtonTemplate { get; set; }

Property Value

Type	Description
System.Windows.Controls.ControlTemplate	Type: System.Windows.Controls.ControlTemplate

CollapseButtonToolTip

Gets or sets the tooltip to be displayed when the mouse is hover over the collapse button. This is a dependency property.

Declaration

public object CollapseButtonToolTip { get; set; }

Property Value

Type	Description
System.Object	Type: System.Windows.Controls.ToolTip

CollapsedWidth

Gets or sets value indicating width of the Navigation pane in collapsed mode. This is a dependency property.

Declaration

public double CollapsedWidth { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is 34.

ContentRotationAngle

Gets or sets the angle of displaying the items content. This is a dependency property.

Declaration

public double ContentRotationAngle { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is 0.

CornerRadius

Gets or sets the corner radius.

Declaration

public CornerRadius CornerRadius { get; set; }

Property Value

Type	Description
System.Windows.CornerRadius	The corner radius.

CustomAnimations

Gets or sets the collection of the custom animations applied to the control. This is a dependency property.

Declaration

public CustomAnimationsCollection CustomAnimations { get; set; }

Property Value

Type	Description
CustomAnimationsCollection	Type: CustomAnimationsCollection Default value is null.

DefaultItemImage

Gets or sets the default item image.

Declaration

public ImageSource DefaultItemImage { get; set; }

Property Value

Type	Description
System.Windows.Media.ImageSource	The default item image.

DraggingItemInProgress

Gets or sets a value indicating whether [dragging item in progress].

Declaration

public bool DraggingItemInProgress { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [dragging item in progress]; otherwise, `false`.

DragItemVisibility

Gets or sets the drag item visibility.

Declaration

public Visibility DragItemVisibility { get; set; }

Property Value

Type	Description
System.Windows.Visibility	The drag item visibility.

DragMarkerBrush

Gets or sets the brush for the drag marker. This is a dependency property.

Declaration

public Brush DragMarkerBrush { get; set; }

Property Value

Type	Description
System.Windows.Media.Brush	Type: System.Windows.Media.Brush Default value is System.Windows.Media.Brushes.Black.

DynamicResizing

Gets or sets a value indicating whether [dynamic resizing].

Declaration

public bool DynamicResizing { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [dynamic resizing]; otherwise, `false`.

ExpandButtonToolTip

Gets or sets the tooltip to be displayed when the mouse is hover over the expand button. This is a dependency property.

Declaration

public object ExpandButtonToolTip { get; set; }

Property Value

Type	Description
System.Object	Type: System.Windows.Controls.ToolTip

FitContent

Gets or sets the FitContent.

Declaration

[CLSCompliant(false)]
public bool FitContent { get; set; }

Property Value

Type	Description
System.Boolean	The FitContent option.

GroupBarHeaderStyle

Gets or sets the Header Style for Groupbar. This is a dependency property.

Declaration

public Style GroupBarHeaderStyle { get; set; }

Property Value

Type	Description
System.Windows.Style

GroupBarItemCursor

Gets the group bar item cursor.

Declaration

public Cursor GroupBarItemCursor { get; }

Property Value

Type	Description
System.Windows.Input.Cursor	The group bar item cursor.

GroupBarItemCursorType

Gets or sets the type of the group bar item cursor.

Declaration

public ItemCursorType GroupBarItemCursorType { get; set; }

Property Value

Type	Description
ItemCursorType	The type of the group bar item cursor.

GroupBarItemHeaderTemplate

Gets or sets the Header Template of GroupBarItem. This is a dependency property.

Declaration

public DataTemplate GroupBarItemHeaderTemplate { get; set; }

Property Value

Type	Description
System.Windows.DataTemplate

HeaderHeight

Gets or sets the height of topmost container that hosts the selected header. This is a dependency property.

Declaration

public double HeaderHeight { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is 50.

HiddenItemsCount

Gets the hidden items count.

Declaration

public int HiddenItemsCount { get; }

Property Value

Type	Description
System.Int32	The hidden items count.

HorizontalOrientationStoryboard

Gets or sets the storyboard that is applied to the control's main grid when orientation changes to horizontal. This is a dependency property.

Declaration

public Storyboard HorizontalOrientationStoryboard { get; set; }

Property Value

Type	Description
System.Windows.Media.Animation.Storyboard	Type: System.Windows.Media.Animation.Storyboard Default value is null.

IsCloseButtonEnabled

Gets or sets a value indicating whether this instance is close button enabled.

Declaration

public bool IsCloseButtonEnabled { get; set; }

Property Value

Type	Description
System.Boolean	`true` if this instance is close button enabled; otherwise, `false`.

IsCollapsed

Gets or sets a value indicating whether this instance is collapsed.

Declaration

public bool IsCollapsed { get; set; }

Property Value

Type	Description
System.Boolean	`true` if this instance is collapsed; otherwise, `false`.

IsDropDownOpen

Gets or sets a value indicating whether this instance is drop down open.

Declaration

public bool IsDropDownOpen { get; set; }

Property Value

Type	Description
System.Boolean	`true` if this instance is drop down open; otherwise, `false`.

IsEnabledContextMenu

Gets or sets a value indicating whether this instance is enabled context menu.

Declaration

public bool IsEnabledContextMenu { get; set; }

Property Value

Type	Description
System.Boolean	`true` if this instance is enabled context menu; otherwise, `false`.

IsToolBarEnabled

Gets or sets a value indicating whether this instance is tool bar enabled.

Declaration

public bool IsToolBarEnabled { get; set; }

Property Value

Type	Description
System.Boolean	`true` if this instance is tool bar enabled; otherwise, `false`.

ItemContentLength

Gets or sets height (for vertical layout) or width (for horizontal layout) available for the content of the selected item. This is a dependency property.

Declaration

public double ItemContentLength { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is 0.

ItemHeaderHeight

Gets or sets the height for the each item's header. This is a dependency property.

Declaration

public double ItemHeaderHeight { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is 50.

ItemHeaderTemplate

Gets or sets the item header template.

Declaration

public DataTemplate ItemHeaderTemplate { get; set; }

Property Value

Type	Description
System.Windows.DataTemplate	The item header template.

LogicalParent

Gets the logical parent as System.Windows.FrameworkElement.

Declaration

public FrameworkElement LogicalParent { get; }

Property Value

Type	Description
System.Windows.FrameworkElement	Type: System.Windows.FrameworkElement

NavigationOptionsMenuItemHeader

Gets or sets the NavigationOptionsMenuItemHeader. This is a dependency property.

Declaration

public object NavigationOptionsMenuItemHeader { get; set; }

Property Value

Type	Description
System.Object

NavigationPaneText

Gets or sets the navigation pane text.

Declaration

public string NavigationPaneText { get; set; }

Property Value

Type	Description
System.String	The navigation pane text.

NavigationPopupSize

Gets or sets the size for the navigation popup. This is a dependency property.

Declaration

public Size NavigationPopupSize { get; set; }

Property Value

Type	Description
System.Windows.Size	Type: System.Windows.Size

Orientation

Gets or sets the orientation of the control. This is a dependency property.

Declaration

public Orientation Orientation { get; set; }

Property Value

Type	Description
System.Windows.Controls.Orientation	Type: Orientation Default value is Orientation.Vertical/>.

OrientationChangedContentStoryboard

Gets or sets the storyboard that is applied to selected content during orientation changing animation. This is a dependency property.

Declaration

public Storyboard OrientationChangedContentStoryboard { get; set; }

Property Value

Type	Description
System.Windows.Media.Animation.Storyboard	Type: System.Windows.Media.Animation.Storyboard Default value is null.

OverFlowButtonStyle

Gets or sets the style of the ToggleButton in OverFlowPanel. This is a dependency property.

Declaration

public Style OverFlowButtonStyle { get; set; }

Property Value

Type	Description
System.Windows.Style

OverFlowIndicatorContent

Gets or sets the content of the OverFlowButton. This is a dependency property.

Declaration

public object OverFlowIndicatorContent { get; set; }

Property Value

Type	Description
System.Object

OverFlowItemTemplate

Gets or sets the Template of the OverFlowItem. This is a dependency property.

Declaration

public DataTemplate OverFlowItemTemplate { get; set; }

Property Value

Type	Description
System.Windows.DataTemplate

PopupResizeDirection

Gets or sets value indicating resize direction(s) of the Navigation pane's popup. This is a dependency property.

Declaration

public PopupResizeDirection PopupResizeDirection { get; set; }

Property Value

Type	Description
PopupResizeDirection	Type: PopupResizeDirection Default value is PopupResizeDirection.Both.

RotationAngle

Gets or sets the angle of displaying the GroupBar. This is a dependency property.

Declaration

public double RotationAngle { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is 0.

SaveOriginalState

Gets or sets a value indicating whether [save original state].

Declaration

public bool SaveOriginalState { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [save original state]; otherwise, `false`.

SelectedContent

Gets or sets the content of the selected item. This is a dependency property.

Declaration

public object SelectedContent { get; set; }

Property Value

Type	Description
System.Object	Type: System.Object Default value is null.

SelectedHeader

Gets or sets the header of the selected item. This is a dependency property.

Declaration

public object SelectedHeader { get; set; }

Property Value

Type	Description
System.Object	Type: System.Object Default value is null.

SelectedItem

Gets the selected item.

Declaration

public GroupViewItem SelectedItem { get; }

Property Value

Type	Description
GroupViewItem	The selected item.

SelectedObject

Gets or sets the selected object.

Declaration

public object SelectedObject { get; set; }

Property Value

Type	Description
System.Object	The selected object.

SelectedTab

Gets the selected tab.

Declaration

public GroupBarItem SelectedTab { get; }

Property Value

Type	Description
GroupBarItem	The selected tab.

ShowGripper

Gets or sets a value indicating whether [show gripper].

Declaration

public bool ShowGripper { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [show gripper]; otherwise, `false`.

StackItemHostHeight

Gets or sets the height of the NavigationToolbar. This is a dependency property.

Declaration

public double StackItemHostHeight { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is 50.

StackItemHostVisibility

Gets or sets value indicating visibility of StackItemHost in the StackMode. This is a dependency property.

Declaration

public Visibility StackItemHostVisibility { get; set; }

Property Value

Type	Description
System.Windows.Visibility	Type: System.Windows.Visibility Default value is Visible.

StackVisibleItemsCount

Gets / Set the Maximum Number of Visible Items in StackMode.

Declaration

public int StackVisibleItemsCount { get; set; }

Property Value

Type	Description
System.Int32

TextAlignment

Gets or sets text horizontal alignment for the header of the GroupBarItem. This is a dependency property.

Declaration

public HorizontalAlignment TextAlignment { get; set; }

Property Value

Type	Description
System.Windows.HorizontalAlignment	Type: System.Windows.HorizontalAlignment Default value is System.Windows.HorizontalAlignment.Left.

Examples

// Create a new instance of the GroupBar GroupBar groupBar = new GroupBar(); // Add GroupBar to grid grid1.Children.Add( groupBar ); // Create a new instance of the GroupBarItem GroupBarItem barItem1 = new GroupBarItem(); // Set caption of the item barItem1.HeaderText = "Item1"; // Create a new instance of the GroupBarItem GroupBarItem barItem2 = new GroupBarItem(); // Set caption of the item barItem2.HeaderText = "Item2"; // Add items to GroupBar.Items collection groupBar.Items.Add( barItem1 ); groupBar.Items.Add( barItem2 ); // Set alignment of the text to HorizontalAlignment.Right groupBar.TextAlignment = HorizontalAlignment.Right; /* Result: Items header text will be aligned on the right side. */

VerticalOrientationStoryboard

Gets or sets the storyboard that is applied to the control's main grid when orientation changes to vertical. This is a dependency property.

Declaration

public Storyboard VerticalOrientationStoryboard { get; set; }

Property Value

Type	Description
System.Windows.Media.Animation.Storyboard	Type: System.Windows.Media.Animation.Storyboard Default value is null.

VisualMode

Gets or sets visual mode of the control according to the VisualMode enumeration. This is a dependency property.

Declaration

public VisualMode VisualMode { get; set; }

Property Value

Type	Description
VisualMode	Type: VisualMode Default value is VisualMode.Default/>.

VisualStyle

Gets or sets visual style of the control according to the VisualStyle enumeration. The visual style contains all brushes used for painting the control and all animations applied to the control. This is a dependency property.

Declaration

public VisualStyle VisualStyle { get; set; }

Property Value

Type	Description
VisualStyle	Type: VisualStyle Default value is VisualStyle.Default/>.

Methods

AddTab()

Adds the item to collection of items.

Declaration

public GroupBarItem AddTab()

Returns

Type	Description
GroupBarItem	New GroupBarItem object.

AddTab(Int32)

Adds the item to the collection of items.

Declaration

public GroupBarItem AddTab(int index)

Parameters

Type	Name	Description
System.Int32	index	Index in collection where the specified item is located.

Returns

Type	Description
GroupBarItem	New GroupBarItem object.

AddTab(String)

Adds the item to the collection of items.

Declaration

public GroupBarItem AddTab(string caption)

Parameters

Type	Name	Description
System.String	caption	Displayed text of the item.

Returns

Type	Description
GroupBarItem	New GroupBarItem object.

AddTab(String, Image)

Adds the item to the collection of items.

Declaration

public GroupBarItem AddTab(string caption, Image image)

Parameters

Type	Name	Description
System.String	caption	Displayed text of the item.
System.Windows.Controls.Image	image	Image source to the image.

Returns

Type	Description
GroupBarItem	New GroupBarItem object.

AddTab(String, Image, Int32, Object)

Adds the item to the collection of items.

Declaration

public GroupBarItem AddTab(string caption, Image image, int index, object tagObject)

Parameters

Type	Name	Description
System.String	caption	Displayed text of the item.
System.Windows.Controls.Image	image	Image source to the image.
System.Int32	index	Index in the collection where the specified item is located.
System.Object	tagObject	Arbitrary object value.

Returns

Type	Description
GroupBarItem	New GroupBarItem object.

AddTab(String, Image, Object)

Adds the item to the collection of items.

Declaration

public GroupBarItem AddTab(string caption, Image image, object tagObject)

Parameters

Type	Name	Description
System.String	caption	Displayed text of the item.
System.Windows.Controls.Image	image	Image source to the image.
System.Object	tagObject	Arbitrary object value.

Returns

Type	Description
GroupBarItem	New GroupBarItem object.

ClearContainerForItemOverride(DependencyObject, Object)

Undoes the effects of the PrepareContainerForItemOverride(DependencyObject, Object) method.

Declaration

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameters

Type	Name	Description
System.Windows.DependencyObject	element	The container element.
System.Object	item	The item clear container.

CoerceAllowCollapse(Object)

Fulfils the logic before setting the value of AllowCollapse dependency property.

Declaration

protected virtual object CoerceAllowCollapse(object value)

Parameters

Type	Name	Description
System.Object	value	The value that should be corrected.

Returns

Type	Description
System.Object	The corrected value.

CoerceIsCloseButtonEnabled(Object)

Fulfils the logic before setting the value of IsCloseButtonEnabled dependency property.

Declaration

protected virtual object CoerceIsCloseButtonEnabled(object value)

Parameters

Type	Name	Description
System.Object	value	The value that should be corrected.

Returns

Type	Description
System.Object	The corrected value.

CoerceIsCloseButtonEnabled(DependencyObject, Object)

Coerces the value of the IsCloseButtonEnabled property.

Declaration

public static object CoerceIsCloseButtonEnabled(DependencyObject d, object value)

Parameters

Type	Name	Description
System.Windows.DependencyObject	d	The GroupBar object.
System.Object	value	The instance containing the event data.

Returns

Type	Description
System.Object	The checked value.

CoerceIsCollapsed(Object)

Fulfils the logic before setting the value of IsCollapsed dependency property.

Declaration

protected virtual object CoerceIsCollapsed(object value)

Parameters

Type	Name	Description
System.Object	value	The value that should be corrected.

Returns

Type	Description
System.Object	The corrected value.

CoerceIsDropDownOpen(Object)

Fulfils the logic before setting the value of IsDropDownOpen dependency property.

Declaration

protected virtual object CoerceIsDropDownOpen(object value)

Parameters

Type	Name	Description
System.Object	value	The value that should be corrected.

Returns

Type	Description
System.Object	The corrected value.

CoerceIsDropDownOpen(DependencyObject, Object)

Coerces the value of the IsDropDownOpen property.

Declaration

public static object CoerceIsDropDownOpen(DependencyObject d, object value)

Parameters

Type	Name	Description
System.Windows.DependencyObject	d	The GroupBar object.
System.Object	value	The instance containing the event data.

Returns

Type	Description
System.Object	The checked value.

CoerceIsToolBarEnabled(Object)

Fulfils the logic before setting the value of IsToolBarEnabled dependency property.

Declaration

protected virtual object CoerceIsToolBarEnabled(object value)

Parameters

Type	Name	Description
System.Object	value	The value that should be corrected.

Returns

Type	Description
System.Object	The corrected value.

CoerceIsToolBarEnabled(DependencyObject, Object)

Coerces the value of the IsToolBarEnabled property.

Declaration

public static object CoerceIsToolBarEnabled(DependencyObject d, object value)

Parameters

Type	Name	Description
System.Windows.DependencyObject	d	The GroupBar object.
System.Object	value	The instance containing the event data.

Returns

Type	Description
System.Object	The checked value.

Dispose()

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

Declaration

public void Dispose()

GetContainerForItemOverride()

Creates or identifies the element that is used to display the given item.

Declaration

protected override DependencyObject GetContainerForItemOverride()

Returns

Type	Description
System.Windows.DependencyObject	The element that is used to display the given item.

GetIsEnabledContextMenu(DependencyObject)

Gets the value indicating whether the context menu is enabled.

Declaration

public static bool GetIsEnabledContextMenu(DependencyObject obj)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj	Dependency object to get the value from.

Returns

Type	Description
System.Boolean	bool IsEnabledContextMenuProperty

GetVisualMode(DependencyObject)

Gets visual mode of the control according to VisualMode enumeration.

Declaration

public static VisualMode GetVisualMode(DependencyObject obj)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj	Dependency object to get the visual mode from.

Returns

Type	Description
VisualMode	VisualMode VisualModeProperty

IsItemItsOwnContainerOverride(Object)

Determines if the specified item is (or is eligible to be) its own container.

Declaration

protected override bool IsItemItsOwnContainerOverride(object item)

Parameters

Type	Name	Description
System.Object	item	The item to check.

Returns

Type	Description
System.Boolean	Returns true if the item is (or is eligible to be) its own container; otherwise, false.

LoadBarState()

Loads the state persisted.

Declaration

public void LoadBarState()

LoadBarState(IsolatedStorageFile, String)

Loads the state persisted.

Declaration

public void LoadBarState(IsolatedStorageFile isoStorage, string storeFileName)

Parameters

Type	Name	Description
System.IO.IsolatedStorage.IsolatedStorageFile	isoStorage	Reference in the isolated storage for loading the current docking location.
System.String	storeFileName	File name for the isolated storage.

MeasureOverride(Size)

Measures the size in layout required for child elements.

Declaration

protected override Size MeasureOverride(Size constraint)

Parameters

Type	Name	Description
System.Windows.Size	constraint	The available size that this element can give to child elements.

Returns

Type	Description
System.Windows.Size	The size that this element determines it needs during layout, based on its calculations of child element sizes.

OnAfterGroupBarItemPopupClosed(EventArgs)

Invoked after the popup container is closed.

Declaration

protected virtual void OnAfterGroupBarItemPopupClosed(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs that contains the event data.

OnAllowCollapseChanged(DependencyPropertyChangedEventArgs)

Invoked when the AllowCollapse property is changed.

Declaration

protected virtual void OnAllowCollapseChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnAnimationSpeedChanged(DependencyPropertyChangedEventArgs)

Invoked when the AnimationSpeed property is changed.

Declaration

protected virtual void OnAnimationSpeedChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnAnimationTypeChanged(DependencyPropertyChangedEventArgs)

Invoked when the AnimationType property is changed.

Declaration

protected virtual void OnAnimationTypeChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnApplyTemplate()

Builds the current template's visual tree if necessary.

Declaration

public override void OnApplyTemplate()

OnBeforeGroupBarItemPopupOpened(BeforeGroupBarItemPopupOpenedEventArgs)

Invoked before displaying the GroupBarItem in the popup container during the collapsed mode.

Declaration

protected virtual void OnBeforeGroupBarItemPopupOpened(BeforeGroupBarItemPopupOpenedEventArgs e)

Parameters

Type	Name	Description
BeforeGroupBarItemPopupOpenedEventArgs	e	The BeforeGroupBarItemPopupOpenedEventArgs that contains the event data.

OnCollapseButtonBackgroundChanged(DependencyPropertyChangedEventArgs)

Invoked when the CollapseButtonBackground property is changed.

Declaration

protected virtual void OnCollapseButtonBackgroundChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnCollapseButtonMouseOverBackgroundChanged(DependencyPropertyChangedEventArgs)

Invoked when the CollapseButtonMouseOverBackground property is changed.

Declaration

protected virtual void OnCollapseButtonMouseOverBackgroundChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnCollapseButtonTemplateChanged(DependencyPropertyChangedEventArgs)

Invoked when the CollapseButtonTemplate property is changed.

Declaration

protected virtual void OnCollapseButtonTemplateChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnCollapseButtonToolTipChanged(DependencyPropertyChangedEventArgs)

Invoked when the CollapseButtonToolTip property is changed.

Declaration

protected virtual void OnCollapseButtonToolTipChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnCollapsedChanged(DependencyPropertyChangedEventArgs)

Invoked when the collapse button is clicked.

Declaration

protected virtual void OnCollapsedChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnCollapsedWidthChanged(DependencyPropertyChangedEventArgs)

Invoked when the CollapsedWidth property is changed.

Declaration

protected virtual void OnCollapsedWidthChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnCornerRadiusChanged(DependencyPropertyChangedEventArgs)

Raises the CornerRadiusChanged event.

Declaration

protected virtual void OnCornerRadiusChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnExpandButtonToolTipChanged(DependencyPropertyChangedEventArgs)

Invoked when the ExpandButtonToolTip property is changed.

Declaration

protected virtual void OnExpandButtonToolTipChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnFlowDirectionChanged()

Invoked when the value of System.Windows.FlowDirection property is changed.

Declaration

protected virtual void OnFlowDirectionChanged()

OnGotFocus(RoutedEventArgs)

Invoked whenever an unhandled System.Windows.UIElement.GotFocus event reaches this element in its route.

Declaration

protected override void OnGotFocus(RoutedEventArgs e)

Parameters

Type	Name	Description
System.Windows.RoutedEventArgs	e	The System.Windows.RoutedEventArgs that contains the event data.

OnGroupBarHeaderStyleChanged(DependencyPropertyChangedEventArgs)

Raises the GroupBarHeaderStyleChanged event.

Declaration

protected virtual void OnGroupBarHeaderStyleChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnGroupBarItemAdded(NotifyCollectionChangedEventArgs)

Invoked when a new GroupBarItem is added into the GroupBar.

Declaration

protected virtual void OnGroupBarItemAdded(NotifyCollectionChangedEventArgs e)

Parameters

Type	Name	Description
System.Collections.Specialized.NotifyCollectionChangedEventArgs	e	The System.Collections.Specialized.NotifyCollectionChangedEventArgs that contains the event data.

OnGroupBarItemRemoved(NotifyCollectionChangedEventArgs)

Invoked when an existing GroupBarItem is removed from the GroupBar.

Declaration

protected virtual void OnGroupBarItemRemoved(NotifyCollectionChangedEventArgs e)

Parameters

Type	Name	Description
System.Collections.Specialized.NotifyCollectionChangedEventArgs	e	The System.Collections.Specialized.NotifyCollectionChangedEventArgs that contains the event data.

OnInitialized(EventArgs)

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

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.Windows.RoutedEventArgs that contains the event data.

OnIsCloseButtonEnabledChanged(DependencyPropertyChangedEventArgs)

Invoked when the OnIsCloseButtonEnabledChanged property is changed.

Declaration

protected virtual void OnIsCloseButtonEnabledChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnIsCollapsedChanged(DependencyPropertyChangedEventArgs)

Invoked when the IsCollapsed property is changed.

Declaration

protected virtual void OnIsCollapsedChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnIsDropDownOpenChanged(DependencyPropertyChangedEventArgs)

Raises the IsDropDownOpenChanged event.

Declaration

protected virtual void OnIsDropDownOpenChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnIsToolBarEnabledChanged(DependencyPropertyChangedEventArgs)

Invoked when the OnIsToolBarEnabledChanged property is changed.

Declaration

protected virtual void OnIsToolBarEnabledChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnItemsChanged(NotifyCollectionChangedEventArgs)

Invoked when the Items property changes.

Declaration

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters

Type	Name	Description
System.Collections.Specialized.NotifyCollectionChangedEventArgs	e	The System.Collections.Specialized.NotifyCollectionChangedEventArgs that contains the event data.

OnKeyUp(KeyEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.KeyUp attached event reaches an element in its route that is derived from this class. Is used for key up / key down navigation.

Declaration

protected override void OnKeyUp(KeyEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.KeyEventArgs	e	The System.Windows.Input.KeyEventArgs that contains the event data.

OnLoaded(Object, RoutedEventArgs)

Invoked when the control is ready for presentation.

Declaration

protected virtual void OnLoaded(object sender, RoutedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The source of the event.
System.Windows.RoutedEventArgs	e	The System.Windows.RoutedEventArgs that contains the event data.

OnMouseUp(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.Input.Mouse.MouseUp routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration

protected override void OnMouseUp(MouseButtonEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseButtonEventArgs	e	The System.Windows.Input.MouseButtonEventArgs that contains the event data. The event data reports that the mouse button was released.

OnNavigationPopupSizeChanged(DependencyPropertyChangedEventArgs)

Raises the NavigationPopupSizeChanged event.

Declaration

protected virtual void OnNavigationPopupSizeChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnOrientationChanged()

Invoked when the value of Orientation property is changed.

Declaration

protected virtual void OnOrientationChanged()

OnOrientationChanging()

Invoked when the value of Orientation property is changing.

Declaration

protected virtual void OnOrientationChanging()

OnPopupResizeDirectionChanged(DependencyPropertyChangedEventArgs)

Invoked when the PopupResizeDirection property is changed.

Declaration

protected virtual void OnPopupResizeDirectionChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnPreviewKeyDown(KeyEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.PreviewKeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration

protected override void OnPreviewKeyDown(KeyEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.KeyEventArgs	e	The System.Windows.Input.KeyEventArgs that contains the event data.

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Called when some dependencyProperty is changed.

Declaration

protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	Provides data for various property changed events. Typically these events report effective value changes in the value of a read-only dependency property.

OnRenderSizeChanged(SizeChangedInfo)

Raises the System.Windows.FrameworkElement.SizeChanged event, using the specified information as part of the eventual event data.

Declaration

protected override void OnRenderSizeChanged(SizeChangedInfo sizeInfo)

Parameters

Type	Name	Description
System.Windows.SizeChangedInfo	sizeInfo	Details of the old and new size involved in the change.

OnSaveOriginalStateChanged(DependencyPropertyChangedEventArgs)

Raises the SaveOriginalStateChanged event.

Declaration

protected virtual void OnSaveOriginalStateChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnSelectedContentChanged(DependencyPropertyChangedEventArgs)

Invoked when the OnSelectedContentChanged property is changed.

Declaration

protected virtual void OnSelectedContentChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnSelectedItemChanged(DependencyPropertyChangedEventArgs)

Invoked when SelectedItem property is changed.

Declaration

protected virtual void OnSelectedItemChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnSelectedObjectChanged(DependencyPropertyChangedEventArgs)

Invoked when the SelectedObject property is changed.

Declaration

protected virtual void OnSelectedObjectChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnSelectedTabChanged(DependencyPropertyChangedEventArgs)

Invoked when SelectedTab property is changed.

Declaration

protected virtual void OnSelectedTabChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnShowGripperChanged(DependencyPropertyChangedEventArgs)

Invoked when the ShowGripper property is changed.

Declaration

protected virtual void OnShowGripperChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnStackItemHostHeightChanged(DependencyPropertyChangedEventArgs)

Invoked when the StackItemHostHeight property is changed.

Declaration

protected virtual void OnStackItemHostHeightChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

OnStackItemHostVisibilityChanged(DependencyPropertyChangedEventArgs)

Raises the StackItemHostVisibilityChanged event.

Declaration

protected virtual void OnStackItemHostVisibilityChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnVisualModeChanged()

Invoked when the value of VisualMode property is changed.

Declaration

protected virtual void OnVisualModeChanged()

PrepareContainerForItemOverride(DependencyObject, Object)

Prepare Container for the particular item.

Declaration

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

Type	Name	Description
System.Windows.DependencyObject	element	The container element used to display the given item.
System.Object	item	The item for which the container has to be prepared.

RecalculateItemContentLength()

Recalculates internal content height.

Declaration

protected void RecalculateItemContentLength()

RenameTab(Int32, String)

Rename the item from the collection of items.

Declaration

public GroupBarItem RenameTab(int index, string caption)

Parameters

Type	Name	Description
System.Int32	index	Index in collection where the specified item is located.
System.String	caption	Text to set.

Returns

Type	Description
GroupBarItem	Renamed GroupBarItem object.

ResetBarState()

Resets the state persisted.

Declaration

public void ResetBarState()

SaveBarState()

Saves the state persisted for the current GroupBar location.

Declaration

public void SaveBarState()

SaveBarState(IsolatedStorageFile, String)

Saves the state persisted for the current GroupBar location.

Declaration

public void SaveBarState(IsolatedStorageFile isoStorage, string storeFileName)

Parameters

Type	Name	Description
System.IO.IsolatedStorage.IsolatedStorageFile	isoStorage	Reference in isolated storage for saving the current GroupBar location.
System.String	storeFileName	File name for the isolated storage.

SetIsEnabledContextMenu(DependencyObject, Boolean)

Sets the value indicating whether the context menu is enabled.

Declaration

public static void SetIsEnabledContextMenu(DependencyObject obj, bool value)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj	Dependency object to set the value to.
System.Boolean	value	The Boolean value indicating whether the context menu is enabled.

SetVisualMode(DependencyObject, VisualMode)

Sets visual mode of the control according to VisualMode enumeration.

Declaration

public static void SetVisualMode(DependencyObject obj, VisualMode value)

Parameters

Type	Name	Description
System.Windows.DependencyObject	obj	Dependency object to set the visual mode to.
VisualMode	value	The value of VisualMode enumeration.

Events

AfterGroupBarItemPopupClosed

Occurs after the popup container is closed.

Declaration

public event EventHandler AfterGroupBarItemPopupClosed

Event Type

Type	Description
System.EventHandler

AfterSplitDown

Bubbling routed event is fired after SplitDown is changed.

Declaration

public event RoutedEventHandler AfterSplitDown

Event Type

Type	Description
System.Windows.RoutedEventHandler

AfterSplitUp

Bubbling routed event is fired after SplitUp is changed.

Declaration

public event RoutedEventHandler AfterSplitUp

Event Type

Type	Description
System.Windows.RoutedEventHandler

BeforeGroupBarItemPopupOpened

Occurs before displaying the GroupBarItem in the popup container during the collapsed mode.

Declaration

public event BeforeGroupBarItemPopupOpenedEventHandler BeforeGroupBarItemPopupOpened

Event Type

Type	Description
BeforeGroupBarItemPopupOpenedEventHandler

BeforeSplitDown

Bubbling routed event is fired before SplitDown is changed.

Declaration

public event RoutedEventHandler BeforeSplitDown

Event Type

Type	Description
System.Windows.RoutedEventHandler

BeforeSplitUp

Bubbling routed event is fired before SplitUp is changed.

Declaration

public event RoutedEventHandler BeforeSplitUp

Event Type

Type	Description
System.Windows.RoutedEventHandler

CollapsedChanged

Occurs when the collapse button is clicked.

Declaration

public event PropertyChangedCallback CollapsedChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

CollapsedWidthChanged

Occurs when value of the CollapsedWidth property is changed.

Declaration

public event PropertyChangedCallback CollapsedWidthChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

ContextMenuItemClick

Occurs when any of the Group Bar Context Menu item Clicked.

Declaration

public event GroupBarContextMenuItemEventHandler ContextMenuItemClick

Event Type

Type	Description
GroupBarContextMenuItemEventHandler

CornerRadiusChanged

Occurs when value of the CornerRadiusChanged property is changed.

Declaration

public event PropertyChangedCallback CornerRadiusChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

FlowDirectionChanged

Bubbling routed event is fired when flow direction of the control is changed.

Declaration

public event FlowDirectionChangedEventHandler FlowDirectionChanged

Event Type

Type	Description
FlowDirectionChangedEventHandler

GroupBarHeaderStyleChanged

Occurs when [group bar header style changed].

Declaration

public event PropertyChangedCallback GroupBarHeaderStyleChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

GroupBarItemAdded

Occurs when a new GroupBarItem is added into the GroupBar.

Declaration

public event NotifyCollectionChangedEventHandler GroupBarItemAdded

Event Type

Type	Description
System.Collections.Specialized.NotifyCollectionChangedEventHandler

GroupBarItemRemoved

Occurs when an existing GroupBarItem is removed from the GroupBar.

Declaration

public event NotifyCollectionChangedEventHandler GroupBarItemRemoved

Event Type

Type	Description
System.Collections.Specialized.NotifyCollectionChangedEventHandler

NavigationMenuClosing

Occurs when the Navigation Menu Closing.

Declaration

public event CancelEventHandler NavigationMenuClosing

Event Type

Type	Description
System.ComponentModel.CancelEventHandler

NavigationMenuOpening

Occurs when the Navigation Menu Opening.

Declaration

public event EventHandler NavigationMenuOpening

Event Type

Type	Description
System.EventHandler

NavigationOptionsMenuItemClick

Occurs when the NavigationOptionsMenuItem Clicked.

Declaration

public event EventHandler NavigationOptionsMenuItemClick

Event Type

Type	Description
System.EventHandler

NavigationPopupSizeChanged

Occurs when value of the NavigationPopupSizeChanged property is changed.

Declaration

public event PropertyChangedCallback NavigationPopupSizeChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

OrientationChanged

Bubbling routed event is fired when orientation of the control is changed, i.e. when orientation changing animation is completed.

Declaration

public event OrientationChangeEventHandler OrientationChanged

Event Type

Type	Description
OrientationChangeEventHandler

OrientationChanging

Bubbling routed event is fired when orientation of the control is changing, i.e. when orientation changing animation is in progress.

Declaration

public event OrientationChangeEventHandler OrientationChanging

Event Type

Type	Description
OrientationChangeEventHandler

PopupResizeDirectionChanged

Occurs when value of the PopupResizeDirection property is changed.

Declaration

public event PropertyChangedCallback PopupResizeDirectionChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

SelectedItemChanged

Bubbling routed event is fired when SelectedItem property is changed.

Declaration

public event RoutedEventHandler SelectedItemChanged

Event Type

Type	Description
System.Windows.RoutedEventHandler

SelectedObjectChanged

Bubbling routed event is fired when SelectedObject property is changed.

Declaration

public event RoutedEventHandler SelectedObjectChanged

Event Type

Type	Description
System.Windows.RoutedEventHandler

SelectedTabChanged

Bubbling routed event is fired when SelectedTab property is changed.

Declaration

public event RoutedEventHandler SelectedTabChanged

Event Type

Type	Description
System.Windows.RoutedEventHandler

ShowGripperChanged

Occurs when value of the ShowGripper property is changed.

Declaration

public event PropertyChangedCallback ShowGripperChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

StackItemHostHeightChanged

Occurs when value of the StackItemHostHeightChanged property is changed.

Declaration

public event PropertyChangedCallback StackItemHostHeightChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

StackItemHostVisibilityChanged

Occurs when value of the StackItemHostVisibilityChanged property is changed.

Declaration

public event PropertyChangedCallback StackItemHostVisibilityChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

StackVisibleItemsCountChanged

Occurs when value of the StackVisibleItemsCountChanged property is changed.

Declaration

public event PropertyChangedCallback StackVisibleItemsCountChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

VisualModeChanged

Bubbling routed event is fired when stack mode is changed.

Declaration

public event RoutedEventHandler VisualModeChanged

Event Type

Type	Description
System.Windows.RoutedEventHandler

Implements

System.IDisposable

WPF- v20.4.0.38

Class GroupBar

Inheritance

Implements

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

Constructors

GroupBar()

Declaration

Fields

AddItemCommand

Declaration

Field Value

AddTabCommand

Declaration

Field Value

AfterSplitDownEvent

Declaration

Field Value

AfterSplitUpEvent

Declaration

Field Value

AllowCollapseProperty

Declaration

Field Value

AllowDragandDropProperty

Declaration

Field Value

AnimationSpeedProperty

Declaration

Field Value

AnimationTypeProperty

Declaration

Field Value

BeforeSplitDownEvent

Declaration

Field Value

BeforeSplitUpEvent

Declaration

Field Value

ChangeListViewModeCommand

Declaration

Field Value

CollapseButtonBackgroundProperty

Declaration

Field Value

CollapseButtonMouseOverBackgroundProperty

Declaration

Field Value

CollapseButtonTemplateProperty

Declaration

Field Value

CollapseButtonToolTipProperty

Declaration

Field Value

CollapsedWidthProperty

Declaration

Field Value

ContentRotationAngleProperty

Declaration

Field Value

CopyItemCommand

Declaration

Field Value

CornerRadiusProperty

Declaration

Field Value

CustomAnimationsProperty

Declaration

Field Value

CutItemCommand

Declaration

Field Value

DefaultItemImageProperty

Declaration

Field Value

DeleteItemCommand

Declaration

Field Value