Class FormattedTextParagraphCollection

A collection of FormattedTextParagraph instances in .

See

FormattedText.paragraphs

Hierarchy

Hierarchy

  • Base
    • FormattedTextParagraphCollection

Implements

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

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

    Returns number

Methods

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

    Returns

    The FormattedTextParagraph representing the new paragraph.

    Parameters

    • paragraphText: string

      The text in the paragraph.

    Returns FormattedTextParagraph

  • Removes all paragraphs from the formatted text.

    Returns void

  • Determines whether the specified paragraph exists in the collection.

    Returns

    True if the paragraph exists in the collection; False otherwise.

    Parameters

    Returns boolean

  • Parameters

    • other: any

    Returns boolean

  • Returns number

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

    Returns

    The zero-based index of the paragraph in the collection or -1 if the paragraph doesn't exist in the collection.

    Parameters

    Returns number

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

    Returns

    The FormattedTextParagraph representing the new paragraph.

    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

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

    Returns

    The FormattedTextParagraph representing the paragraph at the specified index.

    Parameters

    • a: number

    Returns FormattedTextParagraph

  • Removes the specified paragraph from the collection.

    Returns

    True if the paragraph was in the collection and was removed; False otherwise.

    Parameters

    Returns boolean

  • 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

  • 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