Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class FormattedTextParagraphCollection

A collection of [[FormattedTextParagraph]] instances in .

See

[[FormattedText.paragraphs]]

Hierarchy

Hierarchy

  • Base
    • FormattedTextParagraphCollection

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 paragraphs in the collection.

    Returns number

Methods

[iterator]

add

  • add(paragraphText): FormattedTextParagraph

  • Adds a paragraph with the specified text and returns the [[FormattedTextParagraph]] representing the new paragraph.

    Parameters

    • paragraphText: string

      The text in the paragraph.

    Returns FormattedTextParagraph

clear

  • clear(): void

  • Removes all paragraphs from the formatted text.

    Returns void

contains

  • contains(paragraph): boolean

  • Determines whether the specified paragraph exists in the collection.

    Parameters

    Returns boolean

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getEnumerator

  • getEnumerator(): IEnumerator$1<FormattedTextParagraph>

  • Gets the enumerator to iterate over all paragraphs.

    Returns IEnumerator$1<FormattedTextParagraph>

getHashCode

  • getHashCode(): number

  • Returns number

indexOf

  • indexOf(paragraph): number

  • Gets the zero-based index of the specified paragraph in the collection.

    Parameters

    Returns number

insert

  • insert(index, paragraphText): FormattedTextParagraph

  • Inserts a paragraph with the specified text and returns the [[FormattedTextParagraph]] representing the new paragraph.

    Throws

    [[ArgumentOutOfRangeException]] 'index' is less than zero or greater than the number of paragraphs in the collection.

    Parameters

    • index: number

      The zero-based index in the collection where the paragraph should be inserted.

    • paragraphText: string

      The text in the paragraph.

    Returns FormattedTextParagraph

item

  • item(a): FormattedTextParagraph

  • Gets the paragraph at the specified zero-based index.

    Throws

    [[ArgumentOutOfRangeException]] 'index' is less than zero or greater than or equal to the number of paragraphs in the collection.

    Parameters

    • a: number

    Returns FormattedTextParagraph

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

remove

  • remove(paragraph): boolean

  • Removes the specified paragraph from the collection.

    Parameters

    Returns boolean

removeAt

  • removeAt(index): void

  • Removes the paragraph at the specified zero-based index in the collection.

    Throws

    [[ArgumentOutOfRangeException]] 'index' is less than zero or greater than or equal to the number of paragraphs in the collection.

    Parameters

    • index: number

      The zero-based index of the paragraph to remove.

    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