DataBar Class

Definition

Namespace:

DocumentFormat.OpenXml.Office2010.Excel

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the DataBar Class.

This class is available in Office 2010 and above.

When the object is serialized out as xml, it's qualified name is x14:dataBar.

public class DataBar : DocumentFormat.OpenXml.OpenXmlCompositeElement

type DataBar = class
    inherit OpenXmlCompositeElement

Public Class DataBar
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

DataBar

Remarks

2.6.30 CT_DataBar

Target namespace: http://schemas.microsoft.com/office/spreadsheetml/2009/9/main

Referenced by: CT_CfRule

A complex type that specifies a data bar used in conditional formatting.

Child Elements:

cfvo: A CT_Cfvo element (section 2.6.26) that specifies the cell values corresponding to the min/max length of the data bar. If there exist CT_Cfvo ([ISO/IEC-29500-4] section A.2) elements in this sheet (1) that are child elements of a CT_DataBar ([ISO/IEC-29500-4] section A.2) element that is a child of a CT_CfRule ([ISO/IEC-29500-4] section A.2) element that is a parent of a CT_ExtensionList ([ISO/IEC-29500-4] section A.2) element with a child CT_Extension ([ISO/IEC-29500-4] section A.2) element that has a child ST_Guid ([ISO/IEC-29500-4] section A.2) element equal to the id attribute of this complex type’s parent CT_CfRule element (section 2.6.27), those CT_Cfvo elements SHOULD<49> be ignored. The first child CT_Cfvo element specifies the condition corresponding to the min length of the data bar. The second child CT_Cfvo element specifies the condition corresponding to the max length of the data bar.

fillColor: A CT_Color ([ISO/IEC-29500-4] section A.2) element that specifies the fill color of the data bar. This element MUST exist if and only if the priority attribute of the CT_CfRule that is a parent of this complex type exists.

borderColor: A CT_Color element that specifies the border color of the data bar. This element MUST exist if and only if border equals "true".

negativeFillColor: A CT_Color element that specifies the negative fill color of the data bar. This element MUST exist if and only if negativeBarColorSameAsPositive equals "false".

negativeBorderColor: A CT_Color element that specifies the negative border color of the data bar. This element MUST exist if and only if negativeBarBorderColorSameAsPositive equals "false" and border equals "true".

axisColor: A CT_Color element that specifies the axis color of the data bar. This element MUST exist if and only if axisPosition does not equal "none".

Attributes:

minLength: An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the length of the shortest data bar in this conditional formatting range, expressed as a percentage of the width of the cell containing the data bar. MUST be greater than or equal to zero and less than or equal to maxLength. If, in this same worksheet part, there exists a CT_ExtensionList element that is a descendent of a CT_CfRule with a child CT_Extension element with the child ST_Guid element equal to the id attribute of the CT_CfRule element that is a parent of this element, and the minLength attribute of this element is zero ("0") and the maxLength attribute of this element is "100", the minLength attribute of the CT_DataBar element that is a descendent of the CT_CfRule element that is a parent of the CT_ExtensionList element that is a parent of the CT_Extension element with the child ST_Guid element equal to the id attribute of the CT_CfRule element that is a parent of this element MUST be "10". If in this same worksheet part there exists an CT_ExtensionList element that is a descendent of a CT_CfRule with a child CT_Extension element with the child ST_Guid element equal to the id attribute of the CT_CfRule element that is a parent of this element, and the minLength attribute of this element is not zero ("0") or the maxLength attribute of this element is not "100", the minLength attribute of the CT_DataBar element that is a descendent of the CT_CfRule element that is a parent of the CT_ExtensionList element that is a parent of the CT_Extension element with the child ST_Guid element that is equal to the id attribute of the CT_CfRule element that is a parent of this element MUST be equal to this complex type’s minLength.

maxLength: An unsignedInt attribute that specifies the length of the longest data bar in this conditional formatting range, expressed as a percentage of the width of the cell being formatted. MUST be greater than or equal to minLength and less than or equal to 100. If in this same worksheet part there exists a CT_ExtensionList element that is a descendent of a CT_CfRule with a child CT_Extension element with the child ST_Guid element equal to the id attribute of the CT_CfRule element that is a parent of this element, and the minLength attribute of this element is zero ("0") and the maxLength attribute of this element is "100", the maxLength attribute of the CT_DataBar element that is a descendent of the CT_CfRule element that is a parent of the CT_ExtensionList element that is a parent of the CT_Extension element with the child ST_Guid element that is equal to the id attribute of the CT_CfRule element that is a parent of this element MUST be "90". If, in this same worksheet part, there exists a CT_ExtensionList element that is a descendent of a CT_CfRule with a child CT_Extension element with the child ST_Guid element equal to the id attribute of the CT_CfRule element that is a parent of this element, and the minLength attribute of this element is not zero ("0") or the maxLength attribute of this element is not "100", the maxLength attribute of the CT_DataBar element that is a descendent of the CT_CfRule element that is a parent of the CT_ExtensionList element that is a parent of the CT_Extension element with the child ST_Guid element that is equal to the id attribute of the CT_CfRule element that is a parent of this element MUST be equal to this record’s maxLength.

