Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class FormattedText

Represents text with multiple paragraphs and mixed formatting in a shape.

The formatting of the string is controlled in a similar fashion as it would be in Microsoft Excel. In Excel, the user must select a portion of the text and set the various formatting properties of that selected text.

With the FormattedText, a portion of the text is "selected" by calling either [[getFont]] or [[getFont]]. Formatting properties are then set on the returned [[FormattedTextFont]] and all characters in the font's selection range are given these properties.

Getting the formatting properties of a [[FormattedTextFont]] will return the formatting of the first character in font's selection range.

See

[[WorksheetShapeWithText.text]]

Hierarchy

Hierarchy

  • Base
    • FormattedText

Implements

  • IFormattedItem
  • IChangeInfoContext

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new FormattedText(): FormattedText

  • Returns FormattedText

  • new FormattedText(unformattedString): FormattedText

  • Parameters

    • unformattedString: string

    Returns FormattedText

  • new FormattedText(..._rest): FormattedText

  • Parameters

    • Rest ..._rest: any[]

    Returns FormattedText

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

verticalAlignment

  • get verticalAlignment(): VerticalTextAlignment

  • Gets or sets the vertical alignment of the formatted text in the owning shape.

    Throws

    [[InvalidEnumArgumentException]] The specified value is not defined in the [[VerticalTextAlignment]] enumeration.

    Returns VerticalTextAlignment

  • set verticalAlignment(a): void

  • Parameters

    Returns void

Methods

clone

  • clone(): FormattedText

  • Creates a new [[FormattedText]] that is a copy of this one.

    This should be used if the same formatted text needs to be used in multiple shapes. The FormattedText class can only exist as the [[WorksheetShapeWithText.text]] of one shape at a time. If the FormattedText is already the text of a shape, and needs to be set as the text of another shape, clone the FormattedText and set the returned clone as text of the shape.

    The cloned FormattedText only takes its original configuration for this instance. If this instance is cloned and than changed, the clone will not be changed as well; it will remain as it was when it was cloned.

    Returns FormattedText

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getFont

  • getFont(startIndex): FormattedTextFont

  • Gets the font which controls the formatting properties in the string from the specified start index to the end of the string.

    If the start index is greater than or equal to the length of the unformatted string, no exception will be thrown. It will be thrown later when one of the formatting properties of the returned [[FormattedTextFont]] is set.

    Throws

    [[ArgumentOutOfRangeException]] 'startIndex' is less than zero.

    Parameters

    • startIndex: number

      The index of the first character the returned font controls.

    Returns FormattedTextFont

  • getFont(startIndex, length): FormattedTextFont

  • Gets the font which controls the formatting properties in the string from the specified start index for the specified number of characters.

    If the start index is greater than or equal to the length of the unformatted string, no exception will be thrown. It will be thrown later when one of the formatting properties of the returned [[FormattedTextFont]] is set.

    Throws

    [[ArgumentOutOfRangeException]] 'startIndex' is less than zero.

    Throws

    [[ArgumentOutOfRangeException]] 'length' is less than one. A zero length string cannot be controlled by a formatting font.

    Parameters

    • startIndex: number

      The index of the first character the returned font controls.

    • length: number

      The number of characters after the start index controlled by the returned font.

    Returns FormattedTextFont

getFormattingRuns

  • getFormattingRuns(): IEnumerable$1<FormattedTextFont>

  • Returns IEnumerable$1<FormattedTextFont>

getHashCode

  • getHashCode(): number

  • Returns number

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

paragraphs

  • paragraphs(index): 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

    • index: number

      The zero-based index of the paragraph to get.

    Returns FormattedTextParagraph

  • paragraphs(): FormattedTextParagraphCollection

  • Gets the paragraphs in the formatted text.

    Returns FormattedTextParagraphCollection

toString

  • toString(): string

  • Returns the string that represents the [[FormattedText]], which is the unformatted string.

    Returns string

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