Webをキャプチャして変換するツール

ASP.NETを使用したGrabzItクライアントASP.NET API

説明

このクラスは、GrabzItスクリーンショットWebサービスとのすべての通信を処理します。 でマークされたすべてのメソッド COM GrabzIt ASP.NET DLLが COMオブジェクト.

パブリックメソッド

GrabzItFile GetResult(string id)COM

このメソッドは、スクリーンショット自体を返します。 何も返されない場合は、何かが間違っているか、スクリーンショットの準備がまだできていません。

パラメーター

  • id-スクリーンショットの一意の識別子
    • 必須

戻り値

GrabzItFile オブジェクト


URLToAnimation(string url、 AnimationOptions オプション)COM

変換する必要のあるオンライン動画のURLを指定します intアニメーションGIF。

パラメーター

  • url-変換するオンライン動画のURL intoアニメーションGIF。
    • 必須
    • VimeoおよびYouTubeビデオURLを受け入れます
      • 警告VimeoおよびYouTubeビデオのアニメーション化は第三者に依存しているため、一貫した結果が得られない場合があります。
  • オプション -のインスタンス AnimationOptions アニメーションGIFを作成するときに使用する特別なオプションを定義するクラス。
    • に必要 COM それ以外の場合はオプション

戻り値

ボイド

AnimationOptionsCOM

名前空間GrabzIt.Parameters

このクラスは、アニメーションGIFを作成するときに使用できるすべてのオプションを表します。

パブリックプロパティ

  • string CustomId -アニメーションGIF Webサービスに渡すことができるカスタム識別子。 これは、指定したコールバックURLとともに返されます。
    • デフォルト:空
  • int Width -結果のアニメーションGIFの幅(ピクセル単位)。
  • int Height -結果のアニメーションGIFのピクセル単位の高さ。
  • int Start -変換するビデオの開始位置 intアニメーションGIF。
    • デフォルト:0秒
  • int Duration -変換するビデオの秒単位の長さ intアニメーションGIF。
    • デフォルト:パッケージの最大長
  • float Speed -アニメーションGIFの速度。
    • デフォルト:1
    • 最小:0.2
    • 最大:10
  • float FramesPerSecond -ビデオからキャプチャされる1秒あたりのフレーム数。
    • デフォルト:10
    • 最小:0.2
    • 最大:60
  • int Repeat -アニメーションGIFをループする回数。
    • デフォルト:0
    • 連続ループ:0
  • bool Reverse -trueの場合、アニメーションGIFのフレームが反転します
    • デフォルト:false
  • string CustomWaterMarkId -アニメーションGIFにカスタム透かしを追加
    • デフォルト:空
  • int Quality - 返される画像の品質、デフォルトの圧縮は85%です。
    • 品質を下げると、ファイルサイズが小さくなり、ダウンロード時間が短縮されます。
    • デフォルト:-1
    • 最小:-1
    • 最大:100
  • Country Country - アニメーションGIFを取得する必要があります。
    • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
    • デフォルト:現在の最速の場所
    • オプション: 。シンガポール、 。英国、 。米国
  • string ExportURL - エクスポートURL キャプチャのエクスポート先も指定します。
    • デフォルト:空
  • string EncryptionKey -ベース64エンコードAES暗号化キーが指定されている場合、キャプチャは作成時に暗号化されます。 を使用することをお勧めします 暗号化キーの作成方法 キーを作成し、 メソッドを解読する に示すように暗号化されたキャプチャを解読する この例.
    • デフォルト:空
  • string Proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
    • デフォルト:空

URLToImage(string url、 ImageOptions オプション)COM

変換するURLを指定します int画像のスクリーンショット。

パラメーター

  • url-スクリーンショットを作成するURL
    • 必須
  • オプション -のインスタンス ImageOptions スクリーンショットを作成するときに使用する特別なオプションを定義するクラス。
    • に必要 COM それ以外の場合はオプション

戻り値

ボイド

HTMLToImage(string html、 ImageOptions オプション)COM

変換するHTMLを指定します intoaイメージ。

パラメーター

  • html- 変換するHTML int画像を
    • 必須
  • オプション -のインスタンス ImageOptions 画像を作成するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

FileToImage(string パス、 ImageOptions オプション)COM

