Looplex Knowledge Base

Attach

O tube attach anexa um arquivo ao documento sendo produzido. Imagens no formato PNG e JPG podem ser anexadas ao corpo do arquivo. Documentos em formato DOC, TXT, PDF podem ser adicionados a um arquivo como um link que abrirá o anexo.

Formato:

attach("imageOrDocumentoName.ext", "align", "explainText", "alt", "width", "height", "captionPosition")

Parâmetros:

  • imageOrDocumentoName.ext: Esse é o único parâmetro obrigatório do tube pois ele indicará qual arquivo que deve ser anexado. Nesse parâmetro o usuário precisa incluir o nome da imagem ou documento e sua extensão (png/jpg/doc/txt/pdf).
  • align: O align é um parâmetro opcional que pode ser utilizado independente dos outros parâmetros. Ele determinará o alinhamento da imagem que pode ser "center", "left", ou "right". Se o usuário não indicar nada, o sistema usa o "center" como alinhamento padrão.
  • explainText: O parâmetro opcional explainText é o que permite inserir uma legenda na imagem. O texto será colocado acima ou abaixo da imagem e ficará agrupado a ela. Basta inserir entre aspas exatamente o que o usuário quiser que apareça.
  • alt: Esse parâmetro opcional quase nunca é utilizado pois ele só aparecerá se a imagem, por alguma razão, não carregar. Seria o equivalente a uma mensagem de erro.
  • width: O parâmetro width define a largura da imagem. Se somente um número for inserido o sistema interpreta a medida em pixels (por exemplo "100" e "100px" são equivalentes). O compilador aceita as medidas tal como no HTML (pixels "px", porcentagem da imagem original "80%", e centímetros "14cm"). Se não for inserida uma medida, a imagem será impressa no tamanho original do arquivo.
  • height: O parâmetro height define a altura da imagem. Se somente um número for inserido o sistema interpreta como a medida em pixels (por exemplo "100" e "100px" são equivalentes). O compilador aceita as medidas tal como no HTML (pixels "px", porcentagem da imagem original "80%", e centímetros "14cm"). Se não for inserida uma medida, a imagem será impressa no tamanho original do arquivo.
  • captionPosition: Define onde será posicionado o texto inserido no parâmetro explainText em relação à imagem. Os possíveis valores para esse parâmetro são "Top" e "Bottom". Se nada for declarado, o padrão do compilador será deixar o texto abaixo da imagem.

Observações:

  • se somente o "width" ou o "height" forem declarados a imagem será esticada e diminuída proporcionalmente mantendo a sua razão original. Se ambas forem declaradas a imagem será distorcida para se adequar ao que foi indicado pelo usuário.
  • não se pode declarar uma variável opcional sem indicar o que deve ser colocado nos parâmetros anteriores. O usuário deve usar null nos campos em que não deseja inserir nada. Por exemplo attach("exemplo.jpg", "left", null, null, "14cm").

Retorno:

O tube não possui um retorno propriamente dito pois ele faz uma operação de adição a um documento.

Exemplos:

1. Attach com upload

Um dos usos mais comuns do tube attach é em conjunto com o tube upload. Uma vez feito o upload de um arquivo (veja procedimento na página do tube) é possível adicionar o arquivo ao documento.

operations {
upload("Termo de Rescisão (TRCT)", "ImagemTRCT.png", "Faça o upload do TRCT no formato .PNG", "+"),
attach("ImagemTRCT.png")
}

2. Attach com documento do sistema

O tube attach também pode ser utilizado para anexar uma imagem que já foi adicionada ao sistema como um documento anexo. Para fazer isso basta verificar que foi feito o upload da imagem e usar o tube attach.

operations {
attach("ImagemEmAnexo.jpg", "center", null, null, "14cm")
}
Edit this page on GitHub