ColumnHeaderCollection

Namespace: Wisej.Web

Assembly: Wisej.Framework (3.5.0.0)

Represents the collection of column headers in a ListView control.

C#

public class ColumnHeaderCollection : IList, ICollection, IEnumerable, IList<ColumnHeader>, ICollection<ColumnHeader>, IEnumerable<ColumnHeader>

VB.NET

Public Class ColumnHeaderCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of ColumnHeader), ICollection(Of ColumnHeader), IEnumerable(Of ColumnHeader)

Constructors

ColumnHeaderCollection(owner)

Initializes a new instance of the ColumnHeaderCollection class.

Name	Type	Description
owner	ListView	The ListView that owns this collection.

Properties

Count

Int32: Returns the number of items in the collection.

IsReadOnly

Boolean: Returns whether the collection is read-only.

Item(index)

ColumnHeader: Returns the column header at the specified index within the collection.

Throws:

• ArgumentOutOfRangeException index is less than 0 or greater than or equal to the value of the Count property of the ColumnHeaderCollection.

Item(key)

ColumnHeader: Returns the column header with the specified key from the collection.

Methods

Add(text, width, textAlign)

Adds a column header to the collection with specified text, width, and alignment settings.

Parameter	Type	Description
text	String	The text to display in the column header.
width	Int32	The initial width of the column header.
textAlign	HorizontalAlignment	One of the HorizontalAlignment values.

Returns: ColumnHeader. The ColumnHeader that was created and added to the collection.

Add(header)

Adds an existing ColumnHeader to the collection.

Parameter	Type	Description
header	ColumnHeader	The ColumnHeader to add to the collection.

Returns: Int32. The zero-based index into the collection where the item was added.

Add(text)

Creates and adds a column with the specified text to the collection.

Parameter	Type	Description
text	String	The text to display in the column header.

Returns: ColumnHeader. The ColumnHeader with the specified text that was added to the ColumnHeaderCollection.

Add(text, width)

Creates and adds a column with the specified text and width to the collection.

Parameter	Type	Description
text	String	The text of the ColumnHeader to add to the collection.
width	Int32	The width of the ColumnHeader to add to the collection.

Returns: ColumnHeader. The ColumnHeader with the specified text and width that was added to the ColumnHeaderCollection.

Add(key, text)

Creates and adds a column with the specified text and key to the collection.

Parameter	Type	Description
key	String	The key of the ColumnHeader to add to the collection.
text	String	The text of the ColumnHeader to add to the collection.

Returns: ColumnHeader. The ColumnHeader with the specified key and text that was added to the ColumnHeaderCollection.

Add(key, text, width)

Creates and adds a column with the specified text, key, and width to the collection.

Parameter	Type	Description
key	String	The key of the column header.
text	String	The text to display in the column header.
width	Int32	The initial width of the ColumnHeader.

Returns: ColumnHeader. The ColumnHeader with the given text, key, and width that was added to the collection.

Add(key, text, width, textAlign, imageKey)

Creates and adds a column with the specified key, aligned text, width, and image key to the collection.

Parameter	Type	Description
key	String	The key of the column header.
text	String	The text to display in the column header.
width	Int32	The initial width of the column header.
textAlign	HorizontalAlignment	One of the HorizontalAlignment values.
imageKey	String	The key value of the image to display in the column header.

Returns: ColumnHeader. The ColumnHeader with the specified key, aligned text, width, and image key that has been added to the collection.

Add(key, text, width, textAlign, imageIndex)

Creates and adds a column with the specified key, aligned text, width, and image index to the collection.

Parameter	Type	Description
key	String	The key of the column header.
text	String	The text to display in the column header.
width	Int32	The initial width of the column header.
textAlign	HorizontalAlignment	One of the HorizontalAlignment values.
imageIndex	Int32	The index value of the image to display in the column.

Returns: ColumnHeader. The ColumnHeader with the specified key, aligned text, width, and image index that has been added to the collection.

AddRange(headers)

Adds an array of column headers to the collection.

Parameter	Type	Description
headers	ColumnHeader[]	An array of ColumnHeader objects to add to the collection.

Clear()

Removes all column headers from the collection.

Clear(dispose)

Removes all column headers from the collection and optionally disposes them.

Parameter	Type	Description
dispose	Boolean	Indicates that the child columns should be disposed after being removed.

Contains(header)

Determines whether the specified header is located in the collection.

Parameter	Type	Description
header	ColumnHeader	A ColumnHeader representing the header to locate in the collection.

Returns: Boolean. true if the header is contained in the collection; otherwise, false.

ContainsKey(key)

Determines if a header with the specified key is contained in the collection.

Parameter	Type	Description
key	String	The name of the header to search for.

