ig.excel.FormattedTextParagraphCollection
A collection of FormattedTextParagraph instances in FormattedText.
Dependencies
jquery-1.4.4.js
infragistics.util.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.ext_core.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
-
add
- .add( paragraphText:string );
- Return Type:
- ig.excel.FormattedTextParagraph
- Return Type Description:
- The FormattedTextParagraph representing the new paragraph.
Adds a paragraph with the specified text and returns the FormattedTextParagraph representing the new paragraph.
- paragraphText
- Type:string
- The text in the paragraph.
-
clear
- .clear( );
Removes all paragraphs from the formatted text.
-
contains
- .contains( paragraph:ig.excel.FormattedTextParagraph );
- Return Type:
- boolean
- Return Type Description:
- True if the paragraph exists in the collection; False otherwise.
Determines whether the specified paragraph exists in the collection.
- paragraph
- Type:ig.excel.FormattedTextParagraph
- The paragraph to find in the collection.
-
count
- .count( );
Gets the number of paragraphs in the collection.
-
getEnumerator
- .getEnumerator( );
Gets the enumerator to iterate over all paragraphs.
-
indexOf
- .indexOf( paragraph:ig.excel.FormattedTextParagraph );
- Return Type:
- number
- Return Type Description:
- The zero-based index of the paragraph in the collection or -1 if the paragraph doesn't exist in the collection.
Gets the zero-based index of the specified paragraph in the collection.
- paragraph
- Type:ig.excel.FormattedTextParagraph
- The paragraph to find in the collection.
-
insert
- .insert( index:number, paragraphText:string );
- Return Type:
- ig.excel.FormattedTextParagraph
- Return Type Description:
- The FormattedTextParagraph representing the new paragraph.
Inserts a paragraph with the specified text and returns the FormattedTextParagraph representing the new paragraph.
- index
- Type:number
- The zero-based index in the collection where the paragraph should be inserted.
- paragraphText
- Type:string
- The text in the paragraph.
Exceptions
Exception Description ig.ArgumentOutOfRangeException index is less than zero or greater than the number of paragraphs in the collection. -
item
- .item( 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. -
remove
- .remove( paragraph:ig.excel.FormattedTextParagraph );
- Return Type:
- boolean
- Return Type Description:
- True if the paragraph was in the collection and was removed; False otherwise.
Removes the specified paragraph from the collection.
- paragraph
- Type:ig.excel.FormattedTextParagraph
- The paragraph to remove from the collection.
-
removeAt
- .removeAt( index:number );
Removes the paragraph at the specified zero-based index in the collection.
- index
- Type:number
- The zero-based index of the paragraph to remove.
Exceptions
Exception Description ig.ArgumentOutOfRangeException index is less than zero or greater than or equal to the number of paragraphs in the collection.