Descrição

Esta classe lida com toda a comunicação com os serviços da Web de captura de tela GrabzIt.

Métodos públicos

• GrabzItFile GetResult(String id)
• URLToAnimation(String url, AnimationOptions options)
• URLToImage(String url, ImageOptions options)
• HTMLToImage(String html, ImageOptions options)
• FileToImage(String path, ImageOptions options)
• URLToPDF(String url, PDFOptions options)
• HTMLToPDF(String html, PDFOptions options)
• FileToPDF(String path, PDFOptions options)
• URLToDOCX(String url, DOCXOptions options)
• HTMLToDOCX(String html, DOCXOptions options)
• FileToDOCX(String path, DOCXOptions options)
• URLToTable(String url, TableOptions options)
• HTMLToTable(String html, TableOptions options)
• FileToTable(String path, TableOptions options)
• URLToRenderedHTML(String url, HTMLOptions options)
• HTMLToRenderedHTML(String html, HTMLOptions options)
• FileToRenderedHTML(String path, HTMLOptions options)
• String Save()
• String Save(String callBackURL)
• GrabzItFile SaveTo()
• boolean SaveTo(String saveToFile)
• Status GetStatus(String id)
• GrabzItCookie[] GetCookies(String domain)
• boolean SetCookie(String name, String domain, String value, String path, boolean httponly, Date? expires)
• boolean DeleteCookie(String name, String domain)
• WaterMark[] GetWaterMarks()
• WaterMark GetWaterMark(String identifier)
• boolean AddWaterMark(String identifier, String path, HorizontalPosition xpos, VerticalPosition ypos)
• boolean DeleteWaterMark(String identifier)
• SetLocalProxy(String proxyUrl)
• UseSSL(boolean value)
• String CreateEncryptionKey()
• Decrypt(String path, String key)
• GrabzItFile Decrypt(GrabzItFile file, String key)
• byte[] Decrypt(byte[] data, String key)

GrabzItFile GetResult(String identidade)

Este método retorna a própria captura de tela. Se nada for retornado, algo deu errado ou a captura de tela ainda não está pronta.

parâmetros

• id - o identificador exclusivo da captura de tela
  • Exigido

Valor de retorno

GrabzItFile objeto

---

URLToAnimation(String url, AnimationOptions opções)

Especifique o URL do vídeo online que deve ser convertido intum GIF animado.

parâmetros

• url - o URL do vídeo online a ser convertido into um GIF animado.
  • Exigido
  • Aceita URLs de vídeo do Vimeo e do YouTube
    • O aviso de animação de vídeos do Vimeo e do YouTube depende de terceiros e, portanto, pode não fornecer resultados consistentes.
• opções - uma instância do AnimationOptions classe que define todas as opções especiais a serem usadas ao criar o GIF animado.

Valor de retorno

anular

AnimationOptions

A classe representa todas as opções disponíveis ao criar um GIF animado.

Propriedades Públicas

• setCustomId(String value) - identificador personalizado pelo qual você pode passar para o serviço da web GIF animado. Isso será retornado com o URL de retorno que você especificou.
  • Padrão: vazio
• setWidth(int value) - a largura do GIF animado resultante em pixels.
  • Padrão: 180px
  • Máximo: Largura máxima para o pacote
  • Tamanho automático: -1 (passar -1 significa que a largura do GIF animado é redimensionado em relação à sua altura, se a largura estiver sendo dimensionada automaticamente, a altura não poderá)
• setHeight(int value) - a altura do GIF animado resultante em pixels.
  • Padrão: 120px
  • Máximo: Altura máxima para o pacote
  • Tamanho automático: -1 (passar -1 significa que a altura do GIF animado é redimensionado em relação à sua largura, se a altura estiver sendo dimensionada automaticamente, a largura não poderá)
• setStart(int value) - a posição inicial do vídeo que deve ser convertida intum GIF animado.
  • Padrão: 0 segundos
• setDuration(int value) - a duração em segundos do vídeo que deve ser convertido intum GIF animado.
  • Padrão: comprimento máximo para o pacote
• setSpeed(float value) - a velocidade do GIF animado.
  • Padrão: 1
  • Mínimo: 0.2
  • Máximo: 10
• setFramesPerSecond(float value) - o número de quadros por segundo que devem ser capturados do vídeo.
  • Padrão: 10
  • Mínimo: 0.2
  • Máximo: 60
• setRepeat(int value) - número de vezes para repetir o GIF animado.
  • Padrão: 0
  • Loop continuamente: 0
  • Nunca Loop: -1
• setReverse(boolean value) - se verdadeiro, os quadros do GIF animado são revertidos
  • Padrão: false
• setCustomWaterMarkId(String value) - adicionar personalizado watermark para o GIF animado
  • Padrão: vazio
