Sheet クラス

リファレンス

定義

名前空間:: DocumentFormat.OpenXml.Spreadsheet

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

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

重要

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

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

public class Sheet : DocumentFormat.OpenXml.OpenXmlLeafElement

type Sheet = class
    inherit OpenXmlLeafElement

Public Class Sheet
Inherits OpenXmlLeafElement

継承: Object

OpenXmlElement

OpenXmlLeafElement
Sheet

例

次のコード例は、既存のスプレッドシートドキュメントのブックに新しいワークシートを挿入します。

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

namespace SheetEx  
{  
    class Program  
    {  
        // Insert a new worksheet in a spreadsheet document.  
        static void Main(string[] args)  
        {  
            string document = @"C:\users\public\documents\SheetsEx.xlsx";  

            // Open the document for editing.  
            using (SpreadsheetDocument spreadsheetDocument  
                = SpreadsheetDocument.Open(document, true))  
            {  
                // Add a blank WorksheetPart.  
                WorksheetPart newWorksheetPart =   
                    spreadsheetDocument.WorkbookPart.AddNewPart<WorksheetPart>();  
                newWorksheetPart.Worksheet = new Worksheet(new SheetData());  

                Sheets sheets = spreadsheetDocument.WorkbookPart.Workbook  
                    .GetFirstChild<Sheets>();  
                string relationshipId = spreadsheetDocument.WorkbookPart  
                    .GetIdOfPart(newWorksheetPart);  

                // Get 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("A new sheet has been inserted into the workbook.\nPress a key.");  
                Console.ReadKey();  
            }  
        }  
    }  
}

Imports System.Linq  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Spreadsheet  

Module Module1  
    ' Insert a new worksheet in a spreadsheet document.  
    Sub Main(ByVal args As String())  
        Dim document As String = "C:\users\public\documents\SheetsEx.xlsx"  

        ' Open the document for editing.  
        Using spreadsheetDocument As SpreadsheetDocument = _  
            spreadsheetDocument.Open(document, True)  
            ' Add a blank WorksheetPart.  
            Dim newWorksheetPart As WorksheetPart = _  
                spreadsheetDocument.WorkbookPart.AddNewPart(Of WorksheetPart)()  
            newWorksheetPart.Worksheet = New Worksheet(New SheetData())  

            Dim sheets As Sheets = _  
                spreadsheetDocument.WorkbookPart.Workbook.GetFirstChild(Of Sheets)()  
            Dim relationshipId As String = _  
                spreadsheetDocument.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  

            ' Append the new worksheet and associate it with the workbook.  
            Dim sheet As New Sheet() With { _  
             .Id = relationshipId, _  
             .SheetId = sheetId, _  
             .Name = sheetName _  
            }  
            sheets.Append(sheet)  

            Console.WriteLine("A new sheet has been inserted into the workbook." _  
                              & vbLf & "Press a key.")  
            Console.ReadKey()  
        End Using  
    End Sub  
End Module

注釈

[ISO/IEC 29500-1 1st Edition]

シート (シートの情報)

この要素は、このブック内のシートを定義します。シートのデータは、別の部分に格納されます。

親要素
シート (§18.2.20)

属性	説明
id (Id の関係) Namespace: .../officeDocument/2006/relationships	このシートの定義が保存されているシートの一部の識別子を指定します。この属性は、必要があります。この属性の値は、 ST_RelationshipIdの単純型 (§22.8.2.1) によって定義されます。
(シート名)	シートの名前を指定します。この名前は一意であるものとします。この属性は、必要があります。この属性の値は、 ST_Xstringの単純型 (§22.9.2.19) によって定義されます。
sheetId (シートタブの Id)	シートの内部識別子を指定します。この識別子は一意であるものとします。この属性は、必要があります。この属性に指定できる値は、W3C XML スキーマの unsignedInt データ型で定義されます。
状態 (可視状態)	このシートの表示状態を指定します。この属性の既定値は [表示] この属性の値は、 ST_SheetStateの単純型 (§18.18.68) によって定義されます。

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

ISO/IEC29500: 2008。

コンストラクター

Sheet()

シートクラスの新しいインスタンスを初期化します。

プロパティ

