WinForms

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

    Show / Hide Table of Contents

    Class GroupBarItem

    Represents an item in the GroupBar control.

    Inheritance
    System.Object
    GroupBarItem
    Implements
    System.ComponentModel.ICustomTypeDescriptor
    Namespace: Syncfusion.Windows.Forms.Tools
    Assembly: Syncfusion.Shared.Base.dll
    Syntax
    public class GroupBarItem : Component, ICustomTypeDescriptor
    Remarks

    The GroupBar control is composed of a number of selectable groups or items each of which is associated with a client control. Each of these items is an instance of the GroupBarItem type. The collection of items present in the GroupBar can be accessed through the control's GroupBarItems property.

    Constructors

    GroupBarItem()

    Creates an instance of the GroupBarItem class.

    Declaration
    public GroupBarItem()

    Fields

    bBackColorSet

    Declaration
    protected bool bBackColorSet
    Field Value
    Type Description
    System.Boolean

    bBorderColorsSet

    Declaration
    protected bool bBorderColorsSet
    Field Value
    Type Description
    System.Boolean

    bdrColors

    Declaration
    protected BorderColors bdrColors
    Field Value
    Type Description
    BorderColors

    bEnabled

    Declaration
    protected bool bEnabled
    Field Value
    Type Description
    System.Boolean

    bFontSet

    Declaration
    protected bool bFontSet
    Field Value
    Type Description
    System.Boolean

    bInNavigationPane

    Declaration
    protected bool bInNavigationPane
    Field Value
    Type Description
    System.Boolean

    brBackground

    Declaration
    protected Brush brBackground
    Field Value
    Type Description
    System.Drawing.Brush

    bVisible

    Declaration
    protected bool bVisible
    Field Value
    Type Description
    System.Boolean

    clrForeGround

    Declaration
    protected Color clrForeGround
    Field Value
    Type Description
    System.Drawing.Color

    ftText

    Declaration
    protected Font ftText
    Field Value
    Type Description
    System.Drawing.Font

    groupBarCtrl

    Declaration
    protected GroupBar groupBarCtrl
    Field Value
    Type Description
    GroupBar

    iItemIcon

    Declaration
    protected Icon iItemIcon
    Field Value
    Type Description
    System.Drawing.Icon

    iItemImage

    Declaration
    protected Image iItemImage
    Field Value
    Type Description
    System.Drawing.Image

    imageYchanged

    Declaration
    protected bool imageYchanged
    Field Value
    Type Description
    System.Boolean

    iNavPaneIcon

    Declaration
    protected Icon iNavPaneIcon
    Field Value
    Type Description
    System.Drawing.Icon

    objTag

    Declaration
    protected object objTag
    Field Value
    Type Description
    System.Object

    szText

    Declaration
    protected string szText
    Field Value
    Type Description
    System.String

    textDraw

    Declaration
    protected bool textDraw
    Field Value
    Type Description
    System.Boolean

    wndClient

    Declaration
    protected Control wndClient
    Field Value
    Type Description
    System.Windows.Forms.Control

    Properties

    BackColor

    Gets / sets the color used to fill the GroupBarItem background.

    Declaration
    public Color BackColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    A System.Drawing.Color value.

    BackgroundBrush

    Gets / sets the brush used for painting the GroupBarItem background.

    Declaration
    public Brush BackgroundBrush { get; set; }
    Property Value
    Type Description
    System.Drawing.Brush

    A System.Drawing.Brush value.

    Client

    Gets / sets the client control associated with the GroupBarItem.

    Declaration
    public Control Client { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.Control

    A System.Windows.Forms.Control instance.

    ClientBorderColors

    Gets / sets the colors used to draw the borders around the GroupBarItem's client control.

    Declaration
    public BorderColors ClientBorderColors { get; set; }
    Property Value
    Type Description
    BorderColors

    A BorderColors value.

    Enabled

    Indicates whether the GroupBarItem is enabled / disabled.

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

    False if the item is disabled. The default is True.

    Font

    Gets / sets the font used for drawing the GroupBarItem text.

    Declaration
    public Font Font { get; set; }
    Property Value
    Type Description
    System.Drawing.Font

    A System.Drawing.Font value.

    ForeColor

    Gets / sets the foreground color used to paint the text in the GroupBarItem.

    Declaration
    public Color ForeColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    A System.Drawing.Color value.

    GroupBar

    Returns the GroupBar control that the item is assigned to.

    Declaration
    public GroupBar GroupBar { get; }
    Property Value
    Type Description
    GroupBar

    A GroupBar that represents the parent GroupBar control that the GroupBarItem is assigned to.

    Icon

    Gets / sets the icon displayed on the GroupBarItem.

    Declaration
    public Icon Icon { get; set; }
    Property Value
    Type Description
    System.Drawing.Icon

    An System.Drawing.Icon value.

    Image

    Gets / sets the image displayed on the GroupBarItem.

    Declaration
    public Image Image { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    An System.Drawing.Icon value.

    InDesignMode

    Declaration
    protected bool InDesignMode { get; }
    Property Value
    Type Description
    System.Boolean

    InNavigationPane

    Indicates whether the GroupBarItem should be added to the navigation pane.

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

    TRUE if the item should be added to the navigation pane. The default is FALSE.

    Remarks

    This property is valid only when the GroupBar control is in the stacked mode. StackedMode

    IsTextVisible

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

    LargeImageMode

    Indicates whether all types of images can be used or not

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

    NavigationPaneIcon

    Gets / sets the icon representing the GroupBarItem in the navigation pane.

    Declaration
    public Icon NavigationPaneIcon { get; set; }
    Property Value
    Type Description
    System.Drawing.Icon

    An System.Drawing.Icon value.

    Remarks

    This property is valid only when the GroupBar control is in the stacked mode. StackedMode

    NavigationPaneImage

    Gets / sets image representing the item in the GroupBar's navigation pane.

    Declaration
    public Image NavigationPaneImage { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    Padding

    Gets or sets padding for GroupBarItem.

    Declaration
    public int Padding { get; set; }
    Property Value
    Type Description
    System.Int32

    Tag

    Gets / sets the object that contains data about the GroupBarItem.

    Declaration
    public object Tag { get; set; }
    Property Value
    Type Description
    System.Object

    A System.Object value that contains data about the control. The default is a NULL reference (Nothing in Visual Basic).

    Remarks

    Any type derived from the Object class can be assigned to this property. If the Tag property is set through the Windows Forms designer, only text may be assigned.

    Text

    Gets / sets the text displayed on the GroupBarItem.

    Declaration
    public string Text { get; set; }
    Property Value
    Type Description
    System.String

    A String value.

    Visible

    Indicates whether the GroupBarItem is visible.

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

    False if the item is hidden. The default is True.

    YChanged

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

    Methods

    Dispose(Boolean)

    Overridden. See System.ComponentModel.Component.Dispose(System.Boolean).

    Declaration
    protected override void Dispose(bool bdispose)
    Parameters
    Type Name Description
    System.Boolean bdispose

    GroupBar_BackColorChanged(Object, EventArgs)

    Declaration
    protected void GroupBar_BackColorChanged(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    GroupBar_FontChanged(Object, EventArgs)

    Declaration
    protected void GroupBar_FontChanged(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    OnPropertyChanged(PropertyChangedEventArgs)

    Declaration
    protected void OnPropertyChanged(PropertyChangedEventArgs args)
    Parameters
    Type Name Description
    System.ComponentModel.PropertyChangedEventArgs args

    ResetBackColor()

    Resets the BackColor property to its default value.

    Declaration
    public void ResetBackColor()

    ResetClientBorderColors()

    Resets the ClientBorderColors property to its default value.

    Declaration
    public void ResetClientBorderColors()

    ResetFont()

    Resets the Font property to its default value.

    Declaration
    public void ResetFont()

    ResetForeColor()

    Resets the ForeColor property to its default value.

    Declaration
    public void ResetForeColor()

    SetGroupBarControlReference(GroupBar)

    Declaration
    protected void SetGroupBarControlReference(GroupBar ctrl)
    Parameters
    Type Name Description
    GroupBar ctrl

    ShouldSerializeBackColor()

    Declaration
    protected bool ShouldSerializeBackColor()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeClientBorderColors()

    Declaration
    protected bool ShouldSerializeClientBorderColors()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeFont()

    Declaration
    protected bool ShouldSerializeFont()
    Returns
    Type Description
    System.Boolean

    ShouldSerializeForeColor()

    Declaration
    protected bool ShouldSerializeForeColor()
    Returns
    Type Description
    System.Boolean

    ShouldSerializePadding()

    Declaration
    public bool ShouldSerializePadding()
    Returns
    Type Description
    System.Boolean

    Events

    PropertyChanged

    Declaration
    public event PropertyChangedEventHandler PropertyChanged
    Event Type
    Type Description
    System.ComponentModel.PropertyChangedEventHandler

    Implements

    System.ComponentModel.ICustomTypeDescriptor
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved