Export (0) Print
Expand All

ObjectEmbed class

Defines the ObjectEmbed Class. When the object is serialized out as xml, its qualified name is w:objectEmbed.

Namespace:  DocumentFormat.OpenXml.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

public class ObjectEmbed : OpenXmlLeafElement

[ISO/IEC 29500-1 1st Edition]

objectEmbed (Embedded Object Properties)

This element specifies the visual properties and associated server application of an embedded object.

[Example: The following demonstrates a video file embedded in a WordprocessingML document:

<w:object … >
  <w:drawing> … </w:drawing>
  <w:objectEmbed drawAspect="content" r:id="rId3" progId="AVIFile" shapeId="10"/>
</w:object>

end example]

Parent Elements

object (§17.3.3.19)

Attributes

Description

drawAspect (Object Representation)

Specifies how the object is represented visually in the application.

[Example:

<w:objectEmbed … drawAspect="content"/>

end example]

The possible values for this attribute are defined by the ST_ObjectDrawAspect simple type (§17.18.60).

fieldCodes (Field Switches)

This element specifies the WordprocessingML field switches which shall be stored with an embedded object, using the set of field switches defined by the field, as specified in §17.16. This element shall specify the exact field switches for the field which represents the object.

[Rationale: Legacy word processors used fields to represent embedded objects - this element stores the field switches not explicitly defined for embeddings so as not to use the fidelity of their contents. end rationale]

[Example:

<w:objectEmbed … fieldCodes="\f 0"/>

This embedded object specifies additional field code values of \f 0, which specifies that the embedded object must retain its source formatting (as defined in §17.16).

end example]

The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).

id (Relationship to Embedded Object Data)

Namespace: .../officeDocument/2006/relationships

Specifies the relationship ID for the relationship which targets the Embedded Object Part containing the embedded object data.

The specified relationship shall be of type http://schemas.openxmlformats.org/officeDocument/2006/oleObject or the document shall be considered non-conformant.

[Example: Consider an XML element which has the following id attribute:

<… r:id="rId1" />

The markup specifies the associated relationship part with relationship ID rId1 targets the part containing the corresponding embedded object information. end example]

The possible values for this attribute are defined by the ST_RelationshipId simple type (§22.8.2.1).

progId (Object Application)

Specifies the application associated with the object.

[Example:

<w:objectEmbed … progId="AVIFile"/>

end example]

The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).

shapeId (Object Shape)

Specifies the shape with which the object is associated. A shape provides the visual placeholder for an object and this attribute is set to the ID of the placeholder shape.

[Example:

<w:objectEmbed … shapeId="10"/>

end example]

The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).

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

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

Show:
© 2014 Microsoft