• setQuality(int value) - a qualidade da imagem retornada, que possui uma compactação padrão de 85%.
  • Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
  • Padrão: -1
  • Mínimo: -1
  • Máximo: 100
• setCountry(Country value) - o país o GIF animado deve ser retirado.
  • Padrão: o local mais rápido atual
  • opções: País.CINGAPURA, País.REINO UNIDO, País.ESTADOS UNIDOS
• setExportURL(String value) - a URL de exportação que especifica onde a captura também deve ser exportada
  • Padrão: vazio
• setEncryptionKey(String key) - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
  • Padrão: vazio
• setProxy(String proxy) - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
  • Padrão: vazio

---

URLToImage(String url, ImageOptions opções)

Especifica o URL que deve ser convertido intuma captura de tela da imagem.

parâmetros

• url - o URL do qual a captura de tela deve ser feita
  • Exigido
• opções - uma instância do ImageOptions classe que define todas as opções especiais a serem usadas ao criar a captura de tela.

Valor de retorno

anular

HTMLToImage(String html, ImageOptions opções)

Especifica o HTML que deve ser convertido intuma imagem.

parâmetros

• html - o HTML para converter intoa imagem
  • Exigido
• opções - uma instância do ImageOptions classe que define todas as opções especiais a serem usadas ao criar uma imagem.

Valor de retorno

anular

FileToImage(String caminho, ImageOptions opções)

Especifica um arquivo HTML que deve ser convertido intuma imagem.

parâmetros

• path - o caminho do arquivo HTML para converter intoa imagem
  • Exigido
• opções - uma instância do ImageOptions classe que define todas as opções especiais a serem usadas ao criar uma imagem.

Valor de retorno

anular

ImageOptions

A classe representa todas as opções disponíveis ao criar capturas de imagens.

Propriedades Públicas

• setCustomId(String value) - identificador personalizado que você pode passar para o serviço da tela. Isso será retornado com o URL de retorno que você especificou.
  • Padrão: vazio
• setBrowserWidth(int value) - a largura do navegador em pixels
  • Padrão: 1366
  • Máximo: 10000
• setBrowserHeight(int value) - a altura do navegador em pixels
  • Padrão: 1170
  • Máximo: 10000
  • Comprimento total: -1 (passar -1 significa que é feita uma captura de tela de toda a página da web)
• setOutputWidth(int value) - a largura da miniatura resultante em pixels
  • Padrão: se a largura e a altura de saída não forem especificadas ou 0, a largura e altura de saída corresponderão à largura e altura da imagem final, se a altura de saída for especificada, a largura de saída será proporcional à altura de saída
  • Máximo: Largura máxima para o pacote
  • Largura total: -1 (passar -1 significa que a largura da miniatura não é reduzida)
• setOutputHeight(int value) - a altura da miniatura resultante em pixels
  • Padrão: se a largura e a altura de saída não forem especificadas ou 0, a largura e altura de saída corresponderão à largura e altura da imagem final; se a largura de saída for especificada, a altura de saída será proporcional à largura de saída
  • Máximo: Altura máxima para o pacote
  • Altura total: -1 (passar -1 significa que a altura da miniatura não é reduzida)
• setFormat(ImageFormat value) - o formato em que a captura de tela deve estar.
  • Padrão: ImageFormat. JPG
  • opções: ImageFormat.BMP8, ImageFormat.BMP16, ImageFormat.BMP24, ImageFormat.BMP, ImageFormat.TIFF, ImageFormat.WEBP, ImageFormat.JPG, ImageFormat. PNG
• setDelay(int value) - o número de milissegundos a aguarde antes de tirar a captura de tela
  • Padrão: 0
  • Máximo: 30000
• setClickElement - especifica o elemento HTML, usando um Seletor CSS clicar. Lembre-se de que também pode ser necessário um atraso para ver os efeitos do clique
  • Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
• setTargetElement(String value) - a Seletor CSS do único elemento HTML na página da web de destino a ser ativada into uma captura de tela, todas as outras partes da página da web são ignoradas. Se houver vários elementos HTML correspondentes, o primeiro será escolhido
  • Padrão: vazio
• setHideElement(String value) - a Seletores CSS dos um ou mais elementos HTML na página da web a serem ocultados, para especificar vários elementos HTML a serem ocultados separadamente cada seletor com uma vírgula
  • Padrão: vazio
• setWaitForElement(String value) - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
  • Padrão: vazio
• setRequestAs(BrowserType value) - o tipo de agente do usuário que você deseja usar
  • Padrão: BrowserType.STANDARDBROWSER
  • opções: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTOR DE PESQUISA
• setCustomWaterMarkId(String value) - adicione um personalizado watermark para a imagem
  • Padrão: vazio
