Class GroupBarItem

Represents the GroupBarItem UI element.

Inheritance

System.Object

GroupBarItem

Implements

System.IDisposable

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
public class GroupBarItem : HeaderedContentControl, IDisposable

Constructors

GroupBarItem()

Initializes a new instance of the GroupBarItem class.

Declaration

public GroupBarItem()

Fields

AfterEditEvent

Identifies AfterEdit event.

Declaration

public static readonly RoutedEvent AfterEditEvent

Field Value

Type
System.Windows.RoutedEvent

BeforeEditEvent

Identifies BeforeEdit event.

Declaration

public static readonly RoutedEvent BeforeEditEvent

Field Value

Type
System.Windows.RoutedEvent

ClickEvent

Identifies Click event.

Declaration

public static readonly RoutedEvent ClickEvent

Field Value

Type
System.Windows.RoutedEvent

CollapsedEvent

Identifies Expanded event.

Declaration

public static readonly RoutedEvent CollapsedEvent

Field Value

Type
System.Windows.RoutedEvent

CustomAnimationsProperty

Identifies CustomAnimations dependency property.

Declaration

public static readonly DependencyProperty CustomAnimationsProperty

Field Value

Type
System.Windows.DependencyProperty

DoubleClickEvent

Identifies DoubleClick event.

Declaration

public static readonly RoutedEvent DoubleClickEvent

Field Value

Type
System.Windows.RoutedEvent

ExpandedEvent

Identifies Expanded event.

Declaration

public static readonly RoutedEvent ExpandedEvent

Field Value

Type
System.Windows.RoutedEvent

GroupBarItemCornerRadiusProperty

Identifies GroupBarItemCornerRadius dependency property.

Declaration

public static readonly DependencyProperty GroupBarItemCornerRadiusProperty

Field Value

Type
System.Windows.DependencyProperty

HeaderImageSourceProperty

Identifies HeaderImageSource dependency property.

Declaration

public static readonly DependencyProperty HeaderImageSourceProperty

Field Value

Type
System.Windows.DependencyProperty

HeaderStyleProperty

Declaration

public static readonly DependencyProperty HeaderStyleProperty

Field Value

Type
System.Windows.DependencyProperty

HeaderTextProperty

Identifies HeaderText dependency property.

Declaration

public static readonly DependencyProperty HeaderTextProperty

Field Value

Type
System.Windows.DependencyProperty

HoverEvent

Identifies Hover event.

Declaration

public static readonly RoutedEvent HoverEvent

Field Value

Type
System.Windows.RoutedEvent

IsAnimatingProperty

Identifies IsAnimating dependency property.

Declaration

public static readonly DependencyProperty IsAnimatingProperty

Field Value

Type
System.Windows.DependencyProperty

Remarks

Used for setting ScrollBarVisibility when animation is executing.

IsContextMenuOpenedProperty

Identifies IsContextMenuOpened dependency property.

Declaration

public static readonly DependencyProperty IsContextMenuOpenedProperty

Field Value

Type
System.Windows.DependencyProperty

IsDragOverDownProperty

Identifies IsDragOverDown dependency property.

Declaration

public static readonly DependencyProperty IsDragOverDownProperty

Field Value

Type
System.Windows.DependencyProperty

IsDragOverTopProperty

Identifies IsDragOverTop dependency property.

Declaration

public static readonly DependencyProperty IsDragOverTopProperty

Field Value

Type
System.Windows.DependencyProperty

IsExpandedProperty

Identifies IsExpanded dependency property.

Declaration

public static readonly DependencyProperty IsExpandedProperty

Field Value

Type
System.Windows.DependencyProperty

IsHighlightedProperty

Identifies IsHighlighted dependency property.

Declaration

public static readonly DependencyProperty IsHighlightedProperty

Field Value

Type
System.Windows.DependencyProperty

IsInEditModeProperty

Identifies IsInEditMode dependency property.

Declaration

public static readonly DependencyProperty IsInEditModeProperty

Field Value

Type
System.Windows.DependencyProperty

IsLastItemProperty

Identifies IsLastItemProperty dependency property.

Declaration

public static readonly DependencyProperty IsLastItemProperty

Field Value

Type
System.Windows.DependencyProperty

IsPressedProperty

Identifies IsPressed dependency property.

Declaration

public static readonly DependencyProperty IsPressedProperty

Field Value

Type
System.Windows.DependencyProperty

IsSelectedProperty

Identifies IsSelected dependency property.

Declaration

public static readonly DependencyProperty IsSelectedProperty

Field Value

Type
System.Windows.DependencyProperty

PressEvent

Identifies Press event.

Declaration

public static readonly RoutedEvent PressEvent

Field Value

Type
System.Windows.RoutedEvent

SelectedAnimationProperty

Identifies SelectedAnimation dependency property.

Declaration

public static DependencyProperty SelectedAnimationProperty

Field Value

Type
System.Windows.DependencyProperty

ShowInGroupBarProperty

Identifies ShowInGroupBar dependency property.

Declaration

public static readonly DependencyProperty ShowInGroupBarProperty

Field Value

