OleObject Class
Embedded OLE Object.When the object is serialized out as xml, its qualified name is o:OLEObject.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Vml.Office.OleObject
Namespace: DocumentFormat.OpenXml.Vml.Office
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<ChildElementInfoAttribute(GetType(LinkType))> _
<ChildElementInfoAttribute(GetType(LockedField))> _
<ChildElementInfoAttribute(GetType(FieldCodes))> _
Public Class OleObject _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As OleObject
[ChildElementInfoAttribute(typeof(LinkType))]
[ChildElementInfoAttribute(typeof(LockedField))]
[ChildElementInfoAttribute(typeof(FieldCodes))]
public class OleObject : OpenXmlCompositeElement
Remarks
The following table lists the possible child types:
LinkType <o:LinkType>
LockedField <o:LockedField>
FieldCodes <o:FieldCodes>
[ISO/IEC 29500-1 1st Edition]
14.2.2.20 OLEObject (Embedded OLE Object)
This element specifies an embedded object.
[Example: The following markup defines a reference to an embedded object using Bonobo. The ProgId attribute contains the shared library that contains the widget. The content type of the referred part identifies the referenced Bonobo object.
<OLEObject r:id="rb1" ProgId="OAFIID:Bonobo_Sample_Calculator">
…
</OLEObject>
The target of the relationship with ID rb1, defines the Bonobo object itself. This example shows a link to a sample Bonobo widget taken from the article http://www.ibm.com/developerworks/webservices/library/co-bnbo2.html, which also provides an introduction to Bonobo. end example]
[Example: The following demonstrates a video file embedded in a WordprocessingML document:
<w:object … >
<v:shape id="_x0000_i1025" type="#_x0000_t75"
style="width:1in;height:24pt" o:ole="">
<v:imagedata r:id="rId4" o:title=""/>
</v:shape>
<o:OLEObject Type="Embed" ProgID="AVIFile" ShapeID="_x0000_i1025"
DrawAspect="Content" ObjectID="_1219561732" r:id="rId5"/>
</w:object>
end example]
Parent Elements |
|---|
background (Part 1, §17.2.1); hdrShapeDefaults (§9.7.2.1); object (Part 1, §17.3.3.19); pict (§9.2.2.2); pict (§9.5.1); shapeDefaults (§9.7.2.2) |
Child Elements |
Subclause |
|---|---|
FieldCodes (WordprocessingML Field Switches) |
§14.2.2.12 |
LinkType (Embedded Object Alternate Image Request) |
§14.2.2.17 |
LockedField (Embedded Object Cannot Be Refreshed) |
§14.2.2.19 |
Attributes |
Description |
|---|---|
DrawAspect (Embedded Object Representation) |
Specifies how the embedded object is represented visually in the application. [Example: end example] The possible values for this attribute are defined by the ST_OLEDrawAspect simple type (§14.2.3.18). |
id (Relationship) Namespace: .../officeDocument/2006/relationships |
Specifies the actual OLE object using a standard part relationship lookup. [Example: end example] The possible values for this attribute are defined by the ST_RelationshipId simple type (Part 1, §22.8.2.1). |
ObjectID (Unique ID for Embedded Object) |
Specifies a unique ID identifying the embedded object. [Example: The following markup defines a reference to a linked object using KParts. The name attribute contains the shared library that contains the plugin. The item element contains the name of the plugin. The content type of the referred part would identifies the referenced KParts object. The following XML, contained in the target of the relationship with ID rKp1, defines the KPart object, and follows the kpartgui DTD: This example is taken from the kde.org web site (http://developer.kde.org/documentation/tutorials/dot/writing-plugins.html), and contains a tutorial on building the plugin referenced by the above markup. end example] … The possible values for this attribute are defined by the W3C XML Schema string datatype. |
ProgID (Object Link Identifier) |
Specifies the embedded object server application associated with the embedded object. [Example: end example] The possible values for this attribute are defined by the W3C XML Schema string datatype. |
ShapeID (Embedded Object Shape) |
Specifies the shape with which the embedded object is associated. A VML shape provides the visual placeholder for an embedded object and this attribute is set to the id of the placeholder shape. [Example: end example] The possible values for this attribute are defined by the W3C XML Schema string datatype. |
Type (Embedded Object Type) |
Specifies the kind of embedded object connection. [Example: end example] The possible values for this attribute are defined by the ST_OLEType simple type (§14.2.3.20). |
UpdateMode (Update Mode for Embedded Object) |
Specifies how the object is updated with new data if the Type is Link - automatically or on-demand by the user. [Example: end example] The possible values for this attribute are defined by the ST_OLEUpdateMode simple type (§14.2.3.21). |
[Note: The W3C XML Schema definition of this element’s content model (CT_OLEObject) is located in §A.6.2. end note]
© ISO/IEC29500: 2008.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.