• setQuality(int value) - a qualidade da imagem retornada. Atualmente, isso afeta apenas imagens JPG e WEBP, que têm uma compactação padrão de 90%.
  • Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
  • Padrão: -1
  • Mínimo: -1
  • Máximo: 100
• setTransparent(boolean value) - se verdadeiro, o a captura de imagem deve ser transparente. Isso é compatível apenas com imagens png e tiff.
  • Padrão: false
• setHd(boolean value) - se verdadeira a imagem captura estará em alta definição isso dobra o tamanho das dimensões da imagem.
  • Padrão: false
• setCountry(Country value) - o país a captura de tela deve ser retirada.
  • Padrão: o local mais rápido atual
  • opções: País.CINGAPURA, País.REINO UNIDO, País.ESTADOS UNIDOS
• setExportURL(String value) - a URL de exportação que especifica onde a captura também deve ser exportada
  • Padrão: vazio
• setEncryptionKey(String key) - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
  • Padrão: vazio
• setNoAds(boolean noAds) - se for verdade anúncios devem ser ocultados automaticamente.
  • Padrão: false
• setNoCookieNotifications(boolean noCookieNotifications) - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
  • Padrão: false
• setAddress(String address) - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
  • Padrão: vazio
• setProxy(String proxy) - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
  • Padrão: vazio

Métodos públicos

• AddPostParameter (String nome String valor) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
  • name - o nome do parâmetro HTTP Post
  • value - o valor do parâmetro HTTP Post

---

URLToRenderedHTML(String url, HTMLOptions opções)

Especifica o URL que deve ser convertido into HTML renderizado.

parâmetros

• url - a URL da qual o HTML renderizado deve ser feito
  • Exigido
• opções - uma instância do HTMLOptions classe que define todas as opções especiais a serem usadas ao criar o HTML renderizado.

Valor de retorno

anular

HTMLToRenderedHTML(string html, HTMLOptions opções)

Especifica o HTML que deve ser convertido into HTML renderizado.

parâmetros

• html - o HTML para converter into HTML renderizado
• opções - uma instância do HTMLOptions classe que define todas as opções especiais a serem usadas ao criar HTML renderizado.

Valor de retorno

anular

FileToRenderedHTML(string caminho, HTMLOptions opções)

Especifica um arquivo HTML que deve ser convertido into HTML renderizado.

parâmetros

• path - o caminho do arquivo HTML para converter into HTML renderizado
  • Exigido
• opções - uma instância do HTMLOptions classe que define todas as opções especiais a serem usadas ao criar HTML renderizado.

Valor de retorno

anular

HTMLOptions

A classe representa todas as opções disponíveis quando criando capturas HTML renderizadas.

Propriedades Públicas

• setCustomId(String value) - identificador personalizado que você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou.
  • Padrão: vazio
• setBrowserWidth(int value) - a largura do navegador em pixels
  • Padrão: 1366
  • Máximo: 10000
• setBrowserHeight(int value) - a altura do navegador em pixels
  • Padrão: 1170
  • Máximo: 10000
• setWaitForElement(String value) - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
  • Padrão: vazio
• setRequestAs(BrowserType value) - o tipo de agente do usuário que você deseja usar
  • Padrão: BrowserType.STANDARDBROWSER
  • opções: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTOR DE PESQUISA
• setExportURL(String value) - a URL de exportação que especifica onde a captura também deve ser exportada
  • Padrão: vazio
• setEncryptionKey(String key) - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
  • Padrão: vazio
• setNoAds(boolean noAds) - se for verdade anúncios devem ser ocultados automaticamente.
  • Padrão: false
• setNoCookieNotifications(boolean noCookieNotifications) - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
  • Padrão: false
• setAddress(String address) - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
  • Padrão: vazio
• setProxy(String proxy) - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
  • Padrão: vazio

Métodos públicos

• AddPostParameter (String nome String valor) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
  • name - o nome do parâmetro HTTP Post
  • value - o valor do parâmetro HTTP Post

---

URLToPDF(String url, PDFOptions opções)

Especifica o URL que deve ser convertido intum PDF.

parâmetros

• url - o URL que deve ser convertido intoa PDF
  • Exigido
• PDFOptions options - uma instância da classe PDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.

Valor de retorno

anular

HTMLToPDF(String html, PDFOptions opções)

Especifica o HTML que deve ser convertido intum PDF.

parâmetros

• html - o HTML para converter intoa PDF
  • Exigido
• PDFOptions options - uma instância da classe PDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.

Valor de retorno

anular

FileToPDF(String caminho, PDFOptions opções)

Especifica um arquivo HTML que deve ser convertido intum PDF.

parâmetros

• path - o caminho do arquivo HTML para converter intoa PDF
  • Exigido
• PDFOptions options - uma instância da classe PDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.

Valor de retorno

anular

PDFOptions

