8 de septiembre de 2013

Documentación de FoxBarcode

FoxBarcode es una clase 100% Visual FoxPro que ofrece una herramienta para la generación de imágenes con distintas simbologías de códigos de barras, para ser usadas en informes y formularios de VFP, o exportadas a otras aplicaciones. Su uso y distribución es libre para toda la Comunidad de Visual FoxPro.

Sitio oficial de FoxBarcode: http://vfpx.codeplex.com/wikipage?title=FoxBarcode

Última versión: 1.12 lanzada el 08/09/2013

Sitio de Descarga: http://vfpx.codeplex.com/releases/view/56050

Características

FoxBarcode soporta las siguientes 18 simbologías lineales de códigos de barras: Código 128, Código 39, Código 39 Extendido (Full ASCII), Código 93, Código 93 Extendido (Full ASCII), Standard 2 de 5, Interleaved 2 de 5, EAN-8, EAN-13, UPC-A, UPC-E (EAN y UPC con suplementos de 2 y 5 dígitos), ITF-14, GS1/EAN/UCC-128, Codabar, Código 11, MSI / Plessey, Telepen, PostNet, RM4SCC, KIX-Code, One Track Pharmacode y Two Track Pharmacode.

FoxBarcode soporta los siguientes tipos de imagenes: JPG, BMP, GIF, PNG y TIFF