変換するHTMLファイルを指定します intoaイメージ。

パラメーター

  • path-変換するHTMLファイルのファイルパス int画像を
    • 必須
  • オプション -のインスタンス ImageOptions 画像を作成するときに使用する特別なオプションを定義するクラス。
    • に必要 COM それ以外の場合はオプション

戻り値

ボイド

ImageOptionsCOM

名前空間GrabzIt.Parameters

このクラスは、画像キャプチャの作成時に使用可能なすべてのオプションを表します。

パブリックプロパティ

  • string CustomId -スクリーンショットWebサービスにパススルーできるカスタム識別子。 これは、指定したコールバックURLとともに返されます。
    • デフォルト:空
  • int BrowserWidth -ピクセル単位のブラウザの幅
    • デフォルト:1024
    • 最大:10000
  • int BrowserHeight -ピクセル単位のブラウザの高さ
    • デフォルト:768
    • 最大:10000
    • 全長:-1 (-1を渡すと、Webページ全体のスクリーンショットが取得されます)
  • int OutputWidth -結果のサムネイルの幅(ピクセル単位)
    • デフォルト:ユーザーパッケージの最大幅内に収まるブラウザ幅の最大比率
    • 最大:パッケージの最大幅
    • 全幅:-1 (-1を渡すと、サムネイルの幅は縮小されません)
  • int OutputHeight -結果のサムネイルの高さ(ピクセル単位)
    • デフォルト:ユーザーパッケージの最大の高さに収まるブラウザの高さの最大比率
    • 最大:パッケージの最大高さ
    • 全高:-1 (-1を渡すと、サムネイルの高さが縮小されないことを意味します)
  • ImageFormat Format -スクリーンショットの形式。
  • int Delay -ミリ秒数 スクリーンショットを撮る前に待つ
    • デフォルト:0
    • 最大:30000
  • string TargetElement - CSSセレクター ターニングされるターゲットWebページ上の唯一のHTML要素の intスクリーンショットでは、ウェブページの他の部分はすべて無視されます。 一致するHTML要素が複数ある場合、最初の要素が選択されます
    • デフォルト:空
  • string HideElement - CSSセレクター 非表示にするWebページ内の1つまたは複数のHTML要素。複数のHTML要素を指定して、各セレクターをコンマで区切ります。
    • デフォルト:空
  • string WaitForElement - CSSセレクター Webページ内のHTML要素の キャプチャが実行される前に表示されている必要があります
    • デフォルト:空
  • BrowserType RequestAs -使用したいユーザーエージェントのタイプ
  • string CustomWaterMarkId -画像にカスタム透かしを追加します
    • デフォルト:空
  • int Quality - 返される画像の品質。 これは現在、デフォルトの圧縮が85%のJPG画像にのみ影響します。
    • 品質を下げると、ファイルサイズが小さくなり、ダウンロード時間が短縮されます。
    • デフォルト:-1
    • 最小:-1
    • 最大:100
  • bool Transparent -trueの場合 画像キャプチャは透明でなければなりません。 これは、pngおよびtiff画像とのみ互換性があります。
    • デフォルト:false
  • bool HD -trueの場合、画像 キャプチャは高解像度になります これにより、画像のサイズが2倍になります。
    • デフォルト:false
  • Country Country - スクリーンショットを取得する必要があります。
    • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
    • デフォルト:現在の最速の場所
    • オプション: 。シンガポール、 。英国、 。米国
  • string ExportURL - エクスポートURL キャプチャのエクスポート先も指定します
    • デフォルト:空
  • string EncryptionKey -ベース64エンコードAES暗号化キーが指定されている場合、キャプチャは作成時に暗号化されます。 を使用することをお勧めします 暗号化キーの作成方法 キーを作成し、 メソッドを解読する に示すように暗号化されたキャプチャを解読する この例.
    • デフォルト:空
  • bool NoAds - 真であれば 広告は自動的に非表示になります.
    • デフォルト:false
  • bool NoCookieNotifications -すべての一般的に見つかったtrueの場合 Cookie通知は自動的に非表示にする必要があります.
    • デフォルト:false
  • string Address -HTMLコードを実行するURL。変換されるHTMLが使用する場合に役立ちます CSSや画像などのリソースの相対URL.
    • デフォルト:空
  • string Proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
    • デフォルト:空