A classe representa todas as opções disponíveis ao criar capturas de PDF.

Propriedades Públicas

• setCustomId(String value) - um identificador personalizado pelo qual você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou.
  • Padrão: vazio
• setIncludeBackground(boolean value) - se verdadeiro, o plano de fundo da página da web deve ser incluído na captura de tela
  • Padrão: true
• setPageSize(PageSize value) - o tamanho da página do PDF
  • Padrão: PageSize.A4
  • opções: PageSize.A3, PageSize.A4, PageSize.A5, PageSize.A6, PageSize.B3, PageSize.B4, PageSize.B5, PageSize.B6, PageSize.LEGAL, PageSize.CARTA
• setOrientation(PageOrientation value) - a orientação do documento PDF
  • Padrão: PageOrientation.RETRATO
  • opções: PageOrientation.RETRATO, PageOrientation.PANORAMA
• setCSSMediaType(CSSMediaType value) - a Tipo de mídia CSS do documento PDF
  • Padrão: CSSMediaType.TELA
  • opções: CSSMediaType.TELA, CSSMediaType.PRINT
• setIncludeLinks(boolean value) - true se os links devem ser incluídos no PDF
  • Padrão: true
• setIncludeOutline(boolean value) - verdadeiro se Favoritos em PDF Deveria ser incluído
  • Padrão: false
• setTitle(String value) - forneça um título para o documento PDF
  • Padrão: vazio
• setCoverURL(string value) - o URL de uma página da web que deve ser usada como uma página de rosto para o PDF
  • Padrão: vazio
• setMarginTop(int value) - a margem em milímetros que deve aparecer na parte superior da página do documento PDF
  • Padrão: 10
• setMarginLeft(int value) - a margem em milímetros que deve aparecer à esquerda da página do documento PDF
  • Padrão: 10
• setMarginBottom(int value) - a margem em milímetros que deve aparecer na parte inferior da página do documento PDF
  • Padrão: 10
• setMarginRight(int value) - a margem em milímetros que deve aparecer à direita do documento PDF
  • Padrão: 10
• setBrowserWidth(int value) - oo largura do navegador em pixels
  • Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
  • Padrão: 1366
  • Máximo: 10000
  • Largura automática: -1 (passar -1 significa que a largura do navegador corresponde à largura do documento PDF)
• setPageWidth(int value) - a largura personalizada do PDF resultante em mm
  • Padrão: PageSize largura
  • Mínimo: 15
• setPageHeight(int value) - a altura personalizada do PDF resultante em mm
  • Padrão: PageSize altura
  • Mínimo: 15
• setDelay(int value) - o número de milissegundos a aguarde antes de tirar a captura de tela
  • Padrão: 0
  • Máximo: 30000
• setRequestAs(BrowserType value) - o tipo de agente do usuário que você deseja usar
  • Padrão: BrowserType.STANDARDBROWSER
  • opções: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTOR DE PESQUISA
• setTemplateId(String value) - adicione um modelo ID que especifica o cabeçalho e rodapé do documento PDF
  • Padrão: vazio
• setClickElement - especifica o elemento HTML, usando um Seletor CSS clicar. Lembre-se de que também pode ser necessário um atraso para ver os efeitos do clique
  • Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
• setTargetElement(String value) - a Seletor CSS dos únicos Elemento HTML na página da web de destino a ser ativada intoa PDF, todas as outras partes da página da web são ignoradas. Se houver vários elementos HTML correspondentes, o primeiro será escolhido
  • Padrão: vazio
• setHideElement(String value) - a Seletores CSS dos um ou mais elementos HTML na página da web a serem ocultados, para especificar vários elementos HTML a serem ocultados separadamente cada seletor com uma vírgula
  • Padrão: vazio
• setWaitForElement(String value) - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
  • Padrão: vazio
• setCustomWaterMarkId(String value) - adicione um personalizado watermark para cada página do documento PDF
  • Padrão: vazio
• setQuality(int value) - a qualidade do PDF retornado. O padrão usa a qualidade recomendada para o PDF.
  • Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
  • Padrão: -1
  • Mínimo: -1
  • Máximo: 100
• setCountry(Country value) - o país a captura de tela deve ser retirada.
  • Padrão: o local mais rápido atual
  • opções: País.CINGAPURA, País.REINO UNIDO, País.ESTADOS UNIDOS
• setExportURL(String value) - a URL de exportação que especifica onde a captura também deve ser exportada
  • Padrão: vazio
• setEncryptionKey(String key) - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
  • Padrão: vazio
• setNoAds(boolean noAds) - se for verdade anúncios devem ser ocultados automaticamente.
  • Padrão: false
• setNoCookieNotifications(boolean noCookieNotifications) - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
  • Padrão: false
• setAddress(String address) - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
  • Padrão: vazio