Type
System.Windows.DependencyProperty

UnselectedAnimationProperty

Identifies UnselectedAnimation dependency property.

Declaration

public static DependencyProperty UnselectedAnimationProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

ContentBreadth

Declaration

public double ContentBreadth { get; set; }

Property Value

Type
System.Double

ContentLength

Gets or sets the length of the content.

Declaration

public double ContentLength { get; set; }

Property Value

Type	Description
System.Double	The length of the content.

CustomAnimations

Gets or sets the custom animations.

Declaration

public CustomAnimationsCollection CustomAnimations { get; set; }

Property Value

Type	Description
CustomAnimationsCollection	The custom animations.

GroupBarItemCornerRadius

Gets or sets the Corner Radius of the GroupBarItem

Declaration

public CornerRadius GroupBarItemCornerRadius { get; set; }

Property Value

Type	Description
System.Windows.CornerRadius	Type: System.Windows.CornerRadius Default value is 0.

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(); // Add item to GroupBar.Items collection groupBar.Items.Add( barItem1 ); // Set content of GroupBarItem as GroupView barItem1.Content = new CalendarEdit(); // Set the CornerRadius of the GroupBarItem barItem1.GroupBarItemCornerRadius=new CornerRadius(20d); /* Result: GroupBarItems,Cornerradius is set to 20. */

HeaderImageSource

Gets or sets the source of the image shown in the header.

Declaration

public ImageSource HeaderImageSource { get; set; }

Property Value

Type	Description
System.Windows.Media.ImageSource	Type: System.Windows.Media.ImageSource Default value is null.

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(); // Add item to GroupBar.Items collection groupBar.Items.Add( barItem1 ); // Set content of GroupBarItem as GroupView barItem1.Content = new CalendarEdit(); // Create bitmap image BitmapImage bmpImage = new BitmapImage(new Uri("pack://application:,,/Images/picture.png")); // Set image for the header of the GroupBarItem barItem1.HeaderImageSource = bmpImage; /* Result: Chosen image will be displayed on the header of the GroupBarItem. */

HeaderStyle

Declaration

public Style HeaderStyle { get; set; }

Property Value

Type
System.Windows.Style

HeaderText

Gets or sets the header text.

Declaration

public string HeaderText { get; set; }

Property Value

Type	Description
System.String	The header text.

IsAnimating

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

Declaration

public bool IsAnimating { get; set; }

Property Value

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

IsContextMenuOpened

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

Declaration

public bool IsContextMenuOpened { get; set; }

Property Value

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

IsDragOverDown

Gets or sets a value indicating whether this instance is drag over down.

Declaration

