ig.excel.FormattedText

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

Remarks

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 FormattedText.getFont or FormattedText.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.

Dependencies

jquery-1.4.4.js
infragistics.util.js
The current widget has no options.
The current widget has no events.

  • ig.excel.FormattedText
    Constructor

    new $.ig.excel.FormattedText( unformattedString:string );

    Creates a new instance of the FormattedText class.

    • unformattedString
    • Type:string
    • The string that will be displayed in the shape. Each line of the string will be placed in a separate paragraph of the FormattedText.paragraphs collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException unformattedString is null.

  • clone

    .clone( );
    Return Type:
    ig.excel.FormattedText
    Return Type Description:
    A new FormattedText that is a copy of this one.

    Creates a new FormattedText that is a copy of this one.

    Remarks

    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.

  • getFont

    .getFont( startIndex:number );
    Return Type:
    ig.excel.FormattedTextFont
    Return Type Description:
    A FormattedTextFont instance which controls the formatting of the end portion of the string.

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

    • startIndex
    • Type:number
    • The index of the first character the returned font controls.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException startIndex is less than zero.

    Remarks

    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.

  • getFont

    .getFont( startIndex:number, length:number );
    Return Type:
    ig.excel.FormattedTextFont
    Return Type Description:
    A FormattedTextFont instance which controls the formatting of a portion of the string.

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

    • startIndex
    • Type:number
    • The index of the first character the returned font controls.
    • length
    • Type:number
    • The number of characters after the start index controlled by the returned font.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException startIndex is less than zero.
    ig.ArgumentOutOfRangeException length is less than one. A zero length string cannot be controlled by a formatting font.

    Remarks

    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.

  • getFormattingRuns

    .getFormattingRuns( );

    Gets the collection of formatting runs representing contiguous blocks of similar formatting starting at the beginning of the string.

  • paragraphs

    .paragraphs( );

    Gets the paragraphs in the formatted text.

  • paragraphs

    .paragraphs( index:number );
    Return Type:
    ig.excel.FormattedTextParagraph
    Return Type Description:
    The FormattedTextParagraph representing the paragraph at the specified index.

    Gets the paragraph at the specified zero-based index.

    • index
    • Type:number
    • The zero-based index of the paragraph to get.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or greater than or equal to the number of paragraphs in the collection.

  • toString

    .toString( );
    Return Type:
    string
    Return Type Description:
    The string that represents the FormattedText.

    Returns the string that represents the FormattedText, which is the unformatted string.

  • verticalAlignment

    .verticalAlignment( );

    Gets the vertical alignment of the formatted text in the owning shape.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The specified value is not defined in the VerticalTextAlignment enumeration.

  • verticalAlignment

    .verticalAlignment( value:ig.excel.VerticalTextAlignment );

    Sets the vertical alignment of the formatted text in the owning shape.

    • value
    • Type:ig.excel.VerticalTextAlignment

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException The specified value is not defined in the VerticalTextAlignment enumeration.

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.