Cliente GrabzIt com ASP.NET
Descrição
Esta classe lida com toda a comunicação com os serviços da Web de captura de tela GrabzIt. Todos os métodos marcados com COM também funciona quando a DLL do GrabzIt ASP.NET é usada como um Objeto COM.
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()
- GrabzItFile SaveToAsync()
- bool SaveTo(string saveToFile)
- bool SaveToAsync(string saveToFile)
- Status GetStatus(string id)
- GrabzItCookie[] GetCookies(string domain)
- bool SetCookie(string name, string domain, string value, string path, bool httponly, DateTime? expires)
- bool DeleteCookie(string name, string domain)
- WaterMark[] GetWaterMarks()
- WaterMark GetWaterMark(string identifier)
- bool AddWaterMark(string identifier, string path, HorizontalPosition xpos, VerticalPosition ypos)
- bool DeleteWaterMark(string identifier)
- SetLocalProxy(string proxyUrl)
- UseSSL(bool value)
- string CreateEncryptionKey()
- Decrypt(string path, string key)
- GrabzItFile Decrypt(GrabzItFile file, string key)
- byte[] Decrypt(byte[] data, string key)
GrabzItFile GetResult(string identidade)COM
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
Valor de retorno
GrabzItFile objeto
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.
- Necessário para COM caso contrário opcional
Valor de retorno
anular
AnimationOptionsCOM
NamespaceGrabzIt.Parameters
A classe representa todas as opções disponíveis ao criar um GIF animado.
Propriedades Públicas
-
string CustomId - 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.
-
int Width - 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á)
-
int Height - 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á)
-
int Start - a posição inicial do vídeo que deve ser convertida intum GIF animado.
-
int Duration - a duração em segundos do vídeo que deve ser convertido intum GIF animado.
- Padrão: comprimento máximo para o pacote
-
float Speed - a velocidade do GIF animado.
- Padrão: 1
- Mínimo: 0.2
- Máximo: 10
-
float FramesPerSecond - o número de quadros por segundo que devem ser capturados do vídeo.
- Padrão: 10
- Mínimo: 0.2
- Máximo: 60
-
int Repeat - número de vezes para repetir o GIF animado.
- Padrão: 0
- Loop continuamente: 0
- Nunca Loop: -1
-
bool Reverse - se verdadeiro, os quadros do GIF animado são revertidos
-
string CustomWaterMarkId - adicionar personalizado watermark para o GIF animado
-
int Quality - 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
-
Country Country - 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.US
-
string ExportURL - a URL de exportação que especifica onde a captura também deve ser exportada.
-
string EncryptionKey - 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.
-
string Proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
URLToImage(string url, ImageOptions opções)COM
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
-
opções - uma instância do ImageOptions classe que define todas as opções especiais a serem usadas ao criar a captura de tela.
- Necessário para COM caso contrário opcional
Valor de retorno
anular
HTMLToImage(string html, ImageOptions opções)COM
Especifica o HTML que deve ser convertido intuma imagem.
parâmetros
-
html - o HTML para converter intoa imagem
- 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)COM
Especifica um arquivo HTML que deve ser convertido intuma imagem.
parâmetros
-
path - o caminho do arquivo HTML para converter intoa imagem
-
opções - uma instância do ImageOptions classe que define todas as opções especiais a serem usadas ao criar uma imagem.
- Necessário para COM caso contrário opcional
Valor de retorno
anular
ImageOptionsCOM
NamespaceGrabzIt.Parameters
A classe representa todas as opções disponíveis ao criar capturas de imagens.
Propriedades Públicas
-
string CustomId - identificador personalizado que você pode passar para o serviço da tela. Isso será retornado com o URL de retorno que você especificou.
-
int BrowserWidth - a largura do navegador em pixels
- Padrão: 1366
- Máximo: 10000
-
int BrowserHeight - 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)
-
int OutputWidth - 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)
-
int OutputHeight - 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)
-
ImageFormat Format - o formato em que a captura de tela deve estar.
-
int Delay - o número de milissegundos a aguarde antes de tirar a captura de tela
-
string ClickElement - 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
- Padrão: vazio
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
-
string TargetElement - 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
-
string HideElement - 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
-
string WaitForElement - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
-
BrowserType RequestAs - o tipo de agente do usuário que você deseja usar
-
string CustomWaterMarkId - adicione um personalizado watermark para a imagem
-
int Quality - 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
-
bool Transparent - se verdadeiro se o a captura de imagem deve ser transparente. Isso é compatível apenas com imagens png e tiff.
-
bool HD - se verdadeira a imagem captura estará em alta definição isso dobra o tamanho das dimensões da imagem.
-
Country Country - 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.US
-
string ExportURL - a URL de exportação que especifica onde a captura também deve ser exportada
-
string EncryptionKey - 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.
-
bool NoAds - se for verdade anúncios devem ser ocultados automaticamente.
-
bool NoCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
-
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.
-
string Proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
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)COM
Especifica o URL que deve ser convertido into HTML renderizado.
parâmetros
-
url - a URL da qual o HTML renderizado deve ser feito
-
opções - uma instância do HTMLOptions classe que define todas as opções especiais a serem usadas ao criar o HTML renderizado.
- Necessário para COM caso contrário opcional
Valor de retorno
anular
HTMLToRenderedHTML(string html, HTMLOptions opções)COM
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)COM
Especifica um arquivo HTML que deve ser convertido into HTML renderizado.
parâmetros
-
path - o caminho do arquivo 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.
- Necessário para COM caso contrário opcional
Valor de retorno
anular
HTMLOptionsCOM
NamespaceGrabzIt.Parameters
A classe representa todas as opções disponíveis quando criando capturas HTML renderizadas.
Propriedades Públicas
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)COM
Especifica o URL que deve ser convertido intum PDF.
parâmetros
-
url - o URL que deve ser convertido intoa PDF
-
PDFOptions options - uma instância da classe PDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.
- Necessário para COM caso contrário opcional
Valor de retorno
anular
HTMLToPDF(string html, PDFOptions opções)COM
Especifica o HTML que deve ser convertido intum PDF.
parâmetros
-
html - o HTML para converter intoa PDF
-
PDFOptions options - uma instância da classe GrabzItPDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.
- Necessário para COM caso contrário opcional
Valor de retorno
anular
FileToPDF(string caminho, PDFOptions opções)COM
Especifica um arquivo HTML que deve ser convertido intum PDF.
parâmetros
-
path - o caminho do arquivo HTML para converter intoa PDF
-
PDFOptions options - uma instância da classe PDFOptions que define todas as opções especiais a serem usadas ao criar um PDF.
- Necessário para COM caso contrário opcional
Valor de retorno
anular
PDFOptionsCOM
NamespaceGrabzIt.Parameters
A classe representa todas as opções disponíveis ao criar capturas de PDF.
Propriedades Públicas
-
string CustomId - 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.
-
bool IncludeBackground - se verdadeiro, o plano de fundo da página da web deve ser incluído na captura de tela
-
PageSize PageSize - o tamanho da página do PDF
-
PageOrientation Orientation - a orientação do documento PDF
-
CSSMediaType CSSMediaType - a Tipo de mídia CSS do documento PDF
-
bool IncludeLinks - true se os links devem ser incluídos no PDF
-
bool IncludeOutline - verdadeiro se Favoritos em PDF Deveria ser incluído
-
string Title - forneça um título para o documento PDF
-
string CoverURL - o URL de uma página da web que deve ser usada como uma página de rosto para o PDF
-
int MarginTop - a margem em milímetros que deve aparecer na parte superior da página do documento PDF
-
int MarginLeft - a margem em milímetros que deve aparecer à esquerda da página do documento PDF
-
int MarginBottom - a margem em milímetros que deve aparecer na parte inferior da página do documento PDF
-
int MarginRight - a margem em milímetros que deve aparecer à direita do documento PDF
-
int BrowserWidth - 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)
-
int PageWidth - a largura personalizada do PDF resultante em mm
-
int PageHeight - a altura personalizada do PDF resultante em mm
-
int Delay - o número de milissegundos a aguarde antes de tirar a captura de tela
-
BrowserType RequestAs - o tipo de agente do usuário que você deseja usar
-
string TemplateId - adicione um modelo ID que especifica o cabeçalho e rodapé do documento PDF
-
string ClickElement - 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
- Padrão: vazio
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
-
string TargetElement - 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
-
string HideElement - 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
-
string WaitForElement - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
-
string CustomWaterMarkId - adicione um personalizado watermark para cada página do documento PDF
-
int Quality - 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
-
Country Country - 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.US
-
string ExportURL - a URL de exportação que especifica onde a captura também deve ser exportada
-
string EncryptionKey - 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.
-
bool NoAds - se for verdade anúncios devem ser ocultados automaticamente.
-
bool NoCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
-
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.
-
string Proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
-
string MergeId - o ID de uma captura que deve ser mesclados no início do novo documento PDF
-
string Password - a senha para proteger o documento PDF com
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)COM
Especifica o URL que deve ser convertido into DOCX.
parâmetros
-
url - o URL que deve ser convertido into DOCX
-
DOCXOptions opções - uma instância do DOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.
- Necessário para COM caso contrário opcional
Valor de retorno
anular
HTMLToDOCX(string html, DOCXOptions opções)COM
Especifica o HTML que deve ser convertido into DOCX.
parâmetros
-
html - o HTML para converter into DOCX
-
DOCXOptions opções - uma instância do GrabzItDOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.
- Necessário para COM caso contrário opcional
Valor de retorno
anular
FileToDOCX(string caminho, DOCXOptions opções)COM
Especifica um arquivo HTML que deve ser convertido into DOCX.
parâmetros
-
path - o caminho do arquivo HTML para converter into DOCX
-
DOCXOptions opções - uma instância do DOCXOptions classe que define todas as opções especiais a serem usadas ao criar um DOCX.
- Necessário para COM caso contrário opcional
Valor de retorno
anular
DOCXOptionsCOM
NamespaceGrabzIt.Parameters
A classe representa todas as opções disponíveis ao criar capturas de DOCX.
Propriedades Públicas
-
string CustomId - 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.
-
bool IncludeBackground - se verdadeiro, as imagens de fundo da página da web devem ser incluídas no DOCX
-
PageSize PageSize - o tamanho da página do DOCX
-
PageOrientation Orientation - a orientação do documento DOCX
-
bool IncludeLinks - true se os links devem ser incluídos no DOCX
-
bool IncludeImages - se verdadeiro, as imagens da página da web devem ser incluídas no DOCX
-
string Title - fornecer um título ao documento DOCX
-
int MarginTop - a margem em milímetros que deve aparecer na parte superior da página do documento DOCX
-
int MarginLeft - a margem em milímetros que deve aparecer à esquerda da página do documento DOCX
-
int MarginBottom - a margem em milímetros que deve aparecer na parte inferior da página do documento DOCX
-
int MarginRight - a margem em milímetros que deve aparecer à direita do documento DOCX
-
int BrowserWidth - 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 DOCX)
-
int PageWidth - a largura personalizada do DOCX resultante em mm
-
int PageHeight - a altura personalizada do DOCX resultante em mm
-
int Delay - o número de milissegundos a aguarde antes de tirar a captura de tela
-
BrowserType RequestAs - o tipo de agente do usuário que você deseja usar
-
string TemplateId - adicione um modelo ID que especifica o cabeçalho e rodapé do documento DOCX
-
string ClickElement - 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
- Padrão: vazio
- Aviso: este recurso está atualmente na versão beta e pode não fornecer resultados consistentes.
-
string TargetElement - a Seletor CSS do único elemento HTML na página da web de destino a ser ativada into DOCX, todas as outras partes da página da web são ignoradas. Se houver vários elementos HTML correspondentes, o primeiro será escolhido
-
string HideElement - 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
-
string WaitForElement - a Seletores CSS do elemento HTML na página da web que deve estar visível antes da captura ser realizada
-
int Quality - 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
-
Country Country - 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.US
-
string ExportURL - a URL de exportação que especifica onde a captura também deve ser exportada
-
string EncryptionKey - 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.
-
bool NoAds - se for verdade anúncios devem ser ocultados automaticamente.
-
bool NoCookieNotifications - se verdadeiro, todos comumente encontrados as notificações de cookies devem ser ocultadas automaticamente.
-
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.
-
string Proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
-
string MergeId - o ID de uma captura que deve ser mesclados no início do novo documento DOCX
-
string Password - a senha para proteger o documento DOCX com
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)COM
Especifica a URL da qual as tabelas HTML devem ser extraídas.
parâmetros
-
url - o URL para extrair tabelas HTML de
-
TableOptions opções - uma instância do TableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.
- Necessário para COM caso contrário opcional
Valor de retorno
anular
HTMLToTable (string html, TableOptions opções)COM
Especifica o HTML do qual as tabelas HTML devem ser extraídas.
parâmetros
-
html - o HTML para extrair tabelas HTML.
-
TableOptions opções - uma instância do TableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.
- Necessário para COM caso contrário opcional
Valor de retorno
anular
FileToTable (string caminho, TableOptions opções)COM
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.
-
TableOptions opções - uma instância do TableOptions classe que define todas as opções especiais a serem usadas ao converter a tabela HTML.
- Necessário para COM caso contrário opcional
Valor de retorno
anular
TableOptionsCOM
NamespaceGrabzIt.Parameters
A classe representa todas as opções disponíveis ao converter tabelas HTML para CSV, XLSX ou JSON.
Propriedades Públicas
-
string CustomId - 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
-
int TableNumberToInclude - 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
-
TableFormat Format - o formato em que a tabela deve estar
-
bool IncludeHeaderNames - se nomes de cabeçalho verdadeiros serão incluídos na tabela
-
bool IncludeAllTables - 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
-
string TargetElement - o ID do único elemento HTML na página da web que deve ser usado para extrair tabelas de
-
BrowserType RequestAs - o tipo de agente do usuário que você deseja usar
-
Country Country - 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.US
-
string ExportURL - a URL de exportação que especifica onde a captura também deve ser exportada
-
string EncryptionKey - 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.
-
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.
-
string Proxy - os detalhes do proxy HTTP o software do navegador deve usar para criar essa captura
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
Este é o método recomendado para salvar um arquivo
Save(string callBackURL)COM
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
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
Advertindo que este método é síncrono, fará com que um aplicativo pause enquanto o resultado é processado
Save o resultado de forma síncrona para um GrabzItFile objeto.
Valor de retorno
GrabzItFile objeto
Save o resultado de forma assíncrona para um GrabzItFile objeto. Disponível apenas se a versão do .NET suportar métodos assíncronos.
Valor de retorno
GrabzItFile objeto
Advertindo que este método é síncrono, fará com que um aplicativo pause enquanto o resultado é processado
SaveTo(string saveToArquivo)COM
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
Valor de retorno
retorna true se for bem-sucedido, caso contrário, lança uma exceção.
SaveToAssíncrono(string saveToArquivo)
Save o resultado de forma assíncrona para um arquivo. Disponível apenas se a versão do .NET suportar métodos assíncronos.
parâmetros
-
saveToArquivo - o caminho do arquivo que a captura será saved uma vez que tenha sido concluída
Valor de retorno
retorna true se for bem-sucedido, caso contrário, lança uma exceção.
Estado
GetStatus (string identidade)COM
Obtenha o status atual de uma captura de tela do GrabzIt.
parâmetros
-
id - o identificador exclusivo da captura de tela
Valor de retorno
Estado
objeto
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
Valor de retorno
GrabzItCookie ordem
SetCookie (string nome string domínio, string valor, string caminho, bool httponly, DateTime? expira)COM
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
-
domínio - o domínio do site para definir o cookie para
- 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)COM
Excluir um cookie personalizado ou impedir que um cookie global seja usado
parâmetros
-
nome - o nome do cookie a ser excluído
-
domínio - o domínio do site para excluir o cookie para
Valor de retorno
Verdadeiro se o cookie for excluído com êxito, caso contrário, falso
WaterMark[] GetWaterMarks(String identificador)COM
Obtenha todo o seu upload personalizado watermarks
Valor de retorno
WaterMark ordem
WaterMark GetWaterMark(String identificador)COM
Devolva seu costume watermark que corresponde ao identificador especificado
parâmetros
-
identificador - o identificador de um determinado costume watermark você quer ver
Valor de retorno
WaterMark
Adicionar um novo personalizado watermark
parâmetros
-
identificador - o identificador que você deseja fornecer ao watermark. É importante que esse identificador seja único.
-
caminho - o caminho absoluto do watermark no seu servidor. Por exemplo C: /watermark/1.png
-
xpos - a posição horizontal em que você deseja que a captura de tela apareça
-
ypos - posição vertical em que você deseja que a captura de tela apareça
Valor de retorno
retorna verdadeiro se o watermark foi definido com sucesso
DeleteWaterMark(string identificador)COM
Excluir um personalizado watermark
parâmetros
-
identificador - o identificador do costume watermark você quer deletar
Valor de retorno
retorna verdadeiro se o watermark foi excluído com sucesso
SetLocalProxy (string proxyUrl)COM
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
UseSSL (bool valor)COM
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
string CreateEncryptionKey ()COM
Crie uma chave de criptografia 64 básica com criptografia segura, com caracteres 44.
Descriptografar (string caminho, string chave)COM
Descriptografe uma captura criptografada usando a chave de criptografia fornecida.
parâmetros
GrabzItFile Descriptografar (GrabzItFile arquivo, string chave)
Descriptografe uma captura criptografada usando a chave de criptografia fornecida.
parâmetros
byte [] Decrypt (byte [] dados, string chave)
Descriptografe uma captura criptografada usando a chave de criptografia fornecida.
parâmetros
Ao definir propriedades de enum em objetos COM, use o valor numérico equivalente para a enum.
Enums
ImageFormat
NamespaceGrabzIt.Enums
Essa enumeração é composta pelos seguintes valores.
- bmp8 = 0
- bmp16 = 1
- bmp24 = 2
- bmp = 3
- jpg = 4
- tiff = 5
- png = 6
- webp = 7
BrowserType
NamespaceGrabzIt.Enums
Essa enumeração é composta pelos seguintes valores.
- StandardBrowser = 0
- MobileBrowser = 1
- SearchEngine = 2
País
NamespaceGrabzIt.Enums
Essa enumeração é composta pelos seguintes valores.
- Padrão = 0
- Singapura = 1
- UK = 2
- US = 3
PageSize
NamespaceGrabzIt.Enums
Essa enumeração é composta pelos seguintes valores.
- A3 = 0
- A4 = 1
- A5 = 2
- A6 = 3
- B3 = 4
- B4 = 5
- B5 = 6
- B6 = 7
- Legal = 8
- Letter = 9
PageOrientation
NamespaceGrabzIt.Enums
Essa enumeração é composta pelos seguintes valores.
CSSMediaType
NamespaceGrabzIt.Enums
Essa enumeração é composta pelos seguintes valores.
TableFormat
NamespaceGrabzIt.Enums
Essa enumeração é composta pelos seguintes valores.
- csv = 0
- json = 1
- xslx = 2
HorizontalPosition
NamespaceGrabzIt.Enums
Essa enumeração é composta pelos seguintes valores.
- Esquerda = 0
- Centro = 1
- Direita = 2
VerticalPosition
NamespaceGrabzIt.Enums
Essa enumeração é composta pelos seguintes valores.
- Topo = 0
- Médio = 1
- Parte inferior = 2
Classes de resultado
GrabzItCookieCOM
NamespaceGrabzIt.Cookies
Propriedades Públicas
-
string Name
-
string Value
-
string Domain
- O domínio para o qual o cookie está definido.
-
string Path
- O caminho no domínio ao qual este cookie se aplica.
-
string HttpOnly
- Se este cookie for válido apenas quando o site for visualizado com o protocolo HTTP.
-
string Expires
- A data em que esse cookie expira
-
string Type
-
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ê
GrabzItFileCOM
NamespaceGrabzIt.Screenshots
Métodos públicos
-
anular Save(string Caminho)
-
caminho - o caminho para save o resultado para
- string ParaString()
Propriedades Públicas
Estado
COM
NamespaceGrabzIt.Screenshots
A classe que representa o status atual da captura de tela.
Propriedades Públicas
-
bool Processing
- Se verdadeiro, a captura de tela ainda está sendo processada.
-
bool Cached
- Se verdadeiro, a captura de tela foi processada e está atualmente em cache.
-
bool Expired
- Se verdadeiro, a captura de tela não está mais no sistema GrabzIt.
-
string Message
- Uma mensagem de erro retornada pelo sistema.
WaterMarkCOM
NamespaceGrabzIt.Screenshots
Esta classe representa o costume watermarks armazenado no GrabzIt
Métodos públicos
Propriedades Públicas
-
string Identifier
- O identificador do watermark
-
string XPosition
-
A posição horizontal do watermark
- Esquerdo
- Centralização de
- Certo
-
string YPosition
-
A posição vertical do watermark
-
string Format