Top10Filter Class

Namespace:
GemBox.Spreadsheet
Assembly:
GemBox.Spreadsheet.dll

Represents a filter that filters by a top N (percent or number of items).

public sealed class Top10Filter : Filter
Public NotInheritable Class Top10Filter
    Inherits Filter
Inheritance:
System.Object
Top10Filter

Properties

FilterType

Gets the Top10 value.

public override FilterType FilterType { get; }
Public Overrides ReadOnly Property FilterType As FilterType
Property Value
FilterType

The Top10 value.

Overrides

Percent

Gets or sets a value indicating whether or not to filter by percent value of the column. A false value filters by number of items.

Default value is false.

public bool Percent { get; set; }
Public Property Percent As Boolean
Property Value
System.Boolean

true to filter by percent value of the column; otherwise, false.

Top

Gets or sets a value indicating whether or not to filter by top order. A false value filters by bottom order.

Default value is true.

public bool Top { get; set; }
Public Property Top As Boolean
Property Value
System.Boolean

true to filter by top order; otherwise, false.

Value

Gets or sets the top or bottom value to use as the filter criteria. For example "Filter by Top 10 Percent" or "Filter by Top 5 Items".

public double Value { get; set; }
Public Property Value As Double
Property Value
System.Double

The top or bottom value to use as the filter criteria.

Exceptions
System.ArgumentOutOfRangeException

Value must be greater than zero.

Methods

ToString()

Returns a System.String that represents this Top10Filter instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this Top10Filter instance.

Overrides
Remarks

This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Examples