.. index:: 
  !TextFieldList.set Method
  
.. _id3_document_text_field_list_set_class_method:

===============================================================================
TextFieldList.set Method
===============================================================================

Module: :ref:`TextFieldList<id3_document_text_field_list_class>`

Definition
----------

Sets an item of the TextFieldList object.


.. tab-set::

    .. tab-item:: Python
      :sync: Python

      .. code:: Python

        set(self, index: int, text_field_item: TextField) -> None

      **Parameters**

        .. line-block::

          ``index`` int
          :guilabel:`in` Index of the TextField item to set.

          ``text_field_item`` :ref:`TextField<id3_document_text_field_class>`
          :guilabel:`in` TextField item to set.


      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: Dart
      :sync: Dart

      .. code:: Dart

        void set(int index, TextField textFieldItem)

      **Parameters**

        .. line-block::

          ``index`` int
          :guilabel:`in` Index of the TextField item to set.

          ``textFieldItem`` :ref:`TextField<id3_document_text_field_class>`
          :guilabel:`in` TextField item to set.


      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: C#
      :sync: C#

      .. code:: C#

        public void Set(int index, TextField textFieldItem)

      **Parameters**

        .. line-block::

          ``index`` int
          :guilabel:`in` Index of the TextField item to set.

          ``textFieldItem`` :ref:`TextField<id3_document_text_field_class>`
          :guilabel:`in` TextField item to set.


      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: Java
      :sync: Java

      .. code:: Java

        public void set(int index, TextField textFieldItem) throws DocumentException

      **Parameters**

        .. line-block::

          ``index`` int
          :guilabel:`in` Index of the TextField item to set.

          ``textFieldItem`` :ref:`TextField<id3_document_text_field_class>`
          :guilabel:`in` TextField item to set.


      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: Swift
      :sync: Swift

      .. code:: Swift

        public func set(index: Int32, textFieldItem: TextField) throws

      **Parameters**

        .. line-block::

          ``index`` Int32
          :guilabel:`in` Index of the TextField item to set.

          ``textFieldItem`` :ref:`TextField<id3_document_text_field_class>`
          :guilabel:`in` TextField item to set.


      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: C
      :sync: C

      .. code:: C

        int id3DocumentTextFieldList_Set (
            ID3_DOCUMENT_TEXT_FIELD_LIST hTextFieldList, 
            int index, 
            ID3_DOCUMENT_TEXT_FIELD hTextFieldItem)

      **Parameters**

        .. line-block::

          ``hTextFieldList`` :ref:`ID3_DOCUMENT_TEXT_FIELD_LIST<id3_document_text_field_list_class>`
          :guilabel:`in` Handle to the TextFieldList object.

          ``index`` int
          :guilabel:`in` Index of the TextField item to set.

          ``hTextFieldItem`` :ref:`ID3_DOCUMENT_TEXT_FIELD<id3_document_text_field_class>`
          :guilabel:`in` TextField item to set.


      **Returns**

        .. line-block::

          ``int``
          An error code.
          See :ref:`id3DocumentError<id3_document_document_error_enum>` file for the list of possible error codes.


