Document クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
文書 MainDocumentPart のルート要素です。 オブジェクトを xml としてシリアル化されるときに、修飾名は、w:document です。
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.DocumentBackground))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.Body))]
public class Document : DocumentFormat.OpenXml.OpenXmlPartRootElementtype Document = class
inherit OpenXmlPartRootElementPublic Class Document
Inherits OpenXmlPartRootElement- 継承
- 属性
例
次のコード例では、ワード プロセッサの文書で指定したパス"DocumentEx.docx"をという名前を作成します。
using System;
using DocumentFormat.OpenXml;
using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Wordprocessing;
namespace DocumentEx
{
class Program
{
static void Main(string[] args)
{
string fileName = @"C:\users\public\documents\DocumentEx.docx";
// Create a document.
using (WordprocessingDocument myDocument =
WordprocessingDocument.Create(fileName, WordprocessingDocumentType.Document))
{
// Add a main part.
MainDocumentPart mainPart = myDocument.AddMainDocumentPart();
// Create the document structure.
mainPart.Document = new Document();
Body body = mainPart.Document.AppendChild(new Body());
Paragraph para = body.AppendChild(new Paragraph());
Run run = para.AppendChild(new Run());
// Add some text to the document.
run.AppendChild(new Text("Hello, World!"));
}
Console.WriteLine("The document has been created.\nPress a key.");
Console.ReadKey();
}
}
}
Imports DocumentFormat.OpenXml
Imports DocumentFormat.OpenXml.Packaging
Imports DocumentFormat.OpenXml.Wordprocessing
Module Module1
Sub Main(ByVal args As String())
Dim fileName As String = "C:\users\public\documents\DocumentEx.docx"
' Create a document.
Using myDocument As WordprocessingDocument = WordprocessingDocument.Create(fileName, WordprocessingDocumentType.Document)
' Add a main part.
Dim mainPart As MainDocumentPart = myDocument.AddMainDocumentPart()
' Create the document structure.
mainPart.Document = New Document()
Dim body As Body = mainPart.Document.AppendChild(New Body())
Dim para As Paragraph = body.AppendChild(New Paragraph())
Dim run As Run = para.AppendChild(New Run())
' Add some text to the document.
run.AppendChild(New Text("Hello, World!"))
End Using
Console.WriteLine("The document has been created." & vbLf & "Press a key.")
Console.ReadKey()
End Sub
End Module
注釈
[ISO/IEC 29500-1 1st Edition]
ドキュメント (ドキュメント)
WordprocessingML ドキュメント内のメインのドキュメント パーツのコンテンツを指定します。
[例: 次のように、基本的な WordprocessingML ドキュメント内のメイン文書の一部の基本的な構造を検討してください。
<w:document>
<w:body>
<w:p/>
</w:body>
</w:document>
ドキュメント要素の下には、メイン ドキュメント パーツの内容のすべてが含まれています。 例終わり]
| 親要素 |
|---|
| WordprocessingML のメイン ドキュメント パーツのルート要素 |
| 子要素 | 句 |
|---|---|
| 背景 (バック グラウンドの文書) | §17.2.1 |
| body (本文) | §17.2.2 |
[注: この要素のコンテンツ モデル (CT_Document) の W3C XML スキーマ定義は §A.1 であります。 メモの終了)
ISO/IEC29500: 2008。
コンストラクター
| Document() |
ドキュメント クラスの新しいインスタンスを初期化します。 |
| Document(IEnumerable<OpenXmlElement>) |
指定された子要素を使用してドキュメント クラスの新しいインスタンスを初期化します。 |
| Document(OpenXmlElement[]) |
指定された子要素を使用してドキュメント クラスの新しいインスタンスを初期化します。 |
| Document(String) |
外側の XML からドキュメント クラスの新しいインスタンスを初期化します。 |
プロパティ
| Body |
本文です。 スキーマでは、次の要素タグを表します w:body。 |
| ChildElements |
現在の要素のすべての子ノードを取得します。 (継承元 OpenXmlElement) |
| Conformance |
準拠します。スキーマでは、次の属性を表します w:conformance。 |
| DocumentBackground |
ドキュメントの背景です。 スキーマでは、次の要素タグを表します w:background。 |
| 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 |
要素のローカル名を取得します。 |
| MainDocumentPart |
この要素に関連付けられている MainDocumentPart を取得します。 |
| MCAttributes |
マークアップの互換性属性を設定します。 現在の要素に対してマークアップ互換性属性が定義されていない場合は null を返します。 (継承元 OpenXmlElement) |
| NamespaceDeclarations |
現在の要素で定義されている名前空間宣言を取得します。 名前空間宣言がない場合は、空の列挙子を返します。 (継承元 OpenXmlElement) |
| NamespaceUri |
現在の要素の名前空間 URI を取得します。 (継承元 OpenXmlElement) |
| OpenXmlElementContext |
現在の要素の OpenXmlEementContext を取得します。 (継承元 OpenXmlElement) |
| OuterXml |
現在の要素とそのすべての子要素を表すマークアップを取得します。 (継承元 OpenXmlElement) |
| Parent |
現在の要素の親要素を取得します。 (継承元 OpenXmlElement) |
| Prefix |
現在の要素の名前空間プレフィックスを取得します。 (継承元 OpenXmlElement) |
| 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(MainDocumentPart) |
DOM を MainDocumentPart から読み込まれます。 |
| 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(MainDocumentPart) |
DOM を MainDocumentPart に保存します。 |
| Save(Stream) |
DOM ツリーを指定したストリームに保存します。 (継承元 OpenXmlPartRootElement) |
| SetAttribute(OpenXmlAttribute) |
属性を指定した要素に設定します。 属性が既知の属性の場合、属性の値が設定されます。 属性が拡張属性の場合、'openxmlAttribute' が拡張属性リストに追加されます。 (継承元 OpenXmlElement) |
| SetAttributes(IEnumerable<OpenXmlAttribute>) |
要素に対して多数の属性を設定します。 属性が既知の属性の場合、属性の値が設定されます。 属性が拡張属性の場合、'openxmlAttribute' が拡張属性リストに追加されます。 (継承元 OpenXmlElement) |
| WriteTo(XmlWriter) |
現在のノードを指定した XmlWriter に保存します。 (継承元 OpenXmlPartRootElement) |
明示的なインターフェイスの実装
| IEnumerable.GetEnumerator() | (継承元 OpenXmlElement) |