WorksheetBase.ExportAsFixedFormat Method

  • Reference

Definition

Namespace:
Microsoft.Office.Tools.Excel
Assembly:
Microsoft.Office.Tools.Excel.v4.0.Utilities.dll

Exports to a file of the specified format.

public void ExportAsFixedFormat (Microsoft.Office.Interop.Excel.XlFixedFormatType type, object filename, object quality, object includeDocProperties, object ignorePrintAreas, object from, object to, object openAfterPublish, object fixedFormatExtClassPtr);
member this.ExportAsFixedFormat : Microsoft.Office.Interop.Excel.XlFixedFormatType * obj * obj * obj * obj * obj * obj * obj * obj -> unit
Public Sub ExportAsFixedFormat (type As XlFixedFormatType, Optional filename As Object, Optional quality As Object, Optional includeDocProperties As Object, Optional ignorePrintAreas As Object, Optional from As Object, Optional to As Object, Optional openAfterPublish As Object, Optional fixedFormatExtClassPtr As Object)

Parameters

type
XlFixedFormatType

One of the Microsoft.Office.Interop.Excel.XlFixedFormatType values that specifies whether to save the workbook in PDF or XPS format.

filename
Object

The full path of the new PDF or XPS file. If you omit this parameter, Excel saves the file in the current folder.

quality
Object

One of the Microsoft.Office.Interop.Excel.XlFixedFormatQuality values that specifies the quality of the exported file.

includeDocProperties
Object

true to include document properties in the exported file; otherwise, false.

ignorePrintAreas
Object

true to ignore any print areas set when exporting; otherwise, false.

from
Object

The number of the page at which to start exporting. If this argument is omitted, exporting starts at the first page.

to
Object

The number of the last page to export. If this argument is omitted, exporting ends with the last page.

openAfterPublish
Object

true to display the file in the viewer immediately; otherwise, false.

fixedFormatExtClassPtr
Object

A pointer to an implementation of the IMsoDocExporter interface that enables the workbook to be saved in a different fixed format. For more information, see Extending the Office (2007) Fixed-Format Export Feature.

Examples

The following code example saves the content of the worksheet Sheet1 in PDF format, up to the first four pages (ignoring print areas). The PDF file is saved to the specified file path and file name using the standard quality resolution. The file includes the workbook properties. To run this code example, your workbook must include a sheet named Sheet1 with some data.

This example is for a document-level customization.

private void SaveWorksheetAsPDF()        
{            
    Microsoft.Office.Tools.Excel.Worksheet mySheet =
        Globals.Sheet1.Base;

    mySheet.ExportAsFixedFormat( 
        Excel.XlFixedFormatType.xlTypePDF, 
        @"c:\myWorksheet", 
        Excel.XlFixedFormatQuality.xlQualityStandard, 
        true, 
        true, 
        1, 
        10, 
        false);
}

Private Sub SaveWorksheetAsPDF()
    Dim mySheet As Microsoft.Office.Tools.Excel.WorksheetBase = Globals.Sheet1

    mySheet.ExportAsFixedFormat( _
        Excel.XlFixedFormatType.xlTypePDF, _
        "c:\myWorksheet", _
        Excel.XlFixedFormatQuality.xlQualityStandard, _
        True, _
        True, _
        1, _
        10, _
        False)
End Sub

Remarks

This method also supports initializing an add-in to export a file to a fixed-format file. For example, Excel will perform file format conversion if the converters are present. The conversion is usually initiated by the user.

Applies to