パブリックメソッド

  • AddPostParameter(string 名、 string 値) -HTTP Postパラメーターとオプションの値を定義します。このメソッドを複数回呼び出して、複数のパラメーターを追加できます。 このメソッドを使用すると、GrabzItが強制的に HTTPポストを実行します.
    • name-HTTP Postパラメーターの名前
    • value-HTTP Postパラメーターの値

URLToRenderedHTML(string url、 HTMLOptions オプション)COM

変換するURLを指定します intoレンダリングされたHTML。

パラメーター

  • url-レンダリングされたHTMLを作成するURL
    • 必須
  • オプション -のインスタンス HTMLOptions レンダリングされたHTMLを作成するときに使用する特別なオプションを定義するクラス。
    • に必要 COM それ以外の場合はオプション

戻り値

ボイド

HTMLToRenderedHTML(string html、 HTMLOptions オプション)COM

変換するHTMLを指定します intoレンダリングされたHTML。

パラメーター

  • html- 変換するHTML intoレンダリングされたHTML
    • 必須
  • オプション -のインスタンス HTMLOptions レンダリングされたHTMLを作成するときに使用する特別なオプションを定義するクラス。

戻り値

ボイド

FileToRenderedHTML(string パス、 HTMLOptions オプション)COM

変換するHTMLファイルを指定します intoレンダリングされたHTML。

パラメーター

  • path-変換するHTMLファイルのファイルパス intoレンダリングされたHTML
    • 必須
  • オプション -のインスタンス HTMLOptions レンダリングされたHTMLを作成するときに使用する特別なオプションを定義するクラス。
    • に必要 COM それ以外の場合はオプション

戻り値

ボイド

HTMLOptionsCOM

名前空間GrabzIt.Parameters

クラスは、次の場合に利用可能なすべてのオプションを表します レンダリングされたHTMLキャプチャの作成.

パブリックプロパティ

パブリックメソッド

  • AddPostParameter(string 名、 string 値) -HTTP Postパラメーターとオプションの値を定義します。このメソッドを複数回呼び出して、複数のパラメーターを追加できます。 このメソッドを使用すると、GrabzItが強制的に HTTPポストを実行します.
    • name-HTTP Postパラメーターの名前
    • value-HTTP Postパラメーターの値

URLToPDF(string url、 PDFOptions オプション)COM

変換するURLを指定します intPDF

パラメーター

  • url-変換されるURL intPDF
    • 必須
  • PDFOptions options-PDFの作成時に使用する特別なオプションを定義するPDFOptionsクラスのインスタンス。
    • に必要 COM それ以外の場合はオプション

戻り値

ボイド

HTMLToPDF(string html、 PDFOptions オプション)COM

変換するHTMLを指定します intPDF

パラメーター

  • html- 変換するHTML intPDF
    • 必須
  • PDFOptions options-PDFの作成時に使用する特別なオプションを定義するGrabzItPDFOptionsクラスのインスタンス。
    • に必要 COM それ以外の場合はオプション

戻り値

ボイド

FileToPDF(string パス、 PDFOptions オプション)COM

変換するHTMLファイルを指定します intPDF

パラメーター

  • path-変換するHTMLファイルのファイルパス intPDF
    • 必須
  • PDFOptions options-PDFの作成時に使用する特別なオプションを定義するPDFOptionsクラスのインスタンス。
    • に必要 COM それ以外の場合はオプション

戻り値

ボイド

PDFOptionsCOM

名前空間GrabzIt.Parameters

このクラスは、PDFキャプチャの作成時に使用可能なすべてのオプションを表します。

