Workbook クラス

リファレンス

定義

名前空間:: DocumentFormat.OpenXml.Spreadsheet

アセンブリ:: DocumentFormat.OpenXml.dll

アセンブリ:: DocumentFormat.OpenXml.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

ブックです。 WorkbookPart のルート要素です。オブジェクトを xml としてシリアル化されるときに、修飾名は、x: ブックです。

[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.FileVersion))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.FileSharing))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.WorkbookProperties))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Office2013.ExcelAc.AbsolutePath), DocumentFormat.OpenXml.FileFormatVersions.Office2013)]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.WorkbookProtection))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.BookViews))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.Sheets))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.FunctionGroups))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.ExternalReferences))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.DefinedNames))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.CalculationProperties))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.OleSize))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.CustomWorkbookViews))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PivotCaches))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.WebPublishing))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.FileRecoveryProperties))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.WebPublishObjects))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.WorkbookExtensionList))]
public class Workbook : DocumentFormat.OpenXml.OpenXmlPartRootElement

type Workbook = class
    inherit OpenXmlPartRootElement

Public Class Workbook
Inherits OpenXmlPartRootElement

継承: Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement
Workbook

属性: ChildElementInfoAttribute

例

コード例を次に示しますは既存のスプレッドシートドキュメントを開きます"mySheet、"という名前の新しいワークシートを追加し、ブックに関連付けます。

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

namespace WorkbookEx  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            string fileName = @"C:\Users\Public\Documents\WorkbookEx.xlsx";  
            // Open an existing spreadsheet document for editing.  
            using (SpreadsheetDocument spreadSheet = SpreadsheetDocument.Open(fileName, true))  
            {  
                // Add a blank WorksheetPart.  
                WorksheetPart newWorksheetPart = spreadSheet.WorkbookPart.AddNewPart<WorksheetPart>();  
                newWorksheetPart.Worksheet = new Worksheet(new SheetData());  

                // Create a Sheets object in the Workbook.  
                Sheets sheets = spreadSheet.WorkbookPart.Workbook.GetFirstChild<Sheets>();  
                string relationshipId = spreadSheet.WorkbookPart.GetIdOfPart(newWorksheetPart);  

                // Create a unique ID for the new worksheet.  
                uint sheetId = 1;  
                if (sheets.Elements<Sheet>().Count() > 0)  
                {  
                    sheetId = sheets.Elements<Sheet>().Select(s => s.SheetId.Value).Max() + 1;  
                }  

                // Give the new worksheet a name.  
                string sheetName = "mySheet" + sheetId;  

                // Append the new worksheet and associate it with the workbook.  
                Sheet sheet = new Sheet() { Id = relationshipId, SheetId = sheetId, Name = sheetName };  
                sheets.Append(sheet);  
            }  
            Console.WriteLine("All done. Press a key.");  
            Console.ReadKey();  
        }  
    }  
}

Imports System.Linq  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Spreadsheet  
Module Module1  
    Sub Main()  
        Dim fileName As String = "C:\Users\Public\Documents\WorkbookEx.xlsx"  
        ' Open an existing spreadsheet document for editing.  
        Dim spreadSheet As SpreadsheetDocument = SpreadsheetDocument.Open(fileName, True)  
        Using (spreadSheet)  
            ' Add a blank WorksheetPart.  
            Dim newWorksheetPart As WorksheetPart = spreadSheet.WorkbookPart.AddNewPart(Of WorksheetPart)()  
            newWorksheetPart.Worksheet = New Worksheet(New SheetData())  

            ' Create a Sheets object.  
            Dim sheets As Sheets = spreadSheet.WorkbookPart.Workbook.GetFirstChild(Of Sheets)()  
            Dim relationshipId As String = spreadSheet.WorkbookPart.GetIdOfPart(newWorksheetPart)  

            ' Get a unique ID for the new worksheet.  
            Dim sheetId As UInteger = 1  
            If (sheets.Elements(Of Sheet).Count > 0) Then  
                sheetId = sheets.Elements(Of Sheet).Select(Function(s) s.SheetId.Value).Max + 1  
            End If  

            ' Give the new worksheet a name.  
            Dim sheetName As String = ("mySheet" + sheetId.ToString())  

            ' Append the new worksheet and associate it with the workbook.  
            Dim sheet As Sheet = New Sheet  
            sheet.Id = relationshipId  
            sheet.SheetId = sheetId  
            sheet.Name = sheetName  
            sheets.Append(sheet)  
        End Using  
        Console.WriteLine("All done. Press a key.")  
        Console.ReadKey()  
    End Sub  
End Module

注釈

[ISO/IEC 29500-1 1st Edition]

ブック (ブック)

ブックの要素は、最上位レベル要素です。ブックのデータの内容が含まれている要素と属性が含まれています。各ブックの子要素がある独自の項参照し、これらを次の子要素の表に示します。これらの要素を表す、ブックの構造体の部分的なリストは次のとおりです。

シート: ブック内のワークシートのコレクションを表します。シートは、ブック内で中心的な構造であり、テキスト、数値、日付、数式、および、ブックの他の要素が含まれています。
ビュー: SpreadsheetML 定義基本的なウィンドウのサイズを定義するブックのビューのコレクション、およびブックの位置、スプレッドシートアプリケーションでこれまで表示されている場合。また、ブック内のデータの 1 つまたは複数のビューを記述する SpreadsheetML では、ユーザー設定のブックのビューのコレクションを定義します。
プロパティ: ブックでは、日付システムを使用して、ファイルの保護の設定、計算設定、およびスマートタグの動作など、基本的なブックの設定を保存するいくつかのプロパティのコレクションがあります。
名前: 単語またはセル、セル、セル、数式、または定数値の範囲を表す文字の文字列です。

[例。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>  
<workbook xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/5/main" mlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">  
  <fileVersion lastEdited="4" lowestEdited="4" rupBuild="4017"/>  
  <workbookPr dateCompatibility="false" vbName="ThisWorkbook" defaultThemeVersion="123820"/>  
  <bookViews>  
    <workbookView xWindow="120" yWindow="45" windowWidth="15135"      windowHeight="7650" activeTab="4"/>  
  </bookViews>  
  <sheets>  
    <sheet name="Sheet1" sheetId="1" r:id="rId1"/>  
    <sheet name="Sheet2" sheetId="2" r:id="rId2"/>  
    <sheet name="Sheet5" sheetId="3" r:id="rId3"/>  
    <sheet name="Chart1" sheetId="4" type="chartsheet" r:id="rId4"/>  
  </sheets>  
  <definedNames>  
    <definedName name="MyDefinedName">Sheet3!$A$1:$C$12</definedName>  
  </definedNames>  
  <calcPr calcId="122211" calcMode="autoNoTable" refMode="R1C1" iterate="1"    fullPrecision="0"/>  
  <customWorkbookViews>  
    <customWorkbookView name="CustomView1"       guid="{CE6681F1-E999-414D-8446-68A031534B57}" maximized="1" xWindow="1"       yWindow="1" windowWidth="1024" windowHeight="547" activeSheetId="1"/>  
  </customWorkbookViews>  
  <pivotCaches>  
    <pivotCache cacheId="0" r:id="rId8"/>  
  </pivotCaches>  
  <smartTagPr embed="1" show="noIndicator"/>  
  <smartTagTypes>  
    <smartTagType namespaceUri="urn:schemas-openxmlformats-org:office:smarttags"       name="date"/>  
  </smartTagTypes>  
  <webPublishing codePage="1252"/>  
</workbook>

例終わり]

親要素
SpreadsheetML ブックパーツのルート要素

子要素	句
bookViews (ブックの表示)	§18.2.1
calcPr (計算プロパティ)	§18.2.2
customWorkbookViews (ユーザー設定のブックの表示)	§18.2.4
definedNames (定義されている名前)	§18.2.6
externalReferences (外部参照)	§18.2.9
extLst (将来機能のデータの記憶領域)	§18.2.10
fileRecoveryPr (ファイル・リカバリ・プロパティ)	§18.2.11
ファイル共有の (ファイル共有)	§18.2.12
fileVersion (ファイルのバージョン)	§18.2.13
functionGroups (機能グループ)	§18.2.15
oleSize (埋め込みオブジェクトのサイズ)	§18.2.16
pivotCaches (PivotCaches)	§18.2.18
シート (シート)	§18.2.20
smartTagPr (スマートタグのプロパティ)	§18.2.21
smartTagTypes (スマートタグの種類)	§18.2.23
webPublishing (Web 公開のプロパティ)	§18.2.24
webPublishObjects (Web 発行オブジェクト)	§18.2.26
workbookPr (ブックのプロパティ)	§18.2.28
workbookProtection (ブックの保護)	§18.2.29

[注: この要素のコンテンツモデル (CT_Workbook) の W3C XML スキーマ定義は §A.2 であります。 メモの終了)

ISO/IEC29500: 2008。

コンストラクター

Workbook()	ブッククラスの新しいインスタンスを初期化します。
Workbook(IEnumerable<OpenXmlElement>)	指定した子要素を使用してブッククラスの新しいインスタンスを初期化します。
Workbook(OpenXmlElement[])	指定した子要素を使用してブッククラスの新しいインスタンスを初期化します。
Workbook(String)	外側の XML からブッククラスの新しいインスタンスを初期化します。

プロパティ

AbsolutePath	AbsolutePath、このプロパティは、Office2013 で利用可能なだけです。スキーマでは、次の要素タグを表します x15ac:absPath。
BookViews	BookViews。スキーマでは、次の要素タグを表します: x: bookViews
CalculationProperties	CalculationProperties。スキーマでは、次の要素タグを表します: x: calcPr
ChildElements	現在の要素のすべての子ノードを取得します。 (継承元 OpenXmlElement)
Conformance	準拠します。スキーマでは、次の属性を表します準拠。
CustomWorkbookViews	CustomWorkbookViews。スキーマでは、次の要素タグを表します: x: customWorkbookViews
DefinedNames	DefinedNames。スキーマでは、次の要素タグを表します: x: definedNames
ExtendedAttributes	現在の要素のすべての拡張属性 (スキーマで定義されていない属性) を取得します。 (継承元 OpenXmlElement)
ExternalReferences	ExternalReferences。スキーマでは、次の要素タグを表します: x: externalReferences
FileSharing	ファイルを共有します。スキーマでは、次の要素タグを表します: x: ファイル共有
FileVersion	FileVersion。スキーマでは、次の要素タグを表します: x: fileVersion
FirstChild	現在の OpenXmlElement 要素の最初の子を取得します。 (継承元 OpenXmlCompositeElement)
FunctionGroups	FunctionGroups。スキーマでは、次の要素タグを表します: x: functionGroups
HasAttributes	現在の要素に属性が含されているかどうかを示すブール値を取得します。 (継承元 OpenXmlElement)
HasChildren	現在の要素に子要素が含されているかどうかを示す値を取得します。 (継承元 OpenXmlCompositeElement)
InnerText	現在のノードとそのすべての子の連結値を取得または設定します。 (継承元 OpenXmlCompositeElement)
InnerXml	現在のノードの子ノードのみを表すマークアップを取得または設定します。 (継承元 OpenXmlCompositeElement)
LastChild	現在の OpenXmlElement 要素の最後の子を取得します。このような OpenXmlElement 要素がないVisual Basic null (Nothing in Visual Basic) を返します。 (継承元 OpenXmlCompositeElement)
LocalName	要素のローカル名を取得します。
MCAttributes	マークアップの互換性属性を設定します。現在の要素に対してマークアップ互換性属性が定義されていない場合は null を返します。 (継承元 OpenXmlElement)
NamespaceDeclarations	現在の要素で定義されている名前空間宣言を取得します。名前空間宣言がない場合は、空の列挙子を返します。 (継承元 OpenXmlElement)
NamespaceUri	現在の要素の名前空間 URI を取得します。 (継承元 OpenXmlElement)
OleSize	OleSize。スキーマでは、次の要素タグを表します: x: oleSize
OpenXmlElementContext	現在の要素の OpenXmlEementContext を取得します。 (継承元 OpenXmlElement)
OuterXml	現在の要素とそのすべての子要素を表すマークアップを取得します。 (継承元 OpenXmlElement)
Parent	現在の要素の親要素を取得します。 (継承元 OpenXmlElement)
PivotCaches	PivotCaches。スキーマでは、次の要素タグを表します: x: pivotCaches
Prefix	現在の要素の名前空間プレフィックスを取得します。 (継承元 OpenXmlElement)
Sheets	シートです。スキーマでは、次の要素タグを表します: x: シート
WebPublishing	WebPublishing。スキーマでは、次の要素タグを表します: x: webPublishing
WorkbookPart	この要素に関連付けられている WorkbookPart を取得します。
WorkbookProperties	WorkbookProperties。スキーマでは、次の要素タグを表します: x: workbookPr
WorkbookProtection	WorkbookProtection。スキーマでは、次の要素タグを表します: x: workbookProtection
XmlQualifiedName	現在の要素の修飾名を取得します。 (継承元 OpenXmlElement)
XName	現在の要素の修飾名を取得します。 (継承元 OpenXmlElement)