showValue: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the cells in the conditional formatting range display both the data bar and the numeric value or only the data bar. The following table describes its possible values.

Value	Meaning
"false"	Only the data bar is displayed in the cell.
"true"	Both the data bar and the numeric value are displayed in the cell.

border: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the data bar has a border.

gradient: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the data bar has a gradient fill. The following table describes its possible values.

Value	Meaning
"false"	The data bar fill is a solid color.
"true"	The data bar fill is a gradient.

direction: An ST_DataBarDirection attribute section 2.7.7) that specifies the direction of the data bar.

negativeBarColorSameAsPositive: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the data bar has a negative bar color that is different from the positive bar color.

negativeBarBorderColorSameAsPositive: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the data bar has a negative border color that is different from the positive border color.

axisPosition: An ST_DataBarAxisPosition attribute (section 2.7.8) that specifies the axis position for the data bar.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

<xsd:complexType name="CT_DataBar">

<xsd:sequence>

<xsd:element name="cfvo" type="CT_Cfvo" minOccurs="2" maxOccurs="2"/>

<xsd:element name="fillColor" type="x:CT_Color" minOccurs="0" maxOccurs="1"/>

<xsd:element name="borderColor" type="x:CT_Color" minOccurs="0" maxOccurs="1"/>

<xsd:element name="negativeFillColor" type="x:CT_Color" minOccurs="0" maxOccurs="1"/>

<xsd:element name="negativeBorderColor" type="x:CT_Color" minOccurs="0" maxOccurs="1"/>

<xsd:element name="axisColor" type="x:CT_Color" minOccurs="0" maxOccurs="1"/>

</xsd:sequence>

<xsd:attribute name="minLength" type="xsd:unsignedInt" use="optional" default="10"/>

<xsd:attribute name="maxLength" type="xsd:unsignedInt" use="optional" default="90"/>

<xsd:attribute name="showValue" type="xsd:boolean" use="optional" default="true"/>

<xsd:attribute name="border" type="xsd:boolean" use="optional" default="false"/>

<xsd:attribute name="gradient" type="xsd:boolean" use="optional" default="true"/>

<xsd:attribute name="direction" type="ST_DataBarDirection" use="optional" default="context"/>

<xsd:attribute name="negativeBarColorSameAsPositive" type="xsd:boolean" use="optional" default="false"/>

<xsd:attribute name="negativeBarBorderColorSameAsPositive" type="xsd:boolean" use="optional" default="true"/>

<xsd:attribute name="axisPosition" type="ST_DataBarAxisPosition" use="optional" default="automatic"/>

</xsd:complexType>

See section 5.4 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

Constructors

DataBar()	Initializes a new instance of the DataBar class.
DataBar(IEnumerable<OpenXmlElement>)	Initializes a new instance of the DataBar class with the specified child elements.
DataBar(OpenXmlElement[])	Initializes a new instance of the DataBar class with the specified child elements.
DataBar(String)	Initializes a new instance of the DataBar class from outer XML.

Properties

AxisPosition	axisPosition, this property is only available in Office 2010 and later. Represents the following attribute in the schema: axisPosition
Border	border, this property is only available in Office 2010 and later. Represents the following attribute in the schema: border
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Direction	direction, this property is only available in Office 2010 and later. Represents the following attribute in the schema: direction
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
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 current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
Gradient	gradient, this property is only available in Office 2010 and later. Represents the following attribute in the schema: gradient
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 OpenXmlCompositeElement)
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MaxLength	maxLength, this property is only available in Office 2010 and later. Represents the following attribute in the schema: maxLength
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
MinLength	minLength, this property is only available in Office 2010 and later. Represents the following attribute in the schema: minLength
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)
NegativeBarBorderColorSameAsPositive	negativeBarBorderColorSameAsPositive, this property is only available in Office 2010 and later. Represents the following attribute in the schema: negativeBarBorderColorSameAsPositive
NegativeBarColorSameAsPositive	negativeBarColorSameAsPositive, this property is only available in Office 2010 and later. Represents the following attribute in the schema: negativeBarColorSameAsPositive
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)
ShowValue	showValue, this property is only available in Office 2010 and later. Represents the following attribute in the schema: showValue
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)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
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 OpenXmlCompositeElement)
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 OpenXmlCompositeElement)
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 of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
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 nodes. (Inherited from OpenXmlCompositeElement)
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 of the current element's child elements. (Inherited from OpenXmlCompositeElement)
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. (Inherited from OpenXmlCompositeElement)
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 one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
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)