パブリックプロパティ

  • string CustomId -Webサービスにパススルーできるカスタム識別子。 これは、指定したコールバックURLとともに返されます。
    • デフォルト:空
  • bool IncludeBackground -trueの場合、Webページの背景をスクリーンショットに含める必要があります
    • デフォルト:true
  • PageSize PageSize -PDFのページサイズ
  • PageOrientation Orientation -PDFドキュメントの向き
  • CSSMediaType CSSMediaType - PDFドキュメントのCSSメディアタイプ
  • bool IncludeLinks -リンクをPDFに含める必要がある場合はtrue
    • デフォルト:true
  • bool IncludeOutline -真の場合 PDFブックマーク 含める必要があります
    • デフォルト:false
  • string Title -PDFドキュメントにタイトルを付けます
    • デフォルト:空
  • string CoverURL -PDFの表紙として使用されるWebページのURL
    • デフォルト:空
  • int MarginTop -PDF文書ページの上部に表示されるミリメートル単位のマージン
    • デフォルト:10
  • int MarginLeft -PDFドキュメントページの左側に表示されるミリメートル単位のマージン
    • デフォルト:10
  • int MarginBottom -PDFドキュメントページの下部に表示されるミリメートル単位のマージン
    • デフォルト:10
  • int MarginRight -PDF文書の右側に表示されるミリメートル単位のマージン
    • デフォルト:10
  • int BrowserWidth - ブラウザの幅 ピクセル単位
    • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
    • デフォルト:1024
    • 最大:10000
    • 自動幅:-1 (-1を渡すと、ブラウザーの幅がPDF文書の幅と一致することを意味します)
  • int PageWidth - 結果のPDFのカスタム幅 mm単位
    • デフォルト: PageSize
    • 最小:15mm
  • int PageHeight - 結果のPDFのカスタムの高さ mm単位
    • デフォルト: PageSize 高さ
    • 最小:15mm
  • int Delay -ミリ秒数 スクリーンショットを撮る前に待つ
    • デフォルト:0
    • 最大:30000
  • BrowserType RequestAs -使用したいユーザーエージェントのタイプ
  • string TemplateId -追加 template PDFドキュメントのヘッダーとフッターを指定するID
    • デフォルト:空
  • string TargetElement - CSSセレクター方向転換されるターゲットWebページのHTML要素 intPDF、ウェブページの他の部分はすべて無視されます。 一致するHTML要素が複数ある場合、最初の要素が選択されます
    • デフォルト:空
  • string HideElement - CSSセレクター 非表示にするWebページ内の1つまたは複数のHTML要素。複数のHTML要素を指定して、各セレクターをコンマで区切ります。
    • デフォルト:空
  • string WaitForElement - CSSセレクター Webページ内のHTML要素の キャプチャが実行される前に表示されている必要があります
    • デフォルト:空
  • string CustomWaterMarkId -PDF文書の各ページにカスタム透かしを追加します
    • デフォルト:空
  • int Quality - 返されるPDFの品質。 デフォルトでは、PDFの推奨品質が使用されます。
    • 品質を下げると、ファイルサイズが小さくなり、ダウンロード時間が短縮されます。
    • デフォルト:-1
    • 最小:-1
    • 最大:100
  • Country Country - スクリーンショットを取得する必要があります。
    • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
    • デフォルト:現在の最速の場所
    • オプション: 。シンガポール、 。英国、 。米国
  • string ExportURL - エクスポートURL キャプチャのエクスポート先も指定します
    • デフォルト:空
  • string EncryptionKey -ベース64エンコードAES暗号化キーが指定されている場合、キャプチャは作成時に暗号化されます。 を使用することをお勧めします 暗号化キーの作成方法 キーを作成し、 メソッドを解読する に示すように暗号化されたキャプチャを解読する この例.
    • デフォルト:空
  • bool NoAds - 真であれば 広告は自動的に非表示になります.
    • デフォルト:false
  • bool NoCookieNotifications -すべての一般的に見つかったtrueの場合 Cookie通知は自動的に非表示にする必要があります.
    • デフォルト:false
  • string Address -HTMLコードを実行するURL。変換されるHTMLが使用する場合に役立ちます CSSや画像などのリソースの相対URL.
    • デフォルト:空
  • string Proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
    • デフォルト:空
  • string MergeId -キャプチャのID 新しい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を指定します intDOCX。

パラメーター

  • url-変換されるURL intDOCX
    • 必須
  • DOCXOptions options-のインスタンス DOCXOptions DOCXを作成するときに使用する特別なオプションを定義するクラス。
    • に必要 COM それ以外の場合はオプション

戻り値

ボイド

HTMLToDOCX(string html、 DOCXOptions オプション)COM

