Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class PrintAreasCollection

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

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

count

  • get count(): number

  • Gets the number of print areas in the collection.

    Returns number

Methods

[iterator]

  • [iterator](): EnumeratorWrapper<WorksheetRegion>

  • Returns EnumeratorWrapper<WorksheetRegion>

add

  • add(printArea): void

  • 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

clear

  • clear(): void

  • Clears all print areas from the collection.

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

    See

    • [[PrintOptions.horizontalPageBreaks]]
    • [[PrintOptions.verticalPageBreaks]]

    Returns void

contains

  • contains(printArea): boolean

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

    Parameters

    Returns boolean

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • getHashCode(): number

  • Returns number

item

  • item(a): WorksheetRegion

  • 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.

    Parameters

    • a: number

    Returns WorksheetRegion

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

remove

  • remove(printArea): boolean

  • 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.

    See

    • [[PrintOptions.horizontalPageBreaks]]
    • [[PrintOptions.verticalPageBreaks]]

    Parameters

    Returns boolean

removeAt

  • removeAt(index): void

  • 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

    • [[PrintOptions.horizontalPageBreaks]]
    • [[PrintOptions.verticalPageBreaks]]

    Parameters

    • index: number

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

    Returns void

Static compare

  • compare(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static staticInit

  • staticInit(): void

  • Returns void