Opis
Ta klasa obsługuje całą komunikację z usługami zrzutów ekranu GrabzIt. Wszystkie metody oznaczone COM działa również, gdy biblioteka DLL GrabzIt ASP.NET jest używana jako Obiekt COM.
Metody publiczne
- 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)
Ta metoda zwraca sam zrzut ekranu. Jeśli nic nie zostanie zwrócone, oznacza to, że coś poszło nie tak lub zrzut ekranu nie jest jeszcze gotowy.
parametry
-
id - unikalny identyfikator zrzutu ekranu
Wartość zwracana
GrabzItFile przedmiot
URLToAnimation(string adres URL, AnimationOptions opcje)COM
Określ adres URL wideo online, które należy przekonwertować into animowany GIF.
parametry
-
url - adres URL wideo online do konwersji into animowany GIF.
- Wymagane
-
Akceptuje adresy URL wideo Vimeo i YouTube
- Ostrzeżenie dotyczące animowania filmów Vimeo i YouTube zależy od strony trzeciej, dlatego może nie zapewniać spójnych wyników.
-
Opcje - instancja AnimationOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia animowanego GIF-a.
- Wymagane do COM w przeciwnym razie opcjonalne
Wartość zwracana
unieważnić
AnimationOptionsCOM
Przestrzeń nazwGrabzIt.Parameters
Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia animowanego GIF-a.
Właściwości publiczne
-
string CustomId - niestandardowy identyfikator, który można przekazać do animowanej usługi internetowej GIF. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
-
int Width - szerokość wynikowego animowanego GIF-a w pikselach.
- Domyślnie: 180px
- Maksymalna: maksymalna szerokość paczki
- Rozmiar automatyczny: -1 (przekazanie -1 oznacza, że szerokość animowany GIF jest skalowany w stosunku do jego wysokości, jeśli szerokość jest automatycznie dopasowywana, wysokość nie może)
-
int Height - wysokość powstałego animowanego GIF-a w pikselach.
- Domyślnie: 120px
- Maksymalna: maksymalna wysokość paczki
- Rozmiar automatyczny: -1 (przekazanie -1 oznacza, że wysokość animowany GIF jest skalowany w stosunku do szerokości, jeśli wysokość jest automatycznie dopasowywana, szerokość nie może)
-
int Start - początkowa pozycja filmu, który należy przekonwertować into animowany GIF.
-
int Duration - długość w sekundach filmu, który należy przekonwertować into animowany GIF.
- Domyślnie: maksymalna długość paczki
-
float Speed - prędkość animowanego GIF-a.
- Domyślnie: 1
- Minimum: 0.2
- Maksymalna ilość znaków: 10
-
float FramesPerSecond - liczba klatek na sekundę, które powinny zostać przechwycone z wideo.
- Domyślnie: 10
- Minimum: 0.2
- Maksymalna ilość znaków: 60
-
int Repeat - ile razy zapętlono animowany GIF.
- Domyślnie: 0
- Pętla w sposób ciągły: 0
- Nigdy nie pętla: -1
-
bool Reverse - jeśli to prawda, ramki animowanego GIF-a są odwrócone
-
string CustomWaterMarkId - dodaj niestandardowe watermark do animowanego GIF-a
-
int Quality - w jakość zwróconego obrazu, który ma domyślną kompresję 85%.
- Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
- Domyślnie: -1
- Minimum: -1
- Maksymalna ilość znaków: 100
-
Country Country - kraj animowany GIF powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: Kraj.Singapur, Kraj.UK, Kraj.NAS
-
string ExportURL - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane.
-
string EncryptionKey - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
-
string Proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
URLToImage(string adres URL, ImageOptions opcje)COM
Określa adres URL, który należy przekonwertować into zrzut ekranu obrazu.
parametry
-
url - adres URL, z którego należy wykonać zrzut ekranu
-
Opcje - instancja ImageOptions klasa, która definiuje specjalne opcje do użycia podczas tworzenia zrzutu ekranu.
- Wymagane do COM w przeciwnym razie opcjonalne
Wartość zwracana
unieważnić
HTMLToImage(string HTML, ImageOptions opcje)COM
Określa kod HTML, który należy przekonwertować into obrazie.
parametry
-
HTML - kod HTML do konwersji into obrazie
- Opcje - instancja ImageOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia obrazu.
Wartość zwracana
unieważnić
FileToImage(string ścieżka, ImageOptions opcje)COM
Określa plik HTML, który należy przekonwertować into obrazie.
parametry
-
ścieżka - ścieżka pliku HTML do konwersji into obrazie
-
Opcje - instancja ImageOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia obrazu.
- Wymagane do COM w przeciwnym razie opcjonalne
Wartość zwracana
unieważnić
ImageOptionsCOM
Przestrzeń nazwGrabzIt.Parameters
Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia zrzutów obrazu.
Właściwości publiczne
-
string CustomId - niestandardowy identyfikator, który można przekazać do usługi zrzutów ekranu. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
-
int BrowserWidth - szerokość przeglądarki w pikselach
- Domyślnie: 1366
- Maksymalna ilość znaków: 10000
-
int BrowserHeight - wysokość przeglądarki w pikselach
- Domyślnie: 1170
- Maksymalna ilość znaków: 10000
- Pełna długość: -1 (przekazanie -1 oznacza, że wykonano sceenshot całej strony)
-
int OutputWidth - szerokość wynikowej miniatury w pikselach
- Domyślnie: jeśli nie określono zarówno szerokości wyjściowej, jak i wysokości wyjściowej lub 0, wówczas szerokość i wysokość wyjściowa będą zgodne z ostateczną szerokością i wysokością obrazu, jeśli określono wysokość wyjściową, szerokość wyjściowa będzie proporcjonalna do wysokości wyjściowej
- Maksymalna: maksymalna szerokość paczki
- Pełna szerokość: -1 (przekazanie -1 oznacza, że szerokość miniatury nie jest zmniejszona)
-
int OutputHeight - wysokość powstałej miniatury w pikselach
- Domyślnie: jeśli nie określono zarówno szerokości wyjściowej, jak i wysokości wyjściowej lub 0, wówczas szerokość i wysokość wyjściowa będą zgodne z ostateczną szerokością i wysokością obrazu, jeśli określono szerokość wyjściową, wysokość wyjściowa będzie proporcjonalna do szerokości wyjściowej
- Maksymalna: maksymalna wysokość paczki
- Pełna wysokość: -1 (przekazanie -1 oznacza, że wysokość miniatury nie jest zmniejszona)
-
ImageFormat Format - format, w jakim powinien być zrzut ekranu.
-
int Delay - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
-
string ClickElement - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Domyślnie: pusty
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
-
string TargetElement - w Selektor CSS jedynego elementu HTML na docelowej stronie internetowej, który ma zostać włączony into zrzut ekranu, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy
-
string HideElement - w Selektory CSS jednego lub więcej elementów HTML na stronie internetowej do ukrycia, aby określić wiele elementów HTML do ukrycia, oddziel każdy selektor przecinkiem
-
string WaitForElement - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
-
BrowserType RequestAs - rodzaj agenta użytkownika, którego chcesz używać
-
string CustomWaterMarkId - dodaj niestandardowy watermark do obrazu
-
int Quality - w jakość zwróconego obrazu. Obecnie wpływa to tylko na obrazy JPG i WEBP, które mają domyślną kompresję 90%.
- Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
- Domyślnie: -1
- Minimum: -1
- Maksymalna ilość znaków: 100
-
bool Transparent - jeśli prawda, jeżeli przechwytywanie obrazu powinno być przezroczyste. Jest to zgodne tylko z obrazami png i tiff.
-
bool HD - jeśli to prawda, obraz przechwytywanie będzie w wysokiej rozdzielczości podwaja to rozmiar wymiarów obrazu.
-
Country Country - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: Kraj.Singapur, Kraj.UK, Kraj.NAS
-
string ExportURL - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
-
string EncryptionKey - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
-
bool NoAds - Jeśli prawda reklamy powinny być automatycznie ukryte.
-
bool NoCookieNotifications - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
-
string Address - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
-
string Proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
Metody publiczne
-
AddPostParameter (string imię, string wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
- name - nazwa parametru HTTP Post
- wartość - wartość parametru HTTP Post
URLToRenderedHTML(string adres URL, HTMLOptions opcje)COM
Określa adres URL, który należy przekonwertować into renderowany HTML.
parametry
-
url - adres URL, z którego powinien być wykonany renderowany HTML
-
Opcje - instancja HTMLOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.
- Wymagane do COM w przeciwnym razie opcjonalne
Wartość zwracana
unieważnić
HTMLToRenderedHTML(string HTML, HTMLOptions opcje)COM
Określa kod HTML, który należy przekonwertować into renderowany HTML.
parametry
-
HTML - kod HTML do konwersji into renderowany HTML
- Opcje - instancja HTMLOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.
Wartość zwracana
unieważnić
FileToRenderedHTML(string ścieżka, HTMLOptions opcje)COM
Określa plik HTML, który należy przekonwertować into renderowany HTML.
parametry
-
ścieżka - ścieżka pliku HTML do konwersji into renderowany HTML
-
Opcje - instancja HTMLOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia renderowanego HTML.
- Wymagane do COM w przeciwnym razie opcjonalne
Wartość zwracana
unieważnić
HTMLOptionsCOM
Przestrzeń nazwGrabzIt.Parameters
Klasa reprezentuje wszystkie opcje dostępne, kiedy tworzenie renderowanych zrzutów HTML.
Właściwości publiczne
-
string CustomId - niestandardowy identyfikator, który można przekazać do wyrenderowanej usługi HTML. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
-
int BrowserWidth - szerokość przeglądarki w pikselach
- Domyślnie: 1366
- Maksymalna ilość znaków: 10000
-
int BrowserHeight - wysokość przeglądarki w pikselach
- Domyślnie: 1170
- Maksymalna ilość znaków: 10000
-
int Delay - liczba milisekund do poczekaj przed pobraniem renderowanego kodu HTML
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
-
string WaitForElement - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
-
BrowserType RequestAs - rodzaj agenta użytkownika, którego chcesz używać
-
Country Country - kraj renderowany kod HTML powinien pochodzić z.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: Kraj.Singapur, Kraj.UK, Kraj.NAS
-
string ExportURL - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
-
string EncryptionKey - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
-
bool NoAds - Jeśli prawda reklamy powinny być automatycznie ukryte.
-
bool NoCookieNotifications - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
-
string Address - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
-
string Proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
Metody publiczne
-
AddPostParameter (string imię, string wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
- name - nazwa parametru HTTP Post
- wartość - wartość parametru HTTP Post
URLToPDF(string adres URL, PDFOpcje opcje)COM
Określa adres URL, który należy przekonwertować into PDF.
parametry
-
url - adres URL, który należy przekonwertować into PDF
-
PDFOpcje options - instancja klasy PDFOptions, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.
- Wymagane do COM w przeciwnym razie opcjonalne
Wartość zwracana
unieważnić
HTMLToPDF(string HTML, PDFOpcje opcje)COM
Określa kod HTML, który należy przekonwertować into PDF.
parametry
-
HTML - kod HTML do konwersji into PDF
-
PDFOpcje options - instancja klasy GrabzItPDFOptions, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.
- Wymagane do COM w przeciwnym razie opcjonalne
Wartość zwracana
unieważnić
FileToPDF(string ścieżka, PDFOpcje opcje)COM
Określa plik HTML, który należy przekonwertować into PDF.
parametry
-
ścieżka - ścieżka pliku HTML do konwersji into PDF
-
PDFOpcje options - instancja klasy PDFOptions, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia pliku PDF.
- Wymagane do COM w przeciwnym razie opcjonalne
Wartość zwracana
unieważnić
PDFOpcjeCOM
Przestrzeń nazwGrabzIt.Parameters
Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia zrzutów PDF.
Właściwości publiczne
-
string CustomId - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
-
bool IncludeBackground - jeśli to prawda, zrzut ekranu powinien zawierać tło strony internetowej
-
PageSize PageSize - rozmiar strony pliku PDF
-
PageOrientation Orientation - orientacja dokumentu PDF
-
CSSMediaType CSSMediaType - w CSS Media Typ dokumentu PDF
-
bool IncludeLinks - prawda, jeśli linki powinny być zawarte w pliku PDF
-
bool IncludeOutline - prawda, jeśli Zakładki PDF powinno być dołączone
-
string Title - podać tytuł dokumentu PDF
-
string CoverURL - adres URL strony internetowej, która powinna być używana jako strona tytułowa pliku PDF
-
int MarginTop - margines w milimetrach, który powinien pojawić się u góry strony dokumentu PDF
-
int MarginLeft - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu PDF
-
int MarginBottom - margines w milimetrach, który powinien pojawić się na dole strony dokumentu PDF
-
int MarginRight - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu PDF
-
int BrowserWidth - w szerokość przeglądarki w pikselach
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
- Domyślnie: 1366
- Maksymalna ilość znaków: 10000
- Automatyczna szerokość: -1 (przekazanie -1 oznacza, że szerokość przeglądarki odpowiada szerokości dokumentu PDF)
-
int PageWidth - w niestandardowa szerokość wynikowego pliku PDF w mm
- Zaniedbanie: PageSize szerokość
- Minimum: 15mm
-
int PageHeight - w niestandardowa wysokość wynikowego pliku PDF w mm
- Zaniedbanie: PageSize wysokość
- Minimum: 15mm
-
int Delay - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
-
BrowserType RequestAs - rodzaj agenta użytkownika, którego chcesz używać
-
string TemplateId - dodać szablon Identyfikator określający nagłówek i stopkę dokumentu PDF
-
string ClickElement - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Domyślnie: pusty
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
-
string TargetElement - w Selektor CSS jedyny Element HTML na docelowej stronie internetowej, która ma zostać odwrócona into PDF, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy
-
string HideElement - w Selektory CSS jednego lub więcej elementów HTML na stronie internetowej do ukrycia, aby określić wiele elementów HTML do ukrycia, oddziel każdy selektor przecinkiem
-
string WaitForElement - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
-
string CustomWaterMarkId - dodaj niestandardowy watermark na każdej stronie dokumentu PDF
-
int Quality - w jakość zwróconego pliku PDF. Domyślnie używana jest zalecana jakość pliku PDF.
- Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
- Domyślnie: -1
- Minimum: -1
- Maksymalna ilość znaków: 100
-
Country Country - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: Kraj.Singapur, Kraj.UK, Kraj.NAS
-
string ExportURL - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
-
string EncryptionKey - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
-
bool NoAds - Jeśli prawda reklamy powinny być automatycznie ukryte.
-
bool NoCookieNotifications - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
-
string Address - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
-
string Proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
-
string MergeId - identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu PDF
-
string Password - w hasło do ochrony dokumentu PDF z
Metody publiczne
-
AddPostParameter (string imię, string wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
- name - nazwa parametru HTTP Post
- wartość - wartość parametru HTTP Post
-
AddTemplateParameter (string imię, string wartość) - zdefiniować a szablon niestandardowy parametr i wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów.
- name - nazwa parametru szablonu
- wartość - wartość parametru szablonu
URLToDOCX (string adres URL, DOCXOptions opcje)COM
Określa adres URL, który należy przekonwertować into DOCX.
parametry
-
url - adres URL, który należy przekonwertować into DOCX
-
DOCXOptions opcje - instancja DOCXOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.
- Wymagane do COM w przeciwnym razie opcjonalne
Wartość zwracana
unieważnić
HTMLToDOCX(string HTML, DOCXOptions opcje)COM
Określa kod HTML, który należy przekonwertować into DOCX.
parametry
-
HTML - kod HTML do konwersji into DOCX
-
DOCXOptions opcje - instancja GrabzItDOCXOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.
- Wymagane do COM w przeciwnym razie opcjonalne
Wartość zwracana
unieważnić
FileToDOCX(string ścieżka, DOCXOptions opcje)COM
Określa plik HTML, który należy przekonwertować into DOCX.
parametry
-
ścieżka - ścieżka pliku HTML do konwersji into DOCX
-
DOCXOptions opcje - instancja DOCXOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas tworzenia DOCX.
- Wymagane do COM w przeciwnym razie opcjonalne
Wartość zwracana
unieważnić
DOCXOptionsCOM
Przestrzeń nazwGrabzIt.Parameters
Klasa reprezentuje wszystkie opcje dostępne podczas tworzenia przechwytywania DOCX.
Właściwości publiczne
-
string CustomId - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego.
-
bool IncludeBackground - jeśli to prawda, obrazy tła strony internetowej powinny być zawarte w DOCX
-
PageSize PageSize - rozmiar strony DOCX
-
PageOrientation Orientation - orientacja dokumentu DOCX
-
bool IncludeLinks - prawda, jeśli linki powinny być zawarte w DOCX
-
bool IncludeImages - jeśli to prawda, obrazy strony internetowej powinny być zawarte w DOCX
-
string Title - podać tytuł dokumentu DOCX
-
int MarginTop - margines w milimetrach, który powinien pojawić się na górze strony dokumentu DOCX
-
int MarginLeft - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu DOCX
-
int MarginBottom - margines w milimetrach, który powinien pojawić się na dole strony dokumentu DOCX
-
int MarginRight - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu DOCX
-
int BrowserWidth - w szerokość przeglądarki w pikselach
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
- Domyślnie: 1366
- Maksymalna ilość znaków: 10000
- Automatyczna szerokość: -1 (przekazanie -1 oznacza, że szerokość przeglądarki odpowiada szerokości dokumentu DOCX)
-
int PageWidth - w niestandardowa szerokość wynikowego DOCX w mm
- Zaniedbanie: PageSize szerokość
- Minimum: 15mm
-
int PageHeight - w niestandardowa wysokość wynikowego DOCX w mm
- Zaniedbanie: PageSize wysokość
- Minimum: 15mm
-
int Delay - liczba milisekund do poczekaj przed wykonaniem zrzutu ekranu
- Domyślnie: 0
- Maksymalna ilość znaków: 30000
-
BrowserType RequestAs - rodzaj agenta użytkownika, którego chcesz używać
-
string TemplateId - dodać szablon Identyfikator określający nagłówek i stopkę dokumentu DOCX
-
string ClickElement - określa element HTML, używając pliku Selektor CSS kliknąć. Pamiętaj, że opóźnienie może być również wymagane do wyświetlenia efektów kliknięcia
- Domyślnie: pusty
- Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
-
string TargetElement - w Selektor CSS jedynego elementu HTML na docelowej stronie internetowej, który ma zostać włączony into DOCX, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy
-
string HideElement - w Selektory CSS jednego lub więcej elementów HTML na stronie internetowej do ukrycia, aby określić wiele elementów HTML do ukrycia, oddziel każdy selektor przecinkiem
-
string WaitForElement - w Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
-
int Quality - w jakość zwróconego DOCX. Domyślnie używana jest zalecana jakość dla DOCX.
- Zmniejszenie jakości zmniejszy rozmiar plików i skróci czas pobierania.
- Domyślnie: -1
- Minimum: -1
- Maksymalna ilość znaków: 100
-
Country Country - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: Kraj.Singapur, Kraj.UK, Kraj.NAS
-
string ExportURL - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
-
string EncryptionKey - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
-
bool NoAds - Jeśli prawda reklamy powinny być automatycznie ukryte.
-
bool NoCookieNotifications - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
-
string Address - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
-
string Proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
-
string MergeId - identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu DOCX
-
string Password - w hasło do ochrony dokumentu DOCX z
Metody publiczne
-
AddPostParameter (string imię, string wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
- name - nazwa parametru HTTP Post
- wartość - wartość parametru HTTP Post
-
AddTemplateParameter (string imię, string wartość) - zdefiniować a szablon niestandardowy parametr i wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów.
- name - nazwa parametru szablonu
- wartość - wartość parametru szablonu
URLToTable(string adres URL, TableOptions opcje)COM
Określa adres URL, z którego należy wyodrębnić tabele HTML.
parametry
-
url - adres URL do wyodrębnienia tabel HTML
-
TableOptions opcje - instancja TableOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas konwertowania tabeli HTML.
- Wymagane do COM w przeciwnym razie opcjonalne
Wartość zwracana
unieważnić
HTMLToTable (string HTML, TableOptions opcje)COM
Określa kod HTML, z którego należy wyodrębnić tabele HTML.
parametry
-
html - HTML, z którego można wyodrębnić tabele HTML.
-
TableOptions opcje - instancja TableOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas konwertowania tabeli HTML.
- Wymagane do COM w przeciwnym razie opcjonalne
Wartość zwracana
unieważnić
FileToTable (string ścieżka, TableOptions opcje)COM
Określa plik HTML, z którego należy wyodrębnić tabele HTML.
parametry
-
ścieżka - ścieżka pliku HTML, z którego można wyodrębnić tabele HTML.
-
TableOptions opcje - instancja TableOptions klasa, która definiuje wszelkie specjalne opcje do użycia podczas konwertowania tabeli HTML.
- Wymagane do COM w przeciwnym razie opcjonalne
Wartość zwracana
unieważnić
TableOptionsCOM
Przestrzeń nazwGrabzIt.Parameters
Klasa reprezentuje wszystkie opcje dostępne podczas konwersji tabel HTML na CSV, XLSX lub JSON.
Właściwości publiczne
-
string CustomId - niestandardowy identyfikator, który można przekazać do usługi internetowej. Zostanie to zwrócone z podanym adresem URL wywołania zwrotnego
-
int TableNumberToInclude - indeks tabeli do przekonwertowania, w której wszystkie tabele na stronie internetowej są uporządkowane od góry strony do dołu
-
TableFormat Format - format, w jakim powinna być tabela
-
bool IncludeHeaderNames - jeśli prawdziwe nazwy nagłówków zostaną uwzględnione w tabeli
-
bool IncludeAllTables - jeśli to prawda, wszystkie tabele na stronie internetowej zostaną wyodrębnione, a każdy z nich pojawi się w osobnym arkuszu kalkulacyjnym. Dostępne tylko w formacie XLSX
-
string TargetElement - identyfikator jedynego elementu HTML na stronie internetowej, którego należy użyć do wyodrębnienia tabel
-
BrowserType RequestAs - rodzaj agenta użytkownika, którego chcesz używać
-
Country Country - kraj zrzut ekranu powinien zostać pobrany.
- Domyślnie: bieżąca najszybsza lokalizacja
- Opcje: Kraj.Singapur, Kraj.UK, Kraj.NAS
-
string ExportURL - w eksportuj adres URL określa, gdzie przechwytywanie powinno być również eksportowane
-
string EncryptionKey - jeśli określono podstawowy klucz szyfrowania AES 64, przechwytywanie jest szyfrowane podczas jego tworzenia. Zalecane jest użycie utwórz metodę klucza szyfrowania stworzyć klucz i metody deszyfrowania aby odszyfrować zaszyfrowane przechwycenie, jak pokazano w ten przykład.
-
string Address - adres URL do wykonania kodu HTML. Może być przydatny, jeśli używany jest konwertowany HTML względne adresy URL zasobów, takich jak CSS i obrazy.
-
string Proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
Metody publiczne
-
AddPostParameter (string imię, string wartość) - określa parametr HTTP Post i opcjonalnie wartość, tę metodę można wywołać wiele razy, aby dodać wiele parametrów. Użycie tej metody zmusi GrabzIt do wykonać post HTTP.
- name - nazwa parametru HTTP Post
- wartość - wartość parametru HTTP Post
Save()
Save wynik asynchronicznie i zwraca unikalny identyfikator, którego można użyć do uzyskania zrzutu ekranu z GetResult Metoda.
Wartość zwracana
Unikalny identyfikator zrzutu ekranu, w przeciwnym razie, jeśli wystąpi błąd, zgłoszony zostanie wyjątek. Można tego użyć, aby uzyskać zrzut ekranu z GetResult metoda
Jest to zalecana metoda zapisywania pliku
Save(string callBackURL)COM
Save wynik asynchronicznie i zwraca unikalny identyfikator, którego można użyć do uzyskania zrzutu ekranu z GetResult Metoda.
parametry
-
callBackURL - treser usługa GrabzIt powinna zadzwonić po zakończeniu pracy
Wartość zwracana
Unikalny identyfikator zrzutu ekranu, w przeciwnym razie, jeśli wystąpi błąd, zgłoszony zostanie wyjątek. Można tego użyć, aby uzyskać zrzut ekranu z GetResult metoda
Ostrzeżenie: ta metoda jest synchroniczna, więc spowoduje zatrzymanie aplikacji podczas przetwarzania wyniku
Save wynik synchronicznie do GrabzItFile obiekt.
Wartość zwracana
GrabzItFile przedmiot
GrabzItFile SaveToAsynchroniczne ()
Save wynik asynchronicznie do a GrabzItFile obiekt. Dostępne tylko wtedy, gdy wersja platformy .NET obsługuje metody asynchroniczne.
Wartość zwracana
GrabzItFile przedmiot
Ostrzeżenie: ta metoda jest synchroniczna, więc spowoduje zatrzymanie aplikacji podczas przetwarzania wyniku
SaveTo(string saveToPlik)COM
Save wynik synchronicznie do pliku.
parametry
-
saveToPlik - ścieżka do pliku, który będzie przechwytywany saved po zakończeniu
Wartość zwracana
zwraca prawdę, jeśli się powiedzie, w przeciwnym razie zgłasza wyjątek.
SaveToAsynchroniczny(string saveToPlik)
Save wynik asynchronicznie do pliku. Dostępne tylko wtedy, gdy wersja platformy .NET obsługuje metody asynchroniczne.
parametry
-
saveToPlik - ścieżka do pliku, który będzie przechwytywany saved po zakończeniu
Wartość zwracana
zwraca prawdę, jeśli się powiedzie, w przeciwnym razie zgłasza wyjątek.
status GetStatus (string ID)COM
Uzyskaj aktualny status zrzutu ekranu GrabzIt.
parametry
-
id - unikalny identyfikator zrzutu ekranu
Wartość zwracana
status przedmiot
Zdobądź wszystkie pliki cookie, których używa GrabzIt dla określonej domeny. Może to również obejmować pliki cookie zdefiniowane przez użytkownika.
parametry
-
domena - domena, dla której zwracane są pliki cookie
Wartość zwracana
GrabzItCookie szyk
SetCookie (string imię, string domena, string wartość, string ścieżka, bool httponly, DateTime? wygasa)COM
Ustawia nowy niestandardowy plik cookie w GrabzIt, jeśli niestandardowy plik cookie ma taką samą nazwę i domenę jak globalny plik cookie, globalny plik cookie zostanie zastąpiony.
Może to być przydatne, jeśli funkcjonalność strony internetowej jest kontrolowana przez pliki cookie.
parametry
-
nazwa - nazwa pliku cookie, który należy ustawić
-
domena - domena strony internetowej, dla której ma zostać ustawiony plik cookie
- wartość - wartość pliku cookie
- ścieżka - ścieżka do strony, której dotyczy plik cookie
- httponly - jeśli to prawda, plik cookie może być używany tylko z protokołem HTTP
- wygasa - określa, kiedy wygasa plik cookie. Podaj wartość zerową, jeśli plik cookie nie wygasa
Wartość zwracana
Prawda, jeśli plik cookie został pomyślnie ustawiony, w przeciwnym razie fałsz
DeleteCookie (string imię, string domena)COM
Usuń niestandardowy plik cookie lub zablokuj używanie globalnego pliku cookie
parametry
-
nazwa - nazwa pliku cookie do usunięcia
-
domena - domena strony internetowej, dla której chcesz usunąć plik cookie
Wartość zwracana
Prawda, jeśli plik cookie zostanie pomyślnie usunięty, w przeciwnym razie fałsz
WaterMark[] Get WaterMarks(String identyfikator)COM
Pobierz wszystkie przesłane pliki niestandardowe watermarks
Wartość zwracana
WaterMark szyk
WaterMark Get WaterMark(String identyfikator)COM
Zwróć swoje zamówienie watermark który pasuje do określonego identyfikatora
parametry
-
identyfikator - identyfikator konkretnego zwyczaju watermark chcesz zobaczyć
Wartość zwracana
WaterMark
Dodaj nowy zwyczaj watermark
parametry
-
identyfikator - identyfikator, który chcesz nadać niestandardowemu watermark. Ważne jest, aby ten identyfikator był niepowtarzalny.
-
path - bezwzględna ścieżka pliku watermark na twoim serwerze. Na przykład C: /watermark/1.png
-
xpos - pozycja pozioma, na której ma się pojawić zrzut ekranu
-
ypos - pozycja pionowa, w której ma się pojawić zrzut ekranu
Wartość zwracana
zwraca prawdę, jeśli watermark został pomyślnie ustawiony
DeleteWaterMark(string identyfikator)COM
Usuń niestandardowy watermark
parametry
-
identyfikator - identyfikator zwyczaju watermark chcesz usunąć
Wartość zwracana
zwraca prawdę, jeśli watermark został pomyślnie usunięty
SetLocalProxy (string proxyUrl)COM
Ta metoda umożliwia lokalny serwer proxy do wykorzystania we wszystkich żądaniach.
parametry
-
proxyUrl - adres URL, który w razie potrzeby może zawierać port serwera proxy. Podanie wartości null spowoduje usunięcie wcześniej ustawionego serwera proxy
UseSSL (bool wartość)COM
Określa, czy żądania do GrabzIt's Interfejs API powinien używać protokołu SSL
parametry
-
wartość - jeśli ma wartość true, wszystkie żądania do interfejsu API GrabzIt będą używać protokołu SSL
string CreateEncryptionKey ()COM
Utwórz kryptograficznie bezpieczny podstawowy klucz szyfrowania 64 o długości znaków 44.
Odszyfruj (string ścieżka, string klawisz)COM
Odszyfruj zaszyfrowane przechwycenie za pomocą dostarczonego klucza szyfrowania.
parametry
GrabzItFile Odszyfruj (GrabzItFile file, string klawisz)
Odszyfruj zaszyfrowane przechwycenie za pomocą dostarczonego klucza szyfrowania.
parametry
byte [] Deszyfruj (byte [] dane, string klawisz)
Odszyfruj zaszyfrowane przechwycenie za pomocą dostarczonego klucza szyfrowania.
parametry
Podczas ustawiania właściwości wyliczania w obiektach COM należy użyć równoważnej wartości liczbowej dla wyliczenia.
Enums
ImageFormat
Przestrzeń nazwGrabzIt.Enums
Ten wyliczenie obejmuje następujące wartości.
- bmp8 = 0
- bmp16 = 1
- bmp24 = 2
- bmp = 3
- jpg = 4
- tiff = 5
- png = 6
- webp = 7
BrowserType
Przestrzeń nazwGrabzIt.Enums
Ten wyliczenie obejmuje następujące wartości.
- StandardBrowser = 0
- MobileBrowser = 1
- SearchEngine = 2
Kraj
Przestrzeń nazwGrabzIt.Enums
Ten wyliczenie obejmuje następujące wartości.
- Domyślnie = 0
- Singapur = 1
- UK = 2
- US = 3
PageSize
Przestrzeń nazwGrabzIt.Enums
Ten wyliczenie obejmuje następujące wartości.
- A3 = 0
- A4 = 1
- A5 = 2
- A6 = 3
- B3 = 4
- B4 = 5
- B5 = 6
- B6 = 7
- Legal = 8
- Letter = 9
PageOrientation
Przestrzeń nazwGrabzIt.Enums
Ten wyliczenie obejmuje następujące wartości.
CSSMediaType
Przestrzeń nazwGrabzIt.Enums
Ten wyliczenie obejmuje następujące wartości.
TableFormat
Przestrzeń nazwGrabzIt.Enums
Ten wyliczenie obejmuje następujące wartości.
- csv = 0
- json = 1
- xslx = 2
HorizontalPosition
Przestrzeń nazwGrabzIt.Enums
Ten wyliczenie obejmuje następujące wartości.
- Lewy = 0
- Centrum = 1
- Prawo = 2
VerticalPosition
Przestrzeń nazwGrabzIt.Enums
Ten wyliczenie obejmuje następujące wartości.
- Góra = 0
- Middle = 1
- Dół = 2
Klasy wyników
GrabzItCookieCOM
Przestrzeń nazwCiasteczka GrabzIt
Właściwości publiczne
-
string Name
-
string Value
-
string Domain
- Domena, dla której ustawiony jest plik cookie.
-
string Path
- Ścieżka do domeny, której dotyczy ten plik cookie.
-
string HttpOnly
- Jeśli ten plik cookie jest ważny tylko wtedy, gdy witryna jest przeglądana za pomocą protokołu HTTP.
-
string Expires
- Data wygaśnięcia tego pliku cookie
-
string Type
-
Jest to rodzaj pliku cookie, który może być jednym z następujących:
- Globalny - jest to globalny plik cookie ustawiony przez GrabzIt
- Lokalny - to lokalny plik cookie ustawiony przez Ciebie
- Zastąpione - globalne ciasteczko, które zostało przez Ciebie zastąpione
GrabzItFileCOM
Przestrzeń nazwZrzuty ekranu GrabzIt.S
Metody publiczne
-
unieważnić Save(string ścieżka)
-
ścieżka - ścieżka do save wynik do
- string DoString()
Właściwości publiczne
Przestrzeń nazwZrzuty ekranu GrabzIt.S
Klasa reprezentująca bieżący status zrzutu ekranu.
Właściwości publiczne
-
bool Processing
- Jeśli true, zrzut ekranu jest nadal przetwarzany.
-
bool Cached
- Jeśli true, zrzut ekranu został przetworzony i jest obecnie buforowany.
-
bool Expired
- Jeśli to prawda, zrzut ekranu nie jest już dostępny w systemie GrabzIt.
-
string Message
- Komunikat o błędzie zwrócony przez system.
WaterMarkCOM
Przestrzeń nazwZrzuty ekranu GrabzIt.S
Ta klasa reprezentuje niestandardowe watermarks przechowywane w GrabzIt
Metody publiczne
Właściwości publiczne
-
string Identifier
-
string XPosition
-
Poziome położenie watermark
-
string YPosition
-
Pionowa pozycja watermark
-
string Format