[Table of Contents] [docx version]

WordprocessingML Reference Material - Table of Contents

control (Inline Embedded Control)

This element specifies that the parent embedded object is a representation of an embedded control at the current location in the document. This element shall be used to associate the appropriate embedded control settings and properties when the document is displayed.

If the embedded control is not present, cannot be loaded due to application settings, or is not supported, then a suitable placeholder image shall be used to provide a representation of the presence of an embedded control at the appropriate location in the document.

[Example: Consider a run which consists of an embedded control. That run would be specified using the following WordprocessingML:

<w:r>
<w:object>

<w:control r:id=”rId99” w:shapeid=”shape01” … />
</w:object>
</w:r>

The control element indicates that the parent embedded object is an embedded control, whose settings and properties are stored on this element and the (optional) target of the relationship specified using the id attribute. end example]

Parent Elements

object2.3.3.19)

 

Attributes

Description

id (Embedded Control Properties Relationship Reference)

 

Namespace: .../officeDocument/2006/relationships

Specifies the relationship ID for the relationship which contains the properties for this embedded control. This property bag is contained in a separate part within the Word Open XML package.

 

The relationship explicitly targeted by this attribute shall be of type http://schemas.openxmlformats.org/officeDocument/2006/relationships/control or the document shall be conisdered non-conformant.

 

If this attribute is omitted, then the embedded control shall be given no property bag when instantiated.

 

[Example: Consider the following WordprocessingML markup for an embedded control in a document:

 

<w:control r:id="rId5" w:id="CheckBox1" w:name="CheckBox1" w:shapeid="_x0000_s1027" w:class="shape" w:w="145" w:h="28" w:align="left" />

 

The id attribute in the relationship reference namespace specifies that the relationship with relationship ID rId5 shall contain the property data for this embedded control. end example]

 

The possible values for this attribute are defined by the ST_RelationshipId simple type7.8.2.1).

name (Unique Name for Embedded Control)

Specifies a unique name for this embedded control. This name shall be unique across all controls in this document.

 

[Example: Consider the following WordprocessingML markup for an embedded control in a document:

 

<w:control r:id="rId5" w:id="CheckBox1" w:name="CheckBox1" w:shapeid="_x0000_s1027" w:class="shape" w:w="145" w:h="28" w:align="left" />

 

The name attribute specifies that the unique name for this control shall be CheckBox1. end example]

 

The possible values for this attribute are defined by the ST_String simple type2.18.89).

shapeid (Associated VML Data Reference)

Specifies the shape ID for a shape which shall be used to define the presentation and location of this embedded control within the document if the control is floating using the VML syntax.

 

[Note: This positioning data is sufficient to display the control in any case where:

The embedded control is not on the current machine

Embedded controls are disabled

Embedded controls of this type are not supported

end note]

 

This shape ID reference is resolved by looking for a VML shape element (§6.1.2.19) whose id attribute matches the value specified within this attribute. If no such shape exists, then the control shall be rendered inline in the document content at the current run content location.

 

If this attribute is omitted, then this embedded control shall be displayed inline in the current location in the parent run.

 

[Example: Consider the following WordprocessingML markup for an embedded control in a document:

 

<w:control r:id="rId5" w:id="CheckBox1" w:name="CheckBox1" w:shapeid="_x0000_s1027" w:class="shape" w:w="145" w:h="28" w:align="left" />

 

The shapeid attribute specifies that the VML shape element with a shape id attribute value of _x0000_s1027 shall contain the VML positioning data for this embedded control. end example]

 

The possible values for this attribute are defined by the ST_String simple type2.18.89).

The following XML Schema fragment defines the contents of this element:

<complexType name="CT_Control">

   <attribute name="name" type="ST_String" use="optional"/>

   <attribute name="shapeid" type="ST_String" use="optional"/>

   <attribute ref="r:id" use="optional"/>

</complexType>