Gets the collection of print areas in a Worksheet or a worksheet's print settings in a CustomView.

See

PrintOptions.printAreas

Hierarchy

Hierarchy

  • Base
    • PrintAreasCollection

Implements

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get count(): number
  • Gets the number of print areas in the collection.

    Returns number

Methods

  • Adds a print area to the collection.

    Throws

    ArgumentNullException Occurs when 'printArea' is null.

    Throws

    ArgumentException Occurs when 'printArea' overlaps with another print area in the collection.

    Parameters

    Returns void

  • Determines whether the specified print area is in the collection.

    Returns

    True if the print area is in the collection; False otherwise.

    Parameters

    • printArea: WorksheetRegion

      The print area to search for in the collection.

    Returns boolean

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • Gets the print area at the specified index.

    Throws

    ArgumentOutOfRangeException Occurs when 'index' is less than 0 or greater than or equal to the size of the collection.

    Returns

    A WorksheetRegion instance representing a print area in the Worksheet.

    Parameters

    • a: number

    Returns WorksheetRegion

  • Removes the specified print area from the collection.

    If any page breaks are contained in the removed print area, they will be removed from their collection.

    Throws

    ArgumentNullException Occurs when 'printArea' is null.

    Returns

    True if the print area was found and removed; False otherwise.

    See

    Parameters

    Returns boolean

  • Removes the print area at the specified index from the collection.

    If any page breaks are contained in the removed print area, they will be removed from their collection.

    Throws

    ArgumentOutOfRangeException Occurs when 'index' is less than 0 or greater than or equal to the size of the collection.

    See

    Parameters

    • index: number

      The index of the print area to remove from the collection.

    Returns void

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Returns void