変換するHTMLを指定します intDOCX。

パラメーター

  • html- 変換するHTML intDOCX
    • 必須
  • DOCXOptions オプション-GrabzItのインスタンスDOCXOptions DOCXを作成するときに使用する特別なオプションを定義するクラス。
    • に必要 COM それ以外の場合はオプション

戻り値

ボイド

FileToDOCX(string パス、 DOCXOptions オプション)COM

変換するHTMLファイルを指定します intDOCX。

パラメーター

  • path-変換するHTMLファイルのファイルパス intDOCX
    • 必須
  • DOCXOptions options-のインスタンス DOCXOptions DOCXを作成するときに使用する特別なオプションを定義するクラス。
    • に必要 COM それ以外の場合はオプション

戻り値

ボイド

DOCXOptionsCOM

名前空間GrabzIt.Parameters

このクラスは、DOCXキャプチャの作成時に使用可能なすべてのオプションを表します。

パブリックプロパティ

  • string CustomId -Webサービスにパススルーできるカスタム識別子。 これは、指定したコールバックURLとともに返されます。
    • デフォルト:空
  • bool IncludeBackground -trueの場合、Webページの背景画像をDOCXに含める必要があります
    • デフォルト:true
  • PageSize PageSize -DOCXのページサイズ
  • PageOrientation Orientation -DOCXドキュメントの方向
  • bool IncludeLinks -リンクをDOCXに含める必要がある場合はtrue
    • デフォルト:true
  • bool IncludeImages -trueの場合、Webページの画像をDOCXに含める必要があります
    • デフォルト:true
  • string Title -DOCXドキュメントにタイトルを付けます
    • デフォルト:空
  • int MarginTop -DOCXドキュメントページの上部に表示されるミリメートル単位のマージン
    • デフォルト:10
  • int MarginLeft -DOCXドキュメントページの左に表示されるミリメートル単位のマージン
    • デフォルト:10
  • int MarginBottom -DOCXドキュメントページの下部に表示されるミリメートル単位のマージン
    • デフォルト:10
  • int MarginRight -DOCXドキュメントの右側に表示されるミリメートル単位のマージン
    • デフォルト:10
  • int BrowserWidth - ブラウザの幅 ピクセル単位
    • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
    • デフォルト:1024
    • 最大:10000
    • 自動幅:-1 (-1を渡すと、ブラウザの幅がDOCXドキュメントの幅と一致することを意味します)
  • int PageWidth - 結果のDOCXのカスタム幅 mm単位
    • デフォルト: PageSize
    • 最小:15mm
  • int PageHeight - 結果のDOCXのカスタムの高さ mm単位
    • デフォルト: PageSize 高さ
    • 最小:15mm
  • int Delay -ミリ秒数 スクリーンショットを撮る前に待つ
    • デフォルト:0
    • 最大:30000
  • BrowserType RequestAs -使用したいユーザーエージェントのタイプ
  • string TemplateId -追加 template DOCXドキュメントのヘッダーとフッターを指定するID
    • デフォルト:空
  • string TargetElement - CSSセレクター ターニングされるターゲットWebページ上の唯一のHTML要素の intDOCXでは、Webページの他のすべての部分は無視されます。 一致するHTML要素が複数ある場合、最初の要素が選択されます
    • デフォルト:空
  • string HideElement - CSSセレクター 非表示にするWebページ内の1つまたは複数のHTML要素。複数のHTML要素を指定して、各セレクターをコンマで区切ります。
    • デフォルト:空
  • string WaitForElement - CSSセレクター Webページ内のHTML要素の キャプチャが実行される前に表示されている必要があります
    • デフォルト:空
  • int Quality - 返されたDOCXの品質。 デフォルトでは、DOCXの推奨品質が使用されます。
    • 品質を下げると、ファイルサイズが小さくなり、ダウンロード時間が短縮されます。
    • デフォルト:-1
    • 最小:-1
    • 最大:100
  • Country Country - スクリーンショットを取得する必要があります。
    • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
    • デフォルト:現在の最速の場所
    • オプション: 。シンガポール、 。英国、 。米国
  • string ExportURL - エクスポートURL キャプチャのエクスポート先も指定します
    • デフォルト:空
  • string EncryptionKey -ベース64エンコードAES暗号化キーが指定されている場合、キャプチャは作成時に暗号化されます。 を使用することをお勧めします 暗号化キーの作成方法 キーを作成し、 メソッドを解読する に示すように暗号化されたキャプチャを解読する この例.
    • デフォルト:空
  • bool NoAds - 真であれば 広告は自動的に非表示になります.
    • デフォルト:false
  • bool NoCookieNotifications -すべての一般的に見つかったtrueの場合 Cookie通知は自動的に非表示にする必要があります.
    • デフォルト:false
  • string Address -HTMLコードを実行するURL。変換されるHTMLが使用する場合に役立ちます CSSや画像などのリソースの相対URL.
    • デフォルト:空
  • string Proxy - HTTPプロキシの詳細 ブラウザソフトウェアは、このキャプチャの作成に使用する必要があります
    • デフォルト:空
  • string MergeId -キャプチャのID 新しいDOCXドキュメントの最初にマージされました
    • デフォルト:空
  • string Password - DOCXドキュメントを保護するパスワード  
    • デフォルト:空

