miércoles, 16 de diciembre de 2009

Documentación


PROPIEDADES DE LA CABECERA PDF
Author Autor del Documento
CreationDate Fecha de Creación del Documento
Creator Programa que generó el Documento
FileName Nombre del Fichero (a nivel Informativo)
Keywords Palabras clave del documento para buscadores
Producer Productor del Documento (Desconocido)
Subject Asunto del Documento (Desconocido)
TextEncoding Codificación del Texto (WinAnsiEncoding)
Title Titulo del documento
PROPIEDADES DE PÁGINA
PageCount (Get)
Total de páginas incluida la actual
PageHeight (Get)
Alto de Página (Definido con NewPage)
PageWidth (Get)
Ancho de Página (Definido con NewPage)
ACLARACIONES
Sistema de Coordenadas
Explicación del sistema de coordenadas usado en la librería
Asignación de Colores
Sistemas para asignar un color

FUNCIONES Y MÉTODOS (alfabético)
AddOutline Añade una rama al árbol de Bookmarks del documento.
ClosePage Fuerza el final de la página actual.
Fonts.Add
Selecciona un fuente interno de PDF para su uso
GetPDFStream Obtiene la cadena con el documento completo (ASP)
GetTextWidth Devuelve el ancho de una cadena de Texto
GetCellHeight Devuelve el alto que necesitaría un TextBox para mostrar el texto
LineStroke Finaliza un ciclo de funciones gráficas
LoadImage Carga un objeto iPicture en la memoria para utilizarlo con posterioridad
LoadImageFromFile Carga un archivo de imagen en la memoria para utilizarlo con posterioridad
MoveTo Posiciona el puntero de gráficos en la posición indicada
NewPage Salta a una nueva Página
PDFClose Finaliza el Documento
PDFCreate Crea un nuevo documento PDF
RestoreGraphicState Restaura la Configuración Grafica guardada con anterioridad
SaveGraphicState Guarda la actual configuración Grafica
SetColors Define los colores de impresión
SetLineFormat Establece la configuración Gráfica
SetTextColor Establece el color del Texto para WText
Show Llama al visor por defecto para abrir el documento
WCircle Dibuja un circulo
WCurve Dibuja una Curva tomando como referencia dos puntos intermedios
WGrid Dibuja un patrón de líneas
WImage Imprime una imagen cargada con anterioridad
WLineTo Dibuja una línea desde la posición actual hasta destino indicado
WRectangle Dibuja un rectángulo en las coordenadas indicadas
WText Imprime Texto
WTextBox Imprime una caja de texto
WTextCode Enviar comandos de Texto de bajo nivel al documento PDF.



AddOutLine Añade una rama al árbol de Bookmarks del documento.
Parámetro Tipo Descripción
Name
Texto Nombre interno del Bookmark, se usará para referenciarlo como Parent
Text Texto Texto que se mostrará en la rama del árbol
Parent Texto Nombre interno de la rama de la cual colgará el nuevo nodo.
Page Numero Numero de página referenciada por el nodo.
PosY Numero Coordenada Y dentro de la página
PosX Numero Coordenada X dentro de la página
PercentZoom Numero Cambia el Zoom al posicionarse en el bookmark ( en %)
Retorno

Notas: EN PRUEBAS.
Vea También:



ClosePageFuerza el cierre de la página actual
ParámetroTipoDescripción



Retorno

Notas: Imprescindible cuando se desean incluir nuevas imágenes en la definición de una página.
Vea También: NewPage



Fonts.Add Selecciona un fuente interno de PDF para su uso
Parámetro Tipo Descripción
Name
Texto
Nombre interno del fuente, se usara con posterioridad para llamarlo
BaseFont
Entero
Nombre del Fuente tal y como se ve en el campo Nombre al hacer doble click desde la carpeta de fuentes
Tipo
Entero
Tipo del Fuente.
Valor por Defecto: 0 = TrueType(0)
Valores para ASP:
const TrueType = 0
const Type1 = 1

Notas:
Vea También: WText WTextBox


GetPDFStream Obtiene la cadena con el documento completo (ASP)
Parámetro Tipo Descripción



Retorno
Bytes()
Notas: Se debe haber omitido el nombre del documento en PDFCreate.
Vea También: PDFCreate


GetTextWidth Devuelve el ancho de una cadena de Texto
Parámetro Tipo Descripción
Text
Texto
Cadena a medir
FontName
Texto
Nombre Interno del Fuente
FontSize
Entero
Tamaño del Fuente
Retorno
Doble
Notas:
Vea También: Fonts.Add


