[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

GrapeCity.Documents.Pdf.GcPdfDocument.SaveAsBmp

SaveAsBmp Method

SaveAsBmp(string, ViewState, OutputRange, SaveAsImageOptions)

Saves the document pages as images in BMP format, one page per output file.

The filePath parameter is used as a .NET format string, with current page number (1-based) passed to it as the value to be formatted. Note that if filePath does not contain a format item (such as "{0}"), all pages will be saved into the same file name, the last page overwriting everything else.

Declaration
public void SaveAsBmp(string filePath, ViewState viewState, OutputRange pageRange = null, SaveAsImageOptions options = null)
Public Sub SaveAsBmp(filePath As String, viewState As ViewState, Optional pageRange As OutputRange = Nothing, Optional options As SaveAsImageOptions = Nothing)
Parameters
Type Name Description
string filePath

The output file path.
ViewState viewState

The document view state.
OutputRange pageRange

The range of pages that should be saved.
SaveAsImageOptions options

Options that allow customizing the output images.

SaveAsBmp(string, OutputRange, SaveAsImageOptions)

Saves the document pages as images in BMP format, one page per output file.

The filePath parameter is used as a .NET format string, with current page number (1-based) passed to it as the value to be formatted. Note that if filePath does not contain a format item (such as "{0}"), all pages will be saved into the same file name, the last page overwriting everything else.

Declaration
public void SaveAsBmp(string filePath, OutputRange pageRange = null, SaveAsImageOptions options = null)
Public Sub SaveAsBmp(filePath As String, Optional pageRange As OutputRange = Nothing, Optional options As SaveAsImageOptions = Nothing)
Parameters
Type Name Description
string filePath

The output file path.
OutputRange pageRange

The range of pages that should be saved.
SaveAsImageOptions options

Options that allow customizing the output images.