This shows you the differences between two versions of the page.
es:pdf_adaptor [2024/01/29 12:44] montse |
es:pdf_adaptor [2024/12/10 13:27] (current) montse [Funciones predefinidas (PF):] |
||
---|---|---|---|
Line 9: | Line 9: | ||
=====Parámetros de inicialización===== | =====Parámetros de inicialización===== | ||
- | * **FilePath:** Ruta completa del archivo. | + | * **FilePath:** ruta completa del archivo. |
- | =====Funciones predefinidas (PF):===== | + | =====Funciones predefinidas===== |
- | * **addBreakLine**: Permite agregar un salto de línea al documento, en la posición en que se encuentre. | ||
- | * **addFooterText**: Permite añadir un texto al pie de página en el documento. | + | * **checkTextOnDocument(Page Area, Search Text):** busca un texto dado en un área específica del documento (Página completa, Encabezado, Cuerpo, Pie de página). Esta función busca una coincidencia exacta del texto de búsqueda. |
- | * **addHeaderText**: Permite añadir un texto a la cabecera de página en el documento. | + | * **checkTextOnPage**: retorna true, si encuentra el texto especificado por el parámetro Search Text, en el área indicada por el parámetro PageArea, en la página representada por el parámetro Page, el número de veces introducido en Occurrences, false en caso contrario. |
- | + | ||
- | * **addImageFile**: Permite añadir una imagen al documento. | + | |
- | + | ||
- | * **addPage**: Permite añadir una página en blanco al documento PDF. | + | |
- | * **addParagraph**: Permite añadir un párrafo al documento PDF. | + | * **checkTextOnPageArea(Page, CoordinateX, CoordinateY, Width, Height, Text):** esta función devuelve verdadero si el parámetro texto existe dentro del área de la pagina definida por los parámetros. El parámetro page indica el número de la página a transformar. CoordinateX y CoordinateY indican las coordenadas de inicio del área. Width y Height indican el tamaño del área deseada, text es el texto que debe comprobar esta función. Y por último la imagen contará con 72 ppp de resolución. |
- | * **addTable**: Permite añadir una tabla al documento PDF. | + | * **generateFileAsEvidence**: la función genera una copia del fichero PDF en su estado actual para añadirlo como evidencia. |
- | * **checkTableOnPage**: Retorna true si existe una tabla en la página indicada del documento PDF, falso en caso contrario. | + | * **getCustomMetaData**: devuelve el valor del metadato personalizado especificado en su parámetro de entrada. Los metadatos personalizados son otros distintos a los automáticos que se incluyen manualmente en los documentos. En el nombre del metadato se discrimina entre mayúsculas y minúsculas. |
- | * **checkTextBoldOnDocument**: Retorna true, si todas las apariciones del texto Search Text en el documento, tienen desactivado/activado el atributo Bold segun se pasa como parámetro. | + | * **getDataSigned**: obtiene los datos de la firma del documento en el caso de que esté firmado digitalmente. Devuelve en salida una variable TastTableData. Los datos se devuelven en una fila y N columnas. |
- | * **checkTextBoldOnPage**: Retorna true, si comprueba que la primera aparición del texto Search Text en la página tiene el atributo Bold en On o en Off. | + | * **getMetaData**: devuelve el valor del metadato seleccionado en el desplegable del parámetro de entrada. Son los metadatos automáticos como: title, author, subject, keyWords, creator, producer, pageCount, creationDate, modificationDate, traped. |
- | * **checkTextColor**: | + | * **getNumPages():** devuelve el número de páginas del documento. |
- | + | ||
- | * **checkTextColorOnDocument**: Retorna True, si todas las ocurrencias del texto Search Text en el documento, tienen el color configurado. | + | |
- | + | ||
- | * **checkTextColorOnPage**: Retorna true, si el texto Search Text aparece en la página indicada con el color configurado. | + | |
- | + | ||
- | * **checkTextFontSizeOnDocument**: Retorna true, si el tamaño del texto Search Text es el indicado en todas sus apariciones en el documento. | + | |
- | + | ||
- | * **checkTextFontSizeOnPage**: Retorna true, si el tamaño de la primera aparición del texto Search Text en la página, es el especificado como parámetro. False en caso contrario. | + | |
- | + | ||
- | * **checkTextFontTypeOnDocument**: Retorna true, si el tipo de la fuente del texto Search Text es el indicado en todas sus apariciones en el documento. False en caso contrario. | + | |
- | + | ||
- | * **checkTextFontTypeOnPage**: Retorna true, si el tipo de la fuente de la primera aparición en la página del texto Search Text es el pasado como parámetro. | + | |
- | + | ||
- | * **checkTextOnDocument(Page Area, Search Text):** Busca un texto dado en un área específica del documento (Página completa, Encabezado, Cuerpo, Pie de página). Esta función busca una coincidencia exacta del texto de búsqueda. | + | |
- | + | ||
- | * **checkTextOnPage**: Retorna true, si encuentra el texto especificado por el parámetro Search Text, en el área indicada por el parámetro PageArea, en la página representada por el parámetro Page, el número de veces introducido en Occurrences, false en caso contrario. | + | |
- | + | ||
- | * **checkTextOnPageArea(Page, CoordinateX, CoordinateY, Width, Height, Text):** Esta función devuelve verdadero si el parámetro texto existe dentro del área de la pagina definida por los parámetros. El parámetro page indica el número de la página a transformar. CoordinateX y CoordinateY indican las coordenadas de inicio del área. Width y Height indican el tamaño del área deseada, text es el texto que debe comprobar esta función. Y por último la imagen contará con 72 ppp de resolución. | + | |
- | + | ||
- | * **copyFile**: | + | |
- | + | ||
- | * **createPdfFile**: Permite crear un fichero PDF en la ruta y con el nombre pasados como parámetro. | + | |
- | + | ||
- | * **generateFileAsEvidence**: La función genera una copia del fichero PDF en su estado actual para añadirlo como evidencia. | + | |
- | + | ||
- | * **getFormFieldType**: | + | |
- | + | ||
- | * **getFormsFieldsNames**: Permite recuperar un array con los nombres de todos los campos de formulario existentes en el documento PDF. | + | |
- | + | ||
- | * **getNumColumns**: Retorna el número de columnas de la TastTableData generada al leer una tabla del fichero PDF con la función getPdfTableAsDataTable. | + | |
- | + | ||
- | * **getNumPages():** Devuelve el número de páginas del documento. | + | |
* **getNumRows**: | * **getNumRows**: | ||
- | * **getNumWhitePages():** Devuelve el número de páginas blancas del documento. | + | * **getNumWhitePages():** devuelve el número de páginas blancas del documento. |
- | * **getPageAsImage(Page,File):** Esta PF transforma una pagina PDF a una imagen jpg con una resolución de 72 ppp. Los parámetros de entrada con los que contamos son Page, que indica el número de página a transformar y el parámetro File que indica la ruta y el nombre de archivo donde la imagen será generada. La extensión es .jpg. \\ El propósito de esta imagen es permitir al usuario cargarla en cualquier aplicación que le ayude a identificar las coordenadas donde una parte con texto aparezca.\\ A parte de esto, si Get Evidences está marcado, se generará la imagen en la carpeta del log, como evidencia. | + | * **getPageAsImage(Page,File):** esta PF transforma una pagina PDF a una imagen jpg con una resolución de 72 ppp. Los parámetros de entrada con los que contamos son Page, que indica el número de página a transformar y el parámetro File que indica la ruta y el nombre de archivo donde la imagen será generada. La extensión es .jpg. \\ El propósito de esta imagen es permitir al usuario cargarla en cualquier aplicación que le ayude a identificar las coordenadas donde una parte con texto aparezca.\\ A parte de esto, si Get Evidences está marcado, se generará la imagen en la carpeta del log, como evidencia. |
- | + | ||
- | * **getPageText:** Permite recuperar el texto contenido en una página de un PDF, y la función genera como evidencia un fichero con el texto recuperado. | + | |
- | + | ||
- | * **getPDFTableAsDataTable**: Esta función genera un objeto TastTableData, leyendo la tabla del documento PDF situada en la página indicada por Page, en el orden indicado por NumTable. El parámetro header permite indicar si la primera línea de la tabla debe considerarse de datos o de cabecera. | + | |
- | + | ||
- | * **getTableValue**: | + | |
- | + | ||
- | * **getTextCountOnDocument(Search Text):** Cuenta el número de veces que el texto de búsqueda está presente en el documento. | + | |
- | + | ||
- | * **getTextCountOnPage(Page, Search Text, Page Area):** Cuenta el número de veces que el texto de búsqueda está presente en un área específica (Página, Encabezado, Cuerpo, Pie de página) de una página dada. La función busca coincidencias exactas del texto de búsqueda dado. | + | |
- | + | ||
- | * **getTextPageByArea(Page, CoordinateX, CoordinateY, Width, Height):** Esta función extrae y devuelve el texto que esta contenido dentro de un área de la página. El parámetro page indica el número de la página a transformar. CoordinateX y CoordinateY indican las coordenadas de inicio del área. Width y Height indican el tamaño del área deseada y por último la imagen contará con 72 ppp de resolución. | + | |
- | + | ||
- | * **getTextPositionOnDocument**: Retorna las coordenadas X, Y de la primera aparición del texto Search Text en el documento. | + | |
- | + | ||
- | * **getTextPositionOnPage**: Retorna las coordenadas X, Y de la primera aparición del texto Search Text en la página representada por Page. | + | |
- | + | ||
- | * **isPageWhite(Page):** Devuelve "true" si la página especificada es blanca, "false" si no. | + | |
- | + | ||
- | * **readPdfFile**: Lee un fichero PDF y lo carga para su procesamiento. | + | |
- | + | ||
- | * **renameFile**: Esta función permite renombrar el fichero pdf. | + | |
- | * **setBold**: Permite configurar Bold On/Off para los textos que se agregan posteriormente al documento. | + | * **getPageText:** permite recuperar el texto contenido en una página de un PDF, y la función genera como evidencia un fichero con el texto recuperado. |
- | * **setDefaultAlignment**: Permite configurar la alineación de los textos que agreguemos posteriormente al documento. | + | * **getTextCountOnDocument(Search Text):** cuenta el número de veces que el texto de búsqueda está presente en el documento. |
- | * **setDefaultFont**: Permite configurar el tipo de fuente a emplear al escribir texto en el documento. | + | * **getTextCountOnPage(Page, Search Text, Page Area):** cuenta el número de veces que el texto de búsqueda está presente en un área específica (Página, Encabezado, Cuerpo, Pie de página) de una página dada. La función busca coincidencias exactas del texto de búsqueda dado. |
- | * **setDefaultFontColor**: Permite configurar el color de los textos que se agreguen al documento posteriormente. | + | * **getTextPageByArea(Page, CoordinateX, CoordinateY, Width, Height):** esta función extrae y devuelve el texto que esta contenido dentro de un área de la página. El parámetro page indica el número de la página a transformar. CoordinateX y CoordinateY indican las coordenadas de inicio del área. Width y Height indican el tamaño del área deseada y por último la imagen contará con 72 ppp de resolución. |
- | * **setDefaultFontSize**:Permite configurar el tamaño de la fuente para el texto que se agregue al documento posteriormente . | + | * **isPageWhite(Page):** devuelve "true" si la página especificada es blanca, "false" si no. |
- | * **setFormCheckBox**: | + | * **isSigned**: devuelve en su variable de salida booleana, **true** o **false**, según el documento está firmado digitalmente o no. |
- | * **setItalic**: Permite configurar Italic On/Off para los textos que se agregan posteriormente al documento. | + | * **readPdfFile**: lee un fichero PDF y lo carga para su procesamiento. |
- | * **setUnderLinePattern**: Permite configurar el patrón de subrayado a emplear en los textos que se agreguen posteriormente al documento. | ||
- | * **typeOnFormField**: Permite escribir un valor en un campo de formulario en el documento, usando como parámetros el nombre cualificado del campo y el valor a escribir. |