com.aspose.slides

Interfaces

Classes

Exceptions

com.aspose.slides

Class ParagraphCollection

  • java.lang.Object
    • com.aspose.slides.ParagraphCollection
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void add(IParagraph value)
      Adds a Paragraph to the end of collection.
      int add(IParagraphCollection value)
      Adds a content of ParagraphCollection to the end of collection.
      void addFromHtml(java.lang.String text)
      Adds text from specified html string to the collection.
      void addFromHtml(java.lang.String text, IExternalResourceResolver resolver, java.lang.String uri)
      Adds text from specified html string to the collection.
      void clear()
      Removes all elements from the collection.
      boolean contains(IParagraph item)
      Determines whether the System.Collections.Generic.ICollection`1 contains a specific value.
      void copyTo(IParagraph[] array, int arrayIndex)
      Copies the elements of the System.Collections.Generic.ICollection`1 to an Array, starting at a particular Array index.
      java.lang.String exportToHtml(int firstParagraphIndex, int paragraphsCount, ITextToHtmlConversionOptions options)
      Converts specifying paragraphs to the HTML and returns it as String object.
      IParagraph get_Item(int index)
      Gets the element at the specified index.
      int getCount()
      Gets the number of elements actually contained in the collection.
      com.aspose.slides.IDOMObject getParent_Immediate()
      Returns Parent_Immediate object.
      IPresentation getPresentation()
      Returns the parent presentation of a paragraphs collection.
      IBaseSlide getSlide()
      Returns the parent slide of a paragraphs collection.
      int indexOf(IParagraph item)
      Determines the index of a specific item in the System.Collections.Generic.IList`1.
      void insert(int index, IParagraph value)
      Inserts a Paragraph into the collection at the specified index.
      void insert(int index, IParagraphCollection value)
      Inserts a content of ParagraphCollection into the collection at the specified index.
      boolean isReadOnly()
      Gets a value indicating whether the System.Collections.Generic.ICollection`1 is read-only.
      com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IParagraph> iterator()
      Returns an enumerator that iterates through the collection.
      void notify(java.lang.Object sender) 
      boolean remove(IParagraph item)
      Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection`1.
      void removeAt(int index)
      Removes the element at the specified index of the collection.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
    • Method Detail

      • getCount

        public final int getCount()

        Gets the number of elements actually contained in the collection. Read-only int.

        Specified by:
        getCount in interface IParagraphCollection
      • isReadOnly

        public final boolean isReadOnly()

        Gets a value indicating whether the System.Collections.Generic.ICollection`1 is read-only. Read-only boolean.

        Returns:
        true if the System.Collections.Generic.ICollection`1 is read-only; otherwise, false.
      • add

        public final void add(IParagraph value)

        Adds a Paragraph to the end of collection.

        Specified by:
        add in interface IParagraphCollection
        Parameters:
        value - The Paragraph to be added to the end of the collection.
      • add

        public final int add(IParagraphCollection value)

        Adds a content of ParagraphCollection to the end of collection.

        Specified by:
        add in interface IParagraphCollection
        Parameters:
        value - The ParagraphCollection to be added to the end of the collection.
        Returns:
        The index at which the Paragraph has been added or -1 if there are nothing to add.
      • indexOf

        public final int indexOf(IParagraph item)

        Determines the index of a specific item in the System.Collections.Generic.IList`1.

        Parameters:
        item - The object to locate in the System.Collections.Generic.IList`1.
        Returns:
        The index of item if found in the list; otherwise, -1.
      • insert

        public final void insert(int index,
                                 IParagraph value)

        Inserts a Paragraph into the collection at the specified index.

        Specified by:
        insert in interface IParagraphCollection
        Parameters:
        index - The zero-based index at which Paragraph should be inserted.
        value - The Paragraph to insert.
      • insert

        public final void insert(int index,
                                 IParagraphCollection value)

        Inserts a content of ParagraphCollection into the collection at the specified index.

        Specified by:
        insert in interface IParagraphCollection
        Parameters:
        index - The zero-based index at which paragraphs should be inserted.
        value - The paragraphs to insert.
      • clear

        public final void clear()

        Removes all elements from the collection.

        Specified by:
        clear in interface IParagraphCollection
      • contains

        public final boolean contains(IParagraph item)

        Determines whether the System.Collections.Generic.ICollection`1 contains a specific value.

        Parameters:
        item - The object to locate in the System.Collections.Generic.ICollection`1.
        Returns:
        true if item is found in the System.Collections.Generic.ICollection`1; otherwise, false.
      • copyTo

        public final void copyTo(IParagraph[] array,
                                 int arrayIndex)

        Copies the elements of the System.Collections.Generic.ICollection`1 to an Array, starting at a particular Array index.

        Parameters:
        array - The one-dimensional Array that is the destination of the elements copied from System.Collections.Generic.ICollection`1. The Array must have zero-based indexing.
        arrayIndex - The zero-based index in array at which copying begins.
        Throws:
        com.aspose.ms.System.ArgumentNullException - array is null.
        com.aspose.ms.System.ArgumentOutOfRangeException - arrayIndex is less than 0.
        com.aspose.ms.System.ArgumentException - The number of elements in the source System.Collections.Generic.ICollection`1 is greater than the available space from arrayIndex to the end of the destination array.
      • removeAt

        public final void removeAt(int index)

        Removes the element at the specified index of the collection.

        Specified by:
        removeAt in interface IParagraphCollection
        Parameters:
        index - The zero-based index of the element to remove.
      • remove

        public final boolean remove(IParagraph item)

        Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection`1.

        Specified by:
        remove in interface IParagraphCollection
        Parameters:
        item - The object to remove from the System.Collections.Generic.ICollection`1.
        Returns:
        true if item was successfully removed from the System.Collections.Generic.ICollection`1; otherwise, false. This method also returns false if item is not found in the original System.Collections.Generic.ICollection`1.
        Throws:
        com.aspose.ms.System.NotSupportedException - The System.Collections.Generic.ICollection`1 is read-only.
      • iterator

        public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IParagraph> iterator()

        Returns an enumerator that iterates through the collection.

        Specified by:
        iterator in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IParagraph>
        Specified by:
        iterator in interface com.aspose.ms.System.Collections.IEnumerable<IParagraph>
        Specified by:
        iterator in interface java.lang.Iterable<IParagraph>
        Returns:
        A System.Collections.Generic.IEnumerator`1 that can be used to iterate through the collection.
      • getParent_Immediate

        public final com.aspose.slides.IDOMObject getParent_Immediate()

        Returns Parent_Immediate object. Read-only IDOMObject.

      • notify

        public final void notify(java.lang.Object sender)
      • addFromHtml

        public final void addFromHtml(java.lang.String text)

        Adds text from specified html string to the collection.

        Specified by:
        addFromHtml in interface IParagraphCollection
        Parameters:
        text - HTML text.
      • addFromHtml

        public final void addFromHtml(java.lang.String text,
                                      IExternalResourceResolver resolver,
                                      java.lang.String uri)

        Adds text from specified html string to the collection.

        Specified by:
        addFromHtml in interface IParagraphCollection
        Parameters:
        text - HTML text.
        resolver - Resolver callback object which resolves URIs and fetches referrenced objects.
        uri - URI for adding HTML document. Used for resolving relative links.


        Specifying resolver can potentially introduce a vulnurability. Use with caution.

      • exportToHtml

        public final java.lang.String exportToHtml(int firstParagraphIndex,
                                                   int paragraphsCount,
                                                   ITextToHtmlConversionOptions options)

        Converts specifying paragraphs to the HTML and returns it as String object.

        Specified by:
        exportToHtml in interface IParagraphCollection
        Parameters:
        firstParagraphIndex - Index of paragraph.
        paragraphsCount - Count of paragraphs.
        options - ITextToHtmlConversionOptions object.
        Returns:
        Generated HTML.