OleLink Class

OLE Link.When the object is serialized out as xml, its qualified name is x:oleLink.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Spreadsheet.OleLink

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(OleItems))> _
Public Class OleLink _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As OleLink
[ChildElementInfoAttribute(typeof(OleItems))]
public class OleLink : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • OleItems <x:oleItems>

[ISO/IEC 29500-1 1st Edition]

18.14.11 oleLink (Generic Object Link Connection)

This element represents an external link to an embedded object, specified by a progID/object pair. The type of object link is determined by reading the target of the id attribute.

[Example: The following markup defines a reference to a linked object using Bonobo. The progId attribute contains the shared library that contains the widget. The r:id identifies the referenced Bonobo object.

<oleLink r:id="rb1" progId="OAFIID:Bonobo_Sample_Calculator">
  … 
</oleLink>

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 following article, which also provides an introduction to Bonobo – http://www.ibm.com/developerworks/webservices/library/co-bnbo2.html. end example]

[Example: The following markup defines a reference to a linked object using KParts. The progId attribute contains the shared library that contains the plugin. The r:id identifies the referenced KParts object.

<oleLink r:id="rKp1" progId="libhtmlvalidatorplugin">
  …
</oleLink>

The following XML, contained in the target of the relationship with ID rKp1, defines the KPart object, and will follow the kpartgui DTD:

<!DOCTYPE kpartgui SYSTEM "kpartgui.dtd">
<kpartgui library="libhtmlvalidatorplugin" name="htmlvalidatorplugin" version="1" >
  <MenuBar>
    <Menu name="tools"><Text>&amp;Tools</Text>
      <Action name="validatewebpage"/>
    </Menu>
  </MenuBar>
</kpartgui>

This example is taken from the kde.org web site, and contains a tutorial on building the plugin referenced by the above markup – http://developer.kde.org/documentation/tutorials/dot/writing-plugins.html. end example]

Parent Elements

externalLink (§18.14.8)

Child Elements

Subclause

oleItems (Object Link Items)

§18.14.10

Attributes

Description

id (Object Link Relationship)

Namespace: .../officeDocument/2006/relationships

Relationship ID that references a link in the relationships collection. The target attribute in the associated relationship will specify the external file name used for this oleLink.

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

progId (Object Link Identifier)

The ID for the object link connection. [Example: For a KParts link, this would store the name of the appropriate KParts library. For an OLE link, this would store the ProgID of the appropriate OLE object. end example]

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

[Note: The W3C XML Schema definition of this element’s content model (CT_OleLink) is located in §A.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.

See Also

Reference

OleLink Members

DocumentFormat.OpenXml.Spreadsheet Namespace