AltChunk Class

Definition

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the AltChunk Class.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is w:altChunk.

public class AltChunk : DocumentFormat.OpenXml.OpenXmlCompositeElement

type AltChunk = class
    inherit OpenXmlCompositeElement

Public Class AltChunk
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

AltChunk

Examples

The following example shows how to merge two word-processing documents using altChunk. The example inserts the content of the file (source.docx) into another file (Destination.docx). After running the example, examine the contents the file “Destination.docx.” You will notice that the contents of the source file are inserted right after the text that was originally in the file. Notice also that the code example starts by deleting the file “Destination.docx” and creates a fresh one. This is to avoid the ID conflict when you run the code more than once.

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  

Remarks

[ISO/IEC 29500-1 1st Edition]

altChunk (Anchor for Imported External Content)

This element specifies a location within a document for the insertion of the contents of a specified file containing external content to be imported into the main WordprocessingML document. The specified file's contents should appear at the specified location within the document, and can henceforth be emitted as regular WordprocessingML without distinction to its origin. The location of the external content to be imported shall be specified by the relationship whose Id attribute matches the id attribute on this element.

If the relationship type of the relationship specified by this element is not http://schemas.openxmlformats.org/officeDocument/2006/afChunk, is not present, or does not have a TargetMode attribute value of Internal, then the document shall be considered non-conformant. If an application cannot process external content of the content type specified by the targeted part, then it should ignore the specified alternate content but continue to process the file. If possible, it should also provide some indication that unknown content was not imported.

[Example: Consider a WordprocessingML document consisting of contents which must be imported from the following HTML document:

<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>  

The resulting WordprocessingML host document would consist of its own WordprocessingML content as well as an external content import anchor in the appropriate location:

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

The altChunk element specifies that the external content targeted by the relationship with an ID of altChunk1 must be imported at the beginning of the document. Examining the contents of the corresponding relationship part item, we can see the targets for that relationship:

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

The corresponding relationship part item shows that the file to be imported is located next to the main document and is named import.htm. end example]

Parent Elements
body (§17.2.2); comment (§17.13.4.2); docPartBody (§17.12.6); endnote (§17.11.2); footnote (§17.11.10); ftr (§17.10.3); hdr (§17.10.4); tc (§17.4.66)

Child Elements	Subclause
altChunkPr (External Content Import Properties)	§17.17.2.2

[Note: The W3C XML Schema definition of this element’s content model (CT_AltChunk) is located in §A.1. end note]

� ISO/IEC29500: 2008.

Constructors

AltChunk()	Initializes a new instance of the AltChunk class.
AltChunk(IEnumerable<OpenXmlElement>)	Initializes a new instance of the AltChunk class with the specified child elements.
AltChunk(OpenXmlElement[])	Initializes a new instance of the AltChunk class with the specified child elements.
AltChunk(String)	Initializes a new instance of the AltChunk class from outer XML.

Properties

AltChunkProperties	External Content Import Properties. Represents the following element tag in the schema: w:altChunkPr.
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
Id	Relationship to Part Represents the following attribute in the schema: r:id
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element. (Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)