C1.WPF.Grid.Extensions.SaveAsync

SaveAsync Method

SaveAsync(FlexGrid, string, string, SaveFileFormat, GridRowColRanges, GridRowColRanges, GridHeadersVisibility, bool, bool, bool, PrinterSettings)

Saves the contents of the grid in a desired format using GcExcel

Declaration

public static Task SaveAsync(this FlexGrid grid, string fileName, string sheetName, SaveFileFormat saveFileFormat, GridRowColRanges rows = null, GridRowColRanges columns = null, GridHeadersVisibility headers = GridHeadersVisibility.None, bool merged = false, bool formatted = false, bool renderImages = false, PrinterSettings printerSettings = null)

Parameters

Type	Name	Description
FlexGrid	grid	The grid this method will be used as an extension towards.
string	fileName	A String representing the name of the file to save.
string	sheetName	A String representing the worksheet name.
SaveFileFormat	saveFileFormat	GrapeCity.Documents.Excel.SaveFileFormatA SaveFileFormat enum value that specifies the format the file should be saved into.
GridRowColRanges	rows	A GridRowColRanges object representing the row settings to be taken into consideration whilst exporting. Could contain specific ranges and/or other flagged options.
GridRowColRanges	columns	A GridRowColRanges object representing the column settings to be taken into consideration whilst exporting. Could contain specific ranges and/or other flagged options.
GridHeadersVisibility	headers	A GridHeadersVisibility enum value that represents the header visibility options to be taken in consideration whilst exporting.
bool	merged	A Boolean flag denoting whether to render merged ranges in the output.
bool	formatted	A Boolean flag denoting whether to render cell values as formatted in the output. If a grid column has a data map and this flag is not true, the rendered output will render the original values.
bool	renderImages	A Boolean flag denoting whether to render images in the output. If this value is false, their URI's are used instead.
PrinterSettings	printerSettings	A PrinterSettings object representing all the printer settings to be passed down to the output.

Returns

Type	Description
Task

SaveAsync(FlexGrid, Stream, string, SaveFileFormat, GridRowColRanges, GridRowColRanges, GridHeadersVisibility, bool, bool, bool, PrinterSettings)

Saves the contents of the grid in a desired format using GcExcel

Declaration

public static Task SaveAsync(this FlexGrid grid, Stream stream, string sheetName, SaveFileFormat saveFileFormat, GridRowColRanges rows = null, GridRowColRanges columns = null, GridHeadersVisibility headers = GridHeadersVisibility.None, bool merged = false, bool formatted = false, bool renderImages = false, PrinterSettings printerSettings = null)

Parameters

Type	Name	Description
FlexGrid	grid	The grid this method will be used as an extension towards.
Stream	stream	A Stream for the output to be written into.
string	sheetName	A String representing the worksheet name.
SaveFileFormat	saveFileFormat	GrapeCity.Documents.Excel.SaveFileFormatA SaveFileFormat enum value that specifies the format the file should be saved into.
GridRowColRanges	rows	A GridRowColRanges object representing the row settings to be taken into consideration whilst exporting. Could contain specific ranges and/or other flagged options.
GridRowColRanges	columns	A GridRowColRanges object representing the column settings to be taken into consideration whilst exporting. Could contain specific ranges and/or other flagged options.
GridHeadersVisibility	headers	A GridHeadersVisibility enum value that represents the header visibility options to be taken in consideration whilst exporting.
bool	merged	A Boolean flag denoting whether to render merged ranges in the output.
bool	formatted	A Boolean flag denoting whether to render cell values as formatted in the output. If a grid column has a data map and this flag is not true, the rendered output will render the original values.
bool	renderImages	A Boolean flag denoting whether to render images in the output. If this value is false, their URI's are used instead.
PrinterSettings	printerSettings	A PrinterSettings object representing all the printer settings to be passed down to the output.

Returns

Type	Description
Task