GetCellHeight Partiendo de un Texto, Fuente y Tamaño de fuente, así como del ancho de la celda, devuelve la altura que tendría que tener para poder imprimir completamente un texto
Parámetro Tipo Descripción
Text
Texto
Cadena a medir
FontName
Texto
Nombre Interno del fuente
FontSize
Entero
Tamaño del Fuente
CellWidth
Entero
Ancho de la celda
Retorno
Doble
Notas: Al imprimir celdas de texto variable, antes de debería llamar a esta función.
Vea También: GetTextWidth Fonts.Add


LineStroke Finaliza un ciclo de funciones gráficas
Parámetro Tipo Descripción



Notas: Las figuras realizadas con funciones gráficas no se ejecutarán hasta no encontrar un LineStroke
Vea También:


LoadImage Carga un objeto iPicture en la memoria para utilizarlo con posterioridad
Parámetro Tipo Descripción
Image
iPicture
Objetos Pictures o Image de Visual Basic
Name
Texto
Nombre interno de la Imagen, se usará con posterioridad
GrayScale
Si/No
Permite convertir las imágenes a escala de grises
Zipped
Sí/No
Comprime las imágenes en el documento PDF
Notas: la compresión requiere la librería zLib.dll (libre)
Vea También: LoadImageFromFile WImage


LoadImageFromFile Carga un archivo de imagen en la memoria para utilizarlo con posterioridad
Parámetro Tipo Descripción
FileName
Texto
Nombre del Archivo de Imagen. Tipos soportados
Mapa de bits (.bmp)
Icono (.ico)
Codificación por longitud de línea (.rle)
Metarchivos (.wmf)
Metarchivo mejorado (.emf)
GIF (.gif)
> JPEG (.jpg).
Name
Texto
Nombre interno de la Imagen, se usará con posterioridad
GrayScale
Sí/No
Permite convertir las imágenes a escala de grises
Zipped
Sí/No
Comprime las imágenes en el documento PDF
Notas: la compresión requiere la librería zLib.dll (Libre).
El nombre del archivo debe indicarse con su ruta absoluta.
Vea También: LoadImage WImage


MoveTo Posiciona el puntero de gráficos en la posición indicada
Parámetro Tipo Descripción
X
Doble
Coordenada X (Izda->Der)
Y
Doble
Coordenada Y (Arr->Aba)
Notas:
Vea También:


NewPage Salta a una nueva Página
Parámetro Tipo Descripción
Size
Entero
Tamaños Predefinidos para la nueva página
Valor por defecto: A4_Vertical (0)
Valores para ASP
const A4_Vertical = 0
const A4_Horizontal = 1
const Folio_Vertical = 2
const Folio_Horizontal = 3
const UsarAnchoAlto = 4
Width
Entero
Ancho de la Página
Height
Entero
Alto de la Página
Notas: los valores de Width y Height sólo se tomaran en cuenta cuando se seleccione UsarAnchoAlto (4) en Size
Vea También: PageHeight PageWidth PageCount


PDFClose Finaliza el Documento y cierra el fichero en disco (cuando proceda)
Parámetro Tipo Descripción



Notas: De momento es obligatoria, pero estoy pensando en ponerla automáticamente antes de la llamada a Show y GetPDFStream. en ese caso sólo se utilizaría al crear un fichero que no queramos mostrar (para adjuntar en un correo, por ejemplo)
Vea También: Show GetPDFStream


PDFCreate Crea un nuevo documento PDF
Parámetro Tipo Descripción
FileName
Texto
Nombre del Archivo, para documentos a mostrar desde ASP dejar en Blanco.
Notas: En caso de documentos ASP el nombre del documento se obtendría de la propiedad FileName
Vea También: FileName


RestoreGraphicState Restaura la Configuración Grafica guardada con anterioridad
Parámetro Tipo Descripción



Notas: Para que tenga algún efecto, antes se debe haber usado SaveGraphicState
Vea También: SaveGraphicState SetLineFormat


SaveGraphicState Guarda la actual configuración Grafica
Parámetro Tipo Descripción



Notas: Guarda la configuración realizada con SetLineFormat, con posterioridad se puede modificar para imprimir un gráfico modificado y retomar con RestoreGraphicState
Vea También: RestoreGraphicState SetLineFormat

SetColors Guarda la actual configuración Grafica
Parámetro Tipo Descripción
ForeColor Entero Largo Define el color de Linea
FillColor Entero Largo Define el Color de Relleno
Notas: Afecta a WLineTo, WCircle, WCurve
Vea También: WLineTo, WCircle, WCurve


