Exposes methods to identify a region in the wroksheet and to apply sort criteria to that region.

Hierarchy

Hierarchy

Implements

  • IChangeInfoContext

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get caseSensitive(): boolean
  • Gets or sets the value which indicates whether strings should be compared case-sensitively when they are sorted.

    This is only applicable to sort conditions which sort strings.

    True to sort strings case-sensitively; False to ignore case.

    Returns boolean

  • set caseSensitive(a: boolean): void
  • Parameters

    • a: boolean

    Returns void

  • get sortType(): WorksheetSortType
  • Determines whether columns or rows will be sorted within the region. 'Rows' is the default. Note: when this property is changed all existing sort conditions will be cleared so this property should be set before sort conditions are added.

    Returns WorksheetSortType

  • set sortType(a: WorksheetSortType): void
  • Parameters

    Returns void

Methods

  • Clears the region as well as any existing sort criteria

    See

    Returns void

  • Parameters

    • other: any

    Returns boolean

  • Re-sorts all data cells in the region based on the sort conditions.

    See

    SortSettings`1.sortConditions

    Returns void

  • Sets the region where the filter settings should be applied

    The Workbook.cellReferenceMode of the workbook will be used to parse the region address.

    Note: setting the region will clear any applied filters or sort criteria.

    Throws

    InvalidOperationException If the region intersects with a table of other reserved area in the worksheet.

    See

    Parameters

    • address: string

      The address of the new region.

    Returns void

  • Sets the region where the filter settings should be applied

    Note: setting the region will clear any applied filters or sort criteria.

    Throws

    InvalidOperationException If the region intersects with a table of other reserved area in the worksheet.

    See

    Parameters

    • address: string

      The address of the new region.

    • cellReferenceMode: CellReferenceMode

      The reference to use the parse the address.

    Returns void

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean