.. role:: clio-inherited
   :class: clio-flag clio-flag-inherited


#################
TextBoxCollection
#################

.. js:class:: Markup.Shapes.TextBoxCollection

   This class is useful for drawing a number of text boxes which share the same visual settings.
   
   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Markup.Shapes.TextBoxCollection.addString`
   * :js:meth:`~Markup.Shapes.TextBoxCollection.clear`
   * :js:meth:`~Markup.Shapes.TextBoxCollection.getBoxPortion`
   * :js:meth:`~Markup.Shapes.TextBoxCollection.getPadding`
   * :js:meth:`~Markup.Shapes.TextBoxCollection.getStrings`
   * :js:meth:`~Markup.Shapes.TextBoxCollection.getTextPortion`
   * :js:meth:`~Markup.Shapes.TextBoxCollection.setPadding`
   
   




Methods
=======

.. js:method:: Markup.Shapes.TextBoxCollection.addString

   .. rst-class:: sig-pretty-signature
   
      | addString(**text**\ : *string*\ , **position**\ : :js:class:`~Point2`\ ): *void*
   
   Adds a string to the collection
   
   **Parameters**
   
      **text**\ : *string*
   
         the text to render
   
   
      **position**\ : :js:class:`~Point2`
   
         the top left position of the text
   
   
   
   **Returns**\ : *void*
   



.. js:method:: Markup.Shapes.TextBoxCollection.clear

   .. rst-class:: sig-pretty-signature
   
      | clear(): *void*
   
   Removes all text strings from this collection
   
   **Returns**\ : *void*
   



.. js:method:: Markup.Shapes.TextBoxCollection.getBoxPortion

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getBoxPortion(): :js:class:`RectangleBase <Markup.Shapes.RectangleBase>`
   
   Gets the Box portion of the TextBox. Use the methods on this object to modify the appearance of the rectangle around the text string
   
   **Returns**\ : :js:class:`RectangleBase <Markup.Shapes.RectangleBase>`
   
      the rectangle markup object.
   
   



.. js:method:: Markup.Shapes.TextBoxCollection.getPadding

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getPadding(): *number*
   
   Gets the Pixel distance between the text and outer rectangle
   
   **Returns**\ : *number*
   
      the padding value.
   
   



.. js:method:: Markup.Shapes.TextBoxCollection.getStrings

   .. rst-class:: sig-pretty-signature
   
      | getStrings(): *_MarkupTextData*\ []
   
   Gets the strings in the collection
   
   **Returns**\ : *_MarkupTextData*\ []
   



.. js:method:: Markup.Shapes.TextBoxCollection.getTextPortion

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getTextPortion(): :js:class:`TextMarkupBase <Markup.Shapes.TextMarkupBase>`
   
   Gets the Text portion of the TextBox. Use the methods on this object to modify the appearance of the text string
   
   **Returns**\ : :js:class:`TextMarkupBase <Markup.Shapes.TextMarkupBase>`
   
      the text markup object
   
   



.. js:method:: Markup.Shapes.TextBoxCollection.setPadding

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setPadding(**padding**\ : *number*\ ): *void*
   
   Sets the Pixel distance between the text and outer rectangle
   
   **Parameters**
   
      **padding**\ : *number*
   
         the padding value.
   
   
   
   **Returns**\ : *void*
   