• setProxy(String proxy) - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
  • Padrão: vazio
• setMergeId(String mergeId) - o ID de uma captura que deve ser mesclados no início do novo documento PDF
  • Padrão: vazio
• setPassword(String password) - a senha para proteger o documento PDF com
  • Padrão: vazio

Métodos públicos

• AddPostParameter (String nome String valor) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
  • name - o nome do parâmetro HTTP Post
  • value - o valor do parâmetro HTTP Post
• AddTemplateParameter (String nome String valor) - defina um modelo personalizado parâmetro e valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros.
  • nome - o nome do parâmetro do modelo
  • valor - o valor do parâmetro do modelo

---

URLToDOCX (String url, DOCXOptions opções)

Especifica o URL que deve ser convertido into DOCX.

parâmetros

• url - o URL que deve ser convertido into DOCX
  • Exigido
• DOCXOptions opções - uma instância do DOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.

Valor de retorno

anular

HTMLToDOCX(String html, DOCXOptions opções)

Especifica o HTML que deve ser convertido into DOCX.

parâmetros

• html - o HTML para converter into DOCX
  • Exigido
• DOCXOptions opções - uma instância do DOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.

Valor de retorno

anular

FileToDOCX(String caminho, DOCXOptions opções)

Especifica um arquivo HTML que deve ser convertido into DOCX.

parâmetros

• path - o caminho do arquivo HTML para converter into DOCX
  • Exigido
• DOCXOptions opções - uma instância do DOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.

Valor de retorno

anular

DOCXOptions

A classe representa todas as opções disponíveis ao criar capturas de DOCX.

Propriedades Públicas

• setCustomId(String value) - um identificador personalizado pelo qual você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou.
  • Padrão: vazio
• setIncludeBackground(boolean value) - se verdadeiro, as imagens de fundo da página da web devem ser incluídas no DOCX
  • Padrão: true
• setPageSize(PageSize value) - o tamanho da página do DOCX
  • Padrão: PageSize.A4
  • opções: PageSize.A3, PageSize.A4, PageSize.A5, PageSize.A6, PageSize.B3, PageSize.B4, PageSize.B5, PageSize.B6, PageSize.LEGAL, PageSize.CARTA
• setOrientation(PageOrientation value) - a orientação do documento DOCX
  • Padrão: PageOrientation.RETRATO
  • opções: PageOrientation.RETRATO, PageOrientation.PANORAMA
• setIncludeLinks(boolean value) - true se os links devem ser incluídos no DOCX
  • Padrão: true
• setIncludeImages(boolean value) - se verdadeiro, as imagens da página da web devem ser incluídas no DOCX
  • Padrão: true
• setTitle(String value) - fornecer um título ao documento DOCX
  • Padrão: vazio
• setMarginTop(int value) - a margem em milímetros que deve aparecer na parte superior da página do documento DOCX
  • Padrão: 10
• setMarginLeft(int value) - a margem em milímetros que deve aparecer à esquerda da página do documento DOCX
  • Padrão: 10
• setMarginBottom(int value) - a margem em milímetros que deve aparecer na parte inferior da página do documento DOCX
  • Padrão: 10
• setMarginRight(int value) - a margem em milímetros que deve aparecer à direita do documento DOCX
  • Padrão: 10
• setBrowserWidth(int value) - a largura do navegador em pixels
  • Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
  • Padrão: 1366
  • Máximo: 10000
  • Largura automática: -1 (passar -1 significa que a largura do navegador corresponde à largura do documento PDF)
• setPageWidth(int value) - a largura personalizada do DOCX resultante em mm
  • Padrão: PageSize largura
  • Mínimo: 15
• setPageHeight(int value) - a altura personalizada do DOCX resultante em mm
  • Padrão: PageSize altura
  • Mínimo: 15
• setDelay(int value) - o número de milissegundos a aguarde antes de tirar a captura de tela
  • Padrão: 0
  • Máximo: 30000
• setRequestAs(BrowserType value) - o tipo de agente do usuário que você deseja usar
  • Padrão: BrowserType.STANDARDBROWSER
  • opções: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTOR DE PESQUISA
• setTemplateId(String value) - adicione um modelo ID que especifica o cabeçalho e rodapé do documento DOCX
  • Padrão: vazio
• setClickElement - especifica o elemento HTML, usando um Seletor CSS clicar. Lembre-se de que também pode ser necessário um atraso para ver os efeitos do clique
  • Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
• setTargetElement(String value) - a Seletor CSS do único elemento HTML na página da web de destino a ser ativada into uma captura de tela, todas as outras partes da página da web são ignoradas. Se houver vários elementos HTML correspondentes, o primeiro será escolhido
  • Padrão: vazio
• setHideElement(String value) - a Seletores CSS dos um ou mais elementos HTML na página da web a serem ocultados, para especificar vários elementos HTML a serem ocultados separadamente cada seletor com uma vírgula
  • Padrão: vazio