メソッド

AddAnnotation(Object)	現在の OpenXmlElement 要素の注釈の一覧にオブジェクトを追加します。 (継承元 OpenXmlElement)
AddNamespaceDeclaration(String, String)	現在のノードに namepace 宣言を追加します。 (継承元 OpenXmlElement)
Ancestors()	現在の要素のすべての先祖を列挙します。 (継承元 OpenXmlElement)
Ancestors<T>()	指定した型を持つ現在の要素の先祖のみを列挙します。 (継承元 OpenXmlElement)
Annotation(Type)	現在の OpenXmlElement 要素から、指定した型の最初の注釈オブジェクトを取得します。 (継承元 OpenXmlElement)
Annotation<T>()	現在の OpenXmlElement 要素から、指定した型の最初の注釈オブジェクトを取得します。 (継承元 OpenXmlElement)
Annotations(Type)	現在の OpenXmlElement 要素の指定した型を持つ注釈のコレクションを取得します。 (継承元 OpenXmlElement)
Annotations<T>()	現在の OpenXmlElement 要素の指定した型を持つ注釈のコレクションを取得します。 (継承元 OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	要素のリストから、現在の要素の子要素のリストの末尾に各要素を追加します。 (継承元 OpenXmlElement)
Append(OpenXmlElement[])	要素の配列から、現在の要素の子要素のリストの末尾に各要素を追加します。 (継承元 OpenXmlElement)
AppendChild<T>(T)	指定した要素を、現在の要素の子ノードのリストの末尾に追加します。 (継承元 OpenXmlCompositeElement)
ClearAllAttributes()	既知の属性と拡張属性の両方を含む、すべての属性をクリアします。 (継承元 OpenXmlElement)
Clone()	現在のノードの複製を作成します。 (継承元 OpenXmlElement)
CloneNode(Boolean)	このノードの複製を作成します。
Descendants()	現在の要素のすべての子孫を列挙します。 (継承元 OpenXmlElement)
Descendants<T>()	現在の要素の T 型のすべての子孫を列挙します。 (継承元 OpenXmlElement)
Elements()	現在の要素のすべての子を列挙します。 (継承元 OpenXmlElement)
Elements<T>()	指定した型を持つ現在の要素の子のみを列挙します。 (継承元 OpenXmlElement)
ElementsAfter()	現在の要素に従い、現在の要素と同じ親を持つすべての兄弟要素を列挙します。 (継承元 OpenXmlElement)
ElementsBefore()	現在の要素の前に、現在の要素と同じ親を持つすべての兄弟要素を列挙します。 (継承元 OpenXmlElement)
GetAttribute(String, String)	指定したタグ名と名前空間 URI を持つ Open XML 属性を取得します。 (継承元 OpenXmlElement)
GetAttributes()	すべての属性のコピーを含むリストを取得します。 (継承元 OpenXmlElement)
GetEnumerator()	子コレクションを反復処理する列挙子を返します。 (継承元 OpenXmlElement)
GetFirstChild<T>()	型 T の最初の子要素を検索します。 (継承元 OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	指定した参照要素の直後に、指定した要素を挿入します。 (継承元 OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	現在の要素の直後に指定した要素を挿入します。 (継承元 OpenXmlElement)
InsertAt<T>(T, Int32)	現在の要素の子の指定したインデックスに、指定した要素を挿入します。 (継承元 OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	指定した参照要素の直前に、指定した要素を挿入します。 (継承元 OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	現在の要素の直前に指定した要素を挿入します。 (継承元 OpenXmlElement)
IsAfter(OpenXmlElement)	ドキュメントの順序で指定した要素の後に現在の要素が表示されるかどうかを指定します。 (継承元 OpenXmlElement)
IsBefore(OpenXmlElement)	現在の要素が文書の順序で指定された要素の前に表示されるかどうかを指定します。 (継承元 OpenXmlElement)
Load(WorkbookPart)	DOM を WorkbookPart から読み込まれます。
LookupNamespace(String)	現在のノードのコンテキストで名前空間プレフィックスを解決します。 (継承元 OpenXmlElement)
LookupPrefix(String)	現在の要素スコープ内の名前空間 uri の対応するプレフィックスを検索します。 (継承元 OpenXmlElement)
NextSibling()	現在の OpenXmlElement 要素の直後にある OpenXmlElement 要素を取得します。次の OpenXmlElement 要素がないVisual Basic null (Nothing in Visual Basic) を返します。 (継承元 OpenXmlElement)
NextSibling<T>()	現在の OpenXmlElement 要素に続く、指定した型を持つ OpenXmlElement 要素を取得します。次の OpenXmlElement がないVisual Basic null (Nothing in Visual Basic) を返します。 (継承元 OpenXmlElement)
PrependChild<T>(T)	現在の要素の子ノードのリストの先頭に指定した要素を挿入します。 (継承元 OpenXmlCompositeElement)
PreviousSibling()	現在の OpenXmlElement 要素の直前にある OpenXmlElement 要素を取得します。前の OpenXmlElement 要素がないVisual Basic null ( Nothing in Visual Basic ) を返します。 (継承元 OpenXmlElement)
PreviousSibling<T>()	現在の OpenXmlElement の前に指定された型を持つ OpenXmlElement 要素を取得します。前の OpenXmlElement 要素がない場合は、null (Visual Basic 内の Nothing) を返します。 (継承元 OpenXmlElement)
Reload()	パーツのコンテンツを Open XML DOM ツリーに再読み込みします。このメソッドは複数回呼び出され、呼び出されるごとにツリーが再読み込みされ、ツリー上の以前の変更は破棄されます。 (継承元 OpenXmlPartRootElement)
Remove()	現在の要素を親から削除します。 (継承元 OpenXmlElement)
RemoveAllChildren()	現在の要素のすべての子要素を削除します。 (継承元 OpenXmlCompositeElement)
RemoveAllChildren<T>()	T 型の現在の要素のすべての子要素を削除します。 (継承元 OpenXmlElement)
RemoveAnnotations(Type)	現在の OpenXmlElement 要素から、指定した型の注釈を削除します。 (継承元 OpenXmlElement)
RemoveAnnotations<T>()	現在の OpenXmlElement 要素から、指定した型の注釈を削除します。 (継承元 OpenXmlElement)
RemoveAttribute(String, String)	現在の要素から属性を削除します。 (継承元 OpenXmlElement)
RemoveChild<T>(T)	指定した子要素を削除します。 (継承元 OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	指定したプレフィックスの名前空間宣言を削除します。プレフィックスがない場合は何も削除しません。 (継承元 OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	現在の要素の子要素の 1 つを別の OpenXmlElement 要素に置き換える。 (継承元 OpenXmlCompositeElement)
Save()	DOM ツリーのデータをパーツに保存します。このメソッドは複数回呼び出され、呼び出されるごとにストリームがフラッシュされます。 (継承元 OpenXmlPartRootElement)
Save(Stream)	DOM ツリーを指定したストリームに保存します。 (継承元 OpenXmlPartRootElement)
Save(WorkbookPart)	DOM を WorkbookPart に保存します。
SetAttribute(OpenXmlAttribute)	属性を指定した要素に設定します。属性が既知の属性の場合、属性の値が設定されます。属性が拡張属性の場合、'openxmlAttribute' が拡張属性リストに追加されます。 (継承元 OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	要素に対して多数の属性を設定します。属性が既知の属性の場合、属性の値が設定されます。属性が拡張属性の場合、'openxmlAttribute' が拡張属性リストに追加されます。 (継承元 OpenXmlElement)
WriteTo(XmlWriter)	現在のノードを指定した XmlWriter に保存します。 (継承元 OpenXmlPartRootElement)

明示的なインターフェイスの実装

IEnumerable.GetEnumerator()

(継承元 OpenXmlElement)

適用対象