SetLineFormat Establece la configuración Gráfica
Parámetro Tipo Descripción
LineWidth
Byte
Ancho de la línea
LineCap
Entero
Estilo de fin de línea.
Valor por Defecto ButtCap (0)
Valores para ASP:
const ButtCap = 0
const RoundCap = 1
const ProyectingSquareCap = 2

LineJoin
Entero
Estilo de unión entre líneas.
Valor por defecto: MilterJoin (0)
Valores para ASP:
const MilterJoin = 0
const RoundJoin = 1
const BevelJoin = 2

DashPhase
Entero
Indica cada cuantos puntos reiniciamos el Patrón
DashArray
String
Patrón de Salida de los Puntos de la línea:

El formato es el Siguiente [X Y] donde X serán los puntos Oscurecidos seguidos por Y puntos Blancos antes de reiniciar el patrón, o que la suma de X + Y alcance el valor del parámetro DashPhase.

En resumen, se usa para hacer líneas discontinuas.
Notas: Afecta a WLineTo, WCircle, WCurve
Vea También: WLineTo, WCircle, WCurve


SetTextColor Establece el color del Texto para WText
Parámetro Tipo Descripción
Color
Entero Largo
Define el color del texto
Notas: Se trata de una función con proyección de futuro, pendiente de implementación de las funciones de salida de texto plano, salto de línea, márgenes, etc...
Vea También: WText


Show Llama al visor por defecto para abrir el documento
Parámetro Tipo Descripción



Notas: requiere tener un programa asociado a la extensión PDF y haber indicado una ruta absoluta en PDFCreate
Vea También: PDFCreate


WCircle Dibuja un circulo
Parámetro Tipo Descripción
X
Doble
Coordenada X del Centro del Circulo
Y
Doble
Coordenada Y del Centro del Circulo
Radio
Doble
Radio del Circulo
Notas: Para definir el aspecto de la línea del circulo, utilice SetLineFormat
Vea También: SetLineFormat


WCurve Dibuja una Curva tomando como referencia dos puntos intermedios
Parámetro Tipo Descripción
X
Doble
Coordenada X del Final de la línea
Y
Doble
Coordenada Y del Final de la línea
ControlX1
Doble
Coordenada X del primer Punto de Control, Si se deja a cero junto con ControlY1 se tomará como primer punto de referencia el Inicio de la línea
ControlX1
Doble
Coordenada Y del primer Punto de Control, Si se deja a cero junto con ControlX1 se tomará como primer punto de referencia el Inicio de la línea
ControlX2
Doble
Coordenada X del segundo Punto de Control, Si se deja a cero junto con ControlY2 se tomará como segundo punto de referencia el Final de la línea
ControlY2
Doble
Coordenada Y del segundo Punto de Control, Si se deja a cero junto con ControlX2 se tomará como segundo punto de referencia el Final de la línea
StartX
Doble
Coordenada X del inicio de la línea, si no se indica se utilizará la posición actual
StartY
Doble
Coordenada Y del inicio de la línea, si no se indica se utilizará la posición actual
Notas: Afectada por SetLineFormat.
Utiliza el algoritmo Cubic Bezier, por favor, no me pidan que se lo explique.
Vea También: SetLineFormat


WGrid Dibuja un patrón de líneas
Parámetro Tipo Descripción



Notas: Rellena la página con un patrón de líneas, útil durante el diseño del documento.
Vea También:


WImage Imprime una imagen cargada con anterioridad
Parámetro Tipo Descripción
Top
Entero
Coordenada Y de la esquina inferior Izquierda de la Imagen
Left
Entero
Coordenada X de la esquina inferior Izquierda de la Imagen
Height
Entero
Alto de la imagen (La figura se redimensionara automáticamente)
Width
Entero
Ancho de la imagen (La figura se redimensionara automáticamente)
ImageName
Texto
Nombre interno que dimos al cargar la Imagen
Rotation
Doble
Angulo de rotación de la imagen en Grados.
Notas: Una misma imagen que se imprima varias veces, sólo se cargará una vez.
Vea También: LoadImage LoadImageFromFile


WLineTo Dibuja una línea desde la posición actual hasta destino indicado
Parámetro Tipo Descripción
X
Doble
Coordenada X del Fin de línea
Y
Doble
Coordenada Y del Fin de línea
StartX
Doble
Coordenada X del inicio de la línea, si no se indica se utilizará la posición actual
StartY
Doble
Coordenada Y del inicio de la línea, si no se indica se utilizará la posición actual
Notas: Afectada por SetLineFormat
Vea También: SetLineFormat