ChildElements	現在の要素のすべての子ノードを取得します。 (継承元 OpenXmlElement)
ExtendedAttributes	現在の要素のすべての拡張属性 (スキーマで定義されていない属性) を取得します。 (継承元 OpenXmlElement)
FirstChild	OpenXmlElement 要素の最初の子を取得します。このような OpenXmlElement 要素がないVisual Basic null (Nothing in Visual Basic) を返します。 (継承元 OpenXmlElement)
HasAttributes	現在の要素に属性が含されているかどうかを示すブール値を取得します。 (継承元 OpenXmlElement)
HasChildren	現在の要素に子要素が含されているかどうかを示す値を取得します。 (継承元 OpenXmlLeafElement)
Id	次のスキーマの属性の関係 Id.Represents: r: id
InnerText	ノードとそのすべての子の連結された値を取得します。 (継承元 OpenXmlElement)
InnerXml	現在の要素の子要素のみを表すマークアップを取得または設定します。 (継承元 OpenXmlLeafElement)
LastChild	OpenXmlElement 要素の最後の子を取得します。このような OpenXmlElement 要素がないVisual Basic null (Nothing in Visual Basic) を返します。 (継承元 OpenXmlElement)
LocalName	要素のローカル名を取得します。
MCAttributes	マークアップの互換性属性を設定します。現在の要素に対してマークアップ互換性属性が定義されていない場合は null を返します。 (継承元 OpenXmlElement)
Name	シートの次の属性がスキーマに Name.Represents: 名前
NamespaceDeclarations	現在の要素で定義されている名前空間宣言を取得します。名前空間宣言がない場合は、空の列挙子を返します。 (継承元 OpenXmlElement)
NamespaceUri	現在の要素の名前空間 URI を取得します。 (継承元 OpenXmlElement)
OpenXmlElementContext	現在の要素の OpenXmlEementContext を取得します。 (継承元 OpenXmlElement)
OuterXml	現在の要素とそのすべての子要素を表すマークアップを取得します。 (継承元 OpenXmlElement)
Parent	現在の要素の親要素を取得します。 (継承元 OpenXmlElement)
Prefix	現在の要素の名前空間プレフィックスを取得します。 (継承元 OpenXmlElement)
SheetId	シートの次のスキーマの属性] タブ Id.Represents: この sheetId
State	次のスキーマの属性表示の State.Represents: 状態
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)	指定した要素を、現在の要素の子ノードのリストの末尾に追加します。 (継承元 OpenXmlElement)
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)	指定した参照要素の直後に、指定した要素を挿入します。 (継承元 OpenXmlElement)
InsertAfterSelf<T>(T)	現在の要素の直後に指定した要素を挿入します。 (継承元 OpenXmlElement)
InsertAt<T>(T, Int32)	指定した要素を、現在の要素の子要素のリスト内の指定したインデックスに挿入します。 (継承元 OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)	指定した参照要素の直前に、指定した要素を挿入します。 (継承元 OpenXmlElement)
InsertBeforeSelf<T>(T)	現在の要素の直前に指定した要素を挿入します。 (継承元 OpenXmlElement)
IsAfter(OpenXmlElement)	ドキュメントの順序で指定した要素の後に現在の要素が表示されるかどうかを指定します。 (継承元 OpenXmlElement)
IsBefore(OpenXmlElement)	現在の要素が文書の順序で指定された要素の前に表示されるかどうかを指定します。 (継承元 OpenXmlElement)
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)	現在の要素の子要素のリストの先頭に、指定した要素を挿入します。 (継承元 OpenXmlElement)
PreviousSibling()	現在の OpenXmlElement 要素の直前にある OpenXmlElement 要素を取得します。前の OpenXmlElement 要素がないVisual Basic null ( Nothing in Visual Basic ) を返します。 (継承元 OpenXmlElement)
PreviousSibling<T>()	現在の OpenXmlElement の前に指定された型を持つ OpenXmlElement 要素を取得します。前の OpenXmlElement 要素がない場合は、null (Visual Basic 内の Nothing) を返します。 (継承元 OpenXmlElement)
Remove()	現在の要素を親から削除します。 (継承元 OpenXmlElement)
RemoveAllChildren()	現在の要素のすべての子要素を削除します。 (継承元 OpenXmlLeafElement)
RemoveAllChildren<T>()	T 型の現在の要素のすべての子要素を削除します。 (継承元 OpenXmlElement)
RemoveAnnotations(Type)	現在の OpenXmlElement 要素から、指定した型の注釈を削除します。 (継承元 OpenXmlElement)
RemoveAnnotations<T>()	現在の OpenXmlElement 要素から、指定した型の注釈を削除します。 (継承元 OpenXmlElement)
RemoveAttribute(String, String)	現在の要素から属性を削除します。 (継承元 OpenXmlElement)
RemoveChild<T>(T)	現在の要素の子要素のリストから、指定した子要素を削除します。 (継承元 OpenXmlElement)
RemoveNamespaceDeclaration(String)	指定したプレフィックスの名前空間宣言を削除します。プレフィックスがない場合は何も削除しません。 (継承元 OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	現在の要素の子要素のリスト内の別の子要素に子要素を置き換える。 (継承元 OpenXmlElement)
SetAttribute(OpenXmlAttribute)	属性を指定した要素に設定します。属性が既知の属性の場合、属性の値が設定されます。属性が拡張属性の場合、'openxmlAttribute' が拡張属性リストに追加されます。 (継承元 OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	要素に対して多数の属性を設定します。属性が既知の属性の場合、属性の値が設定されます。属性が拡張属性の場合、'openxmlAttribute' が拡張属性リストに追加されます。 (継承元 OpenXmlElement)
WriteTo(XmlWriter)	現在のノードを指定した XmlWriter に保存します。 (継承元 OpenXmlElement)

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

IEnumerable.GetEnumerator()

(継承元 OpenXmlElement)

適用対象