menu

WinForms

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

    Show / Hide Table of Contents

    Class GridTableBaseStyleCollection

    A collection from GridTableBaseStyle that declares BaseStyles for the whole engine. An instance of this collection is returned by the BaseStyles property of a GridEngine.

    Inheritance
    System.Object
    GridTableBaseStyleCollection
    Implements
    System.IDisposable
    System.Collections.IList
    System.Collections.ICollection
    System.Collections.IEnumerable
    IInsideCollectionEditorProperty
    System.ICloneable
    System.ComponentModel.ICustomTypeDescriptor
    Inherited Members
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Syncfusion.Windows.Forms.Grid.Grouping
    Assembly: Syncfusion.Grid.Grouping.Windows.dll
    Syntax
    public class GridTableBaseStyleCollection : IDisposable, IList, ICollection, IEnumerable, IInsideCollectionEditorProperty, ICloneable, ICustomTypeDescriptor

    Constructors

    GridTableBaseStyleCollection()

    Initializes a new empty collection.

    Declaration
    public GridTableBaseStyleCollection()

    Fields

    Empty

    A Read-only and empty collection.

    Declaration
    public static readonly GridTableBaseStyleCollection Empty
    Field Value
    Type
    GridTableBaseStyleCollection

    Properties

    Count

    Gets the number of elements contained in the collection. The property also ensures that the collection is in sync with the underlying table if changes have been made to the table or the TableDescriptor.

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

    InsideCollectionEditor

    Gets or sets whether the collection is manipulated inside a collection editor.

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

    IsFixedSize

    Returns normally False since this collection has no fixed size. Only when it is Read-only IsFixedSize returns True.

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

    IsModified

    Gets or sets whether the collection is modified from its default state.

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

    IsReadOnly

    Determines if the collection is Read-only.

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

    IsSynchronized

    Returns False.

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

    Item[Int32]

    Gets or sets the element at the zero-based index.

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

    Item[String]

    Gets or sets the element with the specified name.

    Declaration
    public GridTableBaseStyle this[string name] { get; set; }
    Parameters
    Type Name Description
    System.String name
    Property Value
    Type
    GridTableBaseStyle

    Version

    The version number of this collection. The version is increased each time the collection or an element within the collection was modified.

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

    Methods

    Add(GridTableBaseStyle)

    Adds an object to the end of the collection.

    Declaration
    public int Add(GridTableBaseStyle value)
    Parameters
    Type Name Description
    GridTableBaseStyle value

    The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Int32

    The zero-based collection index at which the value has been added.

    Add(String)

    Adds an object to the end of the collection.

    Declaration
    public int Add(string name)
    Parameters
    Type Name Description
    System.String name

    The name of the element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Int32

    The zero-based collection index at which the value has been added.

    AddRange(GridTableBaseStyle[])

    Adds multiple elements at the end of the collection.

    Declaration
    public void AddRange(GridTableBaseStyle[] tableBaseStyles)
    Parameters
    Type Name Description
    GridTableBaseStyle[] tableBaseStyles

    The array with elements that should be added to the end of the collection. The array and its elements cannot be NULL references (Nothing in Visual Basic).

    CheckType(Object)

    Ensures type correctness when a new element is added to the collection.

    Declaration
    protected virtual void CheckType(object obj)
    Parameters
    Type Name Description
    System.Object obj

    The newly added object.

    Clear()

    Removes all elements from the collection.

    Declaration
    public void Clear()

    Clone()

    Creates a copy of the collection and all its elements.

    Declaration
    public GridTableBaseStyleCollection Clone()
    Returns
    Type Description
    GridTableBaseStyleCollection

    A copy of the collection and all its elements.

    Contains(GridTableBaseStyle)

    Determines if the element belongs to this collection.

    Declaration
    public bool Contains(GridTableBaseStyle value)
    Parameters
    Type Name Description
    GridTableBaseStyle value

    The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Boolean

    True if item is found in the collection; otherwise, False.

    Contains(String)

    Searches for the element with the specified name.

    Declaration
    public bool Contains(string name)
    Parameters
    Type Name Description
    System.String name

    The name of the element to locate in the collection.

    Returns
    Type Description
    System.Boolean

    True if item is found in the collection; otherwise, False.

    CopyTo(GridTableBaseStyle[], Int32)

    Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.

    Declaration
    public void CopyTo(GridTableBaseStyle[] array, int index)
    Parameters
    Type Name Description
    GridTableBaseStyle[] array

    The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.

    System.Int32 index

    The zero-based index in an array at which copying begins.

    CreateCollection(GridEngine, GridTableBaseStyle[])

    Called from InternalClone to create a new collection and attach it to the specified table descriptor and insert the specified columns. The BaseStyle objects have already been cloned.

    Declaration
    protected virtual GridTableBaseStyleCollection CreateCollection(GridEngine td, GridTableBaseStyle[] tableBaseStyles)
    Parameters
    Type Name Description
    GridEngine td

    The GridEngine.

    GridTableBaseStyle[] tableBaseStyles

    The cloned base styles.

    Returns
    Type Description
    GridTableBaseStyleCollection

    A new GridTableBaseStyleCollection.

    Dispose()

    Disposes the object and collection items.

    Declaration
    public void Dispose()

    Equals(Object)

    Determines whether the specified System.Object is equal to the current System.Object.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj

    The System.Object to compare with the current System.Object.

    Returns
    Type Description
    System.Boolean

    true if the specified System.Object is equal to the current System.Object; otherwise, false.

    Overrides
    System.Object.Equals(System.Object)

    GetBaseStylesMapStyles(String, out Int32)

    Copies a BaseStyle and all BaseStyles it depends on into an array.

    Declaration
    public GridTableCellStyleInfo[] GetBaseStylesMapStyles(string name, out int level)
    Parameters
    Type Name Description
    System.String name

    The name of the base style.

    System.Int32 level

    The maximum number of levels to look at when walking referenced BaseStyles.

    Returns
    Type Description
    GridTableCellStyleInfo[]

    An array of GridBaseStyle objects with the first BaseStyle and all BaseStyles it depends on.

    GetEnumerator()

    Returns an enumerator for the entire collection.

    Declaration
    public GridTableBaseStyleCollectionEnumerator GetEnumerator()
    Returns
    Type Description
    GridTableBaseStyleCollectionEnumerator

    An Enumerator for the entire collection.

    Remarks

    Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection.

    GetHashCode()

    Serves as a hash function for a particular type.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32

    A hash code for the current object.

    Overrides
    System.Object.GetHashCode()

    IndexOf(GridTableBaseStyle)

    Returns the zero-based index of the occurrence of the element in the collection.

    Declaration
    public int IndexOf(GridTableBaseStyle value)
    Parameters
    Type Name Description
    GridTableBaseStyle value

    The element to locate in the collection. The value can be a NULLreference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Int32

    The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.

    IndexOf(String)

    Searches for the element with the specified name.

    Declaration
    public int IndexOf(string name)
    Parameters
    Type Name Description
    System.String name

    The name of the element to locate in the collection.

    Returns
    Type Description
    System.Int32

    The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.

    InitializeFrom(GridTableBaseStyleCollection)

    Copies settings from another collection and raises Changing and Changed events if differences to the other collection are detected.

    Declaration
    public void InitializeFrom(GridTableBaseStyleCollection other)
    Parameters
    Type Name Description
    GridTableBaseStyleCollection other

    The source collection.

    Insert(Int32, GridTableBaseStyle)

    Inserts a descriptor element into the collection at the specified index.

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

    The zero-based index at which the element should be inserted.

    GridTableBaseStyle value

    The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).

    OnChanged(ListPropertyChangedEventArgs)

    Raises the Changed event.

    Declaration
    protected virtual void OnChanged(ListPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    ListPropertyChangedEventArgs e

    A ListPropertyChangedEventArgs that contains the event data.

    OnChanging(ListPropertyChangedEventArgs)

    Raises the Changing event.

    Declaration
    protected virtual void OnChanging(ListPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    ListPropertyChangedEventArgs e

    A ListPropertyChangedEventArgs that contains the event data.

    Remove(GridTableBaseStyle)

    Removes the specified descriptor element from the collection.

    Declaration
    public void Remove(GridTableBaseStyle value)
    Parameters
    Type Name Description
    GridTableBaseStyle value

    The element to remove from the collection. If the value is NULL or the element is not contained in the collection the method will do nothing.

    Remove(String)

    Removes the specified descriptor element with the specified name from the collection.

    Declaration
    public void Remove(string name)
    Parameters
    Type Name Description
    System.String name

    The name of the element to remove from the collection. If no element with that name is found in the collection, the method will do nothing.

    RemoveAt(Int32)

    Removes the element at the specified index of the collection.

    Declaration
    public void RemoveAt(int index)
    Parameters
    Type Name Description
    System.Int32 index

    The zero-based index of the element to remove.

    Reset()

    Clears the collection.

    Declaration
    public void Reset()

    SuggestName(GridTableBaseStyle)

    Called to get a new default name when a new BaseStyle is created (e.g. when pressing "Add" in a collection editor).

    Declaration
    protected virtual void SuggestName(GridTableBaseStyle value)
    Parameters
    Type Name Description
    GridTableBaseStyle value

    The base style to be named.

    ToString()

    Returns a string that represents the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String

    A string that represents the current object.

    Overrides
    System.Object.ToString()

    Events

    Changed

    Occurs after a property in a nested element or the collection is changed.

    Declaration
    public event ListPropertyChangedEventHandler Changed
    Event Type
    Type
    ListPropertyChangedEventHandler

    Changing

    Occurs before a property in a nested element or the collection is changed.

    Declaration
    public event ListPropertyChangedEventHandler Changing
    Event Type
    Type
    ListPropertyChangedEventHandler

    Explicit Interface Implementations

    IInsideCollectionEditorProperty.InitializeFrom(Object)

    Declaration
    void IInsideCollectionEditorProperty.InitializeFrom(object other)
    Parameters
    Type Name Description
    System.Object other

    ICollection.CopyTo(Array, Int32)

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

    Declaration
    void ICollection.CopyTo(Array array, int index)
    Parameters
    Type Name Description
    System.Array array

    The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing.

    System.Int32 index

    The zero-based index in array at which copying begins.

    ICollection.SyncRoot

    Gets an object that can be used to synchronize access to the System.Collections.ICollection.

    Declaration
    object ICollection.SyncRoot { get; }
    Returns
    Type
    System.Object

    IEnumerable.GetEnumerator()

    Returns an enumerator that iterates through a collection.

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

    An System.Collections.IEnumerator object that can be used to iterate through the collection.

    IList.Add(Object)

    Adds an item to the System.Collections.IList.

    Declaration
    int IList.Add(object value)
    Parameters
    Type Name Description
    System.Object value

    The object to add to the System.Collections.IList.

    Returns
    Type Description
    System.Int32

    The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection.

    IList.Contains(Object)

    Determines whether the System.Collections.IList contains a specific value.

    Declaration
    bool IList.Contains(object value)
    Parameters
    Type Name Description
    System.Object value

    The object to locate in the System.Collections.IList.

    Returns
    Type Description
    System.Boolean

    true if the System.Object is found in the System.Collections.IList; otherwise,false.

    IList.get_Item(Int32)

    Declaration
    object IList.get_Item(int index)
    Parameters
    Type Name Description
    System.Int32 index
    Returns
    Type
    System.Object

    IList.IndexOf(Object)

    Determines the index of a specific item in the System.Collections.IList.

    Declaration
    int IList.IndexOf(object value)
    Parameters
    Type Name Description
    System.Object value

    The object to locate in the System.Collections.IList.

    Returns
    Type Description
    System.Int32

    The index of value if found in the list; otherwise, -1.

    IList.Insert(Int32, Object)

    Inserts an item to the System.Collections.IList at the specified index.

    Declaration
    void IList.Insert(int index, object value)
    Parameters
    Type Name Description
    System.Int32 index

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

    System.Object value

    The object to insert into the System.Collections.IList.

    IList.Item[Int32]

    Gets or sets the element at the specified index.

    Declaration
    object IList.this[] { get; set; }
    Parameters
    Type Name Description
    System.Int32 index

    The zero-based index of the element to get or set.

    Returns
    Type Description
    System.Object

    The element at the specified index.

    IList.Remove(Object)

    Removes the first occurrence of a specific object from the System.Collections.IList.

    Declaration
    void IList.Remove(object value)
    Parameters
    Type Name Description
    System.Object value

    The object to remove from the System.Collections.IList.

    IList.set_Item(Int32, Object)

    Declaration
    void IList.set_Item(int index, object value)
    Parameters
    Type Name Description
    System.Int32 index
    System.Object value

    ICloneable.Clone()

    Declaration
    object ICloneable.Clone()
    Returns
    Type
    System.Object

    Implements

    System.IDisposable
    System.Collections.IList
    System.Collections.ICollection
    System.Collections.IEnumerable
    IInsideCollectionEditorProperty
    System.ICloneable
    System.ComponentModel.ICustomTypeDescriptor
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved