Worksheet クラス

定義

名前空間:

DocumentFormat.OpenXml.Spreadsheet

アセンブリ:

DocumentFormat.OpenXml.dll

パッケージ:

DocumentFormat.OpenXml v3.0.1

ワークシート。

このクラスは、Office 2007 以降で使用できます。

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

public class Worksheet : DocumentFormat.OpenXml.OpenXmlPartRootElement

type Worksheet = class
    inherit OpenXmlPartRootElement

Public Class Worksheet
Inherits OpenXmlPartRootElement

継承

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

Worksheet

例

次のコード例では、ファイル名を指定して、スプレッドシート ドキュメントに新しいワークシートを挿入します。 コード例を実行した後、テスト ファイル "WorksheetEx.xlsx" を調べ、"mySheet" という名前の新しいワークシートに注目してください。

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

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

            using (SpreadsheetDocument spreadSheet = SpreadsheetDocument.Open(fileName, true))  
            {  
                // Add a WorksheetPart.  
                WorksheetPart newWorksheetPart = spreadSheet.WorkbookPart.AddNewPart<WorksheetPart>();  
                newWorksheetPart.Worksheet = new Worksheet(new SheetData());  

                // Create Sheets object.  
                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.");  
            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\WorksheetEx.xlsx"  
        Dim spreadSheet As SpreadsheetDocument = SpreadsheetDocument.Open(fileName, True)  

        Using (spreadSheet)  
            ' Add a 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.")  
        Console.ReadKey()  
    End Sub  
End Module  

注釈

[ISO/IEC 29500-1 1st Edition]

ワークシート (ワークシート)

これは、SpreadsheetML ドキュメント内の Worksheet パーツのルート要素です。

親の要素
SpreadsheetML Worksheet パーツのルート要素

子要素	Subclause
autoFilter (オートフィルター設定)	§18.3.1.2
cellWatches (セル ウォッチ 項目)	§18.3.1.9
colBreaks (垂直改ページ)	§18.3.1.14
cols (列情報)	§18.3.1.17
conditionalFormatting (条件付き書式)	§18.3.1.18
コントロール (埋め込みコントロール)	§18.3.1.21
customProperties (カスタム プロパティ)	§18.3.1.23
customSheetViews (カスタム シート ビュー)	§18.3.1.27
dataConsolidate (データ統合)	§18.3.1.29
dataValidations (データ検証)	§18.3.1.33
dimension (Worksheet Dimensions)	§18.3.1.35
drawing (Drawing)	§18.3.1.36
drawingHF (ヘッダー フッターの図面参照)	§18.3.1.37
extLst (Future Feature Data Storage Area)	§18.2.10
headerFooter (ヘッダー フッター設定)	§18.3.1.46
ハイパーリンク (ハイパーリンク)	§18.3.1.48
ignoredErrors (無視されたエラー)	§18.3.1.51
mergeCells (セルのマージ)	§18.3.1.55
oleObjects (埋め込みオブジェクト)	§18.3.1.60
pageMargins (ページ余白)	§18.3.1.62
pageSetup (ページ設定設定)	§18.3.1.63
phoneticPr (Phonetic プロパティ)	§18.4.3
picture (背景画像)	§18.3.1.67
printOptions (印刷オプション)	§18.3.1.70
protectedRanges (保護された範囲)	§18.3.1.72
rowBreaks (水平改ページ (行))	§18.3.1.74
シナリオ (シナリオ)	§18.3.1.76
sheetCalcPr (シート計算プロパティ)	§18.3.1.79
sheetData (シート データ)	§18.3.1.80
sheetFormatPr (シート書式プロパティ)	§18.3.1.81
sheetPr (シートプロパティ)	§18.3.1.82
sheetProtection (シート保護オプション)	§18.3.1.85
sheetViews (シート ビュー)	§18.3.1.88
smartTags (スマート タグ)	§18.3.1.90
sortState (Sort State)	§18.3.1.92
tableParts (テーブル パーツ)	§18.3.1.95
webPublishItems (Web 発行アイテム)	§18.3.1.98

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

ISO/IEC29500: 2008。

コンストラクター

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

プロパティ

ChildElements	現在の要素のすべての子ノードを取得します。 (継承元 OpenXmlElement)
ExtendedAttributes	現在の要素のすべての拡張属性 (スキーマで定義されていない属性) を取得します。 (継承元 OpenXmlElement)
Features	現在の要素の を IFeatureCollection 取得します。 この機能コレクションは読み取り専用ですが、使用可能な場合は親パーツとパッケージから機能を継承します。 (継承元 OpenXmlElement)
FirstChild	現在の OpenXmlElement 要素の最初の子を取得します。 (継承元 OpenXmlCompositeElement)
HasAttributes	現在の要素に属性があるかどうかを示す値を取得します。 (継承元 OpenXmlElement)
HasChildren	現在の要素に子要素があるかどうかを示す値を取得します。 (継承元 OpenXmlCompositeElement)
InnerText	現在のノードとそのすべての子の連結値を取得または設定します。 (継承元 OpenXmlCompositeElement)
InnerXml	現在のノードの子ノードのみを表すマークアップを取得または設定します。 (継承元 OpenXmlCompositeElement)
LastChild	現在の OpenXmlElement 要素の最後の子を取得します。 このような OpenXmlElement 要素がない場合は、null (Visual Basic では Nothing) を返します。 (継承元 OpenXmlCompositeElement)
LocalName	現在の要素のローカル名を取得します。 (継承元 OpenXmlElement)
MCAttributes	マークアップ互換性属性を取得または設定します。 現在の要素に対してマークアップ互換性属性が定義されていない場合は null を返します。 (継承元 OpenXmlElement)
NamespaceDeclarations	現在の要素で定義されているすべての名前空間宣言を取得します。 名前空間宣言がない場合は、空の列挙子を返します。 (継承元 OpenXmlElement)
NamespaceUri	現在の要素の名前空間 URI を取得します。 (継承元 OpenXmlElement)
OpenXmlElementContext	現在の要素の OpenXmlElementContext を取得します。 (継承元 OpenXmlElement)
OpenXmlPart	DOM ツリーに関連付けられているパーツを取得します。 DOM ツリーがパーツに関連付けられていない場合、null が返されます。 (継承元 OpenXmlPartRootElement)
OuterXml	現在の要素とそのすべての子要素を表すマークアップを取得します。 (継承元 OpenXmlElement)
Parent	現在の要素の親要素を取得します。 (継承元 OpenXmlElement)
Prefix	現在の要素の名前空間プレフィックスを取得します。 (継承元 OpenXmlElement)
SheetDimension	SheetDimension。 スキーマの x:dimension 要素タグを表します。
SheetFormatProperties	SheetFormatProperties。 スキーマ内の次の要素タグを表します: x:sheetFormatPr。
SheetProperties	SheetProperties。 スキーマ内の次の要素タグを表します: x:sheetPr。
SheetViews	SheetViews。 スキーマの x:sheetViews の要素タグを表します。
WorksheetPart	この要素に関連付けられている WorksheetPart を取得します。
XmlQualifiedName	現在の要素の修飾名を取得します。 (継承元 OpenXmlElement)
XName	現在の要素の修飾名を取得します。 (継承元 OpenXmlElement)

メソッド

AddAnnotation(Object)	現在の OpenXmlElement 要素の注釈の一覧にオブジェクトを追加します。 (継承元 OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	指定した要素が既知の子である場合は、 要素に追加します。 これにより、 要素がスキーマに従って正しい場所に追加されます。 (継承元 OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	現在のノードに名前空間宣言を追加します。 (継承元 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(WorksheetPart)	WorksheetPart から DOM を読み込む
LookupNamespace(String)	現在のノードのコンテキストの名前空間プレフィックスを解決します。 (継承元 OpenXmlElement)
LookupPrefix(String)	現在の要素スコープ内の名前空間 URI の対応するプレフィックスを検索します。 (継承元 OpenXmlElement)
NextSibling()	現在の OpenXmlElement 要素の直後にある OpenXmlElement 要素を取得します。 次の OpenXmlElement 要素がない場合は null (Visual Basic では Nothing) を返します。 (継承元 OpenXmlElement)
NextSibling<T>()	現在の OpenXmlElement 要素に続く指定した型を持つ OpenXmlElement 要素を取得します。 次の OpenXmlElement がない場合は、null (Visual Basic では Nothing) を返します。 (継承元 OpenXmlElement)
PrependChild<T>(T)	現在の要素の子ノードのリストの先頭に、指定した要素を挿入します。 (継承元 OpenXmlCompositeElement)
PreviousSibling()	現在の OpenXmlElement 要素のすぐ前にある OpenXmlElement 要素を取得します。 前に OpenXmlElement 要素がない場合は、null (Visual Basic では Nothing) を返します。 (継承元 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(WorksheetPart)	DOM を WorksheetPart に保存します。
SetAttribute(OpenXmlAttribute)	指定した要素に属性を設定します。 属性が既知の属性の場合、属性の値が設定されます。 属性が拡張属性の場合は、拡張属性リストに 'openxmlAttribute' が追加されます。 (継承元 OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	要素に複数の属性を設定します。 属性が既知の属性の場合、属性の値が設定されます。 属性が拡張属性の場合は、拡張属性リストに 'openxmlAttribute' が追加されます。 (継承元 OpenXmlElement)
WriteTo(XmlWriter)	現在のノードを指定した XmlWriter に保存します。 (継承元 OpenXmlPartRootElement)

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

IEnumerable.GetEnumerator()	ワークシート。 このクラスは、Office 2007 以降で使用できます。 オブジェクトを xml としてシリアル化されるときに、修飾名は x:worksheet です。 (継承元 OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	子コレクションを反復処理する列挙子を返します。 (継承元 OpenXmlElement)