• setWaitForElement(String value) - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
  • Padrão: vazio
• setQuality(int value) - a qualidade do DOCX devolvido. O padrão usa a qualidade recomendada para o DOCX.
  • Reduzir a qualidade reduzirá o tamanho do arquivo e reduzirá o tempo de download.
  • Padrão: -1
  • Mínimo: -1
  • Máximo: 100
• setCountry(Country value) - o país a captura de tela deve ser retirada.
  • Padrão: o local mais rápido atual
  • opções: País.CINGAPURA, País.REINO UNIDO, País.ESTADOS UNIDOS
• setExportURL(String value) - a URL de exportação que especifica onde a captura também deve ser exportada
  • Padrão: vazio
• setEncryptionKey(String key) - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
  • Padrão: vazio
• setNoAds(boolean noAds) - se for verdade anúncios devem ser ocultados automaticamente.
  • Padrão: false
• setNoCookieNotifications(boolean noCookieNotifications) - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
  • Padrão: false
• setAddress(String address) - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
  • Padrão: vazio
• setProxy(String proxy) - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
  • Padrão: vazio
• setMergeId(String mergeId) - o ID de uma captura que deve ser mesclados no início do novo documento DOCX
  • Padrão: vazio
• setPassword(String mergeId) - a senha para proteger o documento DOCX com
  • Padrão: vazio

Métodos públicos

• AddPostParameter (String nome String valor) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
  • name - o nome do parâmetro HTTP Post
  • value - o valor do parâmetro HTTP Post
• AddTemplateParameter (String nome String valor) - defina um modelo personalizado parâmetro e valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros.
  • nome - o nome do parâmetro do modelo
  • valor - o valor do parâmetro do modelo

---

URLToTable(String url, TableOptions opções)

Especifica a URL da qual as tabelas HTML devem ser extraídas.

parâmetros

• url - o URL para extrair tabelas HTML de
  • Exigido
• TableOptions opções - uma instância do TableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.

Valor de retorno

anular

HTMLToTable (String html, TableOptions opções)

Especifica o HTML do qual as tabelas HTML devem ser extraídas.

parâmetros

• html - o HTML para extrair tabelas HTML.
  • Exigido
• TableOptions opções - uma instância do TableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.

Valor de retorno

anular

FileToTable (String caminho, TableOptions opções)

Especifica um arquivo HTML do qual as tabelas HTML devem ser extraídas.

parâmetros

• path - o caminho do arquivo HTML para extrair as tabelas HTML.
  • Exigido
• TableOptions opções - uma instância do TableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.

Valor de retorno

anular

TableOptions

A classe representa todas as opções disponíveis ao converter tabelas HTML para CSV, XLSX ou JSON.

Propriedades Públicas

• setCustomId(String value) - um identificador personalizado pelo qual você pode passar para o serviço da web. Isso será retornado com o URL de retorno que você especificou
  • Padrão: vazio
• setTableNumberToInclude(int value) - o índice da tabela a ser convertida, onde todas as tabelas em uma página da web são ordenadas da parte superior da página para a parte inferior
  • Padrão: 1
• setFormat(TableFormat value) - o formato em que a tabela deve estar
  • Padrão: TableFormat.CSV
  • opções: TableFormat.CSV, TableFormat.JSON, TableFormat.XLSX
• setIncludeHeaderNames(boolean value) - se nomes de cabeçalho verdadeiros serão incluídos na tabela
  • Padrão: true
• setIncludeAllTables(boolean value) - se true, toda a tabela na página da Web será extraída, com cada tabela aparecendo em uma planilha separada. Disponível apenas no formato XLSX
  • Padrão: false
• setTargetElement(String value) - o ID do único elemento HTML na página da web que deve ser usado para extrair tabelas de
  • Padrão: vazio
• setRequestAs(BrowserType value) - o tipo de agente do usuário que você deseja usar
  • Padrão: BrowserType.STANDARDBROWSER
  • opções: BrowserType.STANDARDBROWSER, BrowserType.MOBILEBROWSER, BrowserType.MOTOR DE PESQUISA
• setCountry(Country value) - o país a captura de tela deve ser retirada.
  • Padrão: o local mais rápido atual
  • opções: País.CINGAPURA, País.REINO UNIDO, País.ESTADOS UNIDOS
• setExportURL(String value) - a URL de exportação que especifica onde a captura também deve ser exportada
  • Padrão: vazio
• setEncryptionKey(String key) - se uma chave de criptografia AES básica codificada 64 for especificada, sua captura será criptografada quando criada. Recomenda-se usar o criar método de chave de criptografia para criar a chave e o descriptografar métodos descriptografar a captura criptografada, como mostrado em Neste exemplo.
  • Padrão: vazio
