AltChunk クラス

定義

名前空間:

DocumentFormat.OpenXml.Wordprocessing

アセンブリ:

DocumentFormat.OpenXml.dll

パッケージ:

DocumentFormat.OpenXml v3.0.1

AltChunk クラスを定義します。

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

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

public class AltChunk : DocumentFormat.OpenXml.OpenXmlCompositeElement

type AltChunk = class
    inherit OpenXmlCompositeElement

Public Class AltChunk
Inherits OpenXmlCompositeElement

継承

Object

OpenXmlElement

OpenXmlCompositeElement

AltChunk

例

次の例では、 を使用して 2 つのワープロ ドキュメントをマージする方法を altChunk示します。 この例では、ファイルの内容 (source.docx) を別のファイル (Destination.docx) に挿入します。 この例を実行した後、ファイル "Destination.docx" の内容を調べます。 ソース ファイルの内容は、ファイル内の最初のテキストの直後に挿入されていることがわかります。 また、コード例は、ファイル "Destination.docx" を削除することから始まり、新しいファイルを作成することにも注意してください。 これは、コードを複数回実行するときに ID の競合を回避するためです。

using System.Linq;  
using System.IO;  
using DocumentFormat.OpenXml.Packaging;  
using DocumentFormat.OpenXml.Wordprocessing;  
namespace altChunk  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {            
            string fileName1 = @"c:\Users\Public\Documents\Destination.docx";  
            string fileName2 = @"c:\Users\Public\Documents\Source.docx";  
            string testFile = @"c:\Users\Public\Documents\Test.docx";  
            File.Delete(fileName1);  
            File.Copy(testFile, fileName1);  
            using (WordprocessingDocument myDoc =  
                WordprocessingDocument.Open(fileName1, true))  
            {  
                string altChunkId = "AltChunkId1";  
                MainDocumentPart mainPart = myDoc.MainDocumentPart;  
                AlternativeFormatImportPart chunk =   
                    mainPart.AddAlternativeFormatImportPart(  
                    AlternativeFormatImportPartType.WordprocessingML, altChunkId);  
                using (FileStream fileStream = File.Open(fileName2, FileMode.Open))  
                    chunk.FeedData(fileStream);  
                AltChunk altChunk = new AltChunk();  
                altChunk.Id = altChunkId;  
                mainPart.Document  
                    .Body  
                    .InsertAfter(altChunk, mainPart.Document.Body  
                    .Elements<Paragraph>().Last());  
                mainPart.Document.Save();  
            }             
        }  
    }  
}  

Imports System.Linq  
Imports System.IO  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Wordprocessing  

Module Module1  
    Sub Main(ByVal args As String())  
        Dim fileName1 As String = "c:\Users\Public\Documents\Destination.docx"  
        Dim fileName2 As String = "c:\Users\Public\Documents\Source.docx"  
        Dim testFile As String = "c:\Users\Public\Documents\Test.docx"  
        File.Delete(fileName1)  
        File.Copy(testFile, fileName1)  
        Using myDoc As WordprocessingDocument = WordprocessingDocument.Open(fileName1, True)  
            Dim altChunkId As String = "AltChunkId1"  
            Dim mainPart As MainDocumentPart = myDoc.MainDocumentPart  
            Dim chunk As AlternativeFormatImportPart = mainPart.AddAlternativeFormatImportPart(AlternativeFormatImportPartType.WordprocessingML, altChunkId)  
            Using fileStream As FileStream = File.Open(fileName2, FileMode.Open)  
                chunk.FeedData(fileStream)  
            End Using  
            Dim altChunk As New AltChunk()  
            altChunk.Id = altChunkId  
            mainPart.Document.Body.InsertAfter(altChunk, mainPart.Document.Body.Elements(Of Paragraph)().Last())  
            mainPart.Document.Save()  
        End Using  
    End Sub  
End Module  

注釈

[ISO/IEC 29500-1 1st Edition]

altChunk (インポートされた外部コンテンツのアンカー)

この要素は、WordprocessingML ドキュメントにインポートする外部コンテンツを含む指定されたファイルの内容を挿入するための文書内の場所メイン指定します。 指定したファイルの内容は、文書内の指定した場所に表示する必要があります。したがって、その配信元と区別せずに通常の WordprocessingML として出力できます。 インポートする外部コンテンツの場所は、Id 属性がこの要素の id 属性と一致するリレーションシップによって指定されます。

