GrabzIt Client avec ASP.NET

Description

Cette classe gère toutes les communications avec les services Web de capture d’écran GrabzIt. Toutes les méthodes marquées avec COM fonctionne également lorsque la DLL GrabzIt ASP.NET est utilisée en tant que Objet COM.

Méthodes publiques

• 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()
• bool SaveTo(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 id)COM

Cette méthode renvoie la capture d'écran elle-même. Si rien n'est renvoyé, alors quelque chose s'est mal passé ou la capture d'écran n'est pas encore prête.

Paramètres

• id - l'identifiant unique de la capture d'écran
  • Requis

Valeur de retour

GrabzItFile objet

URLToAnimation(string url, AnimationOptions options)COM

Spécifiez l'URL de la vidéo en ligne à convertir into un GIF animé.

Paramètres

• url - l'URL de la vidéo en ligne à convertir into un GIF animé.
  • Requis
  • Accepte les URL de vidéos Vimeo et YouTube
    • Avertissement L'animation de vidéos Vimeo et YouTube dépend d'un tiers et peut donc ne pas fournir des résultats cohérents.
• Options - une instance de AnimationOptions classe qui définit les options spéciales à utiliser lors de la création du fichier GIF animé.
  • Requis pour COM sinon optionnel

Valeur de retour

annuler

AnimationOptionsCOM

La classe représente toutes les options disponibles lors de la création d'un fichier GIF animé.

Propriétés publiques

• string CustomId - identificateur personnalisé que vous pouvez transmettre au service Web GIF animé. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• int Width - la largeur du GIF animé obtenu en pixels.
  • Par défaut: 180px
  • Maximum: Largeur maximale pour le colis
  • Taille automatique: -1 (passage -1 signifie que la largeur de la le GIF animé est mis à l'échelle par rapport à sa hauteur, si la largeur est auto-dimensionnée, la hauteur ne peut pas)
• int Height - la hauteur du GIF animé obtenu en pixels.
  • Par défaut: 120px
  • Maximum: hauteur maximale pour le colis
  • Taille automatique: -1 (passage -1 signifie que la hauteur de la le GIF animé est mis à l'échelle par rapport à sa largeur, si la hauteur est automatiquement dimensionnée, la largeur ne peut pas)
• int Start - la position de départ de la vidéo à convertir into un GIF animé.
  • Par défaut: secondes 0
• int Duration - la durée en secondes de la vidéo à convertir into un GIF animé.
  • Valeur par défaut: longueur maximale du paquet
• float Speed - la vitesse du GIF animé.
  • Par défaut: 1
  • Minimum: 0.2
  • Maximum: 10
• float FramesPerSecond - le nombre d'images par seconde devant être capturées à partir de la vidéo.
  • Par défaut: 10
  • Minimum: 0.2
  • Maximum: 60
• int Repeat - nombre de fois pour boucler le GIF animé.
  • Par défaut: 0
  • Boucle en continu: 0
• bool Reverse - si vrai, les images du GIF animé sont inversées
  • Par défaut: false
• string CustomWaterMarkId - ajouter un filigrane personnalisé au GIF animé
  • Par défaut: vide
• int Quality - la qualité de l'image retournée, qui a une compression par défaut de 85%.
  • Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
  • Par défaut: -1
  • Minimum: -1
  • Maximum: 100
• Country Country - le pays le GIF animé doit provenir de.
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: l'emplacement le plus rapide actuel
  • options: Pays.Singapour, Pays.ROYAUME-UNI, Pays.NOUS
• string ExportURL - la URL d'exportation qui spécifie également où la capture doit être exportée.
  • Par défaut: vide
• string EncryptionKey - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• string Proxy - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide

URLToImage(string url, ImageOptions options)COM

Spécifie l'URL à convertir into une image capture d'écran.

Paramètres

• url - l'URL de la capture d'écran
  • Requis
• Options - une instance de ImageOptions classe qui définit les options spéciales à utiliser lors de la création de la capture d'écran.
  • Requis pour COM sinon optionnel

Valeur de retour

annuler

HTMLToImage(string html, ImageOptions options)COM

Spécifie le HTML à convertir into une image.

Paramètres

• html - le HTML à convertir into une image
  • Requis
• Options - une instance de ImageOptions classe qui définit les options spéciales à utiliser lors de la création d’une image.

Valeur de retour

annuler

FileToImage(string chemin, ImageOptions options)COM

Spécifie un fichier HTML à convertir into une image.

Paramètres

• chemin - le chemin du fichier HTML à convertir into une image
  • Requis
• Options - une instance de ImageOptions classe qui définit les options spéciales à utiliser lors de la création d’une image.
  • Requis pour COM sinon optionnel

Valeur de retour

annuler

ImageOptionsCOM

La classe représente toutes les options disponibles lors de la création de captures d'image.

Propriétés publiques

• string CustomId - identifiant personnalisé que vous pouvez transmettre au service Web de capture d'écran. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• int BrowserWidth - la largeur du navigateur en pixels
  • Par défaut: 1024
  • Maximum: 10000
• int BrowserHeight - la hauteur du navigateur en pixels
  • Par défaut: 768
  • Maximum: 10000
  • Longueur totale: -1 (passant -1 signifie qu’un cliché de la totalité de la page Web est pris)
• int OutputWidth - la largeur de la vignette obtenue en pixels
  • Valeur par défaut: le rapport le plus élevé possible entre la largeur du navigateur et la largeur maximale autorisée pour le package des utilisateurs.
  • Maximum: Largeur maximale pour le colis
  • Pleine largeur: -1 (passage -1 signifie que la largeur de la vignette n'est pas réduite)
• int OutputHeight - la hauteur de la vignette obtenue en pixels
  • Valeur par défaut: le ratio le plus élevé possible entre la hauteur du navigateur et celle qui convient à l'utilisateur.
  • Maximum: hauteur maximale pour le colis
  • Hauteur totale: -1 (passage -1 signifie que la hauteur de la vignette n'est pas réduite)
• ImageFormat Format - le format de la capture d'écran doit être.
  • Valeur par défaut: ImageFormat. Jpg
  • options: ImageFormat.bmp8, ImageFormat.bmp16, ImageFormat.bmp24, ImageFormat.bmp, ImageFormat.tiff, ImageFormat.jpg, ImageFormat.png, ImageFormat.webp
• int Delay - le nombre de millisecondes à attendez avant de prendre la capture d'écran
  • Par défaut: 0
  • Maximum: 30000
• string TargetElement - l'identifiant ou la classe Sélecteur CSS du seul élément HTML sur la page Web cible à transformer into une capture d’écran, toutes les autres parties de la page Web sont ignorées. S'il existe plusieurs éléments HTML correspondants, le premier est choisi
  • Par défaut: vide
• string HideElement - l'identifiant ou la classe Sélecteurs CSS parmi un ou plusieurs éléments HTML de la page Web à masquer, permettant de spécifier plusieurs éléments HTML à masquer, séparer chaque sélecteur par une virgule
  • Par défaut: vide
• string WaitForElement - l'identifiant ou la classe Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
  • Par défaut: vide
• BrowserType RequestAs - le type d'agent utilisateur que vous souhaitez utiliser
  • Valeur par défaut: BrowserType.StandardBrowser
  • options: BrowserType.StandardBrowser, BrowserType.MobileBrowser, BrowserType.Moteur de recherche, BrowserType.FallbackBrowser
• string CustomWaterMarkId - ajouter un filigrane personnalisé à l'image
  • Par défaut: vide
• int Quality - la qualité de l'image retournée. Cela n'affecte actuellement que les images JPG, qui ont une compression par défaut de 85%.
  • Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
  • Par défaut: -1
  • Minimum: -1
  • Maximum: 100
• bool Transparent - si vrai si le la capture d'image doit être transparente. Ceci est uniquement compatible avec les images png et tiff.
  • Par défaut: false
• bool HD - si vrai l'image capture sera en haute définition cela double la taille des dimensions de l'image.
  • Par défaut: false
• Country Country - le pays la capture d'écran doit être prise à partir de.
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: l'emplacement le plus rapide actuel
  • options: Pays.Singapour, Pays.ROYAUME-UNI, Pays.NOUS
• string ExportURL - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• string EncryptionKey - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• bool NoAds - si vrai les annonces doivent être automatiquement masquées.
  • Par défaut: false
• bool NoCookieNotifications - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
  • Par défaut: false
• string Address - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• string Proxy - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide

Méthodes publiques

• AddPostParameter (string prénom, string valeur) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post

URLToRenderedHTML(string url, HTMLOptions options)COM

Spécifie l'URL à convertir into rendu HTML.

Paramètres

• url - l'URL dont le HTML rendu devrait être composé
  • Requis
• Options - une instance de HTMLOptions classe qui définit les options spéciales à utiliser lors de la création du code HTML rendu.
  • Requis pour COM sinon optionnel

Valeur de retour

annuler

HTMLToRenderedHTML(string html, HTMLOptions options)COM

Spécifie le HTML à convertir into rendu HTML.

Paramètres

• html - le HTML à convertir into rendu HTML
  • Requis
• Options - une instance de HTMLOptions classe qui définit les options spéciales à utiliser lors de la création de HTML rendu.

Valeur de retour

annuler

FileToRenderedHTML(string chemin, HTMLOptions options)COM

Spécifie un fichier HTML à convertir into rendu HTML.

Paramètres

• chemin - le chemin du fichier HTML à convertir into rendu HTML
  • Requis
• Options - une instance de HTMLOptions classe qui définit les options spéciales à utiliser lors de la création de HTML rendu.
  • Requis pour COM sinon optionnel

Valeur de retour

annuler

HTMLOptionsCOM

La classe représente toutes les options disponibles lorsque création de captures HTML rendues.

Propriétés publiques

• string CustomId - identificateur personnalisé que vous pouvez transmettre au service Web HTML rendu. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• int BrowserWidth - la largeur du navigateur en pixels
  • Par défaut: 1024
  • Maximum: 10000
• int BrowserHeight - la hauteur du navigateur en pixels
  • Par défaut: 768
  • Maximum: 10000
• int Delay - le nombre de millisecondes à attendez avant de prendre le HTMLt rendu
  • Par défaut: 0
  • Maximum: 30000
• string WaitForElement - l'identifiant ou la classe Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
  • Par défaut: vide
• BrowserType RequestAs - le type d'agent utilisateur que vous souhaitez utiliser
  • Valeur par défaut: BrowserType.StandardBrowser
  • options: BrowserType.StandardBrowser, BrowserType.MobileBrowser, BrowserType.Moteur de recherche, BrowserType.FallbackBrowser
• Country Country - le pays le HTMLt rendu doit être pris de.
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: l'emplacement le plus rapide actuel
  • options: Pays.Singapour, Pays.ROYAUME-UNI, Pays.NOUS
• string ExportURL - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• string EncryptionKey - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• bool NoAds - si vrai les annonces doivent être automatiquement masquées.
  • Par défaut: false
• bool NoCookieNotifications - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
  • Par défaut: false
• string Address - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• string Proxy - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide

Méthodes publiques

• AddPostParameter (string prénom, string valeur) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post

URLToPDF(string url, PDFOptions options)COM

Spécifie l'URL à convertir into un PDF.

Paramètres

• url - l'URL à convertir into un PDF
  • Requis
• PDFOptions options - une instance de la classe PDFOptions qui définit les options spéciales à utiliser lors de la création d'un fichier PDF.
  • Requis pour COM sinon optionnel

Valeur de retour

annuler

HTMLToPDF(string html, PDFOptions options)COM

Spécifie le HTML à convertir into un PDF.

Paramètres

• html - le HTML à convertir into un PDF
  • Requis
• PDFOptions options - une instance de la classe GrabzItPDFOptions qui définit les options spéciales à utiliser lors de la création d'un fichier PDF.
  • Requis pour COM sinon optionnel

Valeur de retour

annuler

FileToPDF(string chemin, PDFOptions options)COM

Spécifie un fichier HTML à convertir into un PDF.

Paramètres

• chemin - le chemin du fichier HTML à convertir into un PDF
  • Requis
• PDFOptions options - une instance de la classe PDFOptions qui définit les options spéciales à utiliser lors de la création d'un fichier PDF.
  • Requis pour COM sinon optionnel

Valeur de retour

annuler

PDFOptionsCOM

La classe représente toutes les options disponibles lors de la création de captures PDF.

Propriétés publiques

• string CustomId - un identifiant personnalisé que vous pouvez transmettre au webservice. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• bool IncludeBackground - si vrai, l'arrière-plan de la page Web devrait être inclus dans la capture d'écran
  • Par défaut: true
• PageSize PageSize - la taille de la page du PDF
  • Valeur par défaut: PageSize.A4
  • options: PageSize.A3, PageSize.A4, PageSize.A5, PageSize.A6, PageSize.B3, PageSize.B4, PageSize.B5, PageSize.B6, PageSize.Légal, PageSize.Lettre
• PageOrientation Orientation - l'orientation du document PDF
  • Valeur par défaut: PageOrientation.Portrait
  • options: PageOrientation.Portrait, PageOrientation.Paysage
• CSSMediaType CSSMediaType - la Type de média CSS du document PDF
  • Valeur par défaut: CSSMediaType.Écran
  • options: CSSMediaType.Écran, CSSMediaType.Print
• bool IncludeLinks - vrai si les liens doivent être inclus dans le PDF
  • Par défaut: true
• bool IncludeOutline - vrai si Signets PDF devrait être inclus
  • Par défaut: false
• string Title - donner un titre au document PDF
  • Par défaut: vide
• string CoverURL - l'URL d'une page Web qui devrait être utilisée comme page de couverture pour le PDF
  • Par défaut: vide
• int MarginTop - la marge en millimètres devant apparaître en haut de la page du document PDF
  • Par défaut: 10
• int MarginLeft - la marge en millimètres devant apparaître à gauche de la page du document PDF
  • Par défaut: 10
• int MarginBottom - la marge en millimètres qui devrait apparaître au bas de la page du document PDF
  • Par défaut: 10
• int MarginRight - la marge en millimètres devant apparaître à droite du document PDF
  • Par défaut: 10
• int BrowserWidth - la largeur du navigateur en pixels
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: 1024
  • Maximum: 10000
  • Largeur automatique: -1 (passant -1 signifie que la largeur du navigateur correspond à la largeur du document PDF)
• int PageWidth - la largeur personnalisée du PDF résultant en mm
  • Valeur par défaut: PageSize largeur
  • Minimum: 15mm
• int PageHeight - la hauteur personnalisée du PDF résultant en mm
  • Valeur par défaut: PageSize la taille
  • Minimum: 15mm
• int Delay - le nombre de millisecondes à attendez avant de prendre la capture d'écran
  • Par défaut: 0
  • Maximum: 30000
• BrowserType RequestAs - le type d'agent utilisateur que vous souhaitez utiliser
  • Valeur par défaut: BrowserType.StandardBrowser
  • options: BrowserType.StandardBrowser, BrowserType.MobileBrowser, BrowserType.Moteur de recherche, BrowserType.FallbackBrowser
• string TemplateId - ajouter un modèle ID spécifiant l'en-tête et le pied de page du document PDF
  • Par défaut: vide
• string TargetElement - l'identifiant ou la classe Sélecteur CSS du seul Élément HTML sur la page Web cible à tourner into un PDF, toutes les autres parties de la page Web sont ignorées. S'il y a plusieurs éléments HTML correspondants, le premier est choisi
  • Par défaut: vide
• string HideElement - l'identifiant ou la classe Sélecteurs CSS parmi un ou plusieurs éléments HTML de la page Web à masquer, permettant de spécifier plusieurs éléments HTML à masquer, séparer chaque sélecteur par une virgule
  • Par défaut: vide
• string WaitForElement - l'identifiant ou la classe Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
  • Par défaut: vide
• string CustomWaterMarkId - ajouter un filigrane personnalisé à chaque page du document PDF
  • Par défaut: vide
• int Quality - la qualité du PDF retourné. La valeur par défaut utilise la qualité recommandée pour le PDF.
  • Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
  • Par défaut: -1
  • Minimum: -1
  • Maximum: 100
• Country Country - le pays la capture d'écran doit être prise à partir de.
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: l'emplacement le plus rapide actuel
  • options: Pays.Singapour, Pays.ROYAUME-UNI, Pays.NOUS
• string ExportURL - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• string EncryptionKey - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• bool NoAds - si vrai les annonces doivent être automatiquement masquées.
  • Par défaut: false
• bool NoCookieNotifications - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
  • Par défaut: false
• string Address - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• string Proxy - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide
• string MergeId - l'identifiant d'une capture qui devrait être fusionné au début du nouveau document PDF
  • Par défaut: vide
• string Password - la mot de passe pour protéger le document PDF avec
  • Par défaut: vide

Méthodes publiques

• AddPostParameter (string prénom, string valeur) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post
• AddTemplateParameter (string prénom, string valeur) - définir un modèle personnalisé paramètre et valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres.
  • name - le nom du paramètre template
  • valeur - la valeur du paramètre template

URLToDOCX (string url, DOCXOptions options)COM

Spécifie l'URL à convertir into un DOCX.

Paramètres

• url - l'URL à convertir into un DOCX
  • Requis
• DOCXOptions options - une instance de DOCXOptions classe qui définit les options spéciales à utiliser lors de la création d'un fichier DOCX.
  • Requis pour COM sinon optionnel

Valeur de retour

annuler

HTMLToDOCX(string html, DOCXOptions options)COM

Spécifie le HTML à convertir into un DOCX.

Paramètres

• html - le HTML à convertir into un DOCX
  • Requis
• DOCXOptions options - une instance de GrabzItDOCXOptions classe qui définit les options spéciales à utiliser lors de la création d'un fichier DOCX.
  • Requis pour COM sinon optionnel

Valeur de retour

annuler

FileToDOCX(string chemin, DOCXOptions options)COM

Spécifie un fichier HTML à convertir into un DOCX.

Paramètres

• chemin - le chemin du fichier HTML à convertir into un DOCX
  • Requis
• DOCXOptions options - une instance de DOCXOptions classe qui définit les options spéciales à utiliser lors de la création d'un fichier DOCX.
  • Requis pour COM sinon optionnel

Valeur de retour

annuler

DOCXOptionsCOM

La classe représente toutes les options disponibles lors de la création de captures DOCX.

Propriétés publiques

• string CustomId - un identifiant personnalisé que vous pouvez transmettre au webservice. Cela sera retourné avec l'URL de rappel que vous avez spécifiée.
  • Par défaut: vide
• bool IncludeBackground - si vrai, les images d'arrière-plan de la page Web doivent être incluses dans le fichier DOCX
  • Par défaut: true
• PageSize PageSize - la taille de la page du DOCX
  • Valeur par défaut: PageSize.A4
  • options: PageSize.A3, PageSize.A4, PageSize.A5, PageSize.A6, PageSize.B3, PageSize.B4, PageSize.B5, PageSize.B6, PageSize.Légal, PageSize.Lettre
• PageOrientation Orientation - l'orientation du document DOCX
  • Valeur par défaut: PageOrientation.Portrait
  • options: PageOrientation.Portrait, PageOrientation.Paysage
• bool IncludeLinks - vrai si les liens doivent être inclus dans le DOCX
  • Par défaut: true
• bool IncludeImages - si vrai, les images de la page Web doivent être incluses dans le fichier DOCX
  • Par défaut: true
• string Title - donner un titre au document DOCX
  • Par défaut: vide
• int MarginTop - la marge en millimètres devant apparaître en haut de la page du document DOCX
  • Par défaut: 10
• int MarginLeft - la marge en millimètres devant apparaître à gauche de la page du document DOCX
  • Par défaut: 10
• int MarginBottom - la marge en millimètres devant apparaître au bas de la page du document DOCX
  • Par défaut: 10
• int MarginRight - la marge en millimètres devant figurer à droite du document DOCX
  • Par défaut: 10
• int BrowserWidth - la largeur du navigateur en pixels
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: 1024
  • Maximum: 10000
  • Largeur automatique: -1 (passer -1 signifie que la largeur du navigateur correspond à la largeur du document DOCX)
• int PageWidth - la largeur personnalisée du DOCX résultant en mm
  • Valeur par défaut: PageSize largeur
  • Minimum: 15mm
• int PageHeight - la hauteur personnalisée du DOCX résultant en mm
  • Valeur par défaut: PageSize la taille
  • Minimum: 15mm
• int Delay - le nombre de millisecondes à attendez avant de prendre la capture d'écran
  • Par défaut: 0
  • Maximum: 30000
• BrowserType RequestAs - le type d'agent utilisateur que vous souhaitez utiliser
  • Valeur par défaut: BrowserType.StandardBrowser
  • options: BrowserType.StandardBrowser, BrowserType.MobileBrowser, BrowserType.Moteur de recherche, BrowserType.FallbackBrowser
• string TemplateId - ajouter un modèle ID spécifiant l'en-tête et le pied de page du document DOCX
  • Par défaut: vide
• string TargetElement - l'identifiant ou la classe Sélecteur CSS du seul élément HTML sur la page Web cible à transformer into DOCX, toutes les autres parties de la page Web sont ignorées. S'il existe plusieurs éléments HTML correspondants, le premier est choisi
  • Par défaut: vide
• string HideElement - l'identifiant ou la classe Sélecteurs CSS parmi un ou plusieurs éléments HTML de la page Web à masquer, permettant de spécifier plusieurs éléments HTML à masquer, séparer chaque sélecteur par une virgule
  • Par défaut: vide
• string WaitForElement - l'identifiant ou la classe Sélecteurs CSS de l'élément HTML dans la page Web qui doit être visible avant que la capture soit effectuée
  • Par défaut: vide
• int Quality - la qualité du DOCX retourné. La valeur par défaut utilise la qualité recommandée pour le fichier DOCX.
  • Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
  • Par défaut: -1
  • Minimum: -1
  • Maximum: 100
• Country Country - le pays la capture d'écran doit être prise à partir de.
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: l'emplacement le plus rapide actuel
  • options: Pays.Singapour, Pays.ROYAUME-UNI, Pays.NOUS
• string ExportURL - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• string EncryptionKey - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• bool NoAds - si vrai les annonces doivent être automatiquement masquées.
  • Par défaut: false
• bool NoCookieNotifications - si vrai tous couramment trouvés les notifications de cookies doivent être automatiquement masquées.
  • Par défaut: false
• string Address - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• string Proxy - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide
• string MergeId - l'identifiant d'une capture qui devrait être fusionné au début du nouveau document DOCX
  • Par défaut: vide
• string Password - la mot de passe pour protéger le document DOCX avec
  • Par défaut: vide

Méthodes publiques

• AddPostParameter (string prénom, string valeur) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post
• AddTemplateParameter (string prénom, string valeur) - définir un modèle personnalisé paramètre et valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres.
  • name - le nom du paramètre template
  • valeur - la valeur du paramètre template

URLToTable(string url, TableOptions options)COM

Spécifie l'URL à partir de laquelle les tables HTML doivent être extraites.

Paramètres

• url - l'URL à partir de laquelle extraire les tables HTML
  • Requis
• TableOptions options - une instance de TableOptions classe qui définit les options spéciales à utiliser lors de la conversion du tableau HTML.
  • Requis pour COM sinon optionnel

Valeur de retour

annuler

HTMLToTable (string html, TableOptions options)COM

Spécifie le HTML à partir duquel les tables HTML doivent être extraites.

Paramètres

• html - HTML pour extraire les tables HTML.
  • Requis
• TableOptions options - une instance de TableOptions classe qui définit les options spéciales à utiliser lors de la conversion du tableau HTML.
  • Requis pour COM sinon optionnel

Valeur de retour

annuler

FileToTable (string chemin, TableOptions options)COM

Spécifie un fichier HTML à partir duquel les tables HTML doivent être extraites.

Paramètres

• chemin - le chemin du fichier HTML à partir duquel extraire les tableaux HTML.
  • Requis
• TableOptions options - une instance de TableOptions classe qui définit les options spéciales à utiliser lors de la conversion du tableau HTML.
  • Requis pour COM sinon optionnel

Valeur de retour

annuler

TableOptionsCOM

La classe représente toutes les options disponibles lors de la conversion de tableaux HTML en fichiers CSV, XLSX ou JSON.

Propriétés publiques

• string CustomId - un identifiant personnalisé que vous pouvez transmettre au webservice. Cela sera retourné avec l'URL de rappel que vous avez spécifiée
  • Par défaut: vide
• int TableNumberToInclude - l'index de la table à convertir, si toutes les tables d'une page Web sont ordonnées du haut de la page Web vers le bas
  • Par défaut: 1
• TableFormat Format - le format dans lequel le tableau doit être
  • Valeur par défaut: TableFormat. Csv
  • options: TableFormat.csv, TableFormat.json, TableFormat. Xlsx
• bool IncludeHeaderNames - si de vrais noms d'en-tête seront inclus dans la table
  • Par défaut: true
• bool IncludeAllTables - Si vrai, tous les tableaux de la page Web seront extraits, chaque tableau apparaissant dans une feuille de calcul distincte. Disponible uniquement avec le format XLSX
  • Par défaut: false
• string TargetElement - l'id du seul élément HTML de la page Web à utiliser pour extraire des tables de
  • Par défaut: vide
• BrowserType RequestAs - le type d'agent utilisateur que vous souhaitez utiliser
  • Valeur par défaut: BrowserType.StandardBrowser
  • options: BrowserType.StandardBrowser, BrowserType.MobileBrowser, BrowserType.Moteur de recherche, BrowserType.FallbackBrowser
• Country Country - le pays la capture d'écran doit être prise à partir de.
  • Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
  • Par défaut: l'emplacement le plus rapide actuel
  • options: Pays.Singapour, Pays.ROYAUME-UNI, Pays.NOUS
• string ExportURL - la URL d'exportation qui spécifie également où la capture doit être exportée
  • Par défaut: vide
• string EncryptionKey - si une clé de chiffrement AES codée 64 de base est spécifiée, votre capture est chiffrée lors de sa création. Il est recommandé d’utiliser le créer une méthode de clé de cryptage pour créer la clé et le déchiffrer les méthodes pour décrypter la capture cryptée comme indiqué dans cet exemple.
  • Par défaut: vide
• string Address - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise URL relatives pour les ressources telles que CSS et les images.
  • Par défaut: vide
• string Proxy - les détails du proxy HTTP le logiciel de navigation doit utiliser pour créer cette capture
  • Par défaut: vide

Méthodes publiques

• AddPostParameter (string prénom, string valeur) - définit un paramètre HTTP Post et éventuellement une valeur, cette méthode peut être appelée plusieurs fois pour ajouter plusieurs paramètres. Utiliser cette méthode forcera GrabzIt à effectuer un post HTTP.
  • name - le nom du paramètre HTTP Post
  • valeur - la valeur du paramètre HTTP Post

Save()

Save le résultat de manière asynchrone et renvoie un identifiant unique, qui peut être utilisé pour obtenir la capture d'écran avec le GetResult méthode.

Valeur de retour

L'identifiant unique de la capture d'écran sinon, si une erreur survient, une exception est levée. Ceci peut être utilisé pour obtenir la capture d'écran avec le GetResult méthode

Save(string URL de rappel)COM

Save le résultat de manière asynchrone et renvoie un identifiant unique, qui peut être utilisé pour obtenir la capture d'écran avec le GetResult méthode.

Paramètres

• callBackURL - le maître le service GrabzIt doit appeler après avoir terminé son travail
  • Requis

Valeur de retour

L'identifiant unique de la capture d'écran sinon, si une erreur survient, une exception est levée. Ceci peut être utilisé pour obtenir la capture d'écran avec le GetResult méthode

GrabzItFile SaveTo()

Save le résultat de manière synchrone à un GrabzItFile objet.

Valeur de retour

GrabzItFile objet

SaveTo(string saveToFile)COM

Save le résultat de manière synchrone à un fichier.

Paramètres

• saveToFile - le chemin du fichier capturé sera saved à une fois qu'il a été complété
  • Requis

Valeur de retour

retourne le vrai s'il réussit, sinon il lève une exception.

Statut GetStatus (string id)COM

Obtenir le statut actuel d'une capture d'écran GrabzIt.

Paramètres

• id - l'identifiant unique de la capture d'écran
  • Requis

Valeur de retour

Statut objet

GrabzItCookie [] GetCookies (string domaine)COM

Obtenez tous les cookies que GrabzIt utilise pour un domaine particulier. Cela peut également inclure les cookies définis par l'utilisateur.

Paramètres

• domain - le domaine pour lequel les cookies sont renvoyés
  • Requis

Valeur de retour

GrabzItCookie tableau

SetCookie (string prénom, string domaine, string valeur, string chemin, bool Honnêtement, DateTime? expire)COM

Définit un nouveau cookie personnalisé sur GrabzIt. Si le cookie personnalisé porte le même nom et le même domaine qu'un cookie global, le cookie global est remplacé.

Cela peut être utile si une fonctionnalité de site Web est contrôlée par des cookies.

Paramètres

• name - le nom du cookie à définir
  • Requis
• domain - le domaine du site Web pour définir le cookie pour
  • Requis
• valeur - la valeur du cookie
• chemin - le chemin du site auquel le cookie se rapporte
• httponly - si vrai, le cookie ne peut être utilisé qu'avec le protocole HTTP
• expires - définit quand le cookie expire. Passer une valeur nulle si le cookie ne doit pas expirer

Valeur de retour

Vrai si le cookie est installé avec succès, sinon faux

DeleteCookie (string prénom, string domaine)COM

Supprimer un cookie personnalisé ou bloquer l'utilisation d'un cookie global

Paramètres

• name - le nom du cookie à supprimer
  • Requis
• domain - le domaine du site Web pour supprimer le cookie pour
  • Requis

Valeur de retour

Vrai si le cookie est supprimé avec succès, sinon faux

WaterMark[] Obtenez unWaterMarks(String identifiant)COM

Obtenez tous vos filigranes personnalisés téléchargés

Valeur de retour

WaterMark tableau

WaterMark Obtenez unWaterMark(String identifiant)COM

Renvoie votre filigrane personnalisé qui correspond à l'identifiant spécifié

Paramètres

• identifiant - l'identifiant d'un filigrane personnalisé que vous voulez voir
  • Requis

Valeur de retour

WaterMark

AjoutezWaterMark(string identifiant, string chemin, HorizontalPosition xpos, VerticalPosition ypos)COM

Ajouter un nouveau filigrane personnalisé

Paramètres

• identifiant - l'identifiant que vous voulez donner au filigrane personnalisé. Il est important que cet identifiant soit unique.
  • Requis
• chemin - le chemin absolu du filigrane sur votre serveur. Par exemple C: /watermark/1.png
  • Requis
• xpos - la position horizontale dans laquelle vous voulez que la capture d'écran apparaisse
  • Requis
  • options: HorizontalPosition.La gauche, HorizontalPosition.Centre, HorizontalPosition.Droite
• ypos - position verticale sur laquelle vous voulez que la capture d'écran apparaisse
  • Requis
  • options: VerticalPosition.Haut, VerticalPosition.Milieu, VerticalPosition.Bas

Valeur de retour

renvoie vrai si le filigrane a été défini avec succès

DeleteWaterMark(string identifiant)COM

Supprimer un filigrane personnalisé

Paramètres

• identifiant - l'identifiant du filigrane personnalisé que vous souhaitez supprimer
  • Requis

Valeur de retour

renvoie vrai si le filigrane a été supprimé avec succès

SetLocalProxy (string proxyUrl)COM

Cette méthode permet une serveur proxy local à utiliser pour toutes les demandes.

Paramètres

• proxyUrl - l'URL, qui peut inclure un port si nécessaire, du proxy. Fournir une valeur nulle supprimera tout proxy précédemment défini
  • Requis

UseSSL (bool valeur)COM

Spécifie si les demandes à GrabzIt API devrait utiliser SSL

Paramètres

• valeur - si vrai, toutes les demandes adressées à l'API de GrabzIt utiliseront SSL
  • Requis

string CreateEncryptionKey ()COM

Créez une clé de chiffrement 64 de base sécurisée sur le plan cryptographique, longue de caractères 44.

Décrypter (string chemin, string clé)COM

Décryptez une capture cryptée à l'aide de la clé de cryptage fournie.

Paramètres

• chemin - le chemin de la capture cryptée
  • Requis
• clé - la clé de chiffrement
  • Requis

GrabzItFile Décrypter (GrabzItFile fichier, string clé)

Décryptez une capture cryptée à l'aide de la clé de cryptage fournie.

Paramètres

• fichier - le crypté GrabzItFile
  • Requis
• clé - la clé de chiffrement
  • Requis

byte [] Decrypt (byte [] data, string clé)

Décryptez une capture cryptée à l'aide de la clé de cryptage fournie.

Paramètres

• data - les octets cryptés
  • Requis
• clé - la clé de chiffrement
  • Requis

Enums

ImageFormat

Cette énumération comprend les valeurs suivantes.

• bmp8 = 0
• bmp16 = 1
• bmp24 = 2
• bmp = 3
• jpg = 4
• tiff = 5
• png = 6
• webp = 7

BrowserType

Cette énumération comprend les valeurs suivantes.

• Navigateur standard = 0
• MobileBrowser = 1
• SearchEngine = 2
• FallbackBrowser = 3

Pays

Cette énumération comprend les valeurs suivantes.

• Par défaut = 0
• Singapour = 1
• UK = 2
• US = 3

PageSize

Cette énumération comprend les valeurs suivantes.

• A3 = 0
• A4 = 1
• A5 = 2
• A6 = 3
• B3 = 4
• B4 = 5
• B5 = 6
• B6 = 7
• Légal = 8
• Lettre = 9

PageOrientation

Cette énumération comprend les valeurs suivantes.

• Paysage = 0
• Portrait = 1

CSSMediaType

Cette énumération comprend les valeurs suivantes.

• Écran = 0
• Print = 1

TableFormat

Cette énumération comprend les valeurs suivantes.

• CSV = 0
• json = 1
• xslx = 2

HorizontalPosition

Cette énumération comprend les valeurs suivantes.

• Gauche = 0
• Centre = 1
• Droite = 2

VerticalPosition

Cette énumération comprend les valeurs suivantes.

• Top = 0
• Milieu = 1
• Bas = 2

Classes de résultat

GrabzItCookieCOM

Propriétés publiques

• string Name
  • Le nom du cookie.
• string Value
  • La valeur du cookie.
• string Domain
  • Le domaine pour lequel le cookie est défini.
• string Path
  • Le chemin d'accès au domaine auquel ce cookie s'applique.
• string HttpOnly
  • Si ce cookie n'est valide que lorsque le site Web est visualisé avec le protocole HTTP.
• string Expires
  • La date d'expiration de ce cookie
• string Type
  • Il s'agit du type de cookie, qui peut être l'un des suivants:
    • Global - il s'agit d'un cookie global défini par GrabzIt
    • Local - il s'agit d'un cookie local défini par vous
    • Overridden - un cookie global que vous avez remplacé

GrabzItFileCOM

Méthodes publiques

• annuler Save(string Chemin)
  • chemin - le chemin vers save le résultat à
    • Requis
• string ÀString()

Propriétés publiques

• byte[] Bytes

StatutCOM

La classe représentant le statut actuel de la capture d'écran.

Propriétés publiques

• bool Processing
  • Si vrai, la capture d'écran est toujours en cours de traitement.
• bool Cached
  • Si la valeur est true, la capture d'écran a été traitée et est actuellement mise en cache.
• bool Expired
  • Si vrai, la capture d'écran n'est plus sur le système GrabzIt.
• string Message
  • Un message d'erreur renvoyé par le système.

WaterMarkCOM

Cette classe représente les filigranes personnalisés stockés dans GrabzIt

Méthodes publiques

• HorizontalPosition GetXPosition ()
• VerticalPosition GetYPosition ()

Propriétés publiques

• string Identifier
  • L'identifiant du filigrane
• string XPosition
  • La position horizontale du filigrane
    • À gauche
    • centre
    • Droite
• string YPosition
  • La position verticale du filigrane
    • Haut de page
    • Milieu
    • Bas
• string Format
  • Le format du filigrane