SpreadsheetDocument クラス

定義

名前空間:

DocumentFormat.OpenXml.Packaging

アセンブリ:

DocumentFormat.OpenXml.dll

パッケージ:

DocumentFormat.OpenXml v3.0.1

SpreadsheetDocument を定義します。OpenXmlPackage はスプレッドシート ドキュメントを表します。

public class SpreadsheetDocument : DocumentFormat.OpenXml.Packaging.OpenXmlPackage, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.ThumbnailPart>, DocumentFormat.OpenXml.Packaging.ISupportedRelationship<DocumentFormat.OpenXml.Packaging.WorkbookPart>

type SpreadsheetDocument = class
    inherit OpenXmlPackage
    interface ISupportedRelationship<ThumbnailPart>
    interface ISupportedRelationship<WorkbookPart>

Public Class SpreadsheetDocument
Inherits OpenXmlPackage
Implements ISupportedRelationship(Of ThumbnailPart), ISupportedRelationship(Of WorkbookPart)

継承

Object

OpenXmlPartContainer

OpenXmlPackage

SpreadsheetDocument

実装

ISupportedRelationship<ThumbnailPart> ISupportedRelationship<WorkbookPart>

例

次の例では、基本的な Excel ドキュメント (1 つのワークシートを含むブック) を作成します。 コード例を実行した後、作成したファイル "SpreadsheetDocumentEx.xlsx" を見て、"mySheet" という名前のワークシートに注目してください。

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

namespace SpreadsheetDocumentEx  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            string fileName = @"c:\Users\Public\Documents\SpreadsheetDocumentEx.xlsx";  

            // Create a spreadsheet document by supplying the file name.  
            SpreadsheetDocument spreadsheetDocument = SpreadsheetDocument.  
                Create(fileName, SpreadsheetDocumentType.Workbook);  

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

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

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

            // Append a 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 document.  
            spreadsheetDocument.Close();  

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

Imports DocumentFormat.OpenXml  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Spreadsheet  
Module Module1  
    Sub Main()  
        ' Create a spreadsheet document by supplying the file name.  
        Dim fileName As String = "c:\Users\Public\Documents\SpreadsheetDocumentEx.xlsx"  
        Dim spreadsheetDocument As SpreadsheetDocument = _  
      spreadsheetDocument.Create(fileName, SpreadsheetDocumentType.Workbook)  

        ' Add a WorkbookPart to the document.  
        Dim workbookpart As WorkbookPart = spreadsheetDocument.AddWorkbookPart  
        workbookpart.Workbook = New Workbook  

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

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

        ' Append a new worksheet and associate it with the workbook.  
        Dim sheet As Sheet = New Sheet  
        sheet.Id = spreadsheetDocument.WorkbookPart.GetIdOfPart(worksheetPart)  
        sheet.SheetId = 1  
        sheet.Name = "mySheet"  
        sheets.Append(sheet)  
        workbookpart.Workbook.Save()  

        ' Close the document.  
        spreadsheetDocument.Close()  

        Console.WriteLine("The spreadsheet document has been created." +  
                          ControlChars.Lf + "Press a key.")  
        Console.ReadKey()  
    End Sub  
End Module  

プロパティ

