Class GroupViewItem

Represents an item in the GroupView control.

Inheritance

System.Object

GroupViewItem

PaletteGroupView.GroupViewPaletteItem

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Windows.Forms.Tools

Assembly: Syncfusion.Shared.Base.dll

Syntax

public class GroupViewItem

Remarks

Each item in a GroupView control is an instance of the GroupViewItem type. The collection of GroupViewItems in the control can be accessed through the GroupViewItems property.

Constructors

GroupViewItem()

Overloaded. Creates an instance of the GroupViewItem class.

Declaration

public GroupViewItem()

GroupViewItem(String, Int32)

Creates an instance of the GroupViewItem class with the specified attributes.

Declaration

public GroupViewItem(string name, int image)

Parameters

Type	Name	Description
System.String	name	A String value representing the GroupViewItem text.
System.Int32	image	An integer value representing a zero-based index into the GroupView control's small and large imagelists.

GroupViewItem(String, Int32, Boolean)

Creates an instance of the GroupViewItem class with the specified attributes.

Declaration

public GroupViewItem(string name, int image, bool enabled)

Parameters

Type	Name	Description
System.String	name	A String value representing the GroupViewItem text.
System.Int32	image	An integer value representing a zero-based index into the GroupView control's small and large imagelists.
System.Boolean	enabled	A boolean value representing the item's enabled / disabled state.

GroupViewItem(String, Int32, Boolean, Object)

Creates an instance of the GroupViewItem class with the specified attributes.

Declaration

public GroupViewItem(string name, int image, bool enabled, object tagObject)

Parameters

Type	Name	Description
System.String	name	A String value representing the GroupViewItem text.
System.Int32	image	An integer value representing a zero-based index into the GroupView control's small and large imagelists.
System.Boolean	enabled	A boolean value representing the item's enabled / disabled state.
System.Object	tagObject	An Object value that contains data about the GroupViewItem.

GroupViewItem(String, Int32, Boolean, Object, Boolean)

Creates an instance of the GroupViewItem class with the specified attributes.

Declaration

public GroupViewItem(string name, int image, bool enabled, object tagObject, bool bVisible)

Parameters

Type	Name	Description
System.String	name	A String value representing the GroupViewItem text.
System.Int32	image	An integer value representing a zero-based index into the GroupView control's small and large imagelists.
System.Boolean	enabled
System.Object	tagObject	An Object value that contains data about the GroupViewItem.
System.Boolean	bVisible	A boolean value representing the item's show/hide the GroupViewItems.

GroupViewItem(String, Int32, Boolean, Object, String)

Creates an instance of the GroupViewItem class with the specified attributes.

Declaration

public GroupViewItem(string name, int image, bool enabled, object tagObject, string tooltipText)

Parameters

Type	Name	Description
System.String	name	A String value representing the GroupViewItem text.
System.Int32	image	An integer value representing a zero-based index into the GroupView control's small and large imagelists.
System.Boolean	enabled	A boolean value representing the item's enabled / disabled state.
System.Object	tagObject	An Object value that contains data about the GroupViewItem.
System.String	tooltipText	A String value representing the GroupViewItem tooltiptext.

GroupViewItem(String, Int32, Boolean, Object, String, Boolean)

Declaration

public GroupViewItem(string name, int image, bool enabled, object tagObject, string tooltipText, bool bVisible)

Parameters

Type	Name	Description
System.String	name
System.Int32	image
System.Boolean	enabled
System.Object	tagObject
System.String	tooltipText
System.Boolean	bVisible

GroupViewItem(String, Int32, Object)

Creates an instance of the GroupViewItem class with the specified attributes.

Declaration

public GroupViewItem(string name, int image, object tagObject)

Parameters

Type	Name	Description
System.String	name	A String value representing the GroupViewItem text.
System.Int32	image	An integer value representing a zero-based index into the GroupView control's small and large imagelists.
System.Object	tagObject	An Object value that contains data about the GroupViewItem.

Fields

bEnabled

Declaration

protected bool bEnabled

Field Value

Type
System.Boolean

groupViewCtrl

Declaration

protected GroupView groupViewCtrl

Field Value

Type
GroupView

GroupViewItemName

Declaration

public const string GroupViewItemName = "GroupViewItem"

Field Value

Type
System.String

nImage

Declaration

protected int nImage

Field Value

Type
System.Int32

nItemXSpacing

Gets or Sets the value to change the Text Position of the GroupViewItem

Declaration

protected int nItemXSpacing

Field Value

Type
System.Int32

nItemYSpacing

Gets / sets the height between adjacent GroupViewItems.

Declaration

protected int nItemYSpacing

Field Value

Type
System.Int32

objTag

Declaration

protected object objTag

Field Value

Type
System.Object

strText

Declaration

protected string strText

Field Value

Type
System.String

Properties

Enabled

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

GroupView

Returns the GroupView control that the item is assigned to.

Declaration

public GroupView GroupView { get; }

Property Value

Type	Description
GroupView	A GroupView that represents the parent GroupView control that the GroupViewItem is assigned to.

ImageIndex

Gets / sets the GroupViewItem's image index.

Declaration

public int ImageIndex { get; set; }

Property Value

Type	Description
System.Int32	An integer value.

Remarks

A zero-based index into the GroupView control's LargeImageList and SmallImageList property values.

ItemXSpacing

Gets or Sets the value to change the Text Position of the GroupViewItem

Declaration

public int ItemXSpacing { get; set; }

Property Value

Type
System.Int32

ItemYSpacing

Gets / sets the height between adjacent GroupViewItems.

Declaration

public int ItemYSpacing { get; set; }

Property Value

Type	Description
System.Int32	An integer value.

Tag

Gets / sets an object that contains data about the GroupViewItem.

Declaration

public object Tag { get; set; }

Property Value

Type	Description
System.Object	An System.Object value that contains data about the GroupViewItem. 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 GroupViewItem's text.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	A String value.

ToolTipText

Gets / sets the GroupViewItem's tooltiptext.

Declaration

public string ToolTipText { get; set; }

Property Value

Type	Description
System.String	A string value.

Visible

Indicates whether the GroupViewItem is visible.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	False if the item is hidden. The default is True.

Methods

OnPropertyChanged(PropertyChangedEventArgs)

Declaration

protected void OnPropertyChanged(PropertyChangedEventArgs args)

Parameters

Type	Name	Description
System.ComponentModel.PropertyChangedEventArgs	args

ResetItemXSpacing()

Resets the ItemXSpacing property to its default value.

Declaration

public void ResetItemXSpacing()

ShouldSerializeItemXSpacing()

Serializes the ItemXSpacing property value.

Declaration

protected bool ShouldSerializeItemXSpacing()

Returns

Type
System.Boolean

Events

PropertyChanged

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type
System.ComponentModel.PropertyChangedEventHandler