Narzędzia do przechwytywania i konwertowania Internetu

Klient GrabzIt z ASP.NETInterfejs API ASP.NET

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)COM

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
    • wymagany

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.
    • wymagany
    • 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.
    • Domyślnie: pusty
  • 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.
    • Domyślnie: 0 sekund
  • 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
  • bool Reverse - jeśli to prawda, ramki animowanego GIF-a są odwrócone
    • Domyślnie: false
  • string CustomWaterMarkId - dodaj niestandardowy znak wodny do animowanego GIF-a
    • Domyślnie: pusty
  • 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.
    • Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
    • 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.
    • Domyślnie: pusty
  • 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.
    • Domyślnie: pusty
  • string Proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
    • Domyślnie: pusty

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
    • wymagany
  • 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
    • wymagany
  • 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
    • wymagany
  • 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.
    • Domyślnie: pusty
  • int BrowserWidth - szerokość przeglądarki w pikselach
    • Domyślnie: 1024
    • Maksymalna ilość znaków: 10000
  • int BrowserHeight - wysokość przeglądarki w pikselach
    • Domyślnie: 768
    • 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: najwyższy możliwy stosunek szerokości przeglądarki, który mieści się w maksymalnej szerokości pakietu użytkowników
    • 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: najwyższy możliwy stosunek wysokości przeglądarki, który mieści się w maksymalnej wysokości dla pakietu użytkowników
    • 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 TargetElement - identyfikator lub klasa 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
    • Domyślnie: pusty
  • string HideElement - identyfikator lub klasa 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
    • Domyślnie: pusty
  • string WaitForElement - identyfikator lub klasa Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
    • Domyślnie: pusty
  • BrowserType RequestAs - rodzaj agenta użytkownika, którego chcesz używać
  • string CustomWaterMarkId - dodaj niestandardowy znak wodny do obrazu
    • Domyślnie: pusty
  • int Quality - w jakość zwróconego obrazu. To obecnie wpływa tylko na obrazy JPG, które mają 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
  • bool Transparent - jeśli prawda, jeżeli przechwytywanie obrazu powinno być przezroczyste. Jest to zgodne tylko z obrazami png i tiff.
    • Domyślnie: false
  • bool HD - jeśli to prawda, obraz przechwytywanie będzie w wysokiej rozdzielczości podwaja to rozmiar wymiarów obrazu.
    • Domyślnie: false
  • Country Country - kraj zrzut ekranu powinien zostać pobrany.
    • Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
    • 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
    • Domyślnie: pusty
  • 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.
    • Domyślnie: pusty
  • bool NoAds - Jeśli prawda reklamy powinny być automatycznie ukryte.
    • Domyślnie: false
  • bool NoCookieNotifications - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
    • Domyślnie: false
  • 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.
    • Domyślnie: pusty
  • string Proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
    • Domyślnie: pusty

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
    • wymagany
  • 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
    • wymagany
  • 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
    • wymagany
  • 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

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
    • wymagany
  • 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
    • wymagany
  • 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
    • wymagany
  • 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.
    • Domyślnie: pusty
  • bool IncludeBackground - jeśli to prawda, zrzut ekranu powinien zawierać tło strony internetowej
    • Domyślnie: true
  • 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
    • Domyślnie: true
  • bool IncludeOutline - prawda, jeśli Zakładki PDF powinno być dołączone
    • Domyślnie: false
  • string Title - podać tytuł dokumentu PDF
    • Domyślnie: pusty
  • string CoverURL - adres URL strony internetowej, która powinna być używana jako strona tytułowa pliku PDF
    • Domyślnie: pusty
  • int MarginTop - margines w milimetrach, który powinien pojawić się u góry strony dokumentu PDF
    • Domyślnie: 10
  • int MarginLeft - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu PDF
    • Domyślnie: 10
  • int MarginBottom - margines w milimetrach, który powinien pojawić się na dole strony dokumentu PDF
    • Domyślnie: 10
  • int MarginRight - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu PDF
    • Domyślnie: 10
  • 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: 1024
    • 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
    • Domyślnie: pusty
  • string TargetElement - identyfikator lub klasa Selektor CSS jedynego elementu HTML na docelowej stronie internetowej, który ma zostać włączony into PDF, wszystkie inne części strony są ignorowane. Jeśli istnieje wiele pasujących elementów HTML, wybierany jest pierwszy
    • Domyślnie: pusty
  • string HideElement - identyfikator lub klasa 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
    • Domyślnie: pusty
  • string WaitForElement - identyfikator lub klasa Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
    • Domyślnie: pusty
  • string CustomWaterMarkId - dodaj niestandardowy znak wodny do każdej strony dokumentu PDF
    • Domyślnie: pusty
  • 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.
    • Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
    • 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
    • Domyślnie: pusty
  • 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.
    • Domyślnie: pusty
  • bool NoAds - Jeśli prawda reklamy powinny być automatycznie ukryte.
    • Domyślnie: false
  • bool NoCookieNotifications - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
    • Domyślnie: false
  • 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.
    • Domyślnie: pusty
  • string Proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
    • Domyślnie: pusty
  • string MergeId - identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu PDF
    • Domyślnie: pusty
  • string Password - w hasło do ochrony dokumentu PDF z
    • Domyślnie: pusty

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
    • wymagany
  • 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
    • wymagany
  • 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
    • wymagany
  • 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.
    • Domyślnie: pusty
  • bool IncludeBackground - jeśli to prawda, obrazy tła strony internetowej powinny być zawarte w DOCX
    • Domyślnie: true
  • PageSize PageSize - rozmiar strony DOCX
  • PageOrientation Orientation - orientacja dokumentu DOCX
  • bool IncludeLinks - prawda, jeśli linki powinny być zawarte w DOCX
    • Domyślnie: true
  • bool IncludeImages - jeśli to prawda, obrazy strony internetowej powinny być zawarte w DOCX
    • Domyślnie: true
  • string Title - podać tytuł dokumentu DOCX
    • Domyślnie: pusty
  • int MarginTop - margines w milimetrach, który powinien pojawić się na górze strony dokumentu DOCX
    • Domyślnie: 10
  • int MarginLeft - margines w milimetrach, który powinien pojawić się po lewej stronie strony dokumentu DOCX
    • Domyślnie: 10
  • int MarginBottom - margines w milimetrach, który powinien pojawić się na dole strony dokumentu DOCX
    • Domyślnie: 10
  • int MarginRight - margines w milimetrach, który powinien pojawić się po prawej stronie dokumentu DOCX
    • Domyślnie: 10
  • 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: 1024
    • 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
    • Domyślnie: pusty
  • string TargetElement - identyfikator lub klasa 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
    • Domyślnie: pusty
  • string HideElement - identyfikator lub klasa 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
    • Domyślnie: pusty
  • string WaitForElement - identyfikator lub klasa Selektory CSS elementu HTML na stronie internetowej, który musi być widoczny przed wykonaniem przechwytywania
    • Domyślnie: pusty
  • 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.
    • Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
    • 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
    • Domyślnie: pusty
  • 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.
    • Domyślnie: pusty
  • bool NoAds - Jeśli prawda reklamy powinny być automatycznie ukryte.
    • Domyślnie: false
  • bool NoCookieNotifications - jeśli to prawda, wszystkie powszechnie spotykane powiadomienia o plikach cookie powinny być automatycznie ukryte.
    • Domyślnie: false
  • 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.
    • Domyślnie: pusty
  • string Proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
    • Domyślnie: pusty
  • string MergeId - identyfikator przechwytywania, który powinien być scalone na początku nowego dokumentu DOCX
    • Domyślnie: pusty
  • string Password - w hasło do ochrony dokumentu DOCX z
    • Domyślnie: pusty

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
    • wymagany
  • 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.
    • wymagany
  • 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.
    • wymagany
  • 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
    • Domyślnie: pusty
  • int TableNumberToInclude - indeks tabeli do przekonwertowania, w której wszystkie tabele na stronie internetowej są uporządkowane od góry strony do dołu
    • Domyślnie: 1
  • TableFormat Format - format, w jakim powinna być tabela
  • bool IncludeHeaderNames - jeśli prawdziwe nazwy nagłówków zostaną uwzględnione w tabeli
    • Domyślnie: true
  • 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
    • Domyślnie: false
  • string TargetElement - identyfikator jedynego elementu HTML na stronie internetowej, którego należy użyć do wyodrębnienia tabel
    • Domyślnie: pusty
  • BrowserType RequestAs - rodzaj agenta użytkownika, którego chcesz używać
  • Country Country - kraj zrzut ekranu powinien zostać pobrany.
    • Ostrzeżenie: ta funkcja jest obecnie w fazie beta i może nie zapewniać spójnych wyników.
    • 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
    • Domyślnie: pusty
  • 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.
    • Domyślnie: pusty
  • 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.
    • Domyślnie: pusty
  • string Proxy - szczegóły proxy HTTP oprogramowanie przeglądarki powinno być użyte do utworzenia tego przechwytywania
    • Domyślnie: pusty

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
    • wymagany

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