public bool IsDragOverDown { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is drag over down; otherwise, false.

IsDragOverTop

Gets or sets a value indicating whether this instance is drag over top.

Declaration

public bool IsDragOverTop { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is drag over top; otherwise, false.

IsExpanded

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

Declaration

public bool IsExpanded { get; set; }

Property Value

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

IsHidden

Gets a value indicating whether the GroupBarItem is in hidden state or not.

Declaration

public bool IsHidden { get; }

Property Value

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

IsHighlighted

Gets a value indicating whether this instance is highlighted.

Declaration

public bool IsHighlighted { get; }

Property Value

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

IsInEditMode

Gets or sets a value indicating whether this instance is in edit mode.

Declaration

public bool IsInEditMode { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is in edit mode; otherwise, false.

IsLastItem

Gets or sets a value indicating whether this instance is last item.

Declaration

public bool IsLastItem { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is last item; otherwise, false.

IsPressed

Gets a value indicating whether this instance is pressed.

Declaration

public bool IsPressed { get; }

Property Value

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

IsSelected

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

Declaration

public bool IsSelected { get; set; }

Property Value

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

LogicalParent

Gets the logical parent.

Declaration

public GroupBar LogicalParent { get; }

Property Value

Type	Description
GroupBar	The logical parent.

SelectedAnimation

Gets or sets the selected animation.

Declaration

public DoubleAnimation SelectedAnimation { get; set; }

Property Value

Type	Description
System.Windows.Media.Animation.DoubleAnimation	The selected animation.

ShowInGroupBar

Gets or sets a value indicating whether [show in group bar].

Declaration

public bool ShowInGroupBar { get; set; }

Property Value

Type	Description
System.Boolean	`true` if [show in group bar]; otherwise, `false`.

UnselectedAnimation

Gets or sets the unselected animation.

Declaration

public DoubleAnimation UnselectedAnimation { get; set; }

Property Value

Type	Description
System.Windows.Media.Animation.DoubleAnimation	The unselected animation.

Methods

Dispose()

Invoked when GroupBarItem unloaded to dispose the instances and hooked events.

Declaration

public void Dispose()

GetClone(GroupBarItem)

Declaration

public GroupBarItem GetClone(GroupBarItem Source)

Parameters

Type	Name	Description
GroupBarItem	Source

Returns

Type
GroupBarItem

MeasureOverride(Size)

Overrides MeasureOverride method.

Declaration

protected override Size MeasureOverride(Size constraint)

Parameters

Type	Name	Description
System.Windows.Size	constraint	Settled by a father measure.

Returns

Type	Description
System.Windows.Size	GroupView measure.

OnApplyTemplate()

Builds the current template's visual tree if necessary.

Declaration

public override void OnApplyTemplate()

OnClick()

Invoked when the mouse performs click on the header.

Declaration

protected virtual void OnClick()

OnDoubleClick()

Invoked when mouse performs double click on the header.

Declaration

protected virtual void OnDoubleClick()

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.

OnGotKeyboardFocus(KeyboardFocusChangedEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.GotKeyboardFocus 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 OnGotKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameters

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

OnHeaderStyleChanged(DependencyPropertyChangedEventArgs)

Raises the GroupBarHeaderStyleChanged event.

Declaration

protected virtual void OnHeaderStyleChanged(DependencyPropertyChangedEventArgs e)

Parameters

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

OnHover()

Invoked when mouse hovers over the header.

Declaration

protected virtual void OnHover()

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.

OnKeyDown(KeyEventArgs)

Invoked when to the System.Windows.Input.Keyboard.KeyDown event is received.

Declaration

protected override void OnKeyDown(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 loaded and ready for presentation.

Declaration

protected virtual void OnLoaded(object sender, RoutedEventArgs e)

Parameters

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

OnLostKeyboardFocus(KeyboardFocusChangedEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.LostKeyboardFocus 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 OnLostKeyboardFocus(KeyboardFocusChangedEventArgs e)

Parameters

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

OnMouseDoubleClick(MouseButtonEventArgs)

Raises the System.Windows.Controls.Control.MouseDoubleClick event.

Declaration

protected override void OnMouseDoubleClick(MouseButtonEventArgs e)

Parameters

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

OnMouseLeftButtonDown(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.MouseLeftButtonDown routed event is raised on this element. Implement this method to add class handling for this event.

Declaration

protected override void OnMouseLeftButtonDown(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 left mouse button was pressed.

OnMouseLeftButtonUp(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.MouseLeftButtonUp 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 OnMouseLeftButtonUp(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 left mouse button was released.

OnMouseMove(MouseEventArgs)

Invoked when an unhandled System.Windows.Input.Mouse.MouseMove 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 OnMouseMove(MouseEventArgs e)

Parameters

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

OnMouseRightButtonDown(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.MouseRightButtonDownrouted event reaches an element in its route that is derived from this class.

Declaration

protected override void OnMouseRightButtonDown(MouseButtonEventArgs e)

Parameters

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

OnMouseRightButtonUp(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.MouseRightButtonUprouted event reaches an element in its route that is derived from this class.

Declaration

protected override void OnMouseRightButtonUp(MouseButtonEventArgs e)

Parameters

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

OnPress()

Invoked when the header is pressed.

Declaration

protected virtual void OnPress()

OnPreviewMouseDown(MouseButtonEventArgs)

Override method for preview mouse down

Declaration

protected override void OnPreviewMouseDown(MouseButtonEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseButtonEventArgs	e

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.

OnSelected()

Invoked when the control is selected.

Declaration

protected virtual void OnSelected()

OnTouchUp(TouchEventArgs)

Invoked when an unhandled System.Windows.UIElement.TouchUp 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 OnTouchUp(TouchEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.TouchEventArgs	e	The System.Windows.Input.TouchEventArgs that contains the event data. The event data reports that the touch was released.

OnUnselected()

Invoked when the control is unselected.

Declaration

protected virtual void OnUnselected()

Events

AfterEdit

Bubbling routed event is fired after renaming the GroupBarItem.

Declaration

public event RoutedEventHandler AfterEdit

Event Type

Type
System.Windows.RoutedEventHandler

BeforeEdit

Bubbling routed event is fired before renaming the GroupBarItem.

Declaration

public event RoutedEventHandler BeforeEdit

Event Type

Type
System.Windows.RoutedEventHandler

Click

Bubbling routed event is fired when mouse click on the header is performed.

Declaration

public event RoutedEventHandler Click

Event Type

Type
System.Windows.RoutedEventHandler

Collapsed

Occurs when the isexpanded property is changed.

Declaration

public event RoutedEventHandler Collapsed

Event Type

Type
System.Windows.RoutedEventHandler

DoubleClick

Bubbling routed event is fired when mouse double click on the header is performed.

Declaration

public event RoutedEventHandler DoubleClick

Event Type

Type
System.Windows.RoutedEventHandler

Expanded

Occurs when the isexpanded property is changed.

Declaration

public event RoutedEventHandler Expanded

Event Type

Type
System.Windows.RoutedEventHandler

HeaderStyleChanged

Declaration

public event PropertyChangedCallback HeaderStyleChanged

Event Type

Type
System.Windows.PropertyChangedCallback

Hover

Bubbling routed event is fired when mouse hovers over the header.

Declaration

public event RoutedEventHandler Hover

Event Type

Type
System.Windows.RoutedEventHandler

Press

Bubbling routed event is fired when the header is pressed.

Declaration

public event RoutedEventHandler Press

Event Type

Type
System.Windows.RoutedEventHandler

Implements

System.IDisposable