Destination Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Merged Document Destination.
This class is available in Office 2007 and above.
When the object is serialized out as xml, it's qualified name is w:destination.
[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
[DocumentFormat.OpenXml.SchemaAttr(23, "destination")]
public class Destination : DocumentFormat.OpenXml.OpenXmlLeafElementpublic class Destination : DocumentFormat.OpenXml.OpenXmlLeafElement[DocumentFormat.OpenXml.SchemaAttr(23, "destination")]
public class Destination : DocumentFormat.OpenXml.OpenXmlLeafElement[DocumentFormat.OpenXml.SchemaAttr("w:destination")]
public class Destination : DocumentFormat.OpenXml.OpenXmlLeafElement[DocumentFormat.OpenXml.SchemaAttr("w:destination")]
public class Destination : DocumentFormat.OpenXml.TypedOpenXmlLeafElement[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
public class Destination : DocumentFormat.OpenXml.OpenXmlLeafElement[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
[<DocumentFormat.OpenXml.SchemaAttr(23, "destination")>]
type Destination = class
inherit OpenXmlLeafElementtype Destination = class
inherit OpenXmlLeafElement[<DocumentFormat.OpenXml.SchemaAttr(23, "destination")>]
type Destination = class
inherit OpenXmlLeafElement[<DocumentFormat.OpenXml.SchemaAttr("w:destination")>]
type Destination = class
inherit OpenXmlLeafElement[<DocumentFormat.OpenXml.SchemaAttr("w:destination")>]
type Destination = class
inherit TypedOpenXmlLeafElement[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
type Destination = class
inherit OpenXmlLeafElementPublic Class Destination
Inherits OpenXmlLeafElementPublic Class Destination
Inherits TypedOpenXmlLeafElement- Inheritance
- Inheritance
- Attributes
Remarks
[ISO/IEC 29500-1 1st Edition]
destination (Merged Document Destination)
This element specifies what the result which shall be generated when a mail merge is carried out on a given WordprocessingML source document. In other words, this element is used to specify what is to be done with the merged documents that result from populating the fields within a given merged WordprocessingML document with data from the specified external data source.
If this element is omitted, then the default destination of merged documents shall be assumed to be of type newDocument.
[Note: The aspects of the mail merge outside of connecting to an external data source and populating the fields within a given merged document with external data from the specified external data source are not specified by /IEC 29500.
For example, if a given merged WordprocessingML document contains a destination element with its val attribute equal to email, the hosting application can surface a user interface specific to creating emails with the data resulting from populating fields within a given merged WordprocessingML document with external data from the specified external data source. WordprocessingML only provides a flag (via the destination element) to tell the hosting application to surface this user interface. end note]
[Example: Consider a WordprocessingML source document containing the following WordprocessingML:
<w:mailMerge>
<w:destination w:val="newDocument" />
…</w:mailMerge>
The destination element's val attribute is set to newDocument, specifying that when the mail merge is carried out, the source document must be used to generate a specified number of new documents, which can be handled as appropriate. end example]
| Parent Elements |
|---|
| mailMerge (§17.14.20) |
[Note: The W3C XML Schema definition of this element’s content model (CT_MailMergeDest) is located in §A.1. end note]
� ISO/IEC29500: 2008.
Constructors
| Destination() |
Initializes a new instance of the Destination class. |
Properties
| 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 OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement) |
| 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 OpenXmlLeafElement) |
| InnerText |
Gets or sets the concatenated values of the node and all of its children. (Inherited from OpenXmlElement) |
| InnerXml |
Gets or sets the markup that only represents child elements of the current element. (Inherited from OpenXmlLeafElement) |
| LastChild |
Gets the last child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement) |
| LocalName | |
| 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) |
| Val |
Mail Merge Merged Document Type Represents the following attribute in the schema: w:val |
| 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) |
| 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 OpenXmlElement) |
| 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 OpenXmlElement) |
| 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 in the current element's list of child elements. (Inherited from OpenXmlElement) |
| InsertBefore<T>(T, OpenXmlElement) |
Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlElement) |
| 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 elements. (Inherited from OpenXmlElement) |
| 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 child elements of the current element. (Inherited from OpenXmlLeafElement) |
| 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 from the current element's list of child elements. (Inherited from OpenXmlElement) |
| 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 a child element with another child element in the current element's list of child elements. (Inherited from OpenXmlElement) |
| 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) |
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for