EntityPickerEmpty 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.
Defines the EntityPickerEmpty Class.
This class is available in Office 2010 and above.
When the object is serialized out as xml, it's qualified name is w14:entityPicker.
public class EntityPickerEmpty : DocumentFormat.OpenXml.Office2010.Word.EmptyType[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2010)]
[DocumentFormat.OpenXml.SchemaAttr(52, "entityPicker")]
public class EntityPickerEmpty : DocumentFormat.OpenXml.Office2010.Word.EmptyType[DocumentFormat.OpenXml.SchemaAttr(52, "entityPicker")]
public class EntityPickerEmpty : DocumentFormat.OpenXml.Office2010.Word.EmptyType[DocumentFormat.OpenXml.SchemaAttr("w14:entityPicker")]
public class EntityPickerEmpty : DocumentFormat.OpenXml.Office2010.Word.EmptyType[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2010)]
public class EntityPickerEmpty : DocumentFormat.OpenXml.Office2010.Word.EmptyTypetype EntityPickerEmpty = class
inherit EmptyType[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2010)>]
[<DocumentFormat.OpenXml.SchemaAttr(52, "entityPicker")>]
type EntityPickerEmpty = class
inherit EmptyType[<DocumentFormat.OpenXml.SchemaAttr(52, "entityPicker")>]
type EntityPickerEmpty = class
inherit EmptyType[<DocumentFormat.OpenXml.SchemaAttr("w14:entityPicker")>]
type EntityPickerEmpty = class
inherit EmptyType[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2010)>]
type EntityPickerEmpty = class
inherit EmptyTypePublic Class EntityPickerEmpty
Inherits EmptyType- Inheritance
- Inheritance
- Attributes
Remarks
2.3.25 entityPicker
Target namespace: http://schemas.microsoft.com/office/word/2010/wordml
A CT_EMPTY element (as specified in [ISO/IEC-29500-1] section A.1) that specifies that the parent structured document tag (as specified in [ISO/IEC-29500-1] section 17.5.2) allows the user to select an instance of an external content type when displayed in the document. See section 2.2.3 for how the entityPicker element integrates with ISO/IEC-29500-1.
The parent structured document tag MUST contain content that is valid within a text element (as specified in [ISO/IEC-29500-1] section 17.5.2.44), and MUST contain a dataBinding element (as specified in [ISO/IEC-29500-1] section 17.5.2.6).
The WordprocessingML document MUST contain a custom XML data part whose root namespace is "http://schemas.microsoft.com/office/2006/metadata/properties", and whose identifier (as specified by [ISO/IEC-29500-1] section 22.5.2.1) matches the value specified by the storeItemID attribute on the dataBinding element of the structured document tag containing the entityPicker element. The xpath attribute on the dataBinding element MUST specify the path to an element within that custom XML data part.
The document MUST also contain a custom XML data part whose root namespace is "http://schemas.microsoft.com/office/2006/metadata/contentType". This custom XML data part contains a schema element (in the "http://www.w3.org/2001/XMLSchema" namespace) that specifies an XML Schema for the element specified by the xpath attribute of the dataBinding element of the entityPicker. The rest of this section refers to this schema as the element schema.
The element schema specifies four attributes, each with a fixed value:
SystemInstance: Specifies the LobSystemInstance name.
EntityNamespace: Specifies the Entity namespace.
EntityName: Specifies the Entity name.
BdcField: Specifies the name of the Field within the EntityInstance.
Together with the location of the document, these values specify the external content type that the user is selecting one or more instances of.
The result of the user choosing an instance of an external content type is an EntityInstanceId, and values of one or more Fields within the EntityInstance.
The element schema further specifies three more attributes, each with a fixed value, which collectively specify where to place the EntityInstanceId, and the Field values resulting from the user’s selection:
RelatedFieldWssStaticName: Specifies a sibling of the XML element specified by the xpath attribute of the dataBinding element mentioned earlier. The text of this element MUST be set to the EntityInstance Identifier obtained from user choosing an instance of the external content type.
SecondaryFieldBdcNames: Specifies a list of names of Fields within the EntityInstance (the fields whose values resulted from user’s choice). The list MUST contain the same number of names as the SecondaryFieldsWssStaticNames attribute.
SecondaryFieldsWssStaticNames: Specifies a corresponding list of names of XML elements that are siblings of the XML element specified by the xpath attribute of the dataBinding element mentioned earlier. The list MUST contain the same number of names as the SecondaryFieldBdcNames attribute.
The value (resulting from the user’s choice) of each one of the Fields within the EntityInstance specified by SecondaryFieldBdcNames MUST be set as the text of the XML element whose name appears at the same index in SecondaryFieldsWssStaticNames.
The list of names specified by SecondaryFieldBdcNames and SecondaryFieldsWssStaticNames MUST be encoded as follows:
1.Start with an empty string.
2.For each name, append the length of the name, plus one, as a base-10 integer, each value followed by a single space character.
3.The names are then appended to the string, in the same order in which their lengths were added in step 2, followed by a single space character.
4.The zero-based character position of where the first name begins in the string is then appended to the string.
5.Finally, the resulting string is escaped as specified by [RFC3986].
The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.
<xsd:element name="entityPicker" type="w:CT_Empty"/>
See section 5.1 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).
Constructors
| EntityPickerEmpty() |
Initializes a new instance of the EntityPickerEmpty 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) |
| 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