Описание
Этот класс обрабатывает все коммуникации с веб-сервисами GrabzIt. Все методы отмечены COM также работают, когда GrabzIt ASP.NET DLL используется как COM-объект.
Публичные методы
- 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)
- URLToVideo(string url, VideoOptions options)
- HTMLToVideo(string html, VideoOptions options)
- FileToVideo(string path, VideoOptions 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)
Этот метод возвращает сам скриншот. Если ничего не возвращено, значит что-то пошло не так или скриншот еще не готов.
параметры
-
id - уникальный идентификатор скриншота
Возвращаемое значение
GrabzItFile объект
Укажите URL-адрес онлайн-видео, которое необходимо преобразовать intанимированный GIF.
параметры
-
url - URL видео онлайн для конвертации intо анимированный GIF.
- необходимые
-
Принимает Vimeo и YouTube видео URL
- Предупреждение о анимации видео Vimeo и YouTube зависит от третьей стороны и, следовательно, может не дать согласованных результатов
-
кредита - экземпляр AnimationOptions Класс, который определяет любые специальные параметры, которые будут использоваться при создании анимированного GIF.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
AnimationOptionsCOM
Пространство именGrabzIt.Parameters
Класс представляет все параметры, доступные при создании анимированного GIF.
Публичная недвижимость
-
string CustomId - пользовательский идентификатор, который вы можете передать через анимированный GIF веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
-
int Width - ширина получаемого анимированного GIF в пикселях.
- По умолчанию: 180px
- Максимум: максимальная ширина для упаковки
- Авто-размер: -1 (передача -1 означает, что ширина анимированный GIF масштабируется по отношению к его высоте, если ширина автоматически измеряется, высота не может)
-
int Height - высота получаемого анимированного GIF в пикселях.
- По умолчанию: 120px
- Максимум: максимальная высота упаковки
- Авто-размер: -1 (передача -1 означает, что высота анимированный GIF масштабируется по отношению к его ширине, если высота автоматически измеряется, ширина не может)
-
int Start - начальная позиция видео, которое должно быть преобразовано intанимированный GIF.
-
int Duration - продолжительность видео в секундах, которое должно быть конвертировано intанимированный GIF.
- По умолчанию: максимальная длина пакета
-
float Speed - скорость анимированного GIF.
- По умолчанию: 1
- Минимум: 0.2
- Максимум: 10
-
float FramesPerSecond - количество кадров в секунду, которое должно быть снято с видео.
- По умолчанию: 10
- Минимум: 0.2
- Максимум: 60
-
int Repeat - количество циклов анимированного GIF.
- По умолчанию: 0
- Цикл непрерывно: 0
- Никогда не зацикливаться: -1
-
bool Reverse - если true, кадры анимированного GIF меняются местами
-
string CustomWaterMarkId - Добавлять изготовленный на заказ watermark or особый watermark в анимированный GIF
-
int Quality - качество возвращаемого изображения, который имеет сжатие по умолчанию 85%.
- Снижение качества уменьшит размер файла и сократит время загрузки.
- По умолчанию: -1
- Минимум: -1
- Максимум: 100
-
Country Country - страна анимированный GIF должен быть взят из.
- По умолчанию: текущее самое быстрое местоположение
- Опции: Страна.Сингапур, Страна.СОЕДИНЕННОЕ КОРОЛЕВСТВО, Страна.НАС
-
string ExportURL - URL экспорта это указывает, куда захват должен быть экспортирован тоже.
-
string EncryptionKey - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
-
string Proxy - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
Определяет URL, который должен быть преобразован intскриншот изображения.
параметры
-
url - URL, из которого должен быть сделан снимок экрана
-
кредита - экземпляр ImageOptions класс, который определяет любые специальные опции, которые будут использоваться при создании скриншота.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
HTMLToImage(string HTML, ImageOptions опции)COM
Определяет HTML, который должен быть преобразован intoa изображение.
параметры
-
HTML - HTML для преобразования intизображение
- кредита - экземпляр ImageOptions Класс, который определяет любые специальные параметры, которые будут использоваться при создании изображения.
Возвращаемое значение
аннулировать
FileToImage(string дорожка, ImageOptions опции)COM
Определяет файл HTML, который должен быть преобразован intoa изображение.
параметры
-
путь - путь к файлу HTML-файла для преобразования intизображение
-
кредита - экземпляр ImageOptions Класс, который определяет любые специальные параметры, которые будут использоваться при создании изображения.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
ImageOptionsCOM
Пространство именGrabzIt.Parameters
Класс представляет все параметры, доступные при создании снимков изображения.
Публичная недвижимость
-
string CustomId - пользовательский идентификатор, который вы можете передать на веб-сервис скриншотов. Он будет возвращен с указанным вами обратным URL-адресом.
-
int BrowserWidth - ширина браузера в пикселях
- По умолчанию: 1366
- Максимум: 10000
-
int BrowserHeight - высота браузера в пикселях
- По умолчанию: 1170
- Максимум: 10000
- Полная длина: -1 (пропуск -1 означает, что взят снимок всей веб-страницы)
-
int OutputWidth - ширина получаемого эскиза в пикселях
- По умолчанию: если и ширина вывода, и высота вывода не указаны или 0, тогда ширина и высота вывода будут соответствовать ширине и высоте окончательного изображения, если высота вывода указана, ширина вывода будет пропорциональна высоте вывода.
- Максимум: максимальная ширина для упаковки
- Полная ширина: -1 (пропуск -1 означает, что ширина эскиза не уменьшается)
-
int OutputHeight - высота получаемого миниатюры в пикселях
- По умолчанию: если и ширина вывода, и высота вывода не указаны или 0, тогда ширина и высота вывода будут соответствовать ширине и высоте окончательного изображения, если ширина вывода указана, высота вывода будет пропорциональна ширине вывода
- Максимум: максимальная высота упаковки
- Полная высота: -1 (пропуск -1 означает, что высота эскиза не уменьшается)
-
ImageFormat Format - формат скриншота должен быть в.
-
int Delay - количество миллисекунд до подождите, прежде чем сделать скриншот
- По умолчанию: 0
- Максимум: 30000
-
string ClickElement - определяет элемент HTML, используя CSS селектор щелкнуть. Помните, что задержка также может потребоваться для просмотра эффектов щелчка.
- По умолчанию: пусто
- Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
-
string TargetElement - CSS селектор единственного HTML-элемента на целевой веб-странице, который должен быть повернут into Скриншот, все остальные части веб-страницы игнорируются. Если есть несколько совпадающих элементов HTML, выбирается первый
-
string HideElement - CSS селекторы один или несколько элементов HTML на веб-странице, которые нужно скрыть, чтобы указать несколько элементов HTML для скрытия, разделяя каждый селектор запятой
-
string WaitForElement - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
-
BrowserType RequestAs - тип пользовательского агента, который вы хотите использовать
-
string CustomWaterMarkId - добавить изготовленный на заказ watermark or особый watermark к изображению
-
int Quality - качество возвращаемого изображения. В настоящее время это влияет только на изображения JPG и WEBP, сжатие которых по умолчанию составляет 90%.
- Снижение качества уменьшит размер файла и сократит время загрузки.
- По умолчанию: -1
- Минимум: -1
- Максимум: 100
-
bool Transparent - если правда, если захват изображения должен быть прозрачным, Это совместимо только с изображениями PNG и TIFF.
-
bool HD - если верно изображение захват будет в высоком разрешении это удваивает размер изображения.
-
Country Country - страна скриншот должен быть взят из.
- По умолчанию: текущее самое быстрое местоположение
- Опции: Страна.Сингапур, Страна.СОЕДИНЕННОЕ КОРОЛЕВСТВО, Страна.НАС
-
string ExportURL - URL экспорта это указывает, куда захват должен быть экспортирован тоже
-
string EncryptionKey - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
-
bool NoAds - если правда реклама должна быть автоматически скрыта.
-
bool NoCookieNotifications - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
-
string Address - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
-
string Proxy - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
Публичные методы
-
AddPostParameter (string название, string стоимость) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
- name - имя параметра HTTP Post
- value - значение параметра HTTP Post
URLToRenderedHTML(string URL, HTMLOptions опции)COM
Определяет URL, который должен быть преобразован intо рендеринга HTML.
параметры
-
url - URL-адрес, из которого должен быть выполнен визуализированный HTML
-
кредита - экземпляр HTMLOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании визуализированного HTML.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
HTMLToRenderedHTML(string HTML, HTMLOptions опции)COM
Определяет HTML, который должен быть преобразован intо рендеринга HTML.
параметры
-
HTML - HTML для преобразования intо рендеринг HTML
- кредита - экземпляр HTMLOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании визуализированного HTML.
Возвращаемое значение
аннулировать
FileToRenderedHTML(string дорожка, HTMLOptions опции)COM
Определяет файл HTML, который должен быть преобразован intо рендеринга HTML.
параметры
-
путь - путь к файлу HTML-файла для преобразования intо рендеринг HTML
-
кредита - экземпляр HTMLOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании визуализированного HTML.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
HTMLOptionsCOM
Пространство именGrabzIt.Parameters
Класс представляет все параметры, доступные при создание визуализированных захватов HTML.
Публичная недвижимость
-
string CustomId - пользовательский идентификатор, через который вы можете перейти к отображаемому веб-сервису HTML. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
-
int BrowserWidth - ширина браузера в пикселях
- По умолчанию: 1366
- Максимум: 10000
-
int BrowserHeight - высота браузера в пикселях
- По умолчанию: 1170
- Максимум: 10000
-
int Delay - количество миллисекунд до подождите, прежде чем брать визуализированный HTML
- По умолчанию: 0
- Максимум: 30000
-
string WaitForElement - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
-
BrowserType RequestAs - тип пользовательского агента, который вы хотите использовать
-
Country Country - страна обработанный HTML должен быть взят из.
- По умолчанию: текущее самое быстрое местоположение
- Опции: Страна.Сингапур, Страна.СОЕДИНЕННОЕ КОРОЛЕВСТВО, Страна.НАС
-
string ExportURL - URL экспорта это указывает, куда захват должен быть экспортирован тоже
-
string EncryptionKey - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
-
bool NoAds - если правда реклама должна быть автоматически скрыта.
-
bool NoCookieNotifications - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
-
string Address - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
-
string Proxy - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
Публичные методы
-
AddPostParameter (string название, string стоимость) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
- name - имя параметра HTTP Post
- value - значение параметра HTTP Post
Определяет URL, который должен быть преобразован intоо видео.
параметры
-
url — URL-адрес, с которого должно быть захвачено видео.
-
кредита — экземпляр класса VideoOptions, определяющий любые специальные параметры, используемые при создании видео.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
Указывает HTML-код, из которого должно быть захвачено видео.
параметры
-
HTML - HTML для преобразования intоа видео
- кредита — экземпляр класса VideoOptions, определяющий любые специальные параметры, используемые при создании видео.
Возвращаемое значение
аннулировать
ФайлToVideo(string дорожка, ВидеоПараметры опции)COM
Определяет файл HTML, который должен быть преобразован intоо видео.
параметры
-
путь - путь к файлу HTML-файла для преобразования intоа видео
-
кредита — экземпляр класса VideoOptions, определяющий любые специальные параметры, используемые при создании видео.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
ВидеоПараметрыCOM
Пространство именGrabzIt.Parameters
Класс представляет все параметры, доступные при создание видео веб-страницы.
Публичная недвижимость
-
string CustomId — пользовательский идентификатор, который можно передать веб-сервису видео. Он будет возвращен с указанным вами URL-адресом обратного вызова.
-
int BrowserWidth - ширина браузера в пикселях
- По умолчанию: 1366
- Максимум: 10000
-
int BrowserHeight - высота браузера в пикселях
- По умолчанию: 1170
- Максимум: 10000
-
int Start - количество миллисекунд ожидания перед созданием видео
- По умолчанию: 0
- Максимум: 30000
-
string WaitForElement - CSS селекторы элемента HTML на веб-странице, которая должно быть видно до рендеринга видео
-
BrowserType RequestAs - тип пользовательского агента, который вы хотите использовать
-
Country Country - страна в котором должна быть загружена веб-страница.
- По умолчанию: текущее самое быстрое местоположение
- Опции: Страна.Сингапур, Страна.СОЕДИНЕННОЕ КОРОЛЕВСТВО, Страна.НАС
-
string ExportURL - URL экспорта это указывает, куда захват должен быть экспортирован тоже
-
string EncryptionKey - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
-
bool NoAds - если правда реклама должна быть автоматически скрыта.
-
bool NoCookieNotifications - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
-
string Address - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
-
string Proxy - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
-
float FramesPerSecond - количество кадров в секунду (или скриншотов в секунду), которое следует использовать при создании видео.
- По умолчанию: 10
- Минимум: 0.2
- Максимум: 60
-
int Duration — продолжительность видео в секундах. Это время захвата веб-страницы.
- По умолчанию: максимальная длина пакета
Публичные методы
-
AddPostParameter (string название, string стоимость) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
- name - имя параметра HTTP Post
- value - значение параметра HTTP Post
URLToPDF(string URL, PDFOptions опции)COM
Определяет URL, который должен быть преобразован intoa PDF.
параметры
-
URL - URL, который должен быть преобразован intoa PDF
-
PDFOptions options - экземпляр класса PDFOptions, который определяет любые специальные параметры, используемые при создании PDF.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
HTMLToPDF(string HTML, PDFOptions опции)COM
Определяет HTML, который должен быть преобразован intoa PDF.
параметры
-
HTML - HTML для преобразования intoa PDF
-
PDFOptions options - экземпляр класса GrabzItPDFOptions, который определяет любые специальные опции, используемые при создании PDF.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
FileToPDF(string дорожка, PDFOptions опции)COM
Определяет файл HTML, который должен быть преобразован intoa PDF.
параметры
-
путь - путь к файлу HTML-файла для преобразования intoa PDF
-
PDFOptions options - экземпляр класса PDFOptions, который определяет любые специальные параметры, используемые при создании PDF.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
PDFOptionsCOM
Пространство именGrabzIt.Parameters
Класс представляет все параметры, доступные при создании снимков PDF.
Публичная недвижимость
-
string CustomId - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
-
bool IncludeBackground - если true, фон веб-страницы должен быть включен в скриншот
-
PageSize PageSize - размер страницы PDF
-
PageOrientation Orientation - ориентация PDF документа
-
CSSMediaType CSSMediaType - CSS Media Тип документа PDF
-
bool IncludeLinks - true, если ссылки должны быть включены в PDF
-
bool IncludeOutline - правда, если PDF закладки должны быть включены
-
string Title - укажите название документа PDF
-
string CoverURL - URL веб-страницы, которая должна использоваться в качестве обложки для PDF
-
int MarginTop - поле в миллиметрах, которое должно отображаться в верхней части страницы документа PDF
-
int MarginLeft - поле в миллиметрах, которое должно появиться слева от страницы документа PDF
-
int MarginBottom - поле в миллиметрах, которое должно отображаться внизу страницы документа PDF
-
int MarginRight - поле в миллиметрах, которое должно отображаться справа от документа PDF
-
int BrowserWidth - ширина браузера в пикселях
- Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
- По умолчанию: 1366
- Максимум: 10000
- Авто Ширина: -1 (передача -1 означает, что ширина браузера соответствует ширине PDF-документа)
-
int PageWidth - пользовательская ширина полученного PDF в мм
- По умолчанию: PageSize ширина
- Минимум: 15mm
-
int PageHeight - пользовательская высота получаемого PDF в мм
- По умолчанию: PageSize высота
- Минимум: 15mm
-
int Delay - количество миллисекунд до подождите, прежде чем сделать скриншот
- По умолчанию: 0
- Максимум: 30000
-
BrowserType RequestAs - тип пользовательского агента, который вы хотите использовать
-
string TemplateId - добавить шаблон Идентификатор, который определяет верхний и нижний колонтитулы документа PDF
-
string ClickElement - определяет элемент HTML, используя CSS селектор щелкнуть. Помните, что задержка также может потребоваться для просмотра эффектов щелчка.
- По умолчанию: пусто
- Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
-
string TargetElement - CSS селектор из единственного HTML-элемент на целевой веб-странице, которую нужно перевернуть intoa PDFвсе остальные части веб-страницы игнорируются. Если есть несколько совпадающих элементов HTML, выбирается первый
-
string HideElement - CSS селекторы один или несколько элементов HTML на веб-странице, которые нужно скрыть, чтобы указать несколько элементов HTML для скрытия, разделяя каждый селектор запятой
-
string WaitForElement - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
-
string CustomWaterMarkId - добавить изготовленный на заказ watermark or особый watermark на каждую страницу PDF-документа
-
int Quality - качество возвращаемого PDF, По умолчанию используется рекомендуемое качество для PDF.
- Снижение качества уменьшит размер файла и сократит время загрузки.
- По умолчанию: -1
- Минимум: -1
- Максимум: 100
-
Country Country - страна скриншот должен быть взят из.
- По умолчанию: текущее самое быстрое местоположение
- Опции: Страна.Сингапур, Страна.СОЕДИНЕННОЕ КОРОЛЕВСТВО, Страна.НАС
-
string ExportURL - URL экспорта это указывает, куда захват должен быть экспортирован тоже
-
string EncryptionKey - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
-
bool NoAds - если правда реклама должна быть автоматически скрыта.
-
bool NoCookieNotifications - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
-
string Address - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
-
string Proxy - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
-
string MergeId - идентификатор захвата, который должен быть объединены в начале нового документа PDF
-
string Password - пароль для защиты PDF документа
Публичные методы
-
AddPostParameter (string название, string стоимость) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
- name - имя параметра HTTP Post
- value - значение параметра HTTP Post
-
AddTemplateParameter (string название, string стоимость) - определить пользовательский шаблон параметр и значение, этот метод может быть вызван несколько раз, чтобы добавить несколько параметров.
- name - имя параметра шаблона
- value - значение параметра шаблона
URLToDOCX (string URL, DOCXOptions опции)COM
Определяет URL, который должен быть преобразован intооо
параметры
-
URL - URL, который должен быть преобразован intoa DOCX
-
DOCXOptions параметры - экземпляр DOCXOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании DOCX.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
HTMLToDOCX(string HTML, DOCXOptions опции)COM
Определяет HTML, который должен быть преобразован intооо
параметры
-
HTML - HTML для преобразования intoa DOCX
-
DOCXOptions варианты - экземпляр GrabzItDOCXOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании DOCX.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
FileToDOCX(string дорожка, DOCXOptions опции)COM
Определяет файл HTML, который должен быть преобразован intооо
параметры
-
путь - путь к файлу HTML-файла для преобразования intoa DOCX
-
DOCXOptions параметры - экземпляр DOCXOptions Класс, который определяет любые специальные опции, которые будут использоваться при создании DOCX.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
DOCXOptionsCOM
Пространство именGrabzIt.Parameters
Класс представляет все параметры, доступные при создании захватов DOCX.
Публичная недвижимость
-
string CustomId - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали.
-
bool IncludeBackground - если true, фоновые изображения веб-страницы должны быть включены в DOCX
-
PageSize PageSize - размер страницы DOCX
-
PageOrientation Orientation - ориентация документа DOCX
-
bool IncludeLinks - true, если ссылки должны быть включены в DOCX
-
bool IncludeImages - если истина, изображения веб-страницы должны быть включены в DOCX
-
string Title - предоставить заголовок документа DOCX
-
int MarginTop - поле в миллиметрах, которое должно отображаться в верхней части страницы документа DOCX
-
int MarginLeft - поле в миллиметрах, которое должно появиться слева от страницы документа DOCX
-
int MarginBottom - поле в миллиметрах, которое должно отображаться внизу страницы документа DOCX
-
int MarginRight - поле в миллиметрах, которое должно отображаться справа от документа DOCX
-
int BrowserWidth - ширина браузера в пикселях
- Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
- По умолчанию: 1366
- Максимум: 10000
- Авто Ширина: -1 (передача -1 означает, что ширина браузера соответствует ширине документа DOCX)
-
int PageWidth - пользовательская ширина результирующего DOCX в мм
- По умолчанию: PageSize ширина
- Минимум: 15mm
-
int PageHeight - Пользовательская высота результирующего DOCX в мм
- По умолчанию: PageSize высота
- Минимум: 15mm
-
int Delay - количество миллисекунд до подождите, прежде чем сделать скриншот
- По умолчанию: 0
- Максимум: 30000
-
BrowserType RequestAs - тип пользовательского агента, который вы хотите использовать
-
string TemplateId - добавить шаблон Идентификатор, который определяет верхний и нижний колонтитулы документа DOCX
-
string ClickElement - определяет элемент HTML, используя CSS селектор щелкнуть. Помните, что задержка также может потребоваться для просмотра эффектов щелчка.
- По умолчанию: пусто
- Предупреждение: эта функция в настоящее время находится в стадии бета-тестирования и может не давать согласованных результатов.
-
string TargetElement - CSS селектор единственного HTML-элемента на целевой веб-странице, который должен быть повернут into DOCX, все остальные части веб-страницы игнорируются. Если есть несколько совпадающих элементов HTML, выбирается первый
-
string HideElement - CSS селекторы один или несколько элементов HTML на веб-странице, которые нужно скрыть, чтобы указать несколько элементов HTML для скрытия, разделяя каждый селектор запятой
-
string WaitForElement - CSS селекторы элемента HTML на веб-странице, которая должен быть виден до выполнения захвата
-
int Quality - качество возвращаемого DOCX, По умолчанию используется рекомендуемое качество для DOCX.
- Снижение качества уменьшит размер файла и сократит время загрузки.
- По умолчанию: -1
- Минимум: -1
- Максимум: 100
-
Country Country - страна скриншот должен быть взят из.
- По умолчанию: текущее самое быстрое местоположение
- Опции: Страна.Сингапур, Страна.СОЕДИНЕННОЕ КОРОЛЕВСТВО, Страна.НАС
-
string ExportURL - URL экспорта это указывает, куда захват должен быть экспортирован тоже
-
string EncryptionKey - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
-
bool NoAds - если правда реклама должна быть автоматически скрыта.
-
bool NoCookieNotifications - если правда, все обычно встречаются уведомления о файлах cookie должны быть автоматически скрыты.
-
string Address - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
-
string Proxy - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
-
string MergeId - идентификатор захвата, который должен быть объединены в начале нового документа DOCX
-
string Password - пароль для защиты документа DOCX
Публичные методы
-
AddPostParameter (string название, string стоимость) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
- name - имя параметра HTTP Post
- value - значение параметра HTTP Post
-
AddTemplateParameter (string название, string стоимость) - определить пользовательский шаблон параметр и значение, этот метод может быть вызван несколько раз, чтобы добавить несколько параметров.
- name - имя параметра шаблона
- value - значение параметра шаблона
Определяет URL, из которого должны быть извлечены таблицы HTML.
параметры
-
url - URL для извлечения HTML-таблиц из
-
TableOptions параметры - экземпляр TableOptions Класс, который определяет любые специальные параметры, которые будут использоваться при преобразовании таблицы HTML.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
HTMLToTable (string HTML, TableOptions опции)COM
Определяет HTML, из которого должны быть извлечены таблицы HTML.
параметры
-
html - HTML-код для извлечения HTML-таблиц.
-
TableOptions параметры - экземпляр TableOptions Класс, который определяет любые специальные параметры, которые будут использоваться при преобразовании таблицы HTML.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
FileToTable (string дорожка, TableOptions опции)COM
Указывает файл HTML, из которого должны быть извлечены таблицы HTML.
параметры
-
путь - путь к файлу HTML, из которого извлекаются таблицы HTML.
-
TableOptions параметры - экземпляр TableOptions Класс, который определяет любые специальные параметры, которые будут использоваться при преобразовании таблицы HTML.
- Требующийся для COM в противном случае необязательно
Возвращаемое значение
аннулировать
TableOptionsCOM
Пространство именGrabzIt.Parameters
Класс представляет все параметры, доступные при преобразовании таблиц HTML в CSV, XLSX или JSON.
Публичная недвижимость
-
string CustomId - пользовательский идентификатор, который вы можете передать через веб-сервис. Это будет возвращено с URL-адресом обратного вызова, который вы указали
-
int TableNumberToInclude - индекс таблицы, которую нужно преобразовать, если все таблицы на веб-странице упорядочены сверху вниз по веб-странице
-
TableFormat Format - формат таблицы должен быть в
-
bool IncludeHeaderNames - если в таблицу будут включены истинные имена заголовков
-
bool IncludeAllTables - если true, вся таблица на веб-странице будет извлечена, и каждая таблица появится в отдельном листе электронной таблицы. Доступно только с форматом XLSX
-
string TargetElement - идентификатор единственного HTML-элемента на веб-странице, который должен использоваться для извлечения таблиц из
-
BrowserType RequestAs - тип пользовательского агента, который вы хотите использовать
-
Country Country - страна скриншот должен быть взят из.
- По умолчанию: текущее самое быстрое местоположение
- Опции: Страна.Сингапур, Страна.СОЕДИНЕННОЕ КОРОЛЕВСТВО, Страна.НАС
-
string ExportURL - URL экспорта это указывает, куда захват должен быть экспортирован тоже
-
string EncryptionKey - если указан базовый ключ шифрования AES в кодировке 64, ваш захват шифруется при его создании. Рекомендуется использовать создать метод ключа шифрования создать ключ и методы дешифрования расшифровать зашифрованный захват, как показано в этот пример.
-
string Address - URL для выполнения кода HTML. Может быть полезен, если конвертируемый HTML использует относительные URL для таких ресурсов, как CSS и изображения.
-
string Proxy - подробности HTTP прокси программное обеспечение браузера должно использовать для создания этого захвата
Публичные методы
-
AddPostParameter (string название, string стоимость) - определяет параметр HTTP Post и, необязательно, значение; этот метод может вызываться несколько раз для добавления нескольких параметров. Использование этого метода заставит GrabzIt выполнить сообщение HTTP.
- name - имя параметра HTTP Post
- value - значение параметра HTTP Post
Save()
Save результат асинхронно и возвращает уникальный идентификатор, который можно использовать для получения снимка экрана с GetResult метод.
Возвращаемое значение
Уникальный идентификатор скриншота, в противном случае, если произошла ошибка, генерируется исключение. Это можно использовать для получения скриншота с GetResult метод
Это рекомендуемый метод сохранения файла
Save(string CallBackURL)COM
Save результат асинхронно и возвращает уникальный идентификатор, который можно использовать для получения снимка экрана с GetResult метод.
параметры
-
callBackURL - обработчик Служба GrabzIt должна позвонить после завершения своей работы
Возвращаемое значение
Уникальный идентификатор скриншота, в противном случае, если произошла ошибка, генерируется исключение. Это можно использовать для получения скриншота с GetResult метод
Предупреждение: этот метод является синхронным, поэтому приложение будет приостановлено во время обработки результата
Save результат синхронно с GrabzItFile объект.
Возвращаемое значение
GrabzItFile объект
Save результат асинхронно с GrabzItFile объект. Доступно, только если версия .NET поддерживает асинхронные методы.
Возвращаемое значение
GrabzItFile объект
Предупреждение: этот метод является синхронным, поэтому приложение будет приостановлено во время обработки результата
SaveTo(string saveToФайл)COM
Save результат синхронно в файл.
параметры
-
saveToФайл - путь к файлу, который будет захвачен. saved, когда он будет завершен
Возвращаемое значение
возвращает true, если он успешен, в противном случае выдается исключение.
SaveToАсинхронный(string saveToФайл)
Save результат асинхронно в файл. Доступно, только если версия .NET поддерживает асинхронные методы.
параметры
-
saveToФайл - путь к файлу, который будет захвачен. saved, когда он будет завершен
Возвращаемое значение
возвращает true, если он успешен, в противном случае выдается исключение.
Статус GetStatus (string Я бы)COM
Получить текущий статус скриншота GrabzIt.
параметры
-
id - уникальный идентификатор скриншота
Возвращаемое значение
Статус объект
Получить все куки, которые GrabzIt использует для определенного домена. Это может также включать определенные пользователем файлы cookie.
параметры
-
домен - домен для возврата куки
Возвращаемое значение
GrabzItCookie массив
SetCookie (string название, string домен, string стоимость, string дорожка, bool httponly, DateTime? истекает)COM
Устанавливает новый пользовательский файл cookie для GrabzIt, если пользовательский файл cookie имеет то же имя и домен, что и глобальный файл cookie, глобальный файл cookie переопределяется.
Это может быть полезно, если функциональность веб-сайта контролируется куки-файлами.
параметры
-
name - имя куки для установки
-
домен - домен веб-сайта, для которого устанавливается файл cookie
- value - значение куки
- путь - путь к сайту, к которому относится cookie
- httponly - если true, cookie может использоваться только с протоколом HTTP
- expires - определяет, когда истекает срок действия cookie. Передайте нулевое значение, если срок действия файла cookie не истек
Возвращаемое значение
True, если cookie успешно установлен, иначе false
DeleteCookie (string название, string домен)COM
Удалить пользовательский файл cookie или заблокировать использование глобального файла cookie
параметры
-
name - имя куки для удаления
-
домен - домен сайта для удаления куки
Возвращаемое значение
True, если cookie успешно удален, иначе false
WaterMark[] ПолучитьWaterMarks(String идентификатор)COM
Получите все загруженные вами watermarks
Возвращаемое значение
WaterMark массив
WaterMark ПолучитьWaterMark(String идентификатор)COM
Верните свой заказ watermark который соответствует указанному идентификатору
параметры
-
идентификатор - идентификатор конкретного кастома watermark ты хочешь посмотреть
Возвращаемое значение
WaterMark
Добавить новый обычай watermark
параметры
-
идентификатор - идентификатор, который вы хотите присвоить пользовательскому watermark. Важно, чтобы этот идентификатор был уникальным.
-
path - абсолютный путь watermark на вашем сервере. Например, C: /watermark/1.png
-
xpos - горизонтальная позиция, в которой вы хотите, чтобы скриншот появлялся в
-
ypos - вертикальная позиция, в которой вы хотите, чтобы скриншот появлялся в
Возвращаемое значение
возвращает истину, если watermark был успешно установлен
DeleteWaterMark(string идентификатор)COM
Удалить кастом watermark
параметры
-
идентификатор - идентификатор кастомного watermark ты хочешь удалить
Возвращаемое значение
возвращает истину, если watermark был успешно удален
SetLocalProxy (string proxyUrl)COM
Этот метод позволяет локальный прокси-сервер использоваться для всех запросов.
параметры
-
proxyUrl - URL-адрес, который может включать порт прокси-сервера при необходимости. Предоставление нулевого значения удалит любой ранее установленный прокси
UseSSL (bool стоимость)COM
Определяет, если запросы к GrabzIt's API должен использовать SSL
параметры
-
значение - если true, все запросы к API GrabzIt будут использовать SSL
string CreateEncryptionKey ()COM
Создайте криптографически безопасный базовый ключ шифрования 64 длиной 44.
Расшифровать (string дорожка, string ключ)COM
Расшифруйте зашифрованный захват, используя предоставленный ключ шифрования.
параметры
GrabzItFile Расшифровать (GrabzItFile файл, string ключ)
Расшифруйте зашифрованный захват, используя предоставленный ключ шифрования.
параметры
byte [] Decrypt (byte [] data, string ключ)
Расшифруйте зашифрованный захват, используя предоставленный ключ шифрования.
параметры
При установке свойств перечисления в COM-объектах вместо этого используйте эквивалентное числовое значение для перечисления.
Перечисления
ImageFormat
Пространство именGrabzIt.Enums
Это перечисление состоит из следующих значений.
- bmp8 = 0
- bmp16 = 1
- bmp24 = 2
- bmp = 3
- jpg = 4
- TIFF = 5
- png = 6
- webp = 7
BrowserType
Пространство именGrabzIt.Enums
Это перечисление состоит из следующих значений.
- StandardBrowser = 0
- MobileBrowser = 1
- SearchEngine = 2
Страна
Пространство именGrabzIt.Enums
Это перечисление состоит из следующих значений.
- По умолчанию = 0
- Сингапур = 1
- Великобритания = 2
- US = 3
PageSize
Пространство именGrabzIt.Enums
Это перечисление состоит из следующих значений.
- A3 = 0
- A4 = 1
- A5 = 2
- A6 = 3
- B3 = 4
- B4 = 5
- B5 = 6
- B6 = 7
- Legal = 8
- Письмо = 9
PageOrientation
Пространство именGrabzIt.Enums
Это перечисление состоит из следующих значений.
CSSMediaType
Пространство именGrabzIt.Enums
Это перечисление состоит из следующих значений.
TableFormat
Пространство именGrabzIt.Enums
Это перечисление состоит из следующих значений.
- csv = 0
- JSON = 1
- xslx = 2
HorizontalPosition
Пространство именGrabzIt.Enums
Это перечисление состоит из следующих значений.
- Слева = 0
- Центр = 1
- Право = 2
VerticalPosition
Пространство именGrabzIt.Enums
Это перечисление состоит из следующих значений.
- Top = 0
- Средний = 1
- Низ = 2
Классы результатов
GrabzItCookieCOM
Пространство именGrabzIt.Cookies
Публичная недвижимость
-
string Name
-
string Value
-
string Domain
- Домен, для которого установлен файл cookie.
-
string Path
- Путь в домене, к которому применяется этот файл cookie.
-
string HttpOnly
- Если этот файл cookie действителен только при просмотре веб-сайта по протоколу HTTP.
-
string Expires
- Дата истечения срока действия этого cookie
-
string Type
-
Тип cookie это может быть одним из следующих:
- Global - это глобальный файл cookie, созданный GrabzIt
- Local - это локальный файл cookie, установленный вами
- Переопределено - глобальный файл cookie, который был переопределен вами
GrabzItFileCOM
Пространство именGrabzIt.Screenshots
Публичные методы
-
аннулировать Save(string путь)
-
путь - путь к save результат для
- string кString()
Публичная недвижимость
Пространство именGrabzIt.Screenshots
Класс, представляющий текущий статус скриншота.
Публичная недвижимость
-
bool Processing
- Если это правда, скриншот все еще обрабатывается.
-
bool Cached
- Если true, снимок экрана был обработан и в настоящее время кэширован.
-
bool Expired
- Если это правда, скриншот больше не находится в системе GrabzIt.
-
string Message
- Сообщение об ошибке, возвращенное системой.
WaterMarkCOM
Пространство именGrabzIt.Screenshots
Этот класс представляет собой обычай watermarks хранится в GrabzIt
Публичные методы
Публичная недвижимость
-
string Identifier
-
string XPosition
-
Горизонтальное положение watermark
-
string YPosition
-
Вертикальное положение watermark
-
string Format