ig.excel.FormattedTextParagraph

Represents a paragraph in FormattedText.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • alignment

    .alignment( );
    Return Type:
    ig.excel.HorizontalTextAlignment
    Return Type Description:
    Returns a HorizontalTextAlignment.

    Gets the alignment of the paragraph.

  • alignment

    .alignment( value:ig.excel.HorizontalTextAlignment );
    Return Type:
    ig.excel.HorizontalTextAlignment
    Return Type Description:
    Returns a HorizontalTextAlignment.

    Sets the alignment of the paragraph.

    • value
    • Type:ig.excel.HorizontalTextAlignment
  • formattedText

    .formattedText( );
    Return Type:
    ig.excel.FormattedText
    Return Type Description:
    Returns a FormattedText.

    Gets the owning FormattedText to which the paragraph belongs or null if the paragraph has been removed from its owning formatted text.

  • startIndex

    .startIndex( );

    Gets the zero-based index of the paragraph's first character in the overall formatted text.

  • unformattedString

    .unformattedString( );
    Return Type:
    string
    Return Type Description:
    The unformatted string.

    Gets the raw string of the paragraph.

    Exceptions

    Exception Description
    ig.ArgumentNullException The value assigned is a null string.

    Remarks

    If the new unformatted string assigned is shorter than the previous unformatted string, all formatting outside the range of the new value will be lost.

  • unformattedString

    .unformattedString( value:string );
    Return Type:
    string
    Return Type Description:
    The unformatted string.

    Sets the raw string of the paragraph.

    • value
    • Type:string

    Exceptions

    Exception Description
    ig.ArgumentNullException The value assigned is a null string.

    Remarks

    If the new unformatted string assigned is shorter than the previous unformatted string, all formatting outside the range of the new value will be lost.

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