Spread ASP.NET 14
FarPoint.Web.Spread Assembly / FarPoint.Web.Spread Namespace / FilterColumnDefinitionCollection Class / Item Property
Zero-based index of the filter column definition in the collection
Example


In This Topic
    Item Property (FilterColumnDefinitionCollection)
    In This Topic
    Gets or sets the filter column definition at the specified position in the collection.
    Syntax
    'Declaration
     
    Public Default Property Item( _
       ByVal index As Integer _
    ) As FilterColumnDefinition
    'Usage
     
    Dim instance As FilterColumnDefinitionCollection
    Dim index As Integer
    Dim value As FilterColumnDefinition
     
    instance.Item(index) = value
     
    value = instance.Item(index)
    public FilterColumnDefinition this[ 
       int index
    ]; {get; set;}

    Parameters

    index
    Zero-based index of the filter column definition in the collection

    Property Value

    FilterColumnDefinition object containing a filter column definition
    Exceptions
    ExceptionDescription
    Specified index is not valid; must be between 0 and total number in the collection
    Index not specified or specified index is null
    Example
    This example sets a row filter.
    FarPoint.Web.Spread.NamedStyle instyle = new FarPoint.Web.Spread.NamedStyle();
    FarPoint.Web.Spread.NamedStyle outstyle = new FarPoint.Web.Spread.NamedStyle();
    instyle.BackColor = Color.Yellow;
    outstyle.BackColor = Color.Aquamarine;
    FarPoint.Web.Spread.FilterColumnDefinition fcd = new FarPoint.Web.Spread.FilterColumnDefinition(1, FarPoint.Web.Spread.FilterListBehavior.SortByMostOccurrences
    | FarPoint.Web.Spread.FilterListBehavior.Default);
    FarPoint.Web.Spread.FilterColumnDefinition fcd1 = new FarPoint.Web.Spread.FilterColumnDefinition(2);
    FarPoint.Web.Spread.FilterColumnDefinition fcd2 = new FarPoint.Web.Spread.FilterColumnDefinition();
    
    FarPoint.Web.Spread.StyleRowFilter sf = new FarPoint.Web.Spread.StyleRowFilter(FpSpread1.ActiveSheetView, instyle, outstyle);
    sf.AddColumn(fcd);
    sf.AddColumn(fcd1);
    sf.AddColumn(fcd2);
    FpSpread1.ActiveSheetView.RowFilter = sf;
    Dim instyle As New FarPoint.Web.Spread.NamedStyle
    Dim outstyle As New FarPoint.Web.Spread.NamedStyle
    instyle.BackColor = Color.Yellow
    outstyle.BackColor = Color.Aquamarine
    Dim fcd As New FarPoint.Web.Spread.FilterColumnDefinition(1, FarPoint.Web.Spread.FilterListBehavior.SortByMostOccurrences
    Or FarPoint.Web.Spread.FilterListBehavior.Default)
    Dim fcd1 As New FarPoint.Web.Spread.FilterColumnDefinition(2)
    Dim fcd2 As New FarPoint.Web.Spread.FilterColumnDefinition
    
    Dim sf As New FarPoint.Web.Spread.StyleRowFilter(FpSpread1.ActiveSheetView, instyle, outstyle)
    sf.AddColumn(fcd)
    sf.AddColumn(fcd1)
    sf.AddColumn(fcd2)
    FpSpread1.ActiveSheetView.RowFilter = sf
    See Also