FoxBarcode genera las imágenes con la clase gpImage2 (http://sites.google.com/site/gpimage2) de Alexander Golovlev (Rusia) y Cesar Ch. (Brasil), basada en GDI+ y requiere gdiplus.dll.

FoxBarcode permite un gran control en la generación de la imagen del código de barras al poder personalizar las siguientes propiedades:
  • nImageHeight: Altura en pixeles de la imagen.
  • nImageWidth: Ancho en pixeles de la imagen. Ahora se puede configurar el ancho
  • nAlignBarcode: Alineación del código de barra con respecto a la imagen. [0=Izquierda, 1=Centro y 2=Derecha]
  • nResolution: Resolución de la imagén en DPI.  
  • nRotation: Rotación de la imagen. [0=0°, 1=90°, 2=180°, 3=270°]
  • cImageType: Tipo de la imagen generada ["JPG", "GIF", "PNG", "BMP", "TIF"]
  • cImageFile: Nombre del archivo de imagen generado. Si no se especifica, se genera un nombre de archivo aleatorio en la carpeta de archivos temporales de Windows.
  • cText: Texto a codificar.
  • nAlignText: Alineación del texto de la lectura humana. [0=Izquierda, 1=Centro, 2=Derecha]
  • lShowHumanReadableText: .T. si se muestra la lectura humana.
  • lShowCheckDigit: .T. si se muestra el dígito de control en la lectura humana.
  • lShowStartStopChars: .T. si se muestra los caracteres de inicio y final en la lectura humana.
  • cFontName: Nombre de la fuente de la lectura humana.
  • lFontBold: .T. si la fuente de la lectura humana es Negrita.
  • lFontItalic: .T. si la fuente de la lectura humana es Cursiva.
  • nFontSize: Tamaño de la letra de la lectura humana. [Recomendado = 8 ó 9]
  • nFontColor: Color de la fuente de la lectura humana. [Recomendado = Negro = RGB(0,0,0)].
  • nBackColor: Color de fondo de la imagen [Recomendado = Blanco = RGB(255,255,255)].
  • nBarsColor: Color de las barras [Recomendado = Negro = RGB(0,0,0)].
  • nBarcodeType: Tipo de la simbología de código de barra. Vea la lista de codigos de barra soportados y su Id.
  • cSet128 Set: Juego del Código 128. ["A", "B", "C" y "*" (Auto)]
  • cSupplementalText: Texto suplementario en códigos EAN y UPC.
  • lAddCheckDigit: .T. si se calcula el dígito de control. En las simbologías en donde el dígito de control es obligatorio, no se tiene en cuenta esta propiedad.
  • nBearerBar: Tipo del marco portante, solo en la simbología ITF-14.  [0=Ninguno, 1=Rectángulo, 2=Superior e inferior]
  • lUseAppId:  .T. para que FoxBarcode interprete en el código GS1/EAN/UCC-128 a los Identificadores de Aplicación (encerrados entre paréntesis).
  • nFactor: Factor de magnificación del código de barras. [1..9]
  • nMargin: Margen alrededor del código de barras. 
  • nRatio: Relación entre las barras angostas y las barras anchas en las simbologías que lo permiten.
  • lDeleteTempFiles: Permite elegir si borra o no la carpeta temporal con las imágenes temporales.
Para la generación de la imagen, solo se debe llamar al método BarcodeImage() que genera la imagen del código de barras y retorna la ruta y nombre de archivo generado.

Ahora se puede validar previamente la cadena a codificar con el método BarcodeTest()

FoxBarcode es compatible con todas las versiones de Visual FoxPro a partir de la versión 6.0

Lenguajes

Gracias a la Comunidad Mundial de VFP, se tradujeron los mensajes de FoxBarcode a los siguientes lenguajes:
  • Inglés
  • Español por VFPEncoding
  • Checo por Martin Krivka
  • Holandés por Koen Piller
  • Alemán por Stefan Wuebbe
  • Indonesio por Samir H.
  • Portugués por Cesar Ch.
  • Turco por Ugur Yilmaz
  • Filipino por Glenn Gevero
  • Francés por Samir H.
  • Serbio por Michael Kopljan
  • Italiano por Roberto Saccomanno
Ejemplos

El siguiente es un ejemplo de código para generar una imagen tipo "PNG" del código de barras "Código 128 C" con una altura de "100" pixeles y un factor de magnificación de "2":
*-- Crear el objeto
loFbc = CREATEOBJECT("FoxBarcode")

*-- Configurar las propiedades
WITH loFBC
  .cImageType = "PNG"
  .nBarcodeType = 110 && Code 128
  .cSet128 = "C" && Set 128 C
  .nImageHeight = 100
  .nFactor = 2
ENDWITH

*-- Generar la imagen 
lcImagen = loFbc.BarcodeImage("123456789012")
Desde la versión 0.11 se agregó un 3er. parámetro al método BarcodeImage() que permite configurar varias propiedades, separadas por comas. El mismo ejemplo de arriba, con el uso del 3er. parámetro.
*-- Creo el objeto
loFbc = CREATEOBJECT("FoxBarcode")
*-- Genero la imagen con sus propiedades
lcImagen = loFbc.BarcodeImage("","",[cText="123456789012", cImageType="PNG", ;
           nBarcodeType=110, cSet128="C", nImageHeight=100, nFactor=2])

La imagen generada se muestra a continuación


Otras imágenes de ejemplo cambiando solo algunas propiedades de la clase FoxBarcode





Ahora FoxBarcode soporta el código EAN/UCC/GS1 128


Para incluir un código de barras en un formulario, se debe insertar un objeto Image. Como la imagen del código de barras no existe en tiempo de diseño, la propiedad Picture tomará el nombre de la imagen cuando se llame al método BarcodeImage(), por ejemplo desde el método Refresh de Formulario, como se muestra en la siguiente figura:



Para incluir un código de barras en un Informe, se debe insertar un objeto Image y configurar la propiedad ControlSource con un llamado al método BarcodeImage() y se recomienda configurar "Scale contents, retain shape" si la imagen difiere de tamaño con el cuadro.



NOTA: Antes de ejecutar el informe y crear el objeto FoxBarcode, se debe declarar la variable como PRIVATE para que ésta tenga alcance en el informe, como se muestra a continuación:
PRIVATE poFbc
poFbc = CREATEOBJECT("FoxBarcode")
...
REPORT FORM MyReport
Distribución

Los únicos archivos necesarios que se deben distribuir para que FoxBarcode funcione correctamente son:
  • FoxBarcode.prg
  • gpImage2.prg
Estos archivos se encuentran en la carpeta \Source incluída en el archivo de la descarga.

Antes de instanciar la clase FoxBarcode, se deben ejecutar las siguientes sentencias:
SET PROCEDURE TO LOCFILE("FoxBarcode.prg"), LOCFILE("gpImage2.prg") ADDITIVE

Demo

En los archivos de la descarga, está incluido un proyecto completo de una aplicación Demo que utiliza FoxBarcode. La siguiente es una captura de pantalla de la aplicación.



La aplicación permite:
  • Configurar todas las propiedades de la clase FoxBarcode y muestrar la imagen generada automáticamente.
  • Copiar al portapapeles la imagen generada.
  • Guardar en un archivo la imagen.
  • Imprimir el código de barras.
  • Ejecutar diversos informes y formularios de ejemplo.
  • Construir un Script con el código en Visual FoxPro.
En la aplicación también se muestra una breve descripción de cada simbología de códigos de barras, según se seleccione en la lista desplegable de las simbologías.

Puede leer mas sobre este demo en: Generando códigos de barras con FoxBarcode



¿Quiénes somos?

VFPEncoding es un grupo de desarrolladores pertenecientes a la Comunidad Hispana de Visual FoxPro que creo FoxBarcode. Los miembros de VFPEncoding son:
  • Guillermo Carrero [QEPD] (Barcelona, España)
  • Luis María Guayán (Tucumán, Argentina)
Agradecimientos
  • A nuestras familias.
  • A Cesar Ch. por sus continuas ideas y colaboraciones con sus clases gpImage2 y FoxyPreviewer.

No hay comentarios. :

Publicar un comentario