• setAddress(String address) - o URL para executar o código HTML. Pode ser útil se o HTML que está sendo convertido usar URLs relativos para recursos como CSS e imagens.
  • Padrão: vazio
• setProxy(String proxy) - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
  • Padrão: vazio

Métodos públicos

• AddPostParameter (String nome String valor) - define um parâmetro HTTP Post e, opcionalmente, valor, esse método pode ser chamado várias vezes para adicionar vários parâmetros. O uso desse método forçará o GrabzIt a executar uma postagem HTTP.
  • name - o nome do parâmetro HTTP Post
  • value - o valor do parâmetro HTTP Post

---

Save()

Save o resultado de forma assíncrona e retorna um identificador exclusivo, que pode ser usado para obter a captura de tela com o GetResult método.

Valor de retorno

O identificador exclusivo da captura de tela, caso contrário, se ocorrer um erro, uma exceção será lançada. Isso pode ser usado para obter a captura de tela com o GetResult método

---

Save(String callBackURL)

Save o resultado de forma assíncrona e retorna um identificador exclusivo, que pode ser usado para obter a captura de tela com o GetResult método.

parâmetros

• callBackURL - o treinador o serviço GrabzIt deve ligar depois de concluir seu trabalho
  • Exigido

Valor de retorno

O identificador exclusivo da captura de tela, caso contrário, se ocorrer um erro, uma exceção será lançada. Isso pode ser usado para obter a captura de tela com o GetResult método

GrabzItFile SaveTo()

Save o resultado de forma síncrona para um GrabzItFile objeto.

Valor de retorno

GrabzItFile objeto

---

SaveTo(String saveToArquivo)

Save o resultado de forma síncrona com um arquivo.

parâmetros

• saveToArquivo - o caminho do arquivo que a captura será saved uma vez que tenha sido concluída
  • Exigido

Valor de retorno

retorna true se for bem-sucedido, caso contrário, lança uma exceção.

---

Estado GetStatus (String identidade)

Obtenha o status atual de uma captura de tela do GrabzIt.

parâmetros

• id - o identificador exclusivo da captura de tela
  • Exigido

Valor de retorno

Estado objeto

---

GrabzItCookie [] GetCookies (String domínio)

Obtenha todos os cookies que o GrabzIt está usando para um domínio específico. Isso também pode incluir cookies definidos pelo usuário.

parâmetros

• domínio - o domínio para o qual retornar cookies para
  • Exigido

Valor de retorno

GrabzItCookie ordem

---

SetCookie (String nome String domínio, String valor, String caminho, boolean httponly, Data expira)

Define um novo cookie personalizado no GrabzIt. Se o cookie personalizado tiver o mesmo nome e domínio que um cookie global, o cookie global será substituído.

Isso pode ser útil se a funcionalidade de um site for controlada por cookies.

parâmetros

• nome - o nome do cookie a ser definido
  • Exigido
• domínio - o domínio do site para definir o cookie para
  • Exigido
• valor - o valor do cookie
• path - o caminho do site ao qual o cookie está relacionado
• httponly - se true, o cookie pode ser usado apenas com o protocolo HTTP
• expira - define quando o cookie expira. Passe um valor nulo se o cookie não expirar

Valor de retorno

Verdadeiro se o cookie for definido com êxito, caso contrário, falso

---

DeleteCookie (String nome String domínio)

Excluir um cookie personalizado ou impedir que um cookie global seja usado

parâmetros

• nome - o nome do cookie a ser excluído
  • Exigido
• domínio - o domínio do site para excluir o cookie para
  • Exigido

Valor de retorno

Verdadeiro se o cookie for excluído com êxito, caso contrário, falso

---

WaterMark[] ObtenhaWaterMarks()

Obtenha todo o seu upload personalizado watermarks

Valor de retorno

WaterMark ordem

---

WaterMark ObtenhaWaterMark(String identificador)

Devolva seu costume watermarks que corresponde ao identificador especificado

parâmetros

• identificador - o identificador de um determinado costume watermark você quer ver
  • Exigido

Valor de retorno

WaterMark objeto

---

AdicionarWaterMark(String identificador, String caminho, HorizontalPosition xpos, VerticalPosition ypos)

Adicionar um novo personalizado watermark

parâmetros

• identificador - o identificador que você deseja fornecer ao watermark. É importante que esse identificador seja único.
  • Exigido
• caminho - o caminho absoluto do watermark no seu servidor. Por exemplo C: /watermark/1.png
  • Exigido
• xpos - a posição horizontal em que você deseja que a captura de tela apareça
  • Exigido
  • opções: HorizontalPosition.ESQUERDA, HorizontalPosition.CENTRO, HorizontalPosition.DIREITA