パブリックメソッド

  • AddPostParameter(string 名、 string 値) -HTTP Postパラメーターとオプションの値を定義します。このメソッドを複数回呼び出して、複数のパラメーターを追加できます。 このメソッドを使用すると、GrabzItが強制的に HTTPポストを実行します.
    • name-HTTP Postパラメーターの名前
    • value-HTTP Postパラメーターの値
  • AddTemplateParameter(string 名、 string 値) -定義する カスタムテンプレート パラメータと値の場合、このメソッドを複数回呼び出して複数のパラメータを追加できます。
    • name-テンプレートパラメータの名前
    • value-テンプレートパラメータの値

URLToTable(string url、 TableOptions オプション)COM

HTMLテーブルの抽出元のURLを指定します。

パラメーター

  • url-HTMLテーブルを抽出するURL
    • 必須
  • TableOptions options-のインスタンス TableOptions HTMLテーブルを変換するときに使用する特別なオプションを定義するクラス。
    • に必要 COM それ以外の場合はオプション

戻り値

ボイド

HTMLToTable(string html、 TableOptions オプション)COM

HTMLテーブルの抽出元のHTMLを指定します。

パラメーター

  • html-HTMLテーブルを抽出するHTML。
    • 必須
  • TableOptions options-のインスタンス TableOptions HTMLテーブルを変換するときに使用する特別なオプションを定義するクラス。
    • に必要 COM それ以外の場合はオプション

戻り値

ボイド

FileToTable(string パス、 TableOptions オプション)COM

HTMLテーブルを抽出するHTMLファイルを指定します。

パラメーター

  • path-HTMLテーブルを抽出するHTMLファイルのファイルパス。
    • 必須
  • TableOptions options-のインスタンス TableOptions HTMLテーブルを変換するときに使用する特別なオプションを定義するクラス。
    • に必要 COM それ以外の場合はオプション

戻り値

ボイド

TableOptionsCOM

名前空間GrabzIt.Parameters

このクラスは、HTMLテーブルをCSV、XLSX、またはJSONに変換するときに使用可能なすべてのオプションを表します。

パブリックプロパティ

  • string CustomId -Webサービスにパススルーできるカスタム識別子。 これは、指定したコールバックURLとともに返されます
    • デフォルト:空
  • int TableNumberToInclude -変換されるテーブルのインデックス。Webページ内のすべてのテーブルがWebページの上部から下部へと順序付けられていた
    • デフォルト:1
  • TableFormat Format -テーブルの形式
  • bool IncludeHeaderNames -真のヘッダー名がテーブルに含まれる場合
    • デフォルト:true
  • bool IncludeAllTables -trueの場合、Webページ上のすべてのテーブルが抽出され、各テーブルが個別のスプレッドシートシートに表示されます。 XLSX形式でのみ利用可能
    • デフォルト:false
  • string TargetElement -テーブルの抽出に使用するWebページ内の唯一のHTML要素のID
    • デフォルト:空
  • BrowserType RequestAs -使用したいユーザーエージェントのタイプ
  • Country Country - スクリーンショットを取得する必要があります。
    • 警告この機能は現在ベータ版であり、一貫した結果が得られない場合があります。
    • デフォルト:現在の最速の場所
    • オプション: 。シンガポール、 。英国、 。米国
  • string ExportURL - エクスポートURL キャプチャのエクスポート先も指定します
    • デフォルト:空
  • string EncryptionKey -ベース64エンコードAES暗号化キーが指定されている場合、キャプチャは作成時に暗号化されます。 を使用することをお勧めします 暗号化キーの作成方法 キーを作成し、 メソッドを解読する に示すように暗号化されたキャプチャを解読する この例.
    • デフォルト:空
  • string Address -HTMLコードを実行するURL。変換されるHTMLが使用する場合に役立ちます CSSや画像などのリソースの相対URL.
    • デフォルト:空
  • 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 方法


