menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridListColumns - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridListColumns

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

    Inheritance
    System.Object
    GridListColumns
    Implements
    System.Collections.Generic.IList<GridListColumn>
    System.Collections.Generic.ICollection<GridListColumn>
    System.Collections.Generic.IEnumerable<GridListColumn>
    System.Collections.IEnumerable
    IPaddedEditableLineSizeHost
    IEditableLineSizeHost
    ILineSizeHost
    System.IDisposable
    System.ComponentModel.ISupportInitialize
    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.Controls.Grid
    Assembly: Syncfusion.Grid.Wpf.dll
    Syntax
    public class GridListColumns : IList<GridListColumn>, ICollection<GridListColumn>, IEnumerable<GridListColumn>, IEnumerable, IPaddedEditableLineSizeHost, IEditableLineSizeHost, ILineSizeHost, IDisposable, ISupportInitialize

    Constructors

    GridListColumns(GridListModel)

    Initializes a new instance of the GridListColumns class.

    Declaration
    public GridListColumns(GridListModel gridModel)
    Parameters
    Type Name Description
    GridListModel gridModel

    The grid model.

    Properties

    Count

    Gets the number of elements contained in the collection.

    Declaration
    public int Count { get; }
    Property Value
    Type
    System.Int32

    DefaultLineSize

    Declaration
    public double DefaultLineSize { get; set; }
    Property Value
    Type
    System.Double

    FooterLineCount

    Declaration
    public int FooterLineCount { get; set; }
    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.

    HeaderLineCount

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

    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 at the specified index.

    Declaration
    public GridListColumn this[int index] { get; set; }
    Parameters
    Type Name Description
    System.Int32 index
    Property Value
    Type
    GridListColumn

    LineCount

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

    Model

    Gets the grid model.

    Declaration
    public GridListModel Model { get; }
    Property Value
    Type Description
    GridListModel

    The grid model.

    PaddingDistance

    Declaration
    public double PaddingDistance { get; set; }
    Property Value
    Type
    System.Double

    SupportsInsertRemove

    Declaration
    public bool SupportsInsertRemove { get; }
    Property Value
    Type
    System.Boolean

    SupportsNestedLines

    Declaration
    public bool SupportsNestedLines { get; }
    Property Value
    Type
    System.Boolean

    TotalExtent

    Declaration
    public double TotalExtent { get; }
    Property Value
    Type
    System.Double

    Methods

    Add(GridListColumn)

    Adds an item to the collection.

    Declaration
    public void Add(GridListColumn item)
    Parameters
    Type Name Description
    GridListColumn item

    The object to add to the collection.

    BeginInit()

    Signals the object that initialization is starting.

    Declaration
    public void BeginInit()

    Clear()

    Removes all items from the collection.

    Declaration
    public void Clear()

    Contains(GridListColumn)

    Determines whether the collection contains a specific value.

    Declaration
    public bool Contains(GridListColumn item)
    Parameters
    Type Name Description
    GridListColumn item

    The object to locate in the collection.

    Returns
    Type Description
    System.Boolean

    true if item is found in the collection; otherwise, false.

    CopyTo(GridListColumn[], Int32)

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

    Declaration
    public void CopyTo(GridListColumn[] array, int arrayIndex)
    Parameters
    Type Name Description
    GridListColumn[] 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.

    CreateMoveLines()

    Declaration
    public IEditableLineSizeHost CreateMoveLines()
    Returns
    Type
    IEditableLineSizeHost

    DeferRefresh()

    Declaration
    public IDisposable DeferRefresh()
    Returns
    Type
    System.IDisposable

    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<GridListColumn> GetEnumerator()
    Returns
    Type Description
    System.Collections.Generic.IEnumerator<GridListColumn>

    An enumerator that can be used to iterate through the collection.

    GetNestedLines(Int32)

    Declaration
    public IEditableLineSizeHost GetNestedLines(int index)
    Parameters
    Type Name Description
    System.Int32 index
    Returns
    Type
    IEditableLineSizeHost

    IndexOf(GridListColumn)

    Determines the index of a the item in the collection.

    Declaration
    public int IndexOf(GridListColumn item)
    Parameters
    Type Name Description
    GridListColumn 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, GridListColumn)

    Inserts an item to the collection at the specified index.

    Declaration
    public void Insert(int index, GridListColumn item)
    Parameters
    Type Name Description
    System.Int32 index

    The zero-based index at which item should be inserted.

    GridListColumn item

    The object to insert into the collection.

    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    index is not a valid index in the collection.

    InsertLines(Int32, Int32)

    Declaration
    public void InsertLines(int insertAtLine, int count)
    Parameters
    Type Name Description
    System.Int32 insertAtLine
    System.Int32 count

    InsertLines(Int32, Int32, IEditableLineSizeHost)

    Declaration
    public void InsertLines(int insertAtLine, int count, IEditableLineSizeHost movelines)
    Parameters
    Type Name Description
    System.Int32 insertAtLine
    System.Int32 count
    IEditableLineSizeHost movelines

    InsertLines(Int32, Int32, LineSizeCollection)

    Declaration
    public void InsertLines(int insertAtLine, int count, LineSizeCollection moveLines)
    Parameters
    Type Name Description
    System.Int32 insertAtLine
    System.Int32 count
    LineSizeCollection moveLines

    Remove(GridListColumn)

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

    Declaration
    public bool Remove(GridListColumn item)
    Parameters
    Type Name Description
    GridListColumn 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.

    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.

    RemoveLines(Int32, Int32)

    Declaration
    public void RemoveLines(int removeAtLine, int count)
    Parameters
    Type Name Description
    System.Int32 removeAtLine
    System.Int32 count

    RemoveLines(Int32, Int32, IEditableLineSizeHost)

    Declaration
    public void RemoveLines(int removeAtLine, int count, IEditableLineSizeHost movelines)
    Parameters
    Type Name Description
    System.Int32 removeAtLine
    System.Int32 count
    IEditableLineSizeHost movelines

    RemoveLines(Int32, Int32, LineSizeCollection)

    Declaration
    public void RemoveLines(int removeAtLine, int count, LineSizeCollection moveLines)
    Parameters
    Type Name Description
    System.Int32 removeAtLine
    System.Int32 count
    LineSizeCollection moveLines

    SetHidden(Int32, Int32, Boolean)

    Declaration
    public void SetHidden(int from, int to, bool hide)
    Parameters
    Type Name Description
    System.Int32 from
    System.Int32 to
    System.Boolean hide

    SetNestedLines(Int32, IEditableLineSizeHost)

    Declaration
    public void SetNestedLines(int index, IEditableLineSizeHost nestedLines)
    Parameters
    Type Name Description
    System.Int32 index
    IEditableLineSizeHost nestedLines

    SetRange(Int32, Int32, Double)

    Declaration
    public void SetRange(int from, int to, double size)
    Parameters
    Type Name Description
    System.Int32 from
    System.Int32 to
    System.Double size

    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

    IEditableLineSizeHost.get_Item(Int32)

    Declaration
    double IEditableLineSizeHost.get_Item(int index)
    Parameters
    Type Name Description
    System.Int32 index
    Returns
    Type
    System.Double

    IEditableLineSizeHost.Item[Int32]

    Declaration
    double IEditableLineSizeHost.this[] { get; set; }
    Parameters
    Type Name Description
    System.Int32 index
    Returns
    Type
    System.Double

    IEditableLineSizeHost.set_Item(Int32, Double)

    Declaration
    void IEditableLineSizeHost.set_Item(int index, double value)
    Parameters
    Type Name Description
    System.Int32 index
    System.Double value

    ILineSizeHost.DefaultLineSizeChanged

    Declaration
    event DefaultLineSizeChangedEventHandler ILineSizeHost.DefaultLineSizeChanged
    Returns
    Type
    DefaultLineSizeChangedEventHandler

    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

    IEnumerable.GetEnumerator()

    Declaration
    IEnumerator IEnumerable.GetEnumerator()
    Returns
    Type
    System.Collections.IEnumerator

    Implements

    System.Collections.Generic.IList<T>
    System.Collections.Generic.ICollection<T>
    System.Collections.Generic.IEnumerable<T>
    System.Collections.IEnumerable
    IPaddedEditableLineSizeHost
    IEditableLineSizeHost
    ILineSizeHost
    System.IDisposable
    System.ComponentModel.ISupportInitialize
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved