GrabzIt Client mit ASP.NET
Beschreibung
Diese Klasse verwaltet die gesamte Kommunikation mit den GrabzIt-Screenshot-Webdiensten. Alle mit gekennzeichneten Methoden COM funktionieren auch, wenn die GrabzIt ASP.NET DLL als COM-Objekt.
Öffentliche Methoden
- 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)
Diese Methode gibt den Screenshot selbst zurück. Wenn nichts zurückgegeben wird, ist ein Fehler aufgetreten oder der Screenshot ist noch nicht fertig.
Parameter
-
id - Die eindeutige Kennung des Screenshots
Rückgabewert
GrabzItFile Objekt
Geben Sie die URL des Online-Videos an, das konvertiert werden soll into ein animiertes GIF.
Parameter
-
url - Die URL des zu konvertierenden Online-Videos into ein animiertes GIF.
- Erforderlich
-
Akzeptiert Vimeo- und YouTube-Video-URLs
- Die Warnung, dass Vimeo- und YouTube-Videos animiert werden müssen, hängt von Dritten ab und liefert möglicherweise keine konsistenten Ergebnisse.
-
Optionen - eine Instanz der AnimationOptions Klasse, die spezielle Optionen definiert, die beim Erstellen des animierten GIF verwendet werden sollen.
- Benötigt für COM ansonsten optional
Rückgabewert
ungültig
AnimationOptionsCOM
NamespaceGrabzIt.Parameters
Die Klasse stellt alle Optionen dar, die beim Erstellen eines animierten GIF zur Verfügung stehen.
Öffentliche Eigenschaften
-
string CustomId - Benutzerdefinierte Kennung, die Sie an den animierten GIF-Webdienst übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
-
int Width - die Breite des resultierenden animierten GIF in Pixel.
- Standard: 180px
- Maximum: Maximale Breite für das Paket
- Automatische Größe: -1 (Übergabe von -1 bedeutet, dass die Breite des animiertes GIF wird skaliert In Bezug auf die Höhe kann die Höhe nicht angepasst werden, wenn die Breite automatisch angepasst wird.
-
int Height - Die Höhe des resultierenden animierten GIF in Pixel.
- Standard: 120px
- Maximum: Maximale Höhe für das Paket
- Automatische Größe: -1 (Übergabe von -1 bedeutet, dass die Höhe des animiertes GIF wird skaliert in Bezug auf die Breite, wenn die Höhe automatisch angepasst wird, kann die Breite nicht)
-
int Start - Die Startposition des Videos, das konvertiert werden soll into ein animiertes GIF.
- Voreinstellung: 0 Sekunden
-
int Duration - Die Länge des zu konvertierenden Videos in Sekunden into ein animiertes GIF.
- Standard: maximale Länge für das Paket
-
float Speed - die Geschwindigkeit des animierten GIF.
- Standard: 1
- Minimum: 0.2
- Maximum: 10
-
float FramesPerSecond - Die Anzahl der Bilder pro Sekunde, die aus dem Video aufgenommen werden sollen.
- Standard: 10
- Minimum: 0.2
- Maximum: 60
-
int Repeat - Häufigkeit, mit der das animierte GIF wiederholt wird.
- Standard: 0
- Endlosschleife: 0
- Schleife nie: -1
-
bool Reverse - Wenn true, werden die Frames des animierten GIF umgekehrt
-
string CustomWaterMarkId - Benutzerdefiniert hinzufügen watermark zum animierten GIF
-
int Quality - der Qualität des zurückgegebenen Bildes, die eine Standardkomprimierung von 85% hat.
- Durch Verringern der Qualität wird die Dateigröße verringert und die Downloadzeit verkürzt.
- Standardeinstellung: -1
- Minimum: -1
- Maximum: 100
-
Country Country - das Land Das animierte GIF sollte entnommen werden.
- Standard: Der aktuell schnellste Standort
- Zubehör: Land.Singapur, Land.VEREINIGTES KÖNIGREICH, Land.UNS
-
string ExportURL - der URL exportieren Hiermit wird festgelegt, wohin das Capture ebenfalls exportiert werden soll.
-
string EncryptionKey - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Es wird empfohlen, die zu verwenden Verschlüsselungsmethode erstellen den Schlüssel und die Methoden entschlüsseln um das verschlüsselte Capture wie in gezeigt zu entschlüsseln Dieses Beispiel.
-
string Proxy - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
URLToImage(string url, ImageOptions Optionen)COM
Gibt die URL an, die konvertiert werden soll into ein Bild Screenshot.
Parameter
-
url - die URL, aus der der Screenshot bestehen soll
-
Optionen - eine Instanz der ImageOptions Klasse, die spezielle Optionen definiert, die beim Erstellen des Screenshots verwendet werden sollen.
- Benötigt für COM ansonsten optional
Rückgabewert
ungültig
HTMLToImage(string html, ImageOptions Optionen)COM
Gibt den HTML-Code an, der konvertiert werden soll into ein Bild.
Parameter
-
html - das zu konvertierende HTML into ein Bild
- Optionen - eine Instanz der ImageOptions Klasse, die spezielle Optionen definiert, die beim Erstellen eines Bildes verwendet werden sollen.
Rückgabewert
ungültig
FileToImage(string Pfad, ImageOptions Optionen)COM
Gibt eine HTML-Datei an, die konvertiert werden soll into ein Bild.
Parameter
-
Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei into ein Bild
-
Optionen - eine Instanz der ImageOptions Klasse, die spezielle Optionen definiert, die beim Erstellen eines Bildes verwendet werden sollen.
- Benötigt für COM ansonsten optional
Rückgabewert
ungültig
ImageOptionsCOM
NamespaceGrabzIt.Parameters
Die Klasse stellt alle Optionen dar, die beim Erstellen von Bilderfassungen verfügbar sind.
Öffentliche Eigenschaften
-
string CustomId - Benutzerdefinierte Kennung, die Sie an den Screenshot-Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
-
int BrowserWidth - die Breite des Browsers in Pixel
- Standard: 1366
- Maximum: 10000
-
int BrowserHeight - die Höhe des Browsers in Pixel
- Standard: 1170
- Maximum: 10000
- Volle Länge: -1 (Die Übergabe von -1 bedeutet, dass ein Screenshot der gesamten Webseite erstellt wird.)
-
int OutputWidth - die Breite des resultierenden Thumbnails in Pixel
- Standard: Wenn sowohl die Ausgabebreite als auch die Ausgabehöhe nicht angegeben sind oder 0, stimmen die Ausgabebreite und -höhe mit der endgültigen Bildbreite und -höhe überein. Wenn die Ausgabehöhe angegeben wird, ist die Ausgabebreite proportional zur Ausgabehöhe
- Maximum: Maximale Breite für das Paket
- Volle Breite: -1 (Das Übergeben von -1 bedeutet, dass die Breite des Thumbnails nicht verringert wird.)
-
int OutputHeight - Die Höhe des resultierenden Thumbnails in Pixel
- Standard: Wenn sowohl die Ausgabebreite als auch die Ausgabehöhe nicht angegeben sind oder 0, stimmen die Ausgabebreite und -höhe mit der endgültigen Bildbreite und -höhe überein. Wenn die Ausgabebreite angegeben wird, ist die Ausgabehöhe proportional zur Ausgabebreite
- Maximum: Maximale Höhe für das Paket
- Volle Höhe: -1 (Das Übergeben von -1 bedeutet, dass die Höhe des Thumbnails nicht verringert wird.)
-
ImageFormat Format - Das Format, in dem der Screenshot angezeigt werden soll.
-
int Delay - die Anzahl der Millisekunden bis Warten Sie, bevor Sie den Screenshot aufnehmen
- Standard: 0
- Maximum: 30000
-
string ClickElement - Dies gibt das HTML-Element mit a an CSS-Selektor klicken. Denken Sie daran, dass auch eine Verzögerung erforderlich sein kann, um die Auswirkungen des Klicks anzuzeigen
- Voreinstellung: leer
- Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
-
string TargetElement - der CSS-Selektor des einzigen HTML-Elements auf der Zielwebseite, das gedreht werden soll intAls Screenshot werden alle anderen Teile der Webseite ignoriert. Wenn mehrere übereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgewählt
-
string HideElement - der CSS-Selektoren Wenn Sie festlegen möchten, dass mehrere HTML-Elemente auf der Webseite ausgeblendet werden sollen, trennen Sie jeden Selektor durch ein Komma
-
string WaitForElement - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
-
BrowserType RequestAs - die Art des Benutzeragenten, den Sie verwenden möchten
-
string CustomWaterMarkId - Fügen Sie eine benutzerdefinierte watermark zum Bild
-
int Quality - der Qualität des zurückgegebenen Bildes. Dies betrifft derzeit nur JPG- und WEBP-Bilder mit einer Standardkomprimierung von 90%.
- Durch Verringern der Qualität wird die Dateigröße verringert und die Downloadzeit verkürzt.
- Standardeinstellung: -1
- Minimum: -1
- Maximum: 100
-
bool Transparent - Wenn wahr, wenn der Die Bildaufnahme sollte transparent sein. Dies ist nur mit PNG- und TIFF-Bildern kompatibel.
-
bool HD - Wenn das Bild wahr ist Die Aufnahme erfolgt in High Definition Dies verdoppelt die Größe der Bildabmessungen.
-
Country Country - das Land Der Screenshot sollte von genommen werden.
- Standard: Der aktuell schnellste Standort
- Zubehör: Land.Singapur, Land.VEREINIGTES KÖNIGREICH, Land.UNS
-
string ExportURL - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
-
string EncryptionKey - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Es wird empfohlen, die zu verwenden Verschlüsselungsmethode erstellen den Schlüssel und die Methoden entschlüsseln um das verschlüsselte Capture wie in gezeigt zu entschlüsseln Dieses Beispiel.
-
bool NoAds - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
-
bool NoCookieNotifications - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
-
string Address - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann nützlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs für Ressourcen wie CSS und Bilder.
-
string Proxy - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
Öffentliche Methoden
-
AddPostParameter (string Name, string Wert) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzufügen. Mit dieser Methode wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
- name - Der Name des HTTP-Post-Parameters
- value - Der Wert des HTTP-Post-Parameters
URLToRenderedHTML(string url, HTMLOptions Optionen)COM
Gibt die URL an, die konvertiert werden soll into gerendertes HTML.
Parameter
-
url - die URL, aus der das gerenderte HTML bestehen soll
-
Optionen - eine Instanz der HTMLOptions Klasse, die spezielle Optionen definiert, die beim Erstellen des gerenderten HTML-Codes verwendet werden sollen.
- Benötigt für COM ansonsten optional
Rückgabewert
ungültig
HTMLToRenderedHTML(string html, HTMLOptions Optionen)COM
Gibt den HTML-Code an, der konvertiert werden soll into gerendertes HTML.
Parameter
-
html - das zu konvertierende HTML into gerendertes HTML
- Optionen - eine Instanz der HTMLOptions Klasse, die spezielle Optionen definiert, die beim Erstellen von gerendertem HTML verwendet werden sollen.
Rückgabewert
ungültig
FileToRenderedHTML(string Pfad, HTMLOptions Optionen)COM
Gibt eine HTML-Datei an, die konvertiert werden soll into gerendertes HTML.
Parameter
-
Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei into gerendertes HTML
-
Optionen - eine Instanz der HTMLOptions Klasse, die spezielle Optionen definiert, die beim Erstellen von gerendertem HTML verwendet werden sollen.
- Benötigt für COM ansonsten optional
Rückgabewert
ungültig
HTMLOptionsCOM
NamespaceGrabzIt.Parameters
Die Klasse stellt alle verfügbaren Optionen dar, wenn Erstellen von gerenderten HTML-Captures.
Öffentliche Eigenschaften
-
string CustomId - Benutzerdefinierte Kennung, die Sie an den gerenderten HTML-Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
-
int BrowserWidth - die Breite des Browsers in Pixel
- Standard: 1366
- Maximum: 10000
-
int BrowserHeight - die Höhe des Browsers in Pixel
- Standard: 1170
- Maximum: 10000
-
int Delay - die Anzahl der Millisekunden bis Warten Sie, bevor Sie den gerenderten HTML-Code übernehmen
- Standard: 0
- Maximum: 30000
-
string WaitForElement - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
-
BrowserType RequestAs - die Art des Benutzeragenten, den Sie verwenden möchten
-
Country Country - das Land Der gerenderte HTML-Code sollte entnommen werden.
- Standard: Der aktuell schnellste Standort
- Zubehör: Land.Singapur, Land.VEREINIGTES KÖNIGREICH, Land.UNS
-
string ExportURL - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
-
string EncryptionKey - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Es wird empfohlen, die zu verwenden Verschlüsselungsmethode erstellen den Schlüssel und die Methoden entschlüsseln um das verschlüsselte Capture wie in gezeigt zu entschlüsseln Dieses Beispiel.
-
bool NoAds - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
-
bool NoCookieNotifications - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
-
string Address - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann nützlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs für Ressourcen wie CSS und Bilder.
-
string Proxy - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
Öffentliche Methoden
-
AddPostParameter (string Name, string Wert) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzufügen. Mit dieser Methode wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
- name - Der Name des HTTP-Post-Parameters
- value - Der Wert des HTTP-Post-Parameters
URLToPDF(string url, PDFOptions Optionen)COM
Gibt die URL an, die konvertiert werden soll into ein PDF.
Parameter
-
url - die URL, die konvertiert werden soll into ein PDF
-
PDFOptions options - Eine Instanz der PDFOptions-Klasse, die alle speziellen Optionen definiert, die beim Erstellen einer PDF-Datei verwendet werden sollen.
- Benötigt für COM ansonsten optional
Rückgabewert
ungültig
HTMLToPDF(string html, PDFOptions Optionen)COM
Gibt den HTML-Code an, der konvertiert werden soll into ein PDF.
Parameter
-
html - das zu konvertierende HTML into ein PDF
-
PDFOptions options - Eine Instanz der GrabzItPDFOptions-Klasse, die alle speziellen Optionen definiert, die beim Erstellen einer PDF-Datei verwendet werden sollen.
- Benötigt für COM ansonsten optional
Rückgabewert
ungültig
FileToPDF(string Pfad, PDFOptions Optionen)COM
Gibt eine HTML-Datei an, die konvertiert werden soll into ein PDF.
Parameter
-
Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei into ein PDF
-
PDFOptions options - Eine Instanz der PDFOptions-Klasse, die alle speziellen Optionen definiert, die beim Erstellen einer PDF-Datei verwendet werden sollen.
- Benötigt für COM ansonsten optional
Rückgabewert
ungültig
PDFOptionsCOM
NamespaceGrabzIt.Parameters
Die Klasse stellt alle Optionen dar, die beim Erstellen von PDF-Captures verfügbar sind.
Öffentliche Eigenschaften
-
string CustomId - eine benutzerdefinierte Kennung, die Sie an den Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
-
bool IncludeBackground - Wenn dies zutrifft, sollte der Hintergrund der Webseite im Screenshot enthalten sein
-
PageSize PageSize - die Seitengröße des PDF
-
PageOrientation Orientation - die Ausrichtung des PDF-Dokuments
-
CSSMediaType CSSMediaType - der CSS-Medientyp des PDF-Dokuments
-
bool IncludeLinks - true, wenn Links in das PDF aufgenommen werden sollen
-
bool IncludeOutline - wahr wenn PDF Lesezeichen das sollte dabei sein
-
string Title - Geben Sie dem PDF-Dokument einen Titel
-
string CoverURL - Die URL einer Webseite, die als Deckblatt für das PDF verwendet werden soll
-
int MarginTop - Der Rand in Millimetern, der oben auf der PDF-Dokumentseite angezeigt werden soll
-
int MarginLeft - Der Rand in Millimetern, der links auf der PDF-Dokumentseite angezeigt werden soll
-
int MarginBottom - Der Rand in Millimetern, der am unteren Rand der PDF-Dokumentseite angezeigt werden soll
-
int MarginRight - Der Rand in Millimetern, der rechts vom PDF-Dokument angezeigt werden soll
-
int BrowserWidth - der Breite des Browsers in Pixeln
- Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
- Standard: 1366
- Maximum: 10000
- Automatische Breite: -1 (Übergabe von -1 bedeutet, dass die Breite des Browsers mit der Breite des PDF-Dokuments übereinstimmt.)
-
int PageWidth - der benutzerdefinierte Breite der resultierenden PDF in mm
-
int PageHeight - der Benutzerdefinierte Höhe der resultierenden PDF in mm
-
int Delay - die Anzahl der Millisekunden bis Warten Sie, bevor Sie den Screenshot aufnehmen
- Standard: 0
- Maximum: 30000
-
BrowserType RequestAs - die Art des Benutzeragenten, den Sie verwenden möchten
-
string TemplateId - füge hinzu ein Vorlage ID, die die Kopf- und Fußzeile des PDF-Dokuments angibt
-
string ClickElement - Dies gibt das HTML-Element mit a an CSS-Selektor klicken. Denken Sie daran, dass auch eine Verzögerung erforderlich sein kann, um die Auswirkungen des Klicks anzuzeigen
- Voreinstellung: leer
- Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
-
string TargetElement - der CSS-Selektor der einzige HTML-Element auf der Zielwebseite, die gedreht werden soll into ein PDFwerden alle anderen Teile der Webseite ignoriert. Wenn mehrere übereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgewählt
-
string HideElement - der CSS-Selektoren Wenn Sie festlegen möchten, dass mehrere HTML-Elemente auf der Webseite ausgeblendet werden sollen, trennen Sie jeden Selektor durch ein Komma
-
string WaitForElement - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
-
string CustomWaterMarkId - Fügen Sie eine benutzerdefinierte watermark zu jeder Seite des PDF-Dokuments
-
int Quality - der Qualität der zurückgegebenen PDF. Die Standardeinstellung verwendet die empfohlene Qualität für das PDF.
- Durch Verringern der Qualität wird die Dateigröße verringert und die Downloadzeit verkürzt.
- Standardeinstellung: -1
- Minimum: -1
- Maximum: 100
-
Country Country - das Land Der Screenshot sollte von genommen werden.
- Standard: Der aktuell schnellste Standort
- Zubehör: Land.Singapur, Land.VEREINIGTES KÖNIGREICH, Land.UNS
-
string ExportURL - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
-
string EncryptionKey - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Es wird empfohlen, die zu verwenden Verschlüsselungsmethode erstellen den Schlüssel und die Methoden entschlüsseln um das verschlüsselte Capture wie in gezeigt zu entschlüsseln Dieses Beispiel.
-
bool NoAds - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
-
bool NoCookieNotifications - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
-
string Address - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann nützlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs für Ressourcen wie CSS und Bilder.
-
string Proxy - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
-
string MergeId - die ID eines Captures, das sein soll am Anfang des neuen PDF-Dokuments zusammengeführt
-
string Password - der Passwort zum Schutz des PDF-Dokuments mit
Öffentliche Methoden
-
AddPostParameter (string Name, string Wert) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzufügen. Mit dieser Methode wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
- name - Der Name des HTTP-Post-Parameters
- value - Der Wert des HTTP-Post-Parameters
-
AddTemplateParameter (string Name, string Wert) - definiere a benutzerdefinierte Vorlage Parameter und Wert, diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzufügen.
- name - Der Name des Vorlagenparameters
- value - Der Wert des Vorlagenparameters
URLToDOCX (string url, DOCXOptions Optionen)COM
Gibt die URL an, die konvertiert werden soll intoa DOCX.
Parameter
-
url - die URL, die konvertiert werden soll intoa DOCX
-
DOCXOptions options - eine Instanz der DOCXOptions Klasse, die spezielle Optionen definiert, die beim Erstellen einer DOCX verwendet werden sollen.
- Benötigt für COM ansonsten optional
Rückgabewert
ungültig
HTMLToDOCX(string html, DOCXOptions Optionen)COM
Gibt den HTML-Code an, der konvertiert werden soll intoa DOCX.
Parameter
-
html - das zu konvertierende HTML intoa DOCX
-
DOCXOptions options - eine Instanz des GrabzItDOCXOptions Klasse, die spezielle Optionen definiert, die beim Erstellen einer DOCX verwendet werden sollen.
- Benötigt für COM ansonsten optional
Rückgabewert
ungültig
FileToDOCX(string Pfad, DOCXOptions Optionen)COM
Gibt eine HTML-Datei an, die konvertiert werden soll intoa DOCX.
Parameter
-
Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei intoa DOCX
-
DOCXOptions options - eine Instanz der DOCXOptions Klasse, die spezielle Optionen definiert, die beim Erstellen einer DOCX verwendet werden sollen.
- Benötigt für COM ansonsten optional
Rückgabewert
ungültig
DOCXOptionsCOM
NamespaceGrabzIt.Parameters
Die Klasse stellt alle Optionen dar, die beim Erstellen von DOCX-Captures verfügbar sind.
Öffentliche Eigenschaften
-
string CustomId - eine benutzerdefinierte Kennung, die Sie an den Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
-
bool IncludeBackground - Wenn dies zutrifft, sollten die Hintergrundbilder der Webseite in die DOCX aufgenommen werden
-
PageSize PageSize - die Seitengröße des DOCX
-
PageOrientation Orientation - die Ausrichtung des DOCX-Dokuments
-
bool IncludeLinks - true, wenn Links in die DOCX aufgenommen werden sollen
-
bool IncludeImages - Wenn dies zutrifft, sollten die Bilder der Webseite in die DOCX aufgenommen werden
-
string Title - Geben Sie dem DOCX-Dokument einen Titel
-
int MarginTop - Der Rand in Millimetern, der oben auf der DOCX-Dokumentseite angezeigt werden soll
-
int MarginLeft - Der Rand in Millimetern, der links auf der DOCX-Dokumentseite angezeigt werden soll
-
int MarginBottom - Der Rand in Millimetern, der am unteren Rand der DOCX-Dokumentseite angezeigt werden soll
-
int MarginRight - der Rand in Millimetern, der rechts vom DOCX-Dokument angezeigt werden soll
-
int BrowserWidth - der Breite des Browsers in Pixeln
- Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
- Standard: 1366
- Maximum: 10000
- Automatische Breite: -1 (Übergabe von -1 bedeutet, dass die Breite des Browsers mit der Breite des DOCX-Dokuments übereinstimmt.)
-
int PageWidth - der benutzerdefinierte Breite des resultierenden DOCX in mm
-
int PageHeight - der benutzerdefinierte Höhe des resultierenden DOCX in mm
-
int Delay - die Anzahl der Millisekunden bis Warten Sie, bevor Sie den Screenshot aufnehmen
- Standard: 0
- Maximum: 30000
-
BrowserType RequestAs - die Art des Benutzeragenten, den Sie verwenden möchten
-
string TemplateId - füge hinzu ein Vorlage ID, die die Kopf- und Fußzeile des DOCX-Dokuments angibt
-
string ClickElement - Dies gibt das HTML-Element mit a an CSS-Selektor klicken. Denken Sie daran, dass auch eine Verzögerung erforderlich sein kann, um die Auswirkungen des Klicks anzuzeigen
- Voreinstellung: leer
- Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
-
string TargetElement - der CSS-Selektor des einzigen HTML-Elements auf der Zielwebseite, das gedreht werden soll intoa DOCX werden alle anderen Teile der Webseite ignoriert. Wenn mehrere übereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgewählt
-
string HideElement - der CSS-Selektoren Wenn Sie festlegen möchten, dass mehrere HTML-Elemente auf der Webseite ausgeblendet werden sollen, trennen Sie jeden Selektor durch ein Komma
-
string WaitForElement - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
-
int Quality - der Qualität des zurückgesandten DOCX. Die Standardeinstellung verwendet die empfohlene Qualität für die DOCX.
- Durch Verringern der Qualität wird die Dateigröße verringert und die Downloadzeit verkürzt.
- Standardeinstellung: -1
- Minimum: -1
- Maximum: 100
-
Country Country - das Land Der Screenshot sollte von genommen werden.
- Standard: Der aktuell schnellste Standort
- Zubehör: Land.Singapur, Land.VEREINIGTES KÖNIGREICH, Land.UNS
-
string ExportURL - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
-
string EncryptionKey - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Es wird empfohlen, die zu verwenden Verschlüsselungsmethode erstellen den Schlüssel und die Methoden entschlüsseln um das verschlüsselte Capture wie in gezeigt zu entschlüsseln Dieses Beispiel.
-
bool NoAds - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
-
bool NoCookieNotifications - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
-
string Address - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann nützlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs für Ressourcen wie CSS und Bilder.
-
string Proxy - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
-
string MergeId - die ID eines Captures, das sein soll am Anfang des neuen DOCX-Dokuments zusammengeführt
-
string Password - der Passwort zum Schutz des DOCX-Dokuments mit
Öffentliche Methoden
-
AddPostParameter (string Name, string Wert) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzufügen. Mit dieser Methode wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
- name - Der Name des HTTP-Post-Parameters
- value - Der Wert des HTTP-Post-Parameters
-
AddTemplateParameter (string Name, string Wert) - definiere a benutzerdefinierte Vorlage Parameter und Wert, diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzufügen.
- name - Der Name des Vorlagenparameters
- value - Der Wert des Vorlagenparameters
URLToTable(string url, TableOptions Optionen)COM
Gibt die URL an, aus der die HTML-Tabellen extrahiert werden sollen.
Parameter
-
url - die URL, aus der HTML-Tabellen extrahiert werden sollen
-
TableOptions options - eine Instanz der TableOptions Klasse, die spezielle Optionen für die Konvertierung der HTML-Tabelle definiert.
- Benötigt für COM ansonsten optional
Rückgabewert
ungültig
HTMLToTable (string html, TableOptions Optionen)COM
Gibt den HTML-Code an, aus dem die HTML-Tabellen extrahiert werden sollen.
Parameter
-
html - das HTML, aus dem HTML-Tabellen extrahiert werden sollen.
-
TableOptions options - eine Instanz der TableOptions Klasse, die spezielle Optionen für die Konvertierung der HTML-Tabelle definiert.
- Benötigt für COM ansonsten optional
Rückgabewert
ungültig
FileToTable (string Pfad, TableOptions Optionen)COM
Gibt eine HTML-Datei an, aus der die HTML-Tabellen extrahiert werden sollen.
Parameter
-
path - Der Dateipfad einer HTML-Datei, aus der HTML-Tabellen extrahiert werden sollen.
-
TableOptions options - eine Instanz der TableOptions Klasse, die spezielle Optionen für die Konvertierung der HTML-Tabelle definiert.
- Benötigt für COM ansonsten optional
Rückgabewert
ungültig
TableOptionsCOM
NamespaceGrabzIt.Parameters
Die Klasse stellt alle Optionen dar, die beim Konvertieren von HTML-Tabellen in CSV, XLSX oder JSON verfügbar sind.
Öffentliche Eigenschaften
-
string CustomId - eine benutzerdefinierte Kennung, die Sie an den Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben
-
int TableNumberToInclude - Der Index der zu konvertierenden Tabelle, in dem alle Tabellen einer Webseite von oben nach unten angeordnet sind
-
TableFormat Format - das Format, in dem die Tabelle sein soll
-
bool IncludeHeaderNames - ob echte Headernamen in die Tabelle aufgenommen werden
-
bool IncludeAllTables - Wenn true, werden alle Tabellen auf der Webseite extrahiert, wobei jede Tabelle in einem separaten Arbeitsblatt angezeigt wird. Nur im XLSX-Format verfügbar
-
string TargetElement - Die ID des einzigen HTML-Elements auf der Webseite, aus dem Tabellen extrahiert werden sollen
-
BrowserType RequestAs - die Art des Benutzeragenten, den Sie verwenden möchten
-
Country Country - das Land Der Screenshot sollte von genommen werden.
- Standard: Der aktuell schnellste Standort
- Zubehör: Land.Singapur, Land.VEREINIGTES KÖNIGREICH, Land.UNS
-
string ExportURL - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
-
string EncryptionKey - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Es wird empfohlen, die zu verwenden Verschlüsselungsmethode erstellen den Schlüssel und die Methoden entschlüsseln um das verschlüsselte Capture wie in gezeigt zu entschlüsseln Dieses Beispiel.
-
string Address - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann nützlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs für Ressourcen wie CSS und Bilder.
-
string Proxy - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
Öffentliche Methoden
-
AddPostParameter (string Name, string Wert) - Definiert einen HTTP-Post-Parameter und optional einen Wert. Diese Methode kann mehrmals aufgerufen werden, um mehrere Parameter hinzuzufügen. Mit dieser Methode wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
- name - Der Name des HTTP-Post-Parameters
- value - Der Wert des HTTP-Post-Parameters
Save()
Save das Ergebnis asynchron und gibt eine eindeutige Kennung zurück, mit der der Screenshot mit dem abgerufen werden kann GetResult Methode.
Rückgabewert
Andernfalls wird die eindeutige Kennung des Screenshots ausgelöst, wenn ein Fehler aufgetreten ist. Dies kann verwendet werden, um den Screenshot mit dem zu erhalten GetResult Methode
Dies ist die empfohlene Methode zum Speichern einer Datei
Save(string callBackURL)COM
Save das Ergebnis asynchron und gibt eine eindeutige Kennung zurück, mit der der Screenshot mit dem abgerufen werden kann GetResult Methode.
Parameter
-
callBackURL - die Handler Der GrabzIt-Dienst sollte anrufen, nachdem er seine Arbeit abgeschlossen hat
Rückgabewert
Andernfalls wird die eindeutige Kennung des Screenshots ausgelöst, wenn ein Fehler aufgetreten ist. Dies kann verwendet werden, um den Screenshot mit dem zu erhalten GetResult Methode
Warnung: Diese Methode ist synchron, sodass eine Anwendung angehalten wird, während das Ergebnis verarbeitet wird
Save das Ergebnis synchron zu a GrabzItFile Objekt.
Rückgabewert
GrabzItFile Objekt
Save das Ergebnis asynchron zu a GrabzItFile Objekt. Nur verfügbar, wenn die Version von .NET asynchrone Methoden unterstützt.
Rückgabewert
GrabzItFile Objekt
Warnung: Diese Methode ist synchron, sodass eine Anwendung angehalten wird, während das Ergebnis verarbeitet wird
SaveTo(string saveToDatei)COM
Save das Ergebnis synchron zu einer Datei.
Parameter
-
saveToDatei - Der Dateipfad, der erfasst wird saved bis sobald es abgeschlossen ist
Rückgabewert
Gibt true zurück, wenn es erfolgreich ist, andernfalls wird eine Ausnahme ausgelöst.
SaveToAsynchron (string saveToDatei)
Save das Ergebnis asynchron in eine Datei. Nur verfügbar, wenn die Version von .NET asynchrone Methoden unterstützt.
Parameter
-
saveToDatei - Der Dateipfad, der erfasst wird saved bis sobald es abgeschlossen ist
Rückgabewert
Gibt true zurück, wenn es erfolgreich ist, andernfalls wird eine Ausnahme ausgelöst.
Kategorie Status bekommen(string Ich würde)COM
Holen Sie sich den aktuellen Status eines GrabzIt-Screenshots.
Parameter
-
id - Die eindeutige Kennung des Screenshots
Rückgabewert
Kategorie Objekt
Holen Sie sich alle Cookies, die GrabzIt für eine bestimmte Domain verwendet. Dies kann auch benutzerdefinierte Cookies beinhalten.
Parameter
-
domain - Die Domain, für die Cookies zurückgegeben werden sollen
Rückgabewert
GrabzItCookie Array
SetCookie (string Name, string Domain, string Wert, string Pfad, bool httponly, DateTime? läuft ab)COM
Legt ein neues benutzerdefiniertes Cookie für GrabzIt fest. Wenn das benutzerdefinierte Cookie denselben Namen und dieselbe Domäne wie ein globales Cookie hat, wird das globale Cookie überschrieben.
Dies kann hilfreich sein, wenn die Funktionalität einer Website durch Cookies gesteuert wird.
Parameter
-
name - Der Name des zu setzenden Cookies
-
domain - Die Domain der Website, für die das Cookie festgelegt werden soll
- value - der Wert des Cookies
- Pfad - Der Website-Pfad, auf den sich das Cookie bezieht
- httponly - Wenn dies zutrifft, kann der Cookie nur mit dem HTTP-Protokoll verwendet werden
- abläuft - Legt fest, wann der Cookie abläuft. Übergeben Sie einen Nullwert, wenn das Cookie nicht ablaufen soll
Rückgabewert
True, wenn das Cookie erfolgreich gesetzt wurde, andernfalls false
DeleteCookie (string Name, string Domain)COM
Löschen Sie ein benutzerdefiniertes Cookie oder blockieren Sie die Verwendung eines globalen Cookies
Parameter
-
name - Der Name des zu löschenden Cookies
-
domain - Die Domain der Website, für die das Cookie gelöscht werden soll
Rückgabewert
True, wenn der Cookie erfolgreich gelöscht wurde, andernfalls false
WaterMark[] Erhalten Sie WaterMarks(String Kennung)COM
Holen Sie sich alle Ihre hochgeladenen benutzerdefinierten watermarks
Rückgabewert
WaterMark Array
WaterMark Erhalten Sie WaterMark(String Kennung)COM
Geben Sie Ihre Gewohnheit zurück watermark das entspricht der angegebenen Kennung
Parameter
-
bezeichner - der bezeichner eines bestimmten benutzerdefinierten watermark Sie möchten anzeigen
Rückgabewert
WaterMark
Fügen Sie einen neuen Benutzer hinzu watermark
Parameter
-
Bezeichner - Der Bezeichner, den Sie dem Benutzer geben möchten watermark. Es ist wichtig, dass diese Kennung eindeutig ist.
-
Pfad - der absolute Pfad des watermark auf Ihrem Server. Zum Beispiel C: /watermark/1.png
-
xpos - Die horizontale Position, an der der Screenshot angezeigt werden soll
-
ypos - vertikale Position, an der der Screenshot angezeigt werden soll
Rückgabewert
gibt true zurück, wenn die watermark wurde erfolgreich eingestellt
DeleteWaterMark(string Kennung)COM
Löschen Sie eine benutzerdefinierte watermark
Parameter
-
bezeichner - der bezeichner des benutzerdefinierten watermark Sie möchten löschen
Rückgabewert
gibt true zurück, wenn die watermark wurde erfolgreich gelöscht
SetLocalProxy (string proxyUrl)COM
Diese Methode ermöglicht a lokaler Proxy-Server für alle Anfragen zu verwenden.
Parameter
-
proxyUrl - Die URL des Proxys, die bei Bedarf einen Port enthalten kann. Wenn Sie eine Null angeben, werden alle zuvor festgelegten Proxys entfernt
UseSSL (bool Wert)COM
Gibt an, ob Anfragen an GrabzIt gesendet werden sollen API sollte SSL verwenden
Parameter
-
value - Wenn true, verwenden alle Anforderungen an die GrabzIt-API SSL
string CreateEncryptionKey ()COM
Erstellen Sie einen kryptografisch sicheren Basis-64-Verschlüsselungsschlüssel mit 44-Zeichen.
Entschlüsseln (string Pfad, string Schlüssel)COM
Entschlüsseln Sie ein verschlüsseltes Capture mit dem angegebenen Verschlüsselungsschlüssel.
Parameter
GrabzItFile Entschlüsseln (GrabzItFile Datei, string Schlüssel)
Entschlüsseln Sie ein verschlüsseltes Capture mit dem angegebenen Verschlüsselungsschlüssel.
Parameter
Byte [] Entschlüsseln (Byte [] Daten, string Schlüssel)
Entschlüsseln Sie ein verschlüsseltes Capture mit dem angegebenen Verschlüsselungsschlüssel.
Parameter
Verwenden Sie beim Festlegen der Aufzählungseigenschaften in COM-Objekten stattdessen den entsprechenden numerischen Wert für die Aufzählung.
Enums
ImageFormat
NamespaceGrabzIt.Enums
Diese Aufzählung umfasst die folgenden Werte.
- bmp8 = 0
- bmp16 = 1
- bmp24 = 2
- bmp = 3
- jpg = 4
- tiff = 5
- png = 6
- webp = 7
BrowserType
NamespaceGrabzIt.Enums
Diese Aufzählung umfasst die folgenden Werte.
- StandardBrowser = 0
- MobileBrowser = 1
- SearchEngine = 2
Land
NamespaceGrabzIt.Enums
Diese Aufzählung umfasst die folgenden Werte.
- Standard = 0
- Singapur = 1
- UK = 2
- US = 3
PageSize
NamespaceGrabzIt.Enums
Diese Aufzählung umfasst die folgenden Werte.
- A3 = 0
- A4 = 1
- A5 = 2
- A6 = 3
- B3 = 4
- B4 = 5
- B5 = 6
- B6 = 7
- Legal = 8
- Buchstabe = 9
PageOrientation
NamespaceGrabzIt.Enums
Diese Aufzählung umfasst die folgenden Werte.
- Querformat = 0
- Hochformat = 1
CSSMediaType
NamespaceGrabzIt.Enums
Diese Aufzählung umfasst die folgenden Werte.
TableFormat
NamespaceGrabzIt.Enums
Diese Aufzählung umfasst die folgenden Werte.
- csv = 0
- json = 1
- xslx = 2
HorizontalPosition
NamespaceGrabzIt.Enums
Diese Aufzählung umfasst die folgenden Werte.
- Links = 0
- Mitte = 1
- Rechts = 2
VerticalPosition
NamespaceGrabzIt.Enums
Diese Aufzählung umfasst die folgenden Werte.
- Oben = 0
- Mittel = 1
- Unten = 2
Ergebnisklassen
GrabzItCookieCOM
NamespaceGrabzIt.Cookies
Öffentliche Eigenschaften
-
string Name
-
string Value
-
string Domain
- Die Domain, für die das Cookie gesetzt ist.
-
string Path
- Der Pfad in der Domäne, für die dieses Cookie gilt.
-
string HttpOnly
- Wenn dieses Cookie nur gültig ist, wenn die Website mit dem HTTP-Protokoll angezeigt wird.
-
string Expires
- Das Datum, an dem dieses Cookie abläuft
-
string Type
-
Hierbei handelt es sich um einen der folgenden Cookie-Typen:
- Global - Dies ist ein globales Cookie, das von GrabzIt gesetzt wird
- Lokal - Dies ist ein von Ihnen festgelegtes lokales Cookie
- Überschrieben - Ein globales Cookie, das von Ihnen überschrieben wurde
GrabzItFileCOM
NamespaceGrabzIt.Screenshots
Öffentliche Methoden
-
ungültig Save(string Pfad)
-
Pfad - der Pfad zu save das ergebnis zu
- string ZuString()
Öffentliche Eigenschaften
KategorieCOM
NamespaceGrabzIt.Screenshots
Die Klasse, die den aktuellen Status des Screenshots darstellt.
Öffentliche Eigenschaften
-
bool Processing
- Wenn true, wird der Screenshot noch verarbeitet.
-
bool Cached
- Wenn true, wurde der Screenshot verarbeitet und ist derzeit im Cache.
-
bool Expired
- Wenn dies zutrifft, befindet sich der Screenshot nicht mehr auf dem GrabzIt-System.
-
string Message
- Eine vom System zurückgegebene Fehlermeldung.
WaterMarkCOM
NamespaceGrabzIt.Screenshots
Diese Klasse repräsentiert den Brauch watermarks in GrabzIt gespeichert
Öffentliche Methoden
Öffentliche Eigenschaften
-
string Identifier
- Die Kennung des watermark
-
string XPosition
-
Die horizontale Position der watermark
-
string YPosition
-
Die vertikale Position der watermark
-
string Format