GrabzItFile SaveTo()

Save wynik synchronicznie do GrabzItFile obiekt.

Wartość zwracana

GrabzItFile przedmiot


Ostrzeżenie: ta metoda jest synchroniczna, więc spowoduje zatrzymanie aplikacji podczas przetwarzania wyniku

SaveTo(string saveDo pliku)COM

Save wynik synchronicznie do pliku.

parametry

  • saveToFile - ścieżka przechwytywania pliku saved po zakończeniu
    • wymagany

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
    • wymagany

Wartość zwracana

status przedmiot


GrabzItCookie [] GetCookies (string domena)COM

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
    • wymagany

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ć
    • wymagany
  • domena - domena strony internetowej, dla której ma zostać ustawiony plik cookie
    • wymagany
  • 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
    • wymagany
  • domena - domena strony internetowej, dla której chcesz usunąć plik cookie
    • wymagany

Wartość zwracana

Prawda, jeśli plik cookie zostanie pomyślnie usunięty, w przeciwnym razie fałsz


WaterMark[] OtrzymaćWaterMarks(String identyfikator)COM

Uzyskaj wszystkie przesłane niestandardowe znaki wodne

Wartość zwracana

WaterMark szyk


WaterMark OtrzymaćWaterMark(String identyfikator)COM

