Class TreeColumns

A collection of TreeColumn objects. The collection implements the ILineSizeHost interface and VirtualTreeView assigns the collection to the ColumnWidthsProvider.

Inheritance

System.Object

TreeColumns

Implements

System.Collections.Generic.IList<TreeColumn>

System.Collections.Generic.ICollection<TreeColumn>

System.Collections.Generic.IEnumerable<TreeColumn>

System.Collections.IEnumerable

ILineSizeHost

System.IDisposable

System.ComponentModel.ISupportInitialize

Namespace: Syncfusion.Windows.Controls.VirtualTreeView

Assembly: Syncfusion.GridCommon.WPF.dll

Syntax

public class TreeColumns : Object, IList<TreeColumn>, ICollection<TreeColumn>, IEnumerable<TreeColumn>, IEnumerable, ILineSizeHost, IDisposable, ISupportInitialize

Constructors

TreeColumns(TreeModel)

Initializes a new instance of the TreeColumns class.

Declaration

public TreeColumns(TreeModel treeModel)

Parameters

Type	Name	Description
TreeModel	treeModel	The tree model.

Properties

Count

Gets the number of elements contained in the collection.

Declaration

public int Count { get; }

Property Value

Type
System.Int32

FrozenFooterCount

Gets or sets the frozen footer count.

Declaration

public int FrozenFooterCount { get; set; }

Property Value

Type	Description
System.Int32	The frozen footer count.

FrozenHeaderCount

Gets or sets the frozen header count.

Declaration

public int FrozenHeaderCount { get; set; }

Property Value

Type	Description
System.Int32	The frozen header count.

IsInitializing

Gets a value indicating whether this instance is initializing.

Declaration

public bool IsInitializing { get; }

Property Value

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

IsReadOnly

Gets a value indicating whether the collection is read-only.

Declaration

public bool IsReadOnly { get; }

Property Value

Type
System.Boolean

Item[Int32]

Gets or sets the TreeColumn at the specified index.

Declaration

public TreeColumn this[int index] { get; set; }

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type
TreeColumn

TreeModel

Gets the tree model.

Declaration

public TreeModel TreeModel { get; }

Property Value

Type	Description
TreeModel	The tree model.

Methods

Add(TreeColumn)

Adds an item to the collection.

Declaration

public void Add(TreeColumn item)

Parameters

Type	Name	Description
TreeColumn	item	The object to add to the collection.

add_LineHiddenChanged(HiddenRangeChangedEventHandler)

Declaration

public void add_LineHiddenChanged(HiddenRangeChangedEventHandler value)

Parameters

Type	Name	Description
HiddenRangeChangedEventHandler	value

add_LinesInserted(LinesInsertedEventHandler)

Declaration

public void add_LinesInserted(LinesInsertedEventHandler value)

Parameters

Type	Name	Description
LinesInsertedEventHandler	value

add_LineSizeChanged(RangeChangedEventHandler)

Declaration

public void add_LineSizeChanged(RangeChangedEventHandler value)

Parameters

Type	Name	Description
RangeChangedEventHandler	value

add_LinesRemoved(LinesRemovedEventHandler)

Declaration

public void add_LinesRemoved(LinesRemovedEventHandler value)

Parameters

Type	Name	Description
LinesRemovedEventHandler	value

BeginInit()

Signals the object that initialization is starting.

Declaration

public void BeginInit()

Clear()

Removes all items from the collection.

Declaration

public void Clear()

Contains(TreeColumn)

Determines whether the collection contains a specific value.

Declaration

public bool Contains(TreeColumn item)

Parameters

Type	Name	Description
TreeColumn	item	The object to locate in the collection.

Returns

Type	Description
System.Boolean	true if item is found in the collection; otherwise, false.

CopyTo(TreeColumn[], Int32)

Copies the elements of the collection to an System.Array, starting at a particular System.Array index.

Declaration

public void CopyTo(TreeColumn[] array, int arrayIndex)

Parameters

Type	Name	Description
TreeColumn[]	array	The one-dimensional System.Array that is the destination of the elements copied from collection. The System.Array must have zero-based indexing.
System.Int32	arrayIndex	The zero-based index in array at which copying begins.

Exceptions

Type	Condition
System.ArgumentNullException	array is null.
System.ArgumentOutOfRangeException	arrayIndex is less than 0.
System.ArgumentException	array is multidimensional.-or-arrayIndex is equal to or greater than the length of array.-or-The number of elements in the source collection is greater than the available space from arrayIndex to the end of the destination array.-or-Type T cannot be cast automatically to the type of the destination array.

Dispose()

Declaration

public void Dispose()

EndInit()

Signals the object that initialization is complete.

Declaration

public void EndInit()

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

public IEnumerator<TreeColumn> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<TreeColumn>	An enumerator that can be used to iterate through the collection.

IndexOf(TreeColumn)

Determines the index of a the item in the collection.

Declaration

public int IndexOf(TreeColumn item)

Parameters

Type	Name	Description
TreeColumn	item	The object to locate.

Returns

Type	Description
System.Int32	The index of item if found in the list; otherwise, -1.

