Class ImageSaveOptions

public class ImageSaveOptions : SaveOptions

継承

object ← SaveOptions ← ImageSaveOptions

継承されたメンバー

• SaveOptions.OutputFile,
• SaveOptions.OutputStream,
• object.ToString(),
• object.Equals(object),
• object.Equals(object, object),
• object.ReferenceEquals(object, object),
• object.GetHashCode(),
• object.GetType(),
• object.MemberwiseClone()

コンストラクタ

ImageSaveOptions()

public ImageSaveOptions()

プロパティ

HorizontalResolution

生成された画像の横方向の解像度を取得または設定します（ドット毎インチ）。

public int HorizontalResolution { get; set; }

プロパティの値

int

注意事項

デフォルト値は96です。

Sheetize.ImageSaveOptions.HorizontalResolutionとSheetize.ImageSaveOptions.VerticalResolutionを設定すると、出力画像の幅と高さに影響します（ピクセル単位）。

ImageType

生成された画像のフォーマットを取得または設定します。 デフォルト値はSheetize.ImageType.Pngです。

public ImageType ImageType { get; set; }

プロパティの値

ImageType

OnePagePerSheet

OnePagePerSheetがtrueの場合、1つのシートのすべてのコンテンツが結果として1ページのみに出力されます。 PageSetupで定義された用紙サイズは無視されますが、PageSetupの他の設定は引き続き有効です。

public bool OnePagePerSheet { get; set; }

プロパティの値

bool

VerticalResolution

生成された画像の縦方向の解像度を取得または設定します（ドット毎インチ）。

public int VerticalResolution { get; set; }

プロパティの値

int

注意事項

デフォルト値は96です。

Sheetize.ImageSaveOptions.HorizontalResolutionとSheetize.ImageSaveOptions.VerticalResolutionを設定すると、出力画像の幅と高さに影響します（ピクセル単位）。

メソッド

Finish(Stream)

ストリームへのデータの書き込みを完了します。
デフォルトでは、このメソッドはストリームを直接閉じます（Sheetize.SaveOptions.OutputStreamによって指定されたストリームを含む）。
ユーザーは、リソースを解放する方法を制御するためにこのメソッドをオーバーライドし、Sheetize.ImageSaveOptions.GetStream(System.Int32) の実装に基づく要件に従ってカスタマイズできます。

public virtual void Finish(Stream stream)

パラメーター

• stream Stream：タスク（データの保存）を完了したストリーム

GetStream(int)

画像を保存するためのストリームを取得します。

public virtual Stream GetStream(int pageIndex)

パラメーター

• pageIndex int：画像にレンダリングするページ

戻り値

Stream：生成された画像を書き込むためのストリーム。

注意事項

デフォルトでは、Sheetize.SaveOptions.OutputStreamが指定され効果を持っている場合、このメソッドは常に指定されたストリームを返します。ユーザーはこのクラスの自分の実装でこのメソッドをオーバーライドして、マルチページ出力のために異なる適切なストリームオブジェクトを提供する必要があります。
Sheetize.SaveOptions.OutputFileが指定され効果を持つ場合、画像が1ページのみであれば、指定されたパス（ファイル）が直接出力として使用されます；それ以外の場合、ページインデックスがファイル名に追加され、そのファイルから構築されたFileStreamが返されます。 例えば、出力パスがres.pngと指定されている場合、生成された画像はres0.png、res1.png、…になります。