Zwróć niestandardowy znak wodny zgodny z określonym identyfikatorem

parametry

  • identyfikator - identyfikator określonego niestandardowego znaku wodnego, który chcesz wyświetlić
    • wymagany

Wartość zwracana

WaterMark


dodaćWaterMark(string identyfikator, string ścieżka, HorizontalPosition XP, VerticalPosition ypos)COM

Dodaj nowy niestandardowy znak wodny

parametry

  • identyfikator - identyfikator, który chcesz nadać niestandardowemu znakowi wodnemu. Ważne jest, aby ten identyfikator był unikalny.
    • wymagany
  • ścieżka - bezwzględna ścieżka znaku wodnego na twoim serwerze. Na przykład C: /watermark/1.png
    • wymagany
  • 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 true, jeśli znak wodny został pomyślnie ustawiony


DeleteWaterMark(string identyfikator)COM

Usuń niestandardowy znak wodny

parametry

  • identyfikator - identyfikator niestandardowego znaku wodnego, który chcesz usunąć
    • wymagany

Wartość zwracana

zwraca true, jeśli znak wodny 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
    • wymagany

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
    • wymagany

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

  • ścieżka - ścieżka zaszyfrowanego przechwytywania
    • wymagany
  • klucz - klucz szyfrujący
    • wymagany

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
  • FallbackBrowser = 3

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.

  • Poziomo = 0
  • Portret = 1

CSSMediaType

Przestrzeń nazwGrabzIt.Enums

Ten wyliczenie obejmuje następujące wartości.

  • Screen = 0
  • Print = 1

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
    • Nazwa ciasteczka
  • string Value
    • Wartość pliku cookie.
  • 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
      • wymagany
  • string DoString()

Właściwości publiczne

  • byte[] Bytes

statusCOM

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 znaki wodne przechowywane w GrabzIt

Metody publiczne

Właściwości publiczne

  • string Identifier
    • Identyfikator znaku wodnego
  • string XPosition
    • Pozioma pozycja znaku wodnego
      • Lewo
      • Centrum
      • Dobrze
  • string YPosition
    • Pionowa pozycja znaku wodnego
      • top
      • Środkowy
      • Dolny
  • string Format
    • Format znaku wodnego