WRectangle Dibuja un rectángulo en las coordenadas indicadas
Parámetro Tipo Descripción
X
Entero
Coordenada X de la esquina superior Izquierda
Y
Entero
Coordenada Y de la esquina superior Izquierda
Width
Entero
Ancho del Rectángulo
Height
Entero
Alto del Rectángulo
Border
Entero
Ancho de la línea
BorderColor
Entero Largo
Color del borde
Fill
Sí/No
Indica si queremos rellenar el rectángulo con el color del borde
Notas: Afectado parcialmente por SetLineFormat
Vea También: SetLineFormat


WText Imprime Texto
Parámetro Tipo Descripción
Top
Entero
Coordenada X de inicio del Texto
Left
Entero
Coordenada Y de Inicio del Texto
FontName
Texto
Nombre interno de la fuente seleccionada
FontSize
Entero
Tamaño de la fuente
Rotation
Doble
Angulo de Inclinación del texto, en Grados
Notas: Afectado por SetTextColor
Vea También: SetTextColor Fonts.Add


WTextBox Dibuja una caja de texto
Parámetro Tipo Descripción
Top
Entero
Coordenada Y de la esquina superior izquierda
Left
Entero
Coordenada X de la esquina superior izquierda
Height
Entero
Alto de la Caja de Texto
Widht
Entero
Ancho de la caja de Texto
Text
Texto
Cadena a Imprimir en el interior de la Caja
FontName
Texto
Nombre Interno de la fuente seleccionada
FontSize
Entero
Tamaño de la fuente
hAlign
Entero
Alineación Horizontal del texto dentro de la caja.
Valor por Defecto: hLeft (0)
Valores para ASP:
const hLeft = 0
const hRight = 1
const hCenter = 2
const hJustify = 3

vAlign
Entero
Alineación Vertical del texto dentro de la caja.
Valor por Defecto: vTop (0)
Valores para ASP:
const vTop = 0
const vBottom = 1
const vMiddle = 2

TextColor
Entero Largo
Color del Texto
Border
Entero
Ancho del borde de la caja
BorderColor
Entero Largo
Color del Borde
FillBox
Sí/No
Permite Rellenar el interior de la caja con el color del borde
TextMargin Entero Margen entre el texto y la Caja
Notas: Afectado en parte por SetLineFormat
Vea También: Fonts.Add SetLineFormat


WTextCode Comandos de Texto de bajo Nivel
Notas: Permite enviar comandos de Texto de bajo nivel al documento PDF. La sintaxis depende del Primer parámetro, este puede ser:

BeginText: (BT) Inicia un bloque de Texto, sin parámetros.
SetFont (/) Asigna Fuente, párametros: FontName y FonSize.
SetColor (rg) Asigna color de texto, parámetro: lngColor.
SetPos (Td) Posiciona el texto, parámetros: posX y posY.
TextShow (Tj) Imprime texto en las coordenadas actuales, parámetro: Texto
NewLine (T*) Avanza a la siguiente linea, depende de TextLeading Sin parámetros
CharSpace (Tc) Modifica el espaciado entre caracteres. Parámetros: Espacio.
WordSpace (Tw) Modifica el espaciado entre palabras. Parámetros: Espacio.
HorizontalScale (Tz) Multiplica la escala horizontal. Parámetro: Multiplo.
TextLeading (TL) Asigna el espacio entre líneas. Parámetro: Espacio.
RenderMode (Tr) Asigna el modo de relleno de caracteres. Parametros:

FillText = 0
StrokeText = 1
FillStroke = 2
Invisible = 3
FillPath = 4
StrokePath = 5
FillStrokePath = 6
Path = 7

TextRise (Ts) Sube o baja el texto los puntos indicados en el segundo parámetro
TransformationMatrix (Tm) Define la matriz de transformación del Texto. Parámetros: Los 6 elementos de la matriz de transformación:

EndText (ET) Finaliza un bloque de texto.

Vea También: Para su mejor compresión y uso PDF Reference


Sistema de Coordenadas Explicación del sistema de coordenadas usado en la librería
Notas:

Se utiliza el sistema de coordenadas interno de los documentos PDF ya que es el que permite la mayor exactitud.

En él un punto equivale a 0.0138 pulgadas ó 0,0353 centímetros

Vea También:



Asignación de Colores Explicación de la asignación de colores
Notas:

Para asignar colores en las funciones que admitan este parámetro se puede utilizar constantes de color (vbRed, vbBlack,...), valores hexadecimales ( "&H402A03" ) o la función rgb( Red, Green, blue )

Vea También:

No hay comentarios: