Worksheet クラス

  • リファレンス

定義

名前空間:
DocumentFormat.OpenXml.Spreadsheet
アセンブリ:
DocumentFormat.OpenXml.dll
アセンブリ:
DocumentFormat.OpenXml.dll

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

[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.SheetProperties))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.SheetDimension))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.SheetViews))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.SheetFormatProperties))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.Columns))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.SheetData))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.SheetCalculationProperties))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.SheetProtection))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.ProtectedRanges))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.Scenarios))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.AutoFilter))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.SortState))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.DataConsolidate))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.CustomSheetViews))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.MergeCells))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PhoneticProperties))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.ConditionalFormatting))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.DataValidations))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.Hyperlinks))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PrintOptions))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PageMargins))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PageSetup))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.HeaderFooter))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.RowBreaks))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.ColumnBreaks))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.CustomProperties))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.CellWatches))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.IgnoredErrors))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.Drawing))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.LegacyDrawing))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.LegacyDrawingHeaderFooter))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.DrawingHeaderFooter))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.Picture))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.OleObjects))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.Controls))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.WebPublishItems))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.TableParts))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.WorksheetExtensionList))]
public class Worksheet : DocumentFormat.OpenXml.OpenXmlPartRootElement
type Worksheet = class
    inherit OpenXmlPartRootElement
Public Class Worksheet
Inherits OpenXmlPartRootElement
継承
Object
OpenXmlElement
OpenXmlCompositeElement
OpenXmlPartRootElement
Worksheet
属性
ChildElementInfoAttribute

例

次のコード例では、ファイル名を指定してスプレッドシート ドキュメントに新しいワークシートを挿入します。 コード例を実行した後、テスト ファイル"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 ドキュメント内のワークシート パーツのルート要素です。

親要素
SpreadsheetML のワークシートの一部のルート要素
子要素 句
オート フィルター (オート フィルターの設定) §18.3.1.2
cellWatches (セル ウォッチ アイテム) §18.3.1.9
(垂直方向の改ページ) colBreaks §18.3.1.14
列 (列情報) §18.3.1.17
(条件付き書式設定) を使って §18.3.1.18
コントロール (埋め込み) §18.3.1.21
ユーザー設定プロパティ (カスタム プロパティ) §18.3.1.23
customSheetViews (ユーザー設定のシート ビュー) §18.3.1.27
(データの統合) dataConsolidate §18.3.1.29
dataValidations (データの妥当性評価) §18.3.1.33
ディメンション ([ワークシート分析コード) §18.3.1.35
図面 (図面) §18.3.1.36
drawingHF (ヘッダー フッターの図面参照) §18.3.1.37
extLst (将来機能のデータの記憶領域) §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 (ふりがな) §18.4.3
画像 (背景画像) §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
スマート タグ (スマート タグ) §18.3.1.90
sortState (並べ替え状態) §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(IEnumerable<OpenXmlElement>)

指定した子要素を使用してワークシート クラスの新しいインスタンスを初期化します。
Worksheet(OpenXmlElement[])

指定した子要素を使用してワークシート クラスの新しいインスタンスを初期化します。
Worksheet(String)

外側の XML からワークシートのクラスの新しいインスタンスを初期化します。

プロパティ

ChildElements

現在の要素のすべての子ノードを取得します。

(継承元 OpenXmlElement)
ExtendedAttributes

現在の要素のすべての拡張属性 (スキーマで定義されていない属性) を取得します。

(継承元 OpenXmlElement)
FirstChild

現在の OpenXmlElement 要素の最初の子を取得します。

(継承元 OpenXmlCompositeElement)
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)
OpenXmlElementContext

現在の要素の OpenXmlEementContext を取得します。

(継承元 OpenXmlElement)
OuterXml

現在の要素とそのすべての子要素を表すマークアップを取得します。

(継承元 OpenXmlElement)
Parent

現在の要素の親要素を取得します。

(継承元 OpenXmlElement)
Prefix

現在の要素の名前空間プレフィックスを取得します。

(継承元 OpenXmlElement)
SheetDimension

SheetDimension。 スキーマでは、次の要素タグを表します: x: ディメンション
SheetFormatProperties

SheetFormatProperties。 スキーマでは、次の要素タグを表します: x: sheetFormatPr
SheetProperties

SheetProperties。 スキーマでは、次の要素タグを表します: x: sheetPr
SheetViews

SheetViews。 スキーマでは、次の要素タグを表します: x: sheetViews
WorksheetPart

この要素に関連付けられている WorksheetPart を取得します。
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(WorksheetPart)

DOM を WorksheetPart から読み込まれます。
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(WorksheetPart)

DOM を WorksheetPart に保存します。
SetAttribute(OpenXmlAttribute)

属性を指定した要素に設定します。 属性が既知の属性の場合、属性の値が設定されます。 属性が拡張属性の場合、'openxmlAttribute' が拡張属性リストに追加されます。

(継承元 OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)

要素に対して多数の属性を設定します。 属性が既知の属性の場合、属性の値が設定されます。 属性が拡張属性の場合、'openxmlAttribute' が拡張属性リストに追加されます。

(継承元 OpenXmlElement)
WriteTo(XmlWriter)

現在のノードを指定した XmlWriter に保存します。

(継承元 OpenXmlPartRootElement)

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

IEnumerable.GetEnumerator() (継承元 OpenXmlElement)

適用対象