.. index:: 
  !DocumentLibrary.loadDocumentTemplate Method
  
.. _id3_document_document_library_load_document_template_class_method:

===============================================================================
DocumentLibrary.loadDocumentTemplate Method
===============================================================================

Module: :ref:`DocumentLibrary<id3_document_document_library_class>`

Definition
----------

Loads the specified document template from a file.


.. tab-set::

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

      .. code:: Python

        @staticmethod
        load_document_template(path: str) -> None

      **Parameters**

        .. line-block::

          ``path`` str
          :guilabel:`in` A string that contains the full path to the document template.


      **Exceptions**

        .. line-block::

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


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

      .. code:: Dart

        static void loadDocumentTemplate(String? path)

      **Parameters**

        .. line-block::

          ``path`` String
          :guilabel:`in` A string that contains the full path to the document template.


      **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 static void LoadDocumentTemplate(string path)

      **Parameters**

        .. line-block::

          ``path`` string
          :guilabel:`in` A string that contains the full path to the document template.


      **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 static void loadDocumentTemplate(String path) throws DocumentException

      **Parameters**

        .. line-block::

          ``path`` String
          :guilabel:`in` A string that contains the full path to the document template.


      **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 static func loadDocumentTemplate(path: String) throws

      **Parameters**

        .. line-block::

          ``path`` String
          :guilabel:`in` A string that contains the full path to the document template.


      **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 id3DocumentLibrary_LoadDocumentTemplate (
            const char * path)

      **Parameters**

        .. line-block::

          ``path`` const char *
          :guilabel:`in` A string that contains the full path to the document template.


      **Returns**

        .. line-block::

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