このメソッドは同期であるため、結果の処理中にアプリケーションが一時停止することを警告します

GrabzItFile SaveTo()

Save 結果を同期的に GrabzItFile オブジェクト。

戻り値

GrabzItFile オブジェクト


このメソッドは同期であるため、結果の処理中にアプリケーションが一時停止することを警告します

SaveTo(string saveファイルへ)COM

Save 結果をファイルに同期して。

パラメーター

  • saveToFile-キャプチャするファイルパス saved完了したら
    • 必須

戻り値

成功した場合はtrueを返し、そうでない場合は例外をスローします。


状態 GetStatus(string id)COM

GrabzItスクリーンショットの現在のステータスを取得します。

パラメーター

  • id-スクリーンショットの一意の識別子
    • 必須

戻り値

状態 オブジェクト


GrabzItCookie [] GetCookies(string ドメイン)COM

GrabzItが特定のドメインで使用しているすべてのCookieを取得します。 これには、ユーザー定義のCookieも含まれる場合があります。

パラメーター

  • domain-Cookieを返すドメイン
    • 必須

戻り値

GrabzItCookie 配列


SetCookie(string 名、 string ドメイン、 string 値、 string パス、 bool httponly、DateTime? 期限切れ)COM

カスタムCookieがグローバルCookieと同じ名前とドメインを持っている場合、グローバルCookieは上書きされます。GrabzItに新しいカスタムCookieを設定します。

これは、Webサイトの機能がCookieによって制御されている場合に役立ちます。

パラメーター

  • name-設定するCookieの名前
    • 必須
  • domain-Cookieを設定するWebサイトのドメイン
    • 必須
  • value-Cookieの値
  • path-Cookieが関係するWebサイトのパス
  • httponly-trueの場合、CookieはHTTPプロトコルでのみ使用できます
  • expires-Cookieの有効期限を定義します。 Cookieの有効期限が切れない場合はnull値を渡します

戻り値

Cookieが正常に設定された場合はtrue、そうでない場合はfalse


DeleteCookie(string 名、 string ドメイン)COM

カスタムCookieを削除するか、グローバルCookieの使用をブロックします

パラメーター

  • name-削除するCookieの名前
    • 必須
  • domain-Cookieを削除するWebサイトのドメイン
    • 必須

戻り値

Cookieが正常に削除された場合はtrue、そうでない場合はfalse


WaterMark[] 取得するWaterMarks(String 識別子)COM

アップロードしたすべてのカスタム透かしを取得する

戻り値

WaterMark 配列


WaterMark 取得するWaterMark(String 識別子)COM

指定された識別子に一致するカスタム透かしを返します

パラメーター

  • identifier-表示したい特定のカスタム透かしの識別子
    • 必須

戻り値

WaterMark


追加WaterMark(string 識別子、 string パス、 HorizontalPosition xpos、 VerticalPosition ypos)COM

新しいカスタム透かしを追加する

パラメーター

  • identifier-カスタム透かしに付けたい識別子。 この識別子は一意であることが重要です。
    • 必須
  • path-サーバー上の透かしの絶対パス。 たとえば、C:/watermark/1.png
    • 必須
  • xpos-スクリーンショットを表示する水平位置
  • ypos-スクリーンショットを表示する垂直位置

戻り値

ウォーターマークが正常に設定された場合、trueを返します


DeleteWaterMark(string 識別子)COM

カスタム透かしを削除する

パラメーター

  • identifier-削除するカスタム透かしの識別子
    • 必須