この要素で指定されたリレーションシップの種類が http://schemas.openxmlformats.org/officeDocument/2006/afChunk ではない場合、存在しない場合、または TargetMode 属性の値が Internal ではない場合は、ドキュメントは不適合と見なされます。 対象のパーツで指定されたコンテンツ タイプの外部コンテンツをアプリケーションが処理できない場合は、指定した代替コンテンツを無視する必要がありますが、ファイルの処理を続行する必要があります。 可能であれば、不明なコンテンツがインポートされなかったことを示す情報も提供する必要があります。

[例: 次の HTML ドキュメントからインポートする必要があるコンテンツで構成される WordprocessingML ドキュメントを検討してください。

<html … >  
  <body style="margin-left:200px;margin-top:50px">  
    <p>Paragraph one.</p>  
    <blockquote style="border:5px solid #00FFFF">Paragraph in a blockquote.</blockquote>  
    <p>Paragraph two.</p>  
  </body>  
</html>  

結果として得られる WordprocessingML ホスト ドキュメントは、独自の WordprocessingML コンテンツと、適切な場所にある外部コンテンツ インポート アンカーで構成されます。

<w:body>  
  <w:altChunk r:id="altChunk1" />  
  <w:p/>  
  <w:sectPr>  
    …  </w:sectPr>  
</w:body>  

altChunk 要素は、id が altChunk1 のリレーションシップの対象となる外部コンテンツをドキュメントの先頭にインポートする必要があることを指定します。 対応するリレーションシップ パーツ項目の内容を調べると、そのリレーションシップのターゲットを確認できます。

<Relationships … >  
  …  <Relationship Id="altChunk1" TargetMode="Internal" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/afChunk" Target="import.htm" />  
  …</Relationships>  

対応するリレーションシップ パーツ項目は、インポートするファイルがメインドキュメントの横にあり、import.htmという名前であることを示しています。 例終わり]

親の要素
body (§17.2.2);comment (§17.13.4.2);docPartBody (§17.12.6);endnote (§17.11.2);脚注 (§17.11.10);ftr (§17.10.3);hdr (§17.10.4);tc (§17.4.66)

子要素	Subclause
altChunkPr (外部コンテンツ インポート プロパティ)	§17.17.2.2

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

ISO/IEC29500: 2008。

コンストラクター

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

プロパティ

AltChunkProperties	外部コンテンツ インポート プロパティ。 スキーマ内の次の要素タグを表します:w:altChunkPr。
ChildElements	現在の要素のすべての子ノードを取得します。 (継承元 OpenXmlElement)
ExtendedAttributes	現在の要素のすべての拡張属性 (スキーマで定義されていない属性) を取得します。 (継承元 OpenXmlElement)
Features	現在の要素の を IFeatureCollection 取得します。 この機能コレクションは読み取り専用ですが、使用可能な場合は親パーツとパッケージから機能を継承します。 (継承元 OpenXmlElement)
FirstChild	現在の OpenXmlElement 要素の最初の子を取得します。 (継承元 OpenXmlCompositeElement)
HasAttributes	現在の要素に属性があるかどうかを示す値を取得します。 (継承元 OpenXmlElement)
HasChildren	現在の要素に子要素があるかどうかを示す値を取得します。 (継承元 OpenXmlCompositeElement)
Id	パーツとの関係 スキーマ内の次の属性を表します: r:id
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)
OuterXml	現在の要素とそのすべての子要素を表すマークアップを取得します。 (継承元 OpenXmlElement)
Parent	現在の要素の親要素を取得します。 (継承元 OpenXmlElement)
Prefix	現在の要素の名前空間プレフィックスを取得します。 (継承元 OpenXmlElement)
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)
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)
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)
SetAttribute(OpenXmlAttribute)	指定した要素に属性を設定します。 属性が既知の属性の場合、属性の値が設定されます。 属性が拡張属性の場合は、拡張属性リストに 'openxmlAttribute' が追加されます。 (継承元 OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	要素に複数の属性を設定します。 属性が既知の属性の場合、属性の値が設定されます。 属性が拡張属性の場合は、拡張属性リストに 'openxmlAttribute' が追加されます。 (継承元 OpenXmlElement)
WriteTo(XmlWriter)	現在のノードを指定した XmlWriter に保存します。 (継承元 OpenXmlElement)

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

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