AutoSave	破棄時にパーツを保存するかどうかを示す値を取得します。 (継承元 OpenXmlPackage)
CompressionOption	新しいパーツのコンテンツの圧縮レベルを取得または設定します (継承元 OpenXmlPackage)
CoreFilePropertiesPart	SpreadsheetDocument の CoreFilePropertiesPart を取得します。
CustomFilePropertiesPart	SpreadsheetDocument の CustomFilePropertiesPart を取得します。
DataPartReferenceRelationships	すべてのリレーションシップを DataPartReferenceRelationship 取得します。 (継承元 OpenXmlPartContainer)
DataParts	ドキュメント パッケージ内のすべての DataPart パーツを取得します。 (継承元 OpenXmlPackage)
DigitalSignatureOriginPart	SpreadsheetDocument の DigitalSignatureOriginPart を取得します。
DocumentType	SpreadsheetDocument の型を取得します。
ExtendedFilePropertiesPart	SpreadsheetDocument の ExtendedFilePropertiesPart を取得します。
ExternalRelationships	すべての外部リレーションシップを取得します。 ハイパーリンク リレーションシップは含まれません。HyperlinkRelationship プロパティを使用してハイパーリンク リレーションシップを列挙します。 (継承元 OpenXmlPartContainer)
Features	この部分に関連付けられている機能を取得します。
FileOpenAccess	ドキュメントの FileAccess 設定を取得します。 現在の I/O アクセス設定は、読み取り、書き込み、または ReadWrite です。 (継承元 OpenXmlPackage)
HyperlinkRelationships	すべてのハイパーリンク リレーションシップを取得します。 (継承元 OpenXmlPartContainer)
LabelInfoPart	Office2021 でのみ使用できる SpreadsheetDocument の LabelInfoPart を取得します。
MarkupCompatibilityProcessSettings	読み込み時に適用されるマークアップ互換性設定を取得します。 (継承元 OpenXmlPackage)
MaxCharactersInPart	Open XML パーツ内の最大許容文字数を示す値を取得します。 ゼロ (0) の値は、パーツのサイズに制限がないことを示します。 0 以外の値は、最大サイズを文字数で指定します。 (継承元 OpenXmlPackage)
Package	ドキュメントのパッケージを取得します。 (継承元 OpenXmlPackage)
PackageProperties	パッケージのプロパティを取得します。 (継承元 OpenXmlPackage)
PartExtensionProvider	ContentType からパーツ拡張機能へのマッピングを提供する PartExtensionProvider パーツを取得します。 (継承元 OpenXmlPackage)
Parts	このパーツのリレーションシップ ターゲットであるすべてのパーツを取得します。 (継承元 OpenXmlPartContainer)
QuickAccessToolbarCustomizationsPart	SpreadsheetDocument の QuickAccessToolbarCustomizationsPart を取得します。
RibbonAndBackstageCustomizationsPart	Office2010 でのみ使用できる SpreadsheetDocument の RibbonAndBackstageCustomizationsPart を取得します。
RibbonExtensibilityPart	SpreadsheetDocument の RibbonExtensibilityPart を取得します。
RootPart	パッケージのルート 部分を取得します。 (継承元 OpenXmlPackage)
StrictRelationshipFound	このパッケージに Strict から変換された遷移関係が含まれているかどうかを示す値を取得します。 (継承元 OpenXmlPackage)
ThumbnailPart	SpreadsheetDocument の ThumbnailPart を取得します。
WebExTaskpanesPart	Office2013 でのみ使用できる SpreadsheetDocument の WebExTaskpanesPart を取得します。
WorkbookPart	SpreadsheetDocument の WorkbookPart を取得します。

メソッド