戻り値

透かしが正常に削除された場合、trueを返します


SetLocalProxy(string proxyUrl)COM

このメソッドにより、 ローカルプロキシサーバー すべてのリクエストに使用されます。

パラメーター

  • proxyUrl-必要に応じてプロキシのポートを含めることができるURL。 nullを指定すると、以前に設定されたプロキシが削除されます
    • 必須

UseSSL(bool 値)COM

GrabzItへのリクエストが APIはSSLを使用する必要があります

パラメーター

  • 値-trueの場合、GrabzItのAPIへのすべてのリクエストはSSLを使用します
    • 必須

string CreateEncryptionKey()COM

暗号的に安全なベース64暗号化キー、44文字長を作成します。


復号化(string パス、 string キー)COM

提供された暗号化キーを使用して、暗号化されたキャプチャを解読します。

パラメーター

  • path-暗号化されたキャプチャのパス
    • 必須
  • キー- 暗号化キー
    • 必須

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

名前空間GrabzIt.Enums

この列挙は、次の値で構成されます。

  • デフォルト= 0
  • シンガポール= 1
  • 英国= 2
  • 米国= 3

PageSize

名前空間GrabzIt.Enums

この列挙は、次の値で構成されます。

  • A3 = 0
  • A4 = 1
  • A5 = 2
  • A6 = 3
  • B3 = 4
  • B4 = 5
  • B5 = 6
  • B6 = 7
  • 有効= 8
  • レター= 9

PageOrientation

名前空間GrabzIt.Enums

この列挙は、次の値で構成されます。

  • 風景= 0
  • ポートレート= 1

CSSMediaType

名前空間GrabzIt.Enums

この列挙は、次の値で構成されます。

  • 画面= 0
  • Print = 1

TableFormat

名前空間GrabzIt.Enums

この列挙は、次の値で構成されます。

  • csv = 0
  • json = 1
  • xslx = 2

HorizontalPosition

名前空間GrabzIt.Enums

この列挙は、次の値で構成されます。

  • 左= 0
  • 中央= 1
  • 右= 2

VerticalPosition

名前空間GrabzIt.Enums

この列挙は、次の値で構成されます。

  • 上= 0
  • 中間= 1
  • 下= 2

結果クラス

GrabzItCookieCOM

名前空間GrabzIt.Cookies

パブリックプロパティ

  • string Name
    • クッキー名。
  • string Value
    • クッキーの値。
  • string Domain
    • Cookieが設定されているドメイン。
  • string Path
    • このCookieが適用されるドメイン上のパス。
  • string HttpOnly
    • このCookieが有効なのは、WebサイトがHTTPプロトコルで表示されている場合のみです。
  • string Expires
    • このCookieの有効期限が切れる日付
  • string Type
    • これはCookieのタイプで、次のいずれかです。
      • グローバル-これはGrabzItによって設定されたグローバルCookieです
      • ローカル-これはユーザーが設定したローカルCookieです
      • オーバーライド-ユーザーによってオーバーライドされたグローバルCookie

GrabzItFileCOM

名前空間GrabzIt.Screenshots

パブリックメソッド

  • ボイド Save(string パス)
    • path-へのパス save 結果
      • 必須
  • string にString()

パブリックプロパティ

  • byte[] Bytes

状態COM

名前空間GrabzIt.Screenshots

スクリーンショットの現在のステータスを表すクラス。

パブリックプロパティ

  • bool Processing
    • trueの場合、スクリーンショットはまだ処理中です。
  • bool Cached
    • trueの場合、スクリーンショットは処理され、現在キャッシュされています。
  • bool Expired
    • trueの場合、スクリーンショットはGrabzItシステム上にありません。
  • string Message
    • システムから返されたエラーメッセージ。

WaterMarkCOM

名前空間GrabzIt.Screenshots

このクラスは、GrabzItに保存されているカスタム透かしを表します

パブリックメソッド

パブリックプロパティ

  • string Identifier
    • 透かしの識別子
  • string XPosition
    • 透かしの水平位置
      • センター
  • string YPosition
    • 透かしの垂直位置
      • トップ
      • 真ん中
      • ボトム
  • string Format
    • 透かしの形式