Callout Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines the Callout Class.
This class is available in Office 2007 and above.
When the object is serialized out as xml, it's qualified name is o:callout.
[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
[DocumentFormat.OpenXml.SchemaAttr(27, "callout")]
public class Callout : DocumentFormat.OpenXml.OpenXmlLeafElementpublic class Callout : DocumentFormat.OpenXml.OpenXmlLeafElement[DocumentFormat.OpenXml.SchemaAttr(27, "callout")]
public class Callout : DocumentFormat.OpenXml.OpenXmlLeafElement[DocumentFormat.OpenXml.SchemaAttr("o:callout")]
public class Callout : DocumentFormat.OpenXml.OpenXmlLeafElement[DocumentFormat.OpenXml.SchemaAttr("o:callout")]
public class Callout : DocumentFormat.OpenXml.TypedOpenXmlLeafElement[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
public class Callout : DocumentFormat.OpenXml.OpenXmlLeafElement[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
[<DocumentFormat.OpenXml.SchemaAttr(27, "callout")>]
type Callout = class
inherit OpenXmlLeafElementtype Callout = class
inherit OpenXmlLeafElement[<DocumentFormat.OpenXml.SchemaAttr(27, "callout")>]
type Callout = class
inherit OpenXmlLeafElement[<DocumentFormat.OpenXml.SchemaAttr("o:callout")>]
type Callout = class
inherit OpenXmlLeafElement[<DocumentFormat.OpenXml.SchemaAttr("o:callout")>]
type Callout = class
inherit TypedOpenXmlLeafElement[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
type Callout = class
inherit OpenXmlLeafElementPublic Class Callout
Inherits OpenXmlLeafElementPublic Class Callout
Inherits TypedOpenXmlLeafElement- Inheritance
- Inheritance
- Attributes
Remarks
[ISO/IEC 29500-1 1st Edition]
callout (Callout)
This element specifies the automatic behavior and layout parameters of callout shapes. Callout shapes are standard VML shapes that behave as callouts, providing an additional callout object which can be used to point at another location:
[Example: Consider the following VML shape:
If this shape is made a callout shape by adding the callout element to its shape definition, then the shape has a callout object, for example:
end example]
| Parent Elements |
|---|
| arc (§14.1.2.1); background (Part 1, §17.2.1); curve (§14.1.2.3); group (§14.1.2.7); hdrShapeDefaults (§9.7.2.1); image (§14.1.2.10); line (§14.1.2.12); object (Part 1, §17.3.3.19); oval (§14.1.2.13); pict (§9.2.2.2); pict (§9.5.1); polyline (§14.1.2.15); rect (§14.1.2.16); roundrect (§14.1.2.17); shape (§14.1.2.19); shapeDefaults (§9.7.2.2); shapedefaults (§14.2.2.28); shapetype (§14.1.2.20) |
| Attributes | Description |
|---|---|
| accentbar (Callout accent bar toggle) | Specifies whether an accent bar is used with the callout. Default is false. The possible values for this attribute are defined by the ST_TrueFalse simple type (§15.1.2.5). |
| angle (Callout angle) | Specifies the angle that the callout makes with respect to the bounding box of the shape. Default is no value. The possible values for this attribute are defined by the ST_Angle simple type (§14.2.3.2). |
| distance (Callout drop distance) | Specifies the drop distance of a callout. The drop distance of a callout is measured from the edge of the shape where the pointer line starts and continues the absolute length of the distance value. If specified with no units, EMUs are assumed. Default is no value. The possible values for this attribute are defined by the W3C XML Schema string datatype. |
| drop (Callout drop position) | Specifies where the drop of a callout is placed. The possible values for this attribute are defined by the ST_CalloutDrop simple type (§14.2.3.4). |
| dropauto (Callout automatic drop toggle) | Specifies whether the callout has an automatic drop. The possible values for this attribute are defined by the ST_TrueFalse simple type (§15.1.2.5). |
| ext (VML Extension Handling Behavior) Namespace: urn:schemas-microsoft-com:vml |
Specifies an optional value that indicates how applications that implement VML should interpret extensions not defined as part of the original specification of core VML. [Rationale: This part of the original VML specification is included to assist applications that leverage existing VML support in implementing the Office Open XML Format. end rationale] The possible values for this attribute are defined by the ST_Ext simple type (§14.1.3.2). |
| gap (Callout gap) | Specifies the distance of the callout line from the bounding rectangle of the callout. Default value is one-twelfth of an inch, in EMUs (76200). The possible values for this attribute are defined by the W3C XML Schema string datatype. |
| length (Callout length) | Specifies the length of the first part of a multi-segmented callout line. If specified with no units, EMUs are assumed. Default is 0. The possible values for this attribute are defined by the W3C XML Schema string datatype. |
| lengthspecified (Callout length toggle) | Specifies whether the length attribute is used for the callout. Default is false. If true, the length attribute is used. If false, a best fit is used. The possible values for this attribute are defined by the ST_TrueFalse simple type (§15.1.2.5). |
| minusx (Callout flip x) | Specifies whether the callout flips to the other side of the drop tip along the x-axis when moved or resized. Default is false. The possible values for this attribute are defined by the ST_TrueFalse simple type (§15.1.2.5). |
| minusy (Callout flip y) | Specifies whether the callout flips to the other side of the drop tip along the y-axis when moved or resized. Default is false. The possible values for this attribute are defined by the ST_TrueFalse simple type (§15.1.2.5). |
| on (Callout toggle) | Specifies whether a shape is a callout. Default is false. The possible values for this attribute are defined by the ST_TrueFalse simple type (§15.1.2.5). |
| textborder (Callout text border toggle) | Specifies whether a callout has a text border. Default is true. The possible values for this attribute are defined by the ST_TrueFalse simple type (§15.1.2.5). |
| type (Callout type) | Specifies the type of callout. Default is rectangle. Allowed values are: - rectangle - roundedrectangle - oval - cloud 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_Callout) is located in §A.6.2. end note]
� ISO/IEC29500: 2008.
Constructors
| Callout() |
Initializes a new instance of the Callout class. |
Properties
| AccentBar |
Callout accent bar toggle Represents the following attribute in the schema: accentbar |
| Angle |
Callout angle Represents the following attribute in the schema: angle |
| ChildElements |
Gets all the child nodes of the current element. (Inherited from OpenXmlElement) |
| Distance |
Callout drop distance Represents the following attribute in the schema: distance |
| Drop |
Callout drop position Represents the following attribute in the schema: drop |
| DropAuto |
Callout automatic drop toggle Represents the following attribute in the schema: dropauto |
| ExtendedAttributes |
Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement) |
| Extension |
VML Extension Handling Behavior Represents the following attribute in the schema: v:ext |
| Features |
Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement) |
| FirstChild |
Gets the first child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement) |
| Gap |
Callout gap Represents the following attribute in the schema: gap |
| HasAttributes |
Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement) |
| HasChildren |
Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlLeafElement) |
| InnerText |
Gets or sets the concatenated values of the node and all of its children. (Inherited from OpenXmlElement) |
| InnerXml |
Gets or sets the markup that only represents child elements of the current element. (Inherited from OpenXmlLeafElement) |
| LastChild |
Gets the last child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement) |
| Length |
Callout length Represents the following attribute in the schema: length |
| LengthSpecified |
Callout length toggle Represents the following attribute in the schema: lengthspecified |
| LocalName | |
| LocalName |
Gets the local name of the current element. (Inherited from OpenXmlElement) |
| MCAttributes |
Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement) |
| MinusX |
Callout flip x Represents the following attribute in the schema: minusx |
| MinusY |
Callout flip y Represents the following attribute in the schema: minusy |
| NamespaceDeclarations |
Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement) |
| NamespaceUri |
Gets the namespace URI of the current element. (Inherited from OpenXmlElement) |
| On |
Callout toggle Represents the following attribute in the schema: on |
| OpenXmlElementContext |
Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement) |
| OuterXml |
Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement) |
| Parent |
Gets the parent element of the current element. (Inherited from OpenXmlElement) |
| Prefix |
Gets the namespace prefix of current element. (Inherited from OpenXmlElement) |
| TextBorder |
Callout text border toggle Represents the following attribute in the schema: textborder |
| Type |
Callout type Represents the following attribute in the schema: type |
| XmlQualifiedName |
Gets the qualified name of the current element. (Inherited from OpenXmlElement) |
| XName |
Gets the qualified name of the current element. (Inherited from OpenXmlElement) |
Methods
| AddAnnotation(Object) |
Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement) |
| AddNamespaceDeclaration(String, String) |
Adds a namespace declaration to the current node. (Inherited from OpenXmlElement) |
| Ancestors() |
Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement) |
| Ancestors<T>() |
Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement) |
| Annotation(Type) |
Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| Annotation<T>() |
Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| Annotations(Type) |
Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| Annotations<T>() |
Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| Append(IEnumerable<OpenXmlElement>) |
Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement) |
| Append(OpenXmlElement[]) |
Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement) |
| AppendChild<T>(T) |
Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlElement) |
| ClearAllAttributes() |
Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement) |
| Clone() |
Creates a duplicate of the current node. (Inherited from OpenXmlElement) |
| CloneNode(Boolean) |
Creates a duplicate of this node. |
| Descendants() |
Enumerates all of the current element's descendants. (Inherited from OpenXmlElement) |
| Descendants<T>() |
Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement) |
| Elements() |
Enumerates all of the current element's children. (Inherited from OpenXmlElement) |
| Elements<T>() |
Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement) |
| ElementsAfter() |
Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement) |
| ElementsBefore() |
Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement) |
| GetAttribute(String, String) |
Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement) |
| GetAttributes() |
Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement) |
| GetEnumerator() |
Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement) |
| GetFirstChild<T>() |
Finds the first child element in type T. (Inherited from OpenXmlElement) |
| InsertAfter<T>(T, OpenXmlElement) |
Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlElement) |
| InsertAfterSelf<T>(T) |
Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement) |
| InsertAt<T>(T, Int32) |
Inserts the specified element at the specified index in the current element's list of child elements. (Inherited from OpenXmlElement) |
| InsertBefore<T>(T, OpenXmlElement) |
Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlElement) |
| InsertBeforeSelf<T>(T) |
Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement) |
| IsAfter(OpenXmlElement) |
Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement) |
| IsBefore(OpenXmlElement) |
Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement) |
| LookupNamespace(String) |
Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement) |
| LookupPrefix(String) |
Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement) |
| NextSibling() |
Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement) |
| NextSibling<T>() |
Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement) |
| PrependChild<T>(T) |
Inserts the specified element at the beginning of the current element's list of child elements. (Inherited from OpenXmlElement) |
| PreviousSibling() |
Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement) |
| PreviousSibling<T>() |
Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement) |
| Remove() |
Removes the current element from its parent. (Inherited from OpenXmlElement) |
| RemoveAllChildren() |
Removes all child elements of the current element. (Inherited from OpenXmlLeafElement) |
| RemoveAllChildren<T>() |
Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement) |
| RemoveAnnotations(Type) |
Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| RemoveAnnotations<T>() |
Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement) |
| RemoveAttribute(String, String) |
Removes the attribute from the current element. (Inherited from OpenXmlElement) |
| RemoveChild<T>(T) |
Removes the specified child element from the current element's list of child elements. (Inherited from OpenXmlElement) |
| RemoveNamespaceDeclaration(String) |
Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement) |
| ReplaceChild<T>(OpenXmlElement, T) |
Replaces a child element with another child element in the current element's list of child elements. (Inherited from OpenXmlElement) |
| SetAttribute(OpenXmlAttribute) |
Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement) |
| SetAttributes(IEnumerable<OpenXmlAttribute>) |
Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement) |
| WriteTo(XmlWriter) |
Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement) |
Explicit Interface Implementations
| IEnumerable.GetEnumerator() | (Inherited from OpenXmlElement) |
| IEnumerable<OpenXmlElement>.GetEnumerator() |
Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement) |
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for