AddAnnotation(Object)	この PartContainer の注釈リストにオブジェクトを追加します。 (継承元 OpenXmlPartContainer)
AddCoreFilePropertiesPart()	CoreFilePropertiesPart を SpreadsheetDocument に追加します。
AddCustomFilePropertiesPart()	CustomFilePropertiesPart を SpreadsheetDocument に追加します。
AddDigitalSignatureOriginPart()	DigitalSignatureOriginPart を SpreadsheetDocument に追加します。
AddExtendedFilePropertiesPart()	ExtendedFilePropertiesPart を SpreadsheetDocument に追加します。
AddExtendedPart(String, String, String)	拡張パーツ (アプリケーション固有の部分) を追加します。 (継承元 OpenXmlPartContainer)
AddExtendedPart(String, String, String, String)	拡張パーツ (アプリケーション固有の部分) を追加します。 (継承元 OpenXmlPartContainer)
AddExternalRelationship(String, Uri)	外部リレーションシップを追加します。 このメソッドを使用してハイパーリンク リレーションシップを追加しないでください。 代わりに AddHyperlinkRelationship() を使用します。 (継承元 OpenXmlPartContainer)
AddExternalRelationship(String, Uri, String)	外部リレーションシップを追加します。 このメソッドを使用してハイパーリンク リレーションシップを追加しないでください。 代わりに AddHyperlinkRelationship() を使用します。 (継承元 OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean)	新しいハイパーリンク関係を追加します。 (継承元 OpenXmlPartContainer)
AddHyperlinkRelationship(Uri, Boolean, String)	新しいハイパーリンク関係を追加します。 (継承元 OpenXmlPartContainer)
AddLabelInfoPart()	SpreadsheetDocument に LabelInfoPart を追加します。このパーツは Office2021 でのみ使用できます。
AddNewPart<T>()	T 型の新しい部分を追加します。 (継承元 OpenXmlPartContainer)
AddNewPart<T>(String)	T 型の新しい部分を追加します。 (継承元 OpenXmlPartContainer)
AddNewPart<T>(String, String)	型の新しい部分を追加します T。
AddPart<T>(T)	指定したパーツをドキュメントに追加します。 返されたパーツを使用して、ドキュメントに追加されたパーツを操作します。 (継承元 OpenXmlPackage)
AddPart<T>(T, String)	指定されたリレーションシップ識別子 (ID) を使用して、パーツをドキュメントに追加します。 ドキュメントに追加されたパーツを操作するには、返されたパーツを使用する必要があります (継承元 OpenXmlPartContainer)
AddQuickAccessToolbarCustomizationsPart()	QuickAccessToolbarCustomizationsPart を SpreadsheetDocument に追加します。
AddRibbonAndBackstageCustomizationsPart()	RibbonAndBackstageCustomizationsPart を SpreadsheetDocument に追加します。このパーツは Office2010 でのみ使用できます。
AddRibbonExtensibilityPart()	RibbonExtensibilityPart を SpreadsheetDocument に追加します。
AddWebExTaskpanesPart()	WebExTaskpanesPart を SpreadsheetDocument に追加します。このパーツは Office2013 でのみ使用できます。
AddWorkbookPart()	WorkbookPart を作成し、このドキュメントに追加します。
Annotation(Type)	指定した型の最初の注釈オブジェクトを、この PartContainer から取得します。 (継承元 OpenXmlPartContainer)
Annotation<T>()	指定した型の最初の注釈オブジェクトを、この PartContainer から取得します。 (継承元 OpenXmlPartContainer)
Annotations(Type)	この PartContainer の指定した型の注釈のコレクションを取得します。 (継承元 OpenXmlPartContainer)
Annotations<T>()	この PartContainer の指定した型の注釈のコレクションを取得します。 (継承元 OpenXmlPartContainer)
ChangeDocumentType(SpreadsheetDocumentType)	ドキュメントの種類を変更します。
ChangeIdOfPart(OpenXmlPart, String)	パーツのリレーションシップ ID を変更します。 (継承元 OpenXmlPartContainer)
Clone()	この OpenXml パッケージの編集可能な複製を作成します。展開可能な容量を持つ で MemoryStream 開き、既定の OpenSettings を使用します。 (継承元 OpenXmlPackage)
Clone(Package)	指定した Package インスタンスで開かれた、この OpenXml パッケージの複製を作成します。 複製は、この OpenXml パッケージと同じ OpenSettings で開かれます。 (継承元 OpenXmlPackage)
Clone(Package, OpenSettings)	指定した Package インスタンスで開かれた、この OpenXml パッケージの複製を作成します。 (継承元 OpenXmlPackage)
Clone(Stream)	指定されたストリームで開かれたこの OpenXml パッケージの複製を作成します。 複製された OpenXml パッケージは、この OpenXml パッケージと同じ設定 (FileOpenAccess と OpenSettings) で開かれます。 (継承元 OpenXmlPackage)
Clone(Stream, Boolean)	指定されたストリームで開かれたこの OpenXml パッケージの複製を作成します。 複製された OpenXml パッケージは、この OpenXml パッケージと同じ OpenSettings で開かれます。 (継承元 OpenXmlPackage)
Clone(Stream, Boolean, OpenSettings)	指定されたストリームで開かれたこの OpenXml パッケージの複製を作成します。 (継承元 OpenXmlPackage)
Clone(String)	指定されたファイルから開かれたこの OpenXml パッケージの複製を作成します (この OpenXml パッケージを複製することによって作成されます)。 複製された OpenXml パッケージは、この OpenXml パッケージと同じ設定 (FileOpenAccess と OpenSettings) で開かれます。 (継承元 OpenXmlPackage)
Clone(String, Boolean)	指定されたファイルから開かれたこの OpenXml パッケージの複製を作成します (この OpenXml パッケージを複製することによって作成されます)。 複製された OpenXml パッケージは、この OpenXml パッケージと同じ OpenSettings で開かれます。 (継承元 OpenXmlPackage)
Clone(String, Boolean, OpenSettings)	指定されたファイルから開かれたこの OpenXml パッケージの複製を作成します (この OpenXml パッケージを複製することによって作成されます)。 (継承元 OpenXmlPackage)
Close()	OpenXml パッケージと、基になるすべてのパーツ ストリームを保存して閉じます。 (継承元 OpenXmlPackage)
Create(Package, SpreadsheetDocumentType)	指定したパッケージから SpreadsheetDocument クラスの新しいインスタンスを作成します。
Create(Package, SpreadsheetDocumentType, Boolean)	指定したパッケージから SpreadsheetDocument クラスの新しいインスタンスを作成します。
Create(Stream, SpreadsheetDocumentType)	IO ストリームから SpreadsheetDocument クラスの新しいインスタンスを作成します。
Create(Stream, SpreadsheetDocumentType, Boolean)	IO ストリームから SpreadsheetDocument クラスの新しいインスタンスを作成します。
Create(String, SpreadsheetDocumentType)	指定したファイルから SpreadsheetDocument クラスの新しいインスタンスを作成します。
Create(String, SpreadsheetDocumentType, Boolean)	指定したファイルから SpreadsheetDocument クラスの新しいインスタンスを作成します。
CreateClone(Package)	指定した Package インスタンスに OpenXmlPackage の新しいインスタンスを作成します。 (継承元 OpenXmlPackage)
CreateClone(Stream)	指定されたストリームに新しい OpenXmlPackage を作成します。 (継承元 OpenXmlPackage)
CreateClone(String)	指定したファイルに新しい OpenXml パッケージを作成します。 (継承元 OpenXmlPackage)
CreateFromTemplate(String)	テンプレートから編集可能な SpreadsheetDocument を作成し、拡張可能な容量を持つ MemoryStream で開きます。
CreateMediaDataPart(MediaDataPartType)	ドキュメント パッケージに新しい MediaDataPart パーツを作成します。 (継承元 OpenXmlPackage)
CreateMediaDataPart(String)	ドキュメント パッケージに新しい MediaDataPart パーツを作成します。 (継承元 OpenXmlPackage)
CreateMediaDataPart(String, String)	ドキュメント パッケージに新しい MediaDataPart パーツを作成します。 (継承元 OpenXmlPackage)
CreateRelationshipToPart(OpenXmlPart)	指定したパーツのリレーションシップをこのパーツに追加します。 (継承元 OpenXmlPartContainer)
CreateRelationshipToPart(OpenXmlPart, String)	指定したパーツのリレーションシップをこのパーツに追加します。 (継承元 OpenXmlPartContainer)
DeleteExternalRelationship(ExternalRelationship)	指定した外部リレーションシップを削除します。 (継承元 OpenXmlPartContainer)
DeleteExternalRelationship(String)	指定した ExternalRelationship を削除します。 (継承元 OpenXmlPartContainer)
DeletePart(DataPart)	指定した をドキュメント パッケージから削除します DataPart 。 (継承元 OpenXmlPackage)
DeletePart(OpenXmlPart)	パッケージ ルート レイヤー内の指定したパーツを削除します。 (継承元 OpenXmlPartContainer)
DeletePart(String)	指定した子パーツをこのパーツから削除します。 (継承元 OpenXmlPartContainer)
DeleteParts<T>(IEnumerable<T>)	渡されたコレクション内にあるすべての部分をドキュメントから削除します。 (継承元 OpenXmlPartContainer)
DeletePartsRecursivelyOfType<T>()	指定したパーツの種類を持つすべてのパーツをパッケージから再帰的に削除します。 (継承元 OpenXmlPackage)
DeleteReferenceRelationship(ReferenceRelationship)	指定した参照関係を削除します。 (継承元 OpenXmlPartContainer)
DeleteReferenceRelationship(String)	指定した参照関係を削除します。 (継承元 OpenXmlPartContainer)
Dispose()	コンテンツをフラッシュして保存し、ドキュメントを閉じ、すべてのリソースを解放します。 (継承元 OpenXmlPackage)
Dispose(Boolean)	コンテンツをフラッシュして保存し、ドキュメントを閉じ、すべてのリソースを解放します。 (継承元 OpenXmlPackage)
FromFlatOpcDocument(XDocument)	で開かれたフラット OPC 形式から XDocument SpreadsheetDocument の新しい編集可能なインスタンスを MemoryStream作成します。
FromFlatOpcDocument(XDocument, Package)	指定した Package インスタンスのフラット OPC 形式のブックから SpreadsheetDocument の新しいインスタンスを作成します。
FromFlatOpcDocument(XDocument, Stream, Boolean)	Flat OPC 形式のブックから SpreadsheetDocument の新しいインスタンスを作成します。
FromFlatOpcDocument(XDocument, String, Boolean)	Flat OPC 形式のブックから SpreadsheetDocument の新しいインスタンスを作成します。
FromFlatOpcString(String)	展開可能な容量のフラット OPC 形式の文字列から SpreadsheetDocument の新しいインスタンスを MemoryStream 作成します。
FromFlatOpcString(String, Package)	Flat OPC 形式の文字列から SpreadsheetDocument の新しいインスタンスを作成します。
FromFlatOpcString(String, Stream, Boolean)	のフラット OPC 形式の文字列から SpreadsheetDocument の新しいインスタンスを作成します。
FromFlatOpcString(String, String, Boolean)	Flat OPC 形式の文字列から SpreadsheetDocument の新しいインスタンスを作成します。
GetExternalRelationship(String)	指定した ExternalRelationship を取得します。 (継承元 OpenXmlPartContainer)
GetIdOfPart(OpenXmlPart)	パーツのリレーションシップ ID を取得します。 (継承元 OpenXmlPartContainer)
GetPartById(String)	リレーションシップ ID を使用して子パーツを取得します。 (継承元 OpenXmlPartContainer)
GetPartsCountOfType<T>()	T 型のすべての部分の数を取得します。 (継承元 OpenXmlPartContainer)
GetPartsOfType<T>()	このパーツの指定した型 T のすべての子部分を列挙します。 (継承元 OpenXmlPartContainer)
GetPartsOfType<T>(ICollection<T>)	指定した型 T のすべての子部分をこの部分に partCollection 取得します。 (継承元 OpenXmlPartContainer)
GetReferenceRelationship(String)	指定した ReferenceRelationship を取得します。 (継承元 OpenXmlPartContainer)
Open(Package)	指定したパッケージから SpreadsheetDocument クラスの新しいインスタンスを作成します。
Open(Package, OpenSettings)	指定したパッケージから SpreadsheetDocument クラスの新しいインスタンスを作成します。
Open(Stream, Boolean)	IO ストリームから SpreadsheetDocument クラスの新しいインスタンスを作成します。
Open(Stream, Boolean, OpenSettings)	IO ストリームから SpreadsheetDocument クラスの新しいインスタンスを作成します。
Open(String, Boolean)	指定したファイルから SpreadsheetDocument クラスの新しいインスタンスを作成します。
Open(String, Boolean, OpenSettings)	指定したファイルから SpreadsheetDocument クラスの新しいインスタンスを作成します。
OpenClone(Stream, Boolean, OpenSettings)	指定されたストリームで複製された OpenXml パッケージを開きます。 (継承元 OpenXmlPackage)
OpenClone(String, Boolean, OpenSettings)	指定されたファイルで複製された OpenXml パッケージを開きます。 (継承元 OpenXmlPackage)
RemoveAnnotations(Type)	指定した型の注釈をこの PartContainer から削除します。 (継承元 OpenXmlPartContainer)
RemoveAnnotations<T>()	指定した型の注釈をこの PartContainer から削除します。 (継承元 OpenXmlPartContainer)
Save()	が の場合FileOpenAccessReadWriteは、OpenXml パッケージに含まれるすべてのパーツとリレーションシップの内容を保存します。 一部のプラットフォームでは、 の Package制限により保存がサポートされていないため、実行時に クエリを実行 CanSave して、 を閉じて破棄 OpenXmlPackageせずに完全な保存がサポートされるかどうかを確認してください。 (継承元 OpenXmlPackage)
SaveAs(String)	OpenXml パッケージに含まれるすべてのパーツとリレーションシップの内容を、指定したファイルに保存します。 この OpenXml パッケージを開くために使用したのと同じ設定を使用して、保存したドキュメントを開きます。 (継承元 OpenXmlPackage)
ThrowIfObjectDisposed()	オブジェクトが破棄された場合にスローされます。 (継承元 OpenXmlPackage)
ToFlatOpcDocument()	OPC 形式の OpenXml パッケージを XDocument フラット OPC 形式に変換します。 (継承元 OpenXmlPackage)
ToFlatOpcDocument(XProcessingInstruction)	OPC 形式の OpenXml パッケージを XDocument フラット OPC 形式に変換します。 (継承元 OpenXmlPackage)
ToFlatOpcString()	OPC 形式の OpenXml パッケージをフラット OPC 形式の文字列に変換します。 (継承元 OpenXmlPackage)
TryGetPartById(String, OpenXmlPart)	リレーションシップ ID で子パーツを取得してみてください。 (継承元 OpenXmlPartContainer)
Validate(OpenXmlPackageValidationSettings)	パッケージを検証します。 このメソッドは、各部分の XML コンテンツを検証しません。 (継承元 OpenXmlPackage)