• ypos - posição vertical em que você deseja que a captura de tela apareça
  • Exigido
  • opções: VerticalPosition.TOPO, VerticalPosition.MEIO, VerticalPosition.INFERIOR

Valor de retorno

retorna verdadeiro se o watermark foi definido com sucesso

---

DeleteWaterMark(String identificador)

Excluir um personalizado watermark

parâmetros

• identificador - o identificador do costume watermark você quer deletar
  • Exigido

Valor de retorno

retorna verdadeiro se o watermark foi excluído com sucesso

---

SetLocalProxy (String proxyUrl)

Este método permite uma servidor proxy local para ser usado para todas as solicitações.

parâmetros

• proxyUrl - a URL, que pode incluir uma porta, se necessário, do proxy. Fornecer um valor nulo removerá qualquer proxy definido anteriormente
  • Exigido

---

UseSSL (boolean valor)

Especifica se as solicitações ao GrabzIt API deve usar SSL

parâmetros

• value - se true, todos os pedidos à API do GrabzIt usarão SSL
  • Exigido

---

String CreateEncryptionKey ()

Crie uma chave de criptografia 64 básica com criptografia segura, com caracteres 44.

---

Descriptografar (String caminho, String chave)

Descriptografe uma captura criptografada usando a chave de criptografia fornecida.

parâmetros

• path - o caminho da captura criptografada
  • Exigido
• chave - o Chave de encriptação
  • Exigido

---

GrabzItFile Descriptografar (GrabzItFile arquivo, String chave)

Descriptografe uma captura criptografada usando a chave de criptografia fornecida.

parâmetros

• arquivo - o criptografado GrabzItFile
  • Exigido
• chave - o Chave de encriptação
  • Exigido

---

byte [] Decrypt (byte [] dados, String chave)

Descriptografe uma captura criptografada usando a chave de criptografia fornecida.

parâmetros

• data - os bytes criptografados
  • Exigido
• chave - o Chave de encriptação
  • Exigido

---

Enums

ImageFormat

Essa enumeração é composta pelos seguintes valores.

• BMP8
• BMP16
• BMP24
• BMP
• JPG
• TIFF
• PNG
• WEBP

---

BrowserType

Essa enumeração é composta pelos seguintes valores.

• STANDARDBROWSER
• MOBILEBROWSER
• MOTOR DE PESQUISA

---

País

Essa enumeração é composta pelos seguintes valores.

• PADRÃO
• CINGAPURA
• REINO UNIDO
• ESTADOS UNIDOS

---

PageSize

Essa enumeração é composta pelos seguintes valores.

• A3
• A4
• A5
• A6
• B3
• B4
• B5
• B6
• LEGAL
• CARTA

---

PageOrientation

Essa enumeração é composta pelos seguintes valores.

• PANORAMA
• RETRATO

---

CSSMediaType

Essa enumeração é composta pelos seguintes valores.

• PRINT
• TELA

---

TableFormat

Essa enumeração é composta pelos seguintes valores.

• CSV
• JSON
• XSLX

---

HorizontalPosition

Essa enumeração é composta pelos seguintes valores.

• ESQUERDA
• CENTRO
• DIREITO

---

VerticalPosition

Essa enumeração é composta pelos seguintes valores.

• TOPO
• MÉDIO
• BOTTOM

---

Classes de resultado

Cookie

Propriedades Públicas

• String getName()
  • O nome do cookie.
• String getValue()
  • O valor do cookie.
• String getDomain()
  • O domínio para o qual o cookie está definido.
• String getPath()
  • O caminho no domínio ao qual este cookie se aplica.
• String getHttpOnly()
  • Se este cookie for válido apenas quando o site for visualizado com o protocolo HTTP.
• String getExpires()
  • A data em que esse cookie expira
• String getType()
  • O tipo de cookie é esse, que pode ser um dos seguintes:
    • Global - este é um cookie global definido por GrabzIt
    • Local - este é um cookie local definido por você
    • Substituído - um cookie global que foi substituído por você

GrabzItFile

Métodos públicos

• byte [] getBytes ()
• anular Save(String Caminho)
• String paraString()

Estado

A classe que representa o status atual da captura de tela.

Métodos públicos

• boolean isProcessing ()
  • Se verdadeiro, a captura de tela ainda está sendo processada.
• boolean isCached ()
  • Se verdadeiro, a captura de tela foi processada e está atualmente em cache.
• boolean está expirado()
  • Se verdadeiro, a captura de tela não está mais no sistema GrabzIt.
• String getMessage ()
  • Uma mensagem de erro retornada pelo sistema.

WaterMark

Esta classe representa o costume watermarks armazenado no GrabzIt

Métodos públicos

• String getIdentifier ()
• String getFormat ()
• HorizontalPosition GetXPosition ()
• VerticalPosition GetYPosition ()