Returns: Boolean. true if a header with the specified name is contained in the collection; otherwise, false.

CopyTo(array, arrayIndex)

Parameter	Type	Description
array	ColumnHeader[]
arrayIndex	Int32

GetEnumerator()

Returns an enumerator to use to iterate through the column header collection.

Returns: IEnumerator. An IEnumerator that represents the column header collection.

IndexOf(value)

Returns the index, within the collection, of the specified header.

Parameter	Type	Description
value	ColumnHeader	A ColumnHeader representing the header to locate in the collection.

Returns: Int32. The zero-based index of the header's location in the collection. If the header is not located in the collection, the return value is -1.

IndexOfKey(key)

Determines the index for a header with the specified key.

Parameter	Type	Description
key	String	The name of the header to retrieve the index for.

Returns: Int32. The zero-based index for the first occurrence of the column with the specified name, if found; otherwise, -1.

Insert(index, header)

Inserts an existing header into the collection at the specified index.

Parameter	Type	Description
index	Int32	The zero-based index location where the header is inserted.
header	ColumnHeader	The ColumnHeader to insert into the collection.

Throws:

• ArgumentOutOfRangeException index is less than 0 or greater than or equal to the value of the Count property of the ColumnHeaderCollection.

Insert(index, text, width, textAlign)

Creates a new column header and inserts it into the collection at the specified index.

Parameter	Type	Description
index	Int32	The zero-based index location where the header is inserted.
text	String	The text to display in the header.
width	Int32	The initial width of the header. Set to -1 to autosize the header to the size of the largest subitem text in the column or -2 to autosize the header to the size of the text of the header.
textAlign	HorizontalAlignment	One of the HorizontalAlignment values.

Throws:

• ArgumentOutOfRangeException index is less than 0 or greater than or equal to the value of the Count property of the ColumnHeaderCollection.

Insert(index, text)

Creates a new column with the specified text, and inserts the header into the collection at the specified index.

Parameter	Type	Description
index	Int32	The zero-based index location where the header is inserted.
text	String	The text to display in the header.

Throws:

• ArgumentOutOfRangeException index is less than 0 or greater than or equal to the value of the Count property of the ColumnHeaderCollection.

Insert(index, text, width)

Creates a new header with the specified text and initial width, and inserts the header into the collection at the specified index.

Parameter	Type	Description
index	Int32	The zero-based index location where the header is inserted.
text	String	The text to display in the header.
width	Int32	The initial width, in pixels, of the header.

Insert(index, key, text)

Creates a new header with the specified text and key, and inserts the header into the collection at the specified index.

Parameter	Type	Description
index	Int32	The zero-based index location where the header is inserted.
key	String	The name of the header.
text	String	The text to display in the header.

Insert(index, key, text, width)

Creates a new column with the specified text, key, and width, and inserts the header into the collection at the specified index.

Parameter	Type	Description
index	Int32	The zero-based index location where the header is inserted.
key	String	The name of the header.
text	String	The text to display in the header.
width	Int32	The initial width, in pixels, of the header.

Insert(index, key, text, width, textAlign, imageKey)

Creates a new header with the specified aligned text, key, width, and image key, and inserts the header into the collection at the specified index.

Parameter	Type	Description
index	Int32	The zero-based index location where the column header is inserted.
key	String	The name of the header.
text	String	The text to display in the header.
width	Int32	The initial width, in pixels, of the header.
textAlign	HorizontalAlignment	One of the HorizontalAlignment values.
imageKey	String	The key of the image to display in the header.

Insert(index, key, text, width, textAlign, imageIndex)

Creates a new header with the specified aligned text, key, width, and image index, and inserts the header into the collection at the specified index.

Parameter	Type	Description
index	Int32	The zero-based index location where the column header is inserted.
key	String	The name of the header.
text	String	The text to display in the column header.
width	Int32	The initial width, in pixels, of the header.
textAlign	HorizontalAlignment	One of the HorizontalAlignment values.
imageIndex	Int32	The index of the image to display in the header.

Remove(column)

Removes the specified header from the collection.

Parameter	Type	Description
column	ColumnHeader	A ColumnHeader representing the header to remove from the collection.

RemoveAt(index)

Removes the header at the specified index within the collection.

Parameter	Type	Description
index	Int32	The zero-based index of the header to remove.

Throws:

• ArgumentOutOfRangeException index is less than 0 or greater than or equal to the value of the Count property of the ColumnHeaderCollection.

RemoveByKey(key)

Removes the header with the specified key from the collection.

Parameter	Type	Description
key	String	The name of the header to remove from the collection.

Events

CollectionChanged

CollectionChangeEventHandler Fired when the collection changes.