InitializeScrollAxis(ScrollAxisBase)

Initializes the scroll axis.

Declaration

public void InitializeScrollAxis(ScrollAxisBase scrollAxis)

Parameters

Type	Name	Description
ScrollAxisBase	scrollAxis	The scroll axis.

Insert(Int32, TreeColumn)

Inserts an item to the collection at the specified index.

Declaration

public void Insert(int index, TreeColumn item)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index at which item should be inserted.
TreeColumn	item	The object to insert into the collection.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	index is not a valid index in the collection.

Remove(TreeColumn)

Removes the first occurrence of a specific object from the collection.

Declaration

public bool Remove(TreeColumn item)

Parameters

Type	Name	Description
TreeColumn	item	The object to remove from the collection.

Returns

Type	Description
System.Boolean	true if item was successfully removed from the collection; otherwise, false. This method also returns false if item is not found in the original collection.

remove_LineHiddenChanged(HiddenRangeChangedEventHandler)

Declaration

public void remove_LineHiddenChanged(HiddenRangeChangedEventHandler value)

Parameters

Type	Name	Description
HiddenRangeChangedEventHandler	value

remove_LinesInserted(LinesInsertedEventHandler)

Declaration

public void remove_LinesInserted(LinesInsertedEventHandler value)

Parameters

Type	Name	Description
LinesInsertedEventHandler	value

remove_LineSizeChanged(RangeChangedEventHandler)

Declaration

public void remove_LineSizeChanged(RangeChangedEventHandler value)

Parameters

Type	Name	Description
RangeChangedEventHandler	value

remove_LinesRemoved(LinesRemovedEventHandler)

Declaration

public void remove_LinesRemoved(LinesRemovedEventHandler value)

Parameters

Type	Name	Description
LinesRemovedEventHandler	value

RemoveAt(Int32)

Removes the collection item at the specified index.

Declaration

public void RemoveAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index of the item to remove.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	index is not a valid index in the collection.

Events

FooterLineCountChanged

Occurs when the footer line count was changed.

Declaration

public event EventHandler FooterLineCountChanged

Event Type

Type
System.EventHandler

HeaderLineCountChanged

Occurs when the header line count was changed.

Declaration

public event EventHandler HeaderLineCountChanged

Event Type

Type
System.EventHandler

LineCountChanged

Occurs when the line count was changed.

Declaration

public event EventHandler LineCountChanged

Event Type

Type
System.EventHandler

LineHiddenChanged

Occurs when a lines hidden state changed.

Declaration

public event HiddenRangeChangedEventHandler LineHiddenChanged

Event Type

Type
HiddenRangeChangedEventHandler

LinesInserted

Occurs when lines were inserted.

Declaration

public event LinesInsertedEventHandler LinesInserted

Event Type

Type
LinesInsertedEventHandler

LineSizeChanged

Occurs when a lines size was changed.

Declaration

public event RangeChangedEventHandler LineSizeChanged

Event Type

Type
RangeChangedEventHandler

LinesRemoved

Occurs when lines were removed.

Declaration

public event LinesRemovedEventHandler LinesRemoved

Event Type

Type
LinesRemovedEventHandler

Explicit Interface Implementations

ILineSizeHost.add_DefaultLineSizeChanged(DefaultLineSizeChangedEventHandler)

Declaration

void ILineSizeHost.add_DefaultLineSizeChanged(DefaultLineSizeChangedEventHandler value)

Parameters

Type	Name	Description
DefaultLineSizeChangedEventHandler	value

ILineSizeHost.GetDefaultLineSize()

Declaration

double ILineSizeHost.GetDefaultLineSize()

Returns

Type
System.Double

ILineSizeHost.GetFooterLineCount()

Declaration

int ILineSizeHost.GetFooterLineCount()

Returns

Type
System.Int32

ILineSizeHost.GetHeaderLineCount()

Declaration

int ILineSizeHost.GetHeaderLineCount()

Returns

Type
System.Int32

ILineSizeHost.GetHidden(Int32, out Int32)

Declaration

bool ILineSizeHost.GetHidden(int index, out int repeatValueCount)

Parameters

Type	Name	Description
System.Int32	index
System.Int32	repeatValueCount

Returns

Type
System.Boolean

ILineSizeHost.GetLineCount()

Declaration

int ILineSizeHost.GetLineCount()

Returns

Type
System.Int32

ILineSizeHost.GetSize(Int32, out Int32)

Declaration

double ILineSizeHost.GetSize(int index, out int repeatValueCount)

Parameters

Type	Name	Description
System.Int32	index
System.Int32	repeatValueCount

Returns

Type
System.Double

ILineSizeHost.remove_DefaultLineSizeChanged(DefaultLineSizeChangedEventHandler)

Declaration

void ILineSizeHost.remove_DefaultLineSizeChanged(DefaultLineSizeChangedEventHandler value)

Parameters

Type	Name	Description
DefaultLineSizeChangedEventHandler	value

Implements

System.Collections.Generic.IList<>

System.Collections.Generic.ICollection<>

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable

ILineSizeHost

System.IDisposable

System.ComponentModel.ISupportInitialize