DocProperties Class
Drawing Object Non-Visual Properties.When the object is serialized out as xml, its qualified name is wp:docPr.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Drawing.Wordprocessing.DocProperties
Namespace: DocumentFormat.OpenXml.Drawing.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<ChildElementInfoAttribute(GetType(HyperlinkOnClick))> _
<ChildElementInfoAttribute(GetType(HyperlinkOnHover))> _
<ChildElementInfoAttribute(GetType(NonVisualDrawingPropertiesExtensionList))> _
Public Class DocProperties _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As DocProperties
[ChildElementInfoAttribute(typeof(HyperlinkOnClick))]
[ChildElementInfoAttribute(typeof(HyperlinkOnHover))]
[ChildElementInfoAttribute(typeof(NonVisualDrawingPropertiesExtensionList))]
public class DocProperties : OpenXmlCompositeElement
Remarks
The following table lists the possible child types:
DocumentFormat.OpenXml.Drawing.HyperlinkOnClick <a:hlinkClick>
DocumentFormat.OpenXml.Drawing.HyperlinkOnHover <a:hlinkHover>
DocumentFormat.OpenXml.Drawing.NonVisualDrawingPropertiesExtensionList <a:extLst>
[ISO/IEC 29500-1 1st Edition]
20.4.2.5 docPr (Drawing Object Non-Visual Properties)
This element specifies non-visual object properties for the parent DrawingML object. These properties are specified as child elements of this element.
[Example: Consider a DrawingML object in a WordprocessingML document defined as follows:
<wp:inline>
…
<wp:docPr id="1" name="Example Object">
<a:hlinkClick … />
<a:hlinkHover … />
</wp:docPr>
</wp:inline>
The docPr element contains a set of common non-visual properties for this object. end example]
Parent Elements |
|---|
anchor (§20.4.2.3); inline (§20.4.2.8) |
Child Elements |
Subclause |
|---|---|
extLst (Extension List) |
§20.1.2.2.15 |
hlinkClick (Click Hyperlink) |
§21.1.2.3.5 |
hlinkHover (Hyperlink for Hover) |
§20.1.2.2.23 |
Attributes |
Description |
|---|---|
descr (Alternative Text for Object) Namespace: .../drawingml/2006/main |
Specifies alternative text for the current DrawingML object, for use by assistive technologies or applications which do not display the current object. If this element is omitted, then no alternative text is present for the parent object. [Example: Consider a DrawingML object defined as follows: The descr attribute contains alternative text which can be used in place of the actual DrawingML object. end example] The possible values for this attribute are defined by the W3C XML Schema string datatype. |
hidden (Hidden) Namespace: .../drawingml/2006/main |
Specifies whether this DrawingML object is displayed. When a DrawingML object is displayed within a document, that object can be hidden (i.e., present, but not visible). This attribute determines whether the object is rendered or made hidden. [Note: An application can have settings which allow this object to be viewed. end note] If this attribute is omitted, then the parent DrawingML object shall be displayed (i.e., not hidden). [Example: Consider an inline DrawingML object which must be hidden within the document's content. This setting would be specified as follows: The hidden attribute has a value of true, which specifies that the DrawingML object is hidden and not displayed when the document is displayed. end example] The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
id (Unique Identifier) Namespace: .../drawingml/2006/main |
Specifies a unique identifier for the current DrawingML object within the current document. This ID can be used to assist in uniquely identifying this object so that it can be referred to by other parts of the document. If multiple objects within the same document share the same id attribute value, then the document shall be considered non-conformant. [Example: Consider a DrawingML object defined as follows: The id attribute has a value of 10, which is the unique identifier for this DrawingML object. end example] The possible values for this attribute are defined by the ST_DrawingElementId simple type (§20.1.10.21). |
name (Name) Namespace: .../drawingml/2006/main |
Specifies the name of the object. [Note: Typically, this is used to store the original file name of a picture object. end note] [Example: Consider a DrawingML object defined as follows: The name attribute has a value of foo.jpg, which is the name of this DrawingML object. end example] The possible values for this attribute are defined by the W3C XML Schema string datatype. |
title (Title) Namespace: .../drawingml/2006/main |
Specifies the title (caption) of the current DrawingML object. If this attribute is omitted, then no title text is present for the parent object. [Example: Consider a DrawingML object defined as follows: end example] The possible values for this attribute are defined by the W3C XML Schema string datatype. |
[Note: The W3C XML Schema definition of this element’s content model (CT_NonVisualDrawingProps) is located in §A.4.1. 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.