拡張メソッド

GetPackage(OpenXmlPackage)	の現在 IPackage の を取得します package。
AddPackageEventsFeature(OpenXmlPackage)	パッケージ ライフサイクル イベントのイベントを追跡する機能を追加します。
AddPartEventsFeature(OpenXmlPackage)	パーツを作成または削除するパッケージのイベントを追跡する機能を追加します。
AddPartRootEventsFeature(OpenXmlPartContainer)	パッケージ ライフ サイクル イベントのイベントを追跡する機能を追加します。
AddRandomNumberGeneratorFeature(OpenXmlPackage)	パッケージに乱数ジェネレーターを追加します。
CreateUnknownElement(OpenXmlPartContainer, String)	外部 XML を使用して、新しい OpenXmlUnknownElement クラスを作成します。
ToFlatOpcDocument(OpenXmlPackage)	OPC 形式の OpenXml パッケージを XDocument フラット OPC 形式に変換します。
ToFlatOpcString(OpenXmlPackage)	OPC 形式の OpenXml パッケージをフラット OPC 形式の文字列に変換します。
GetAllParts(OpenXmlPackage)	幅優先で 内の OpenXmlPackage 部分を走査します。
IgnoreCalculationChainPartRelationship(SpreadsheetDocument)	パーツが存在しない場合は、リレーションシップCalculationChainPartを無視するように をspreadsheet設定します。