WPF

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GroupView

    Show / Hide Table of Contents

    Class GroupView

    Represents the FxGroupView UI element.

    Inheritance
    System.Object
    GroupView
    Namespace: Syncfusion.Windows.Tools.Controls
    Assembly: Syncfusion.Tools.Wpf.dll
    Syntax
    [SkinType(SkinVisualStyle = Skin.Office2010Black, Type = typeof(GroupView), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2010BlackStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Office2010Silver, Type = typeof(GroupView), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2010SilverStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Office2003, Type = typeof(GroupView), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2003Style.xaml")]
    [SkinType(SkinVisualStyle = Skin.ShinyBlue, Type = typeof(GroupView), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/ShinyBlueStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.ShinyRed, Type = typeof(GroupView), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/ShinyRedStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.SyncOrange, Type = typeof(GroupView), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/SyncOrangeStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Transparent, Type = typeof(GroupView), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/TransparentStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Office2010Blue, Type = typeof(GroupView), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2010BlueStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Default, Type = typeof(GroupView), XamlResource = "/Syncfusion.Tools.Wpf;component/Controls/GroupBar/Themes/DefaultStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.VS2010, Type = typeof(GroupView), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/VS2010Style.xaml")]
    [SkinType(SkinVisualStyle = Skin.Metro, Type = typeof(GroupView), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/MetroStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Blend, Type = typeof(GroupView), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/BlendStyle.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(GroupView), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2007BlueStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Office2007Black, Type = typeof(GroupView), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2007BlackStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Office2007Silver, Type = typeof(GroupView), XamlResource = "/Syncfusion.Tools.Wpf.Classic;component/Controls/GroupBar/Themes/Office2007SilverStyle.xaml")]
    public class GroupView : ItemsControl

    Constructors

    GroupView()

    Initializes a new instance of the GroupView class.

    Declaration
    public GroupView()

    Fields

    AllowDragandDropProperty

    Declaration
    public static readonly DependencyProperty AllowDragandDropProperty
    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

    GroupViewItemCursorTypeProperty

    Identifies GroupViewItemCursorType dependency property.

    Declaration
    public static readonly DependencyProperty GroupViewItemCursorTypeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    IsListViewModeProperty

    Identifies IsListViewMode dependency property.

    Declaration
    public static readonly DependencyProperty IsListViewModeProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    IsShowTextProperty

    Identifies IsShowText dependency property.

    Declaration
    public static readonly DependencyProperty IsShowTextProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    OrientationProperty

    Identifies Orientation dependency property.

    Declaration
    public static readonly DependencyProperty OrientationProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ShowToolTipProperty

    Identifies ShowToolTip dependency property.

    Declaration
    public static readonly DependencyProperty ShowToolTipProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    TextAlignmentProperty

    Identifies TextHorizontalAlignment dependency property.

    Declaration
    public static readonly DependencyProperty TextAlignmentProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    Properties

    AllowDragandDrop

    Declaration
    public bool AllowDragandDrop { get; set; }
    Property Value
    Type Description
    System.Boolean

    CustomAnimations

    Gets or sets the custom animations.

    Declaration
    public CustomAnimationsCollection CustomAnimations { get; set; }
    Property Value
    Type Description
    CustomAnimationsCollection

    The custom animations.

    GroupViewItemCursor

    Gets the group view item cursor.

    Declaration
    public Cursor GroupViewItemCursor { get; }
    Property Value
    Type Description
    System.Windows.Input.Cursor

    The group view item cursor.

    GroupViewItemCursorType

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

    Declaration
    public ItemCursorType GroupViewItemCursorType { get; set; }
    Property Value
    Type Description
    ItemCursorType

    The type of the group view item cursor.

    IsListViewMode

    Gets or sets a value indicating whether this instance is list view mode.

    Declaration
    public bool IsListViewMode { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if this instance is list view mode; otherwise, false.

    IsShowText

    Gets or sets a value indicating whether this instance is show text.

    Declaration
    public bool IsShowText { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if this instance is show text; otherwise, false.

    LogicalParent

    Gets the logical parent.

    Declaration
    public GroupBarItem LogicalParent { get; }
    Property Value
    Type Description
    GroupBarItem

    The logical parent.

    Orientation

    Gets or sets the orientation.

    Declaration
    public Orientation Orientation { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.Orientation

    The orientation.

    ShowToolTip

    Gets or sets a value indicating whether [show tool tip].

    Declaration
    public bool ShowToolTip { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if [show tool tip]; otherwise, false.

    TextAlignment

    Gets or sets the text alignment.

    Declaration
    public HorizontalAlignment TextAlignment { get; set; }
    Property Value
    Type Description
    System.Windows.HorizontalAlignment

    The text alignment.

    Methods

    AddItem()

    Adds the item to the collection of items.

    Declaration
    public GroupViewItem AddItem()
    Returns
    Type Description
    GroupViewItem

    New GroupViewItem object.

    AddItem(Int32)

    Adds the item to the collection of items.

    Declaration
    public GroupViewItem AddItem(int index)
    Parameters
    Type Name Description
    System.Int32 index

    Index in the collection where the specified item is located.

    Returns
    Type Description
    GroupViewItem

    New GroupViewItem object

    AddItem(String)

    Adds the item to the collection of items.

    Declaration
    public GroupViewItem AddItem(string caption)
    Parameters
    Type Name Description
    System.String caption

    Displayed text of the item.

    Returns
    Type Description
    GroupViewItem

    New GroupViewItem object.

    AddItem(String, Image)

    Adds the item to the collection of items.

    Declaration
    public GroupViewItem AddItem(string caption, Image image)
    Parameters
    Type Name Description
    System.String caption

    Displayed text of the item.

    System.Windows.Controls.Image image

    The image of the item..

    Returns
    Type Description
    GroupViewItem

    New GroupViewItem object.

    AddItem(String, Image, Int32, Object, String)

    Adds the item.

    Declaration
    public GroupViewItem AddItem(string caption, Image image, int index, object tagObject, string tooltip)
    Parameters
    Type Name Description
    System.String caption

    The caption.

    System.Windows.Controls.Image image

    The image.

    System.Int32 index

    The index.

    System.Object tagObject

    The tag object.

    System.String tooltip

    The tooltip.

    Returns
    Type Description
    GroupViewItem

    Group ViewItem

    AddItem(String, Image, Object)

    Adds the item to the collection of items.

    Declaration
    public GroupViewItem AddItem(string caption, Image image, object tagObject)
    Parameters
    Type Name Description
    System.String caption

    Displayed text of the item.

    System.Windows.Controls.Image image

    The image of the item.

    System.Object tagObject

    Arbitrary object value.

    Returns
    Type Description
    GroupViewItem

    New GroupViewItem object.

    ArrangeOverride(Size)

    Called to arrange and size the content of the control.

    Declaration
    protected override Size ArrangeOverride(Size arrangeBounds)
    Parameters
    Type Name Description
    System.Windows.Size arrangeBounds

    The computed size that is used to arrange the content.

    Returns
    Type Description
    System.Windows.Size

    The size of the control.

    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.

    GetShowToolTip(DependencyObject)

    Gets a value indicating whether tooltip is shown for the items.

    Declaration
    public static bool GetShowToolTip(DependencyObject obj)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    GroupView object.

    Returns
    Type Description
    System.Boolean

    True if toolTip is shown for the items; otherwise, false.

    IsItemItsOwnContainerOverride(Object)

    Indicates whether 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.

    MeasureOverride(Size)

    Called to remeasure a control.

    Declaration
    protected override Size MeasureOverride(Size constraint)
    Parameters
    Type Name Description
    System.Windows.Size constraint

    The maximum size that the method can return.

    Returns
    Type Description
    System.Windows.Size

    The size of the control, up to the maximum specified by constraint.

    OnApplyTemplate()

    Builds the current template's visual tree if necessary.

    Declaration
    public override void OnApplyTemplate()

    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.

    OnGroupViewItemAdded(NotifyCollectionChangedEventArgs)

    Invoked when a new GroupViewItem is added into the GroupView.

    Declaration
    protected virtual void OnGroupViewItemAdded(NotifyCollectionChangedEventArgs e)
    Parameters
    Type Name Description
    System.Collections.Specialized.NotifyCollectionChangedEventArgs e

    The System.Collections.Specialized.NotifyCollectionChangedEventArgs that contains the event data.

    OnGroupViewItemRemoved(NotifyCollectionChangedEventArgs)

    Invoked when an existing GroupViewItem is removed from the GroupView.

    Declaration
    protected virtual void OnGroupViewItemRemoved(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.

    OnItemsChanged(NotifyCollectionChangedEventArgs)

    Invoked when Items property of the control is changed.

    Declaration
    protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
    Parameters
    Type Name Description
    System.Collections.Specialized.NotifyCollectionChangedEventArgs e

    The instance containing 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

    The source of the event.

    System.Windows.RoutedEventArgs e

    The System.Windows.RoutedEventArgs 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.

    RenameItem(Int32, String)

    Rename the item from the collection of items.

    Declaration
    public GroupViewItem RenameItem(int index, string caption)
    Parameters
    Type Name Description
    System.Int32 index

    Index in the collection where the specified item is located.

    System.String caption

    The caption.

    Returns
    Type Description
    GroupViewItem

    Renamed GroupViewItem object.

    SetShowToolTip(DependencyObject, Boolean)

    Sets the show tool tip.

    Declaration
    public static void SetShowToolTip(DependencyObject obj, bool value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject obj

    The obj DependencyObject.

    System.Boolean value

    if set to true [value].

    Events

    GroupViewItemAdded

    Occurs when a new GroupViewItem is added into the GroupView.

    Declaration
    public event NotifyCollectionChangedEventHandler GroupViewItemAdded
    Event Type
    Type Description
    System.Collections.Specialized.NotifyCollectionChangedEventHandler

    GroupViewItemRemoved

    Occurs when an existing GroupViewItem is removed from the GroupView.

    Declaration
    public event NotifyCollectionChangedEventHandler GroupViewItemRemoved
    Event Type
    Type Description
    System.Collections.Specialized.NotifyCollectionChangedEventHandler
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved