WorksheetPart Class

Definition

public class WorksheetPart : DocumentFormat.OpenXml.Packaging.OpenXmlPart, DocumentFormat.OpenXml.Packaging.IFixedContentTypePart

public class WorksheetPart : DocumentFormat.OpenXml.Packaging.TypedOpenXmlPart, DocumentFormat.OpenXml.Packaging.IFixedContentTypePart

[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
public class WorksheetPart : DocumentFormat.OpenXml.Packaging.OpenXmlPart, DocumentFormat.OpenXml.Packaging.IFixedContentTypePart

public class WorksheetPart : DocumentFormat.OpenXml.Packaging.OpenXmlPart, DocumentFormat.OpenXml.Packaging.IFixedContentTypePart, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.CustomPropertyPart>, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.EmbeddedControlPersistenceBinaryDataPart>, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.EmbeddedControlPersistencePart>, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.EmbeddedObjectPart>, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.EmbeddedPackagePart>, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.ImagePart>

type WorksheetPart = class
    inherit OpenXmlPart
    interface IFixedContentTypePart

type WorksheetPart = class
    inherit TypedOpenXmlPart
    interface IFixedContentTypePart

[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
type WorksheetPart = class
    inherit OpenXmlPart
    interface IFixedContentTypePart

type WorksheetPart = class
    inherit OpenXmlPart
    interface IFixedContentTypePart
    interface ISupportedRelationship<CustomPropertyPart>
    interface ISupportedRelationship<EmbeddedControlPersistenceBinaryDataPart>
    interface ISupportedRelationship<EmbeddedControlPersistencePart>
    interface ISupportedRelationship<EmbeddedObjectPart>
    interface ISupportedRelationship<EmbeddedPackagePart>
    interface ISupportedRelationship<ImagePart>

Public Class WorksheetPart
Inherits OpenXmlPart
Implements IFixedContentTypePart

Public Class WorksheetPart
Inherits TypedOpenXmlPart
Implements IFixedContentTypePart

Public Class WorksheetPart
Inherits OpenXmlPart
Implements IFixedContentTypePart, ISupportedRelationship(Of CustomPropertyPart), ISupportedRelationship(Of EmbeddedControlPersistenceBinaryDataPart), ISupportedRelationship(Of EmbeddedControlPersistencePart), ISupportedRelationship(Of EmbeddedObjectPart), ISupportedRelationship(Of EmbeddedPackagePart), ISupportedRelationship(Of ImagePart)

Inheritance

Object

OpenXmlPartContainer

OpenXmlPart

WorksheetPart

Inheritance

Object

OpenXmlPartContainer

OpenXmlPart

TypedOpenXmlPart

WorksheetPart

Attributes

OfficeAvailabilityAttribute

Implements

IFixedContentTypePart ISupportedRelationship<CustomPropertyPart> ISupportedRelationship<EmbeddedControlPersistenceBinaryDataPart> ISupportedRelationship<EmbeddedControlPersistencePart> ISupportedRelationship<EmbeddedObjectPart> ISupportedRelationship<EmbeddedPackagePart> ISupportedRelationship<ImagePart>

Examples

The following code example opens a zip file and creates a spreadsheet document into it.

using System;  
using System.IO.Packaging;  
using DocumentFormat.OpenXml;  
using DocumentFormat.OpenXml.Packaging;  
using DocumentFormat.OpenXml.Spreadsheet;  

namespace WorkSheetPartEx  
{  
    class Program  
    {  
        // Create a spreadsheet by Package.  
        static void Main(string[] args)  
        {  
            string fileName = @"C:\users\public\documents\WorkSheetPartEx.zip";  

            // Open a package file.   
            Package package = Package.Open(fileName);  

            // Create the spreadsheet document.  
            SpreadsheetDocument spreadsheetDocument =   
                SpreadsheetDocument.Create(package, SpreadsheetDocumentType.Template);  

            // Add a WorkbookPart.  
            WorkbookPart workbookpart = spreadsheetDocument.AddWorkbookPart();  
            workbookpart.Workbook = new Workbook();  

            // Add a WorksheetPart.  
            WorksheetPart worksheetPart = workbookpart.AddNewPart<WorksheetPart>();  
            worksheetPart.Worksheet = new Worksheet(new SheetData());  

            // Add a sheets list.  
            Sheets sheets = spreadsheetDocument.WorkbookPart.Workbook  
                .AppendChild<Sheets>(new Sheets());  

            // Append the new worksheet and associate it with the workbook.  
            Sheet sheet = new Sheet() { Id = spreadsheetDocument.WorkbookPart  
                .GetIdOfPart(worksheetPart), SheetId = 1, Name = "mySheet" };  
            sheets.Append(sheet);  

            // Close the spreadsheet and the package.  
            spreadsheetDocument.Close();  
            package.Close();  

            Console.WriteLine("The package has been created.\nPress a key.");  
            Console.ReadKey();  
        }  
    }  
}  

Imports System.IO.Packaging  
Imports DocumentFormat.OpenXml  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Spreadsheet  

Module Module1  
    ' Create a spreadsheet by Package.  
    Sub Main(ByVal args As String())  
        Dim fileName As String = "C:\users\public\documents\WorkSheetPartEx.zip"  

        ' Open a package file.   
        Dim package As Package = package.Open(fileName)  

        ' Create the spreadsheet document.  
        Dim spreadsheetDocument As SpreadsheetDocument = spreadsheetDocument.Create(package, SpreadsheetDocumentType.Template)  

        ' Add a WorkbookPart.  
        Dim workbookpart As WorkbookPart = spreadsheetDocument.AddWorkbookPart()  
        workbookpart.Workbook = New Workbook()  

        ' Add a WorksheetPart.  
        Dim worksheetPart As WorksheetPart = workbookpart.AddNewPart(Of WorksheetPart)()  
        worksheetPart.Worksheet = New Worksheet(New SheetData())  

        ' Add a sheets list.  
        Dim sheets As Sheets = spreadsheetDocument.WorkbookPart.Workbook.AppendChild(Of Sheets)(New Sheets())  

        ' Append the new worksheet and associate it with the workbook.  
        Dim sheet As New Sheet() With { _  
         .Id = spreadsheetDocument.WorkbookPart.GetIdOfPart(worksheetPart), _  
         .SheetId = 1, _  
         .Name = "mySheet" _  
        }  
        sheets.Append(sheet)  

        ' Close the spreadsheet and the package.  
        spreadsheetDocument.Close()  
        package.Close()  

        Console.WriteLine("The package has been created." & vbLf & "Press a key.")  
        Console.ReadKey()  
    End Sub  
End Module  

Constructors

Properties

Methods

Extension Methods

Applies to