GrabzIt-client met ASP.NET
Cursusomschrijving
Deze klasse verzorgt alle communicatie met de GrabzIt-screenshotwebservices. Alle methoden gemarkeerd met COM werken ook wanneer de GrabzIt ASP.NET DLL wordt gebruikt als een COM-object.
Publieke 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)
Deze methode retourneert de screenshot zelf. Als er niets wordt geretourneerd, is er iets misgegaan of is de screenshot nog niet gereed.
parameters
-
id - de unieke identificatie van de screenshot
Winstwaarde
GrabzItFile object
Geef de URL op van de online video die moet worden geconverteerd intoa geanimeerde GIF.
parameters
-
url - de URL van de online video die moet worden geconverteerd into een geanimeerde GIF.
- Nodig
-
Accepteert Vimeo en YouTube video-URL's
- Waarschuwing voor het animeren van Vimeo- en YouTube-video's is afhankelijk van een derde partij en biedt dus mogelijk geen consistente resultaten.
-
opties - een exemplaar van de AnimationOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van de geanimeerde GIF.
- Benodigd voor COM anders optioneel
Winstwaarde
komen te vervallen
AnimationOptionsCOM
namespaceGrabzIt.Parameters
De klasse vertegenwoordigt alle beschikbare opties bij het maken van een geanimeerde GIF.
Publieke eigenschappen
-
string CustomId - aangepaste id die u kunt doorgeven aan de geanimeerde GIF-webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL.
-
int Width - de breedte van de resulterende geanimeerde GIF in pixels.
- Standaard: 180px
- Maximum: maximale breedte voor pakket
- Auto-formaat: -1 (passerend -1 betekent dat de breedte van de geanimeerde GIF is geschaald in verhouding tot de hoogte, als de breedte automatisch wordt aangepast, kan de hoogte niet)
-
int Height - de hoogte van de resulterende geanimeerde GIF in pixels.
- Standaard: 120px
- Maximum: maximale hoogte voor pakket
- Auto-formaat: -1 (passeren van -1 betekent dat de hoogte van de geanimeerde GIF is geschaald in verhouding tot de breedte, als de hoogte automatisch wordt aangepast, kan de breedte niet)
-
int Start - de startpositie van de video die moet worden geconverteerd intoa geanimeerde GIF.
-
int Duration - de lengte in seconden van de video die moet worden geconverteerd intoa geanimeerde GIF.
- Standaard: maximale lengte voor pakket
-
float Speed - de snelheid van de geanimeerde GIF.
- Standaard: 1
- Minimum: 0.2
- Maximaal: 10
-
float FramesPerSecond - het aantal frames per seconde dat moet worden vastgelegd van de video.
- Standaard: 10
- Minimum: 0.2
- Maximaal: 60
-
int Repeat - aantal keren dat de geanimeerde GIF in een lus moet worden geplaatst.
- Standaard: 0
- Lus continu: 0
- Loop nooit: -1
-
bool Reverse - indien waar, worden de frames van de geanimeerde GIF omgekeerd
-
string CustomWaterMarkId - voeg aangepast watermark naar de geanimeerde GIF
-
int Quality - de kwaliteit van de geretourneerde afbeelding, die een standaardcompressie van 85% heeft.
- Het verminderen van de kwaliteit zal de bestandsgrootte verminderen en downloadtijden verkorten.
- Standaard: -1
- Minimum: -1
- Maximaal: 100
-
Country Country - het land de geanimeerde GIF moet worden overgenomen.
- Standaard: de huidige snelste locatie
- Opties: Land.Singapore, Land.UK, Land.ONS
-
string ExportURL - de export URL die aangeeft waar de opname ook moet worden geëxporteerd.
-
string EncryptionKey - als een basis 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
-
string Proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
URLToImage(string url, ImageOptions opties)COM
Hiermee geeft u de URL op die moet worden geconverteerd intoa afbeelding screenshot.
parameters
-
url - de URL waarvan het screenshot moet worden gemaakt
-
opties - een exemplaar van de ImageOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van de schermafbeelding.
- Benodigd voor COM anders optioneel
Winstwaarde
komen te vervallen
HTMLToImage(string html, ImageOptions opties)COM
Hiermee geeft u de HTML op die moet worden geconverteerd inteen afbeelding.
parameters
-
html - de HTML om te zetten inteen afbeelding
- opties - een exemplaar van de ImageOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van een afbeelding.
Winstwaarde
komen te vervallen
FileToImage(string pad, ImageOptions opties)COM
Geeft een HTML-bestand aan dat moet worden geconverteerd inteen afbeelding.
parameters
-
pad - het bestandspad van een HTML-bestand dat moet worden geconverteerd inteen afbeelding
-
opties - een exemplaar van de ImageOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van een afbeelding.
- Benodigd voor COM anders optioneel
Winstwaarde
komen te vervallen
ImageOptionsCOM
namespaceGrabzIt.Parameters
De klasse vertegenwoordigt alle beschikbare opties bij het maken van afbeeldingen.
Publieke eigenschappen
-
string CustomId - aangepaste id die u kunt doorgeven aan de screenshot-webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL.
-
int BrowserWidth - de breedte van de browser in pixels
- Standaard: 1366
- Maximaal: 10000
-
int BrowserHeight - de hoogte van de browser in pixels
- Standaard: 1170
- Maximaal: 10000
- Volledige lengte: -1 (doorgeven van -1 betekent dat een sceenshot van de hele webpagina wordt gemaakt)
-
int OutputWidth - de breedte van de resulterende miniatuur in pixels
- Standaard: als zowel de uitvoerbreedte als de uitvoerhoogte niet zijn opgegeven of 0, dan komen de uitvoerbreedte en -hoogte overeen met de uiteindelijke breedte en hoogte van de afbeelding.Als de uitvoerhoogte is opgegeven, is de uitvoerbreedte evenredig met de uitvoerhoogte
- Maximum: maximale breedte voor pakket
- Volledige breedte: -1 (passeren van -1 betekent dat de breedte van de miniatuur niet wordt verkleind)
-
int OutputHeight - de hoogte van de resulterende miniatuur in pixels
- Standaard: als zowel de uitvoerbreedte als de uitvoerhoogte niet zijn opgegeven of 0, dan komen de uitvoerbreedte en -hoogte overeen met de uiteindelijke breedte en hoogte van de afbeelding.Als de uitvoerbreedte is opgegeven, is de uitvoerhoogte evenredig met de uitvoerbreedte
- Maximum: maximale hoogte voor pakket
- Volledige hoogte: -1 (doorgeven van -1 betekent dat de hoogte van de miniatuur niet wordt verkleind)
-
ImageFormat Format - het formaat waarin de screenshot moet zijn.
-
int Delay - het aantal milliseconden tot wacht voordat je de screenshot maakt
- Standaard: 0
- Maximaal: 30000
-
string ClickElement - dit specificeert het HTML-element met behulp van een CSS-selector klikken. Onthoud dat een vertraging ook nodig kan zijn om de effecten van de klik te zien
- Standaard: leeg
- Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
-
string TargetElement - de CSS-selector van het enige HTML-element op de doelwebpagina dat moet worden omgedraaid intoa screenshot, alle andere delen van de webpagina worden genegeerd. Als er meerdere overeenkomende HTML-elementen zijn, wordt de eerste gekozen
-
string HideElement - de CSS-selectors van de een of meer HTML-elementen op de webpagina die u wilt verbergen, om meerdere HTML-elementen op te geven om elke selector met een komma te verbergen
-
string WaitForElement - de CSS-selectors van het HTML-element op de webpagina dat moet zichtbaar zijn voordat de opname wordt uitgevoerd
-
BrowserType RequestAs - het type user-agent dat u wilt gebruiken
-
string CustomWaterMarkId - voeg een aangepast watermark naar de afbeelding
-
int Quality - de kwaliteit van de geretourneerde afbeelding. Dit heeft momenteel alleen effect op JPG- en WEBP-afbeeldingen, die een standaardcompressie van 90% hebben.
- Het verminderen van de kwaliteit zal de bestandsgrootte verminderen en downloadtijden verkorten.
- Standaard: -1
- Minimum: -1
- Maximaal: 100
-
bool Transparent - indien waar als de beeldopname moet transparant zijn. Dit is alleen compatibel met png- en tiff-afbeeldingen.
-
bool HD - indien waar de afbeelding vastleggen zal in hoge definitie zijn dit verdubbelt de grootte van de afbeeldingsafmetingen.
-
Country Country - het land de schermafbeelding moet worden overgenomen.
- Standaard: de huidige snelste locatie
- Opties: Land.Singapore, Land.UK, Land.ONS
-
string ExportURL - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
-
string EncryptionKey - als een basis 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
-
bool NoAds - als het waar is advertenties moeten automatisch worden verborgen.
-
bool NoCookieNotifications - indien waar allemaal algemeen gevonden cookiemeldingen moeten automatisch worden verborgen.
-
string Address - de URL om de HTML-code uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd gebruikt relatieve URL's voor bronnen zoals CSS en afbeeldingen.
-
string Proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
Publieke methoden
-
AddPostParameter (string naam, string waarde) - definieert een HTTP Post-parameter en optioneel waarde, deze methode kan meerdere keren worden aangeroepen om meerdere parameters toe te voegen. Met deze methode wordt GrabzIt gedwongen voer een HTTP-bericht uit.
- naam - de naam van de parameter HTTP Post
- waarde - de waarde van de parameter HTTP Post
URLToRenderedHTML(string url, HTMLOptions opties)COM
Hiermee geeft u de URL op die moet worden geconverteerd into gerenderde HTML.
parameters
-
url - de URL waarvan de gerenderde HTML moet worden gemaakt
-
opties - een exemplaar van de HTMLOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van de gerenderde HTML.
- Benodigd voor COM anders optioneel
Winstwaarde
komen te vervallen
HTMLToRenderedHTML(string html, HTMLOptions opties)COM
Hiermee geeft u de HTML op die moet worden geconverteerd into gerenderde HTML.
parameters
-
html - de HTML om te zetten into gerenderde HTML
- opties - een exemplaar van de HTMLOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van gerenderde HTML.
Winstwaarde
komen te vervallen
FileToRenderedHTML(string pad, HTMLOptions opties)COM
Geeft een HTML-bestand aan dat moet worden geconverteerd into gerenderde HTML.
parameters
-
pad - het bestandspad van een HTML-bestand dat moet worden geconverteerd into gerenderde HTML
-
opties - een exemplaar van de HTMLOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van gerenderde HTML.
- Benodigd voor COM anders optioneel
Winstwaarde
komen te vervallen
HTMLOptionsCOM
namespaceGrabzIt.Parameters
De klasse vertegenwoordigt alle beschikbare opties wanneer gerenderde HTML-vastleggingen maken.
Publieke eigenschappen
Publieke methoden
-
AddPostParameter (string naam, string waarde) - definieert een HTTP Post-parameter en optioneel waarde, deze methode kan meerdere keren worden aangeroepen om meerdere parameters toe te voegen. Met deze methode wordt GrabzIt gedwongen voer een HTTP-bericht uit.
- naam - de naam van de parameter HTTP Post
- waarde - de waarde van de parameter HTTP Post
URLToPDF(string url, PDFOptions opties)COM
Hiermee geeft u de URL op die moet worden geconverteerd intoa PDF.
parameters
-
url - de URL die moet worden geconverteerd intoa PDF
-
PDFOptions opties - een instantie van de klasse PDFOptions die speciale opties definieert die moeten worden gebruikt bij het maken van een PDF.
- Benodigd voor COM anders optioneel
Winstwaarde
komen te vervallen
HTMLToPDF(string html, PDFOptions opties)COM
Hiermee geeft u de HTML op die moet worden geconverteerd intoa PDF.
parameters
-
html - de HTML om te zetten intoa PDF
-
PDFOptions opties - een instantie van de klasse GrabzItPDFOptions die speciale opties definieert die moeten worden gebruikt bij het maken van een PDF.
- Benodigd voor COM anders optioneel
Winstwaarde
komen te vervallen
FileToPDF(string pad, PDFOptions opties)COM
Geeft een HTML-bestand aan dat moet worden geconverteerd intoa PDF.
parameters
-
pad - het bestandspad van een HTML-bestand dat moet worden geconverteerd intoa PDF
-
PDFOptions opties - een instantie van de klasse PDFOptions die speciale opties definieert die moeten worden gebruikt bij het maken van een PDF.
- Benodigd voor COM anders optioneel
Winstwaarde
komen te vervallen
PDFOptionsCOM
namespaceGrabzIt.Parameters
De klasse vertegenwoordigt alle beschikbare opties bij het maken van PDF-opnames.
Publieke eigenschappen
-
string CustomId - een aangepaste id die u kunt doorgeven aan de webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL.
-
bool IncludeBackground - indien waar, moet de achtergrond van de webpagina in de screenshot worden opgenomen
-
PageSize PageSize - het paginaformaat van de PDF
-
PageOrientation Orientation - de richting van het PDF-document
-
CSSMediaType CSSMediaType - de CSS-mediatype van het PDF-document
-
bool IncludeLinks - waar als links in de PDF moeten worden opgenomen
-
bool IncludeOutline - waar als PDF-bladwijzers moet worden opgenomen
-
string Title - geef een titel op voor het PDF-document
-
string CoverURL - de URL van een webpagina die als voorblad voor de PDF moet worden gebruikt
-
int MarginTop - de marge in millimeter die bovenaan de PDF-documentpagina moet verschijnen
-
int MarginLeft - de marge in millimeters die links van de PDF-documentpagina moet verschijnen
-
int MarginBottom - de marge in millimeter die onderaan de PDF-documentpagina moet verschijnen
-
int MarginRight - de marge in millimeters die rechts van het PDF-document moet verschijnen
-
int BrowserWidth - de breedte van de browser in pixels
- Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
- Standaard: 1366
- Maximaal: 10000
- Automatische breedte: -1 (doorgeven van -1 betekent dat de breedte van de browser overeenkomt met de breedte van het PDF-document)
-
int PageWidth - de aangepaste breedte van de resulterende PDF in mm
- Standaard: PageSize Breedte
- Minimum: 15mm
-
int PageHeight - de aangepaste hoogte van de resulterende PDF in mm
- Standaard: PageSize Hoogte
- Minimum: 15mm
-
int Delay - het aantal milliseconden tot wacht voordat je de screenshot maakt
- Standaard: 0
- Maximaal: 30000
-
BrowserType RequestAs - het type user-agent dat u wilt gebruiken
-
string TemplateId - Voeg een ... toe sjabloon ID die de kop- en voettekst van het PDF-document aangeeft
-
string ClickElement - dit specificeert het HTML-element met behulp van een CSS-selector klikken. Onthoud dat een vertraging ook nodig kan zijn om de effecten van de klik te zien
- Standaard: leeg
- Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
-
string TargetElement - de CSS-selector van de enige HTML-element op de doelpagina die moet worden omgedraaid intoa PDF, worden alle andere delen van de webpagina genegeerd. Als er meerdere overeenkomende HTML-elementen zijn, wordt de eerste gekozen
-
string HideElement - de CSS-selectors van de een of meer HTML-elementen op de webpagina die u wilt verbergen, om meerdere HTML-elementen op te geven om elke selector met een komma te verbergen
-
string WaitForElement - de CSS-selectors van het HTML-element op de webpagina dat moet zichtbaar zijn voordat de opname wordt uitgevoerd
-
string CustomWaterMarkId - voeg een aangepast watermark naar elke pagina van het PDF-document
-
int Quality - de kwaliteit van de geretourneerde PDF. De standaard gebruikt de aanbevolen kwaliteit voor de PDF.
- Het verminderen van de kwaliteit zal de bestandsgrootte verminderen en downloadtijden verkorten.
- Standaard: -1
- Minimum: -1
- Maximaal: 100
-
Country Country - het land de schermafbeelding moet worden overgenomen.
- Standaard: de huidige snelste locatie
- Opties: Land.Singapore, Land.UK, Land.ONS
-
string ExportURL - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
-
string EncryptionKey - als een basis 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
-
bool NoAds - als het waar is advertenties moeten automatisch worden verborgen.
-
bool NoCookieNotifications - indien waar allemaal algemeen gevonden cookiemeldingen moeten automatisch worden verborgen.
-
string Address - de URL om de HTML-code uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd gebruikt relatieve URL's voor bronnen zoals CSS en afbeeldingen.
-
string Proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
-
string MergeId - de ID van een opname die zou moeten zijn samengevoegd aan het begin van het nieuwe PDF-document
-
string Password - de wachtwoord om het PDF-document te beschermen met
Publieke methoden
-
AddPostParameter (string naam, string waarde) - definieert een HTTP Post-parameter en optioneel waarde, deze methode kan meerdere keren worden aangeroepen om meerdere parameters toe te voegen. Met deze methode wordt GrabzIt gedwongen voer een HTTP-bericht uit.
- naam - de naam van de parameter HTTP Post
- waarde - de waarde van de parameter HTTP Post
-
AddTemplateParameter (string naam, string waarde) - definieer een aangepaste sjabloon parameter en waarde, deze methode kan meerdere keren worden aangeroepen om meerdere parameters toe te voegen.
- naam - de naam van de sjabloonparameter
- waarde - de waarde van de sjabloonparameter
URLToDOCX (string url, DOCXOptions opties)COM
Hiermee geeft u de URL op die moet worden geconverteerd intoa DOCX.
parameters
-
url - de URL die moet worden geconverteerd intoa DOCX
-
DOCXOptions opties - een exemplaar van de DOCXOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van een DOCX.
- Benodigd voor COM anders optioneel
Winstwaarde
komen te vervallen
HTMLToDOCX(string html, DOCXOptions opties)COM
Hiermee geeft u de HTML op die moet worden geconverteerd intoa DOCX.
parameters
-
html - de HTML om te zetten intoa DOCX
-
DOCXOptions opties - een exemplaar van de GrabzItDOCXOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van een DOCX.
- Benodigd voor COM anders optioneel
Winstwaarde
komen te vervallen
FileToDOCX(string pad, DOCXOptions opties)COM
Geeft een HTML-bestand aan dat moet worden geconverteerd intoa DOCX.
parameters
-
pad - het bestandspad van een HTML-bestand dat moet worden geconverteerd intoa DOCX
-
DOCXOptions opties - een exemplaar van de DOCXOptions klasse die speciale opties definieert die moeten worden gebruikt bij het maken van een DOCX.
- Benodigd voor COM anders optioneel
Winstwaarde
komen te vervallen
DOCXOptionsCOM
namespaceGrabzIt.Parameters
De klasse vertegenwoordigt alle beschikbare opties bij het maken van DOCX-opnames.
Publieke eigenschappen
-
string CustomId - een aangepaste id die u kunt doorgeven aan de webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL.
-
bool IncludeBackground - indien waar, moeten de achtergrondafbeeldingen van de webpagina worden opgenomen in de DOCX
-
PageSize PageSize - het paginaformaat van de DOCX
-
PageOrientation Orientation - de richting van het DOCX-document
-
bool IncludeLinks - waar als links moeten worden opgenomen in de DOCX
-
bool IncludeImages - indien waar, moeten de afbeeldingen van de webpagina worden opgenomen in de DOCX
-
string Title - geef een titel op voor het DOCX-document
-
int MarginTop - de marge in millimeters die bovenaan de DOCX-documentpagina moet verschijnen
-
int MarginLeft - de marge in millimeters die links van de DOCX-documentpagina moet verschijnen
-
int MarginBottom - de marge in millimeter die onderaan de DOCX-documentpagina moet verschijnen
-
int MarginRight - de marge in millimeter die rechts van het DOCX-document moet verschijnen
-
int BrowserWidth - de breedte van de browser in pixels
- Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
- Standaard: 1366
- Maximaal: 10000
- Automatische breedte: -1 (doorgeven van -1 betekent dat de breedte van de browser overeenkomt met de breedte van het DOCX-document)
-
int PageWidth - de aangepaste breedte van de resulterende DOCX in mm
- Standaard: PageSize Breedte
- Minimum: 15mm
-
int PageHeight - de aangepaste hoogte van de resulterende DOCX in mm
- Standaard: PageSize Hoogte
- Minimum: 15mm
-
int Delay - het aantal milliseconden tot wacht voordat je de screenshot maakt
- Standaard: 0
- Maximaal: 30000
-
BrowserType RequestAs - het type user-agent dat u wilt gebruiken
-
string TemplateId - Voeg een ... toe sjabloon ID die de kop- en voettekst van het DOCX-document aangeeft
-
string ClickElement - dit specificeert het HTML-element met behulp van een CSS-selector klikken. Onthoud dat een vertraging ook nodig kan zijn om de effecten van de klik te zien
- Standaard: leeg
- Waarschuwing deze functie is momenteel in bèta en biedt mogelijk geen consistente resultaten.
-
string TargetElement - de CSS-selector van het enige HTML-element op de doelwebpagina dat moet worden omgedraaid intoa DOCX, alle andere delen van de webpagina worden genegeerd. Als er meerdere overeenkomende HTML-elementen zijn, wordt de eerste gekozen
-
string HideElement - de CSS-selectors van de een of meer HTML-elementen op de webpagina die u wilt verbergen, om meerdere HTML-elementen op te geven om elke selector met een komma te verbergen
-
string WaitForElement - de CSS-selectors van het HTML-element op de webpagina dat moet zichtbaar zijn voordat de opname wordt uitgevoerd
-
int Quality - de kwaliteit van de geretourneerde DOCX. De standaard gebruikt de aanbevolen kwaliteit voor de DOCX.
- Het verminderen van de kwaliteit zal de bestandsgrootte verminderen en downloadtijden verkorten.
- Standaard: -1
- Minimum: -1
- Maximaal: 100
-
Country Country - het land de schermafbeelding moet worden overgenomen.
- Standaard: de huidige snelste locatie
- Opties: Land.Singapore, Land.UK, Land.ONS
-
string ExportURL - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
-
string EncryptionKey - als een basis 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
-
bool NoAds - als het waar is advertenties moeten automatisch worden verborgen.
-
bool NoCookieNotifications - indien waar allemaal algemeen gevonden cookiemeldingen moeten automatisch worden verborgen.
-
string Address - de URL om de HTML-code uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd gebruikt relatieve URL's voor bronnen zoals CSS en afbeeldingen.
-
string Proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
-
string MergeId - de ID van een opname die zou moeten zijn samengevoegd aan het begin van het nieuwe DOCX-document
-
string Password - de wachtwoord om het DOCX-document te beschermen met
Publieke methoden
-
AddPostParameter (string naam, string waarde) - definieert een HTTP Post-parameter en optioneel waarde, deze methode kan meerdere keren worden aangeroepen om meerdere parameters toe te voegen. Met deze methode wordt GrabzIt gedwongen voer een HTTP-bericht uit.
- naam - de naam van de parameter HTTP Post
- waarde - de waarde van de parameter HTTP Post
-
AddTemplateParameter (string naam, string waarde) - definieer een aangepaste sjabloon parameter en waarde, deze methode kan meerdere keren worden aangeroepen om meerdere parameters toe te voegen.
- naam - de naam van de sjabloonparameter
- waarde - de waarde van de sjabloonparameter
URLToTable(string url, TableOptions opties)COM
Hiermee geeft u de URL op waaruit de HTML-tabellen moeten worden geëxtraheerd.
parameters
-
url - de URL om HTML-tabellen uit te extraheren
-
TableOptions opties - een exemplaar van de TableOptions klasse die speciale opties definieert die moeten worden gebruikt bij het converteren van de HTML-tabel.
- Benodigd voor COM anders optioneel
Winstwaarde
komen te vervallen
HTMLToTable (string html, TableOptions opties)COM
Hiermee geeft u de HTML op waaruit de HTML-tabellen moeten worden geëxtraheerd.
parameters
-
html - de HTML om HTML-tabellen uit te extraheren.
-
TableOptions opties - een exemplaar van de TableOptions klasse die speciale opties definieert die moeten worden gebruikt bij het converteren van de HTML-tabel.
- Benodigd voor COM anders optioneel
Winstwaarde
komen te vervallen
FileToTable (string pad, TableOptions opties)COM
Geeft een HTML-bestand aan waaruit de HTML-tabellen moeten worden geëxtraheerd.
parameters
-
pad - het bestandspad van een HTML-bestand om HTML-tabellen uit te extraheren.
-
TableOptions opties - een exemplaar van de TableOptions klasse die speciale opties definieert die moeten worden gebruikt bij het converteren van de HTML-tabel.
- Benodigd voor COM anders optioneel
Winstwaarde
komen te vervallen
TableOptionsCOM
namespaceGrabzIt.Parameters
De klasse vertegenwoordigt alle beschikbare opties bij het converteren van HTML-tabellen naar CSV, XLSX of JSON.
Publieke eigenschappen
-
string CustomId - een aangepaste id die u kunt doorgeven aan de webservice. Dit wordt geretourneerd met de door u opgegeven terugbel-URL
-
int TableNumberToInclude - de index van de te converteren tabel, waarbij alle tabellen op een webpagina van boven naar beneden zijn geordend
-
TableFormat Format - het formaat waarin de tabel moet zijn
-
bool IncludeHeaderNames - of echte kopnamen in de tabel worden opgenomen
-
bool IncludeAllTables - indien waar, worden alle tabellen op de webpagina geëxtraheerd en wordt elke tabel weergegeven in een afzonderlijk spreadsheetblad. Alleen beschikbaar met het XLSX-formaat
-
string TargetElement - de id van het enige HTML-element op de webpagina dat moet worden gebruikt om tabellen uit te halen
-
BrowserType RequestAs - het type user-agent dat u wilt gebruiken
-
Country Country - het land de schermafbeelding moet worden overgenomen.
- Standaard: de huidige snelste locatie
- Opties: Land.Singapore, Land.UK, Land.ONS
-
string ExportURL - de export URL die aangeeft waar de opname ook moet worden geëxporteerd
-
string EncryptionKey - als een basis 64 gecodeerde AES-coderingssleutel is opgegeven, wordt uw opname gecodeerd wanneer deze wordt gemaakt. Het wordt aanbevolen om de maak coderingssleutel methode om de sleutel en de te maken decoderen methoden om de gecodeerde opname te decoderen zoals weergegeven in dit voorbeeld.
-
string Address - de URL om de HTML-code uit te voeren. Kan handig zijn als de HTML die wordt geconverteerd gebruikt relatieve URL's voor bronnen zoals CSS en afbeeldingen.
-
string Proxy - de HTTP-proxygegevens de browsersoftware moet gebruiken om deze opname te maken
Publieke methoden
-
AddPostParameter (string naam, string waarde) - definieert een HTTP Post-parameter en optioneel waarde, deze methode kan meerdere keren worden aangeroepen om meerdere parameters toe te voegen. Met deze methode wordt GrabzIt gedwongen voer een HTTP-bericht uit.
- naam - de naam van de parameter HTTP Post
- waarde - de waarde van de parameter HTTP Post
Save()
Save het resultaat asynchroon en retourneert een unieke identificatie, die kan worden gebruikt om de screenshot met de te krijgen GetResult methode.
Winstwaarde
De unieke identificatie van de screenshot anders wordt een uitzondering gegenereerd als er een fout is opgetreden. Dit kan worden gebruikt om de screenshot met de te krijgen GetResult methode
Dit is de aanbevolen methode om een bestand op te slaan
Save(string callBackURL)COM
Save het resultaat asynchroon en retourneert een unieke identificatie, die kan worden gebruikt om de screenshot met de te krijgen GetResult methode.
parameters
-
callBackURL - de handler de GrabzIt-service moet bellen nadat deze zijn werk heeft voltooid
Winstwaarde
De unieke identificatie van de screenshot anders wordt een uitzondering gegenereerd als er een fout is opgetreden. Dit kan worden gebruikt om de screenshot met de te krijgen GetResult methode
Waarschuwing: deze methode is synchroon, waardoor een toepassing wordt gepauzeerd terwijl het resultaat wordt verwerkt
Save het resultaat synchroon met een GrabzItFile voorwerp.
Winstwaarde
GrabzItFile object
Save het resultaat asynchroon naar a GrabzItFile voorwerp. Alleen beschikbaar als de versie van .NET asynchrone methoden ondersteunt.
Winstwaarde
GrabzItFile object
Waarschuwing: deze methode is synchroon, waardoor een toepassing wordt gepauzeerd terwijl het resultaat wordt verwerkt
SaveTo(string saveToHet dossier)COM
Save het resultaat synchroon met een bestand.
parameters
-
saveToBestand - het bestandspad dat wordt vastgelegd saved tot het eenmaal is voltooid
Winstwaarde
geeft de true terug als het succesvol is, anders wordt een uitzondering gegenereerd.
SaveToAsynchroon (string saveToHet dossier)
Save het resultaat asynchroon naar een bestand. Alleen beschikbaar als de versie van .NET asynchrone methoden ondersteunt.
parameters
-
saveToBestand - het bestandspad dat wordt vastgelegd saved tot het eenmaal is voltooid
Winstwaarde
geeft de true terug als het succesvol is, anders wordt een uitzondering gegenereerd.
Status getStatus (string ID kaart)COM
Download de huidige status van een GrabzIt-schermafbeelding.
parameters
-
id - de unieke identificatie van de screenshot
Winstwaarde
Status object
Download alle cookies die GrabzIt voor een bepaald domein gebruikt. Dit kan ook door de gebruiker gedefinieerde cookies zijn.
parameters
-
domein - het domein waarvoor cookies worden geretourneerd
Winstwaarde
GrabzItCookie reeks
setcookie (string naam, string domein, string waarde, string pad, bool httponly, DateTime? afloopt)COM
Stelt een nieuwe aangepaste cookie in op GrabzIt, als de aangepaste cookie dezelfde naam en hetzelfde domein heeft als een globale cookie, wordt de globale cookie genegeerd.
Dit kan handig zijn als de functionaliteit van een website wordt beheerd door cookies.
parameters
-
naam - de naam van de cookie die moet worden ingesteld
-
domein - het domein van de website waarvoor de cookie wordt ingesteld
- waarde - de waarde van de cookie
- pad - het websitepad waar de cookie betrekking op heeft
- httponly - indien waar, kan de cookie alleen worden gebruikt met het HTTP-protocol
- verloopt - bepaalt wanneer de cookie verloopt. Geef een nulwaarde door als de cookie niet vervalt
Winstwaarde
Waar als de cookie succesvol is ingesteld, anders onwaar
DeleteCookie (string naam, string domein)COM
Verwijder een aangepaste cookie of blokkeer het gebruik van een globale cookie
parameters
-
naam - de naam van de te verwijderen cookie
-
domein - het domein van de website waarvoor de cookie moet worden verwijderd
Winstwaarde
Waar als de cookie succesvol is verwijderd, anders onwaar
WaterMark[] KrijgenWaterMarks(String identifier)COM
Krijg al uw geüploade aangepaste watermarks
Winstwaarde
WaterMark reeks
WaterMark KrijgenWaterMark(String identifier)COM
Retourneer uw aangepaste watermark die overeenkomt met de opgegeven identifier
parameters
-
identifier - de identifier van een bepaalde custom watermark je wilt bekijken
Winstwaarde
WaterMark
Voeg een nieuwe gewoonte toe watermark
parameters
-
identifier - de identifier die u de custom watermark. Het is belangrijk dat deze identifier uniek is.
-
pad - het absolute pad van het watermark op uw server. Bijvoorbeeld C: /watermark/1.png
-
xpos - de horizontale positie waarop u de schermafbeelding wilt weergeven
-
ypos - verticale positie waarin u de schermafbeelding wilt weergeven
Winstwaarde
geeft true terug als de watermark is succesvol ingesteld
DeleteWaterMark(string identifier)COM
Verwijder een custom watermark
parameters
-
identifier - de identifier van het custom watermark u wilt verwijderen
Winstwaarde
geeft true terug als de watermark is succesvol verwijderd
SetLocalProxy (string proxyUrl)COM
Met deze methode kan een lokale proxyserver te gebruiken voor alle verzoeken.
parameters
-
proxyUrl - de URL, die indien nodig een poort kan bevatten, van de proxy. Als u een null opgeeft, wordt alle eerder ingestelde proxy verwijderd
useSSL (bool waarde)COM
Geeft aan of verzoeken aan GrabzIt's zijn API moet SSL gebruiken
parameters
-
waarde - indien true zullen alle verzoeken aan de API van GrabzIt SSL gebruiken
string CreateEncryptionKey ()COM
Maak een cryptografisch veilige basis 64-coderingssleutel, 44-tekens lang.
decrypt (string pad, string key)COM
Decodeer een gecodeerde opname met de meegeleverde coderingssleutel.
parameters
GrabzItFile decrypt (GrabzItFile bestand string key)
Decodeer een gecodeerde opname met de meegeleverde coderingssleutel.
parameters
byte [] Decoderen (byte [] gegevens, string key)
Decodeer een gecodeerde opname met de meegeleverde coderingssleutel.
parameters
Gebruik bij het instellen van enum-eigenschappen in COM-objecten in plaats daarvan de equivalente numerieke waarde voor het enum.
enums
ImageFormat
namespaceGrabzIt.Enums
Dit overzicht bestaat uit de volgende waarden.
- bmp8 = 0
- bmp16 = 1
- bmp24 = 2
- bmp = 3
- jpg = 4
- tiff = 5
- png = 6
- webp = 7
BrowserType
namespaceGrabzIt.Enums
Dit overzicht bestaat uit de volgende waarden.
- StandardBrowser = 0
- MobileBrowser = 1
- SearchEngine = 2
Land
namespaceGrabzIt.Enums
Dit overzicht bestaat uit de volgende waarden.
- Standaard = 0
- Singapore = 1
- VK = 2
- ONS = 3
PageSize
namespaceGrabzIt.Enums
Dit overzicht bestaat uit de volgende waarden.
- A3 = 0
- A4 = 1
- A5 = 2
- A6 = 3
- B3 = 4
- B4 = 5
- B5 = 6
- B6 = 7
- Legal = 8
- Letter = 9
PageOrientation
namespaceGrabzIt.Enums
Dit overzicht bestaat uit de volgende waarden.
- Landschap = 0
- Portret = 1
CSSMediaType
namespaceGrabzIt.Enums
Dit overzicht bestaat uit de volgende waarden.
TableFormat
namespaceGrabzIt.Enums
Dit overzicht bestaat uit de volgende waarden.
- csv = 0
- json = 1
- xslx = 2
HorizontalPosition
namespaceGrabzIt.Enums
Dit overzicht bestaat uit de volgende waarden.
- Links = 0
- Midden = 1
- Rechts = 2
VerticalPosition
namespaceGrabzIt.Enums
Dit overzicht bestaat uit de volgende waarden.
- Boven = 0
- Midden = 1
- Onder = 2
Resultaatklassen
GrabzItCookieCOM
namespaceGrabzIt.Cookies
Publieke eigenschappen
-
string Name
-
string Value
-
string Domain
- Het domein waarvoor de cookie is ingesteld.
-
string Path
- Het pad op het domein waarop deze cookie van toepassing is.
-
string HttpOnly
- Als deze cookie alleen geldig is wanneer de website wordt bekeken met het HTTP-protocol.
-
string Expires
- De datum waarop deze cookie vervalt
-
string Type
-
Het type cookie dat dit is, kan een van de volgende zijn:
- Wereldwijd - dit is een wereldwijd cookie ingesteld door GrabzIt
- Lokaal - dit is een door u ingesteld lokaal cookie
- Overschreven - een globale cookie die door u is overschreven
GrabzItFileCOM
namespaceGrabzIt.Screenshots
Publieke methoden
-
komen te vervallen Save(string path)
-
pad - het pad naar save het resultaat tot
- string NaarString()
Publieke eigenschappen
namespaceGrabzIt.Screenshots
De klasse die de huidige status van de schermafbeelding weergeeft.
Publieke eigenschappen
-
bool Processing
- Indien waar wordt de screenshot nog steeds verwerkt.
-
bool Cached
- Indien true is de screenshot is verwerkt en wordt deze in de cache opgeslagen.
-
bool Expired
- Indien waar is de screenshot niet langer op het GrabzIt-systeem.
-
string Message
- Een foutmelding geretourneerd door het systeem.
WaterMarkCOM
namespaceGrabzIt.Screenshots
Deze klasse vertegenwoordigt de gewoonte watermarks opgeslagen in GrabzIt
Publieke methoden
Publieke eigenschappen
-
string Identifier
- De identifier van het watermark
-
string XPosition
-
De horizontale positie van de watermark
-
string YPosition
-
De verticale positie van de watermark
-
string Format
- Het formaat van de watermark