NumberingFormat NumberingFormat NumberingFormat Class

Definition

Footnote Numbering Format. When the object is serialized out as xml, its qualified name is w:numFmt.

public class NumberingFormat : DocumentFormat.OpenXml.OpenXmlLeafElement
type NumberingFormat = class
    inherit OpenXmlLeafElement
Public Class NumberingFormat
Inherits OpenXmlLeafElement
Inheritance

Remarks

[ISO/IEC 29500-1 1st Edition]

numFmt (Numbering Format)

This element specifies the number format which shall be used to display all numbering at this level in the numbering definition. This information is used to replace the level text string %x, where x is a particular one-based level index, with the appropriate value. This value shall be calculated by counting the number of paragraphs at this level since the last restart using the numbering system defined in the val attribute.

When a document has a custom number format specified by the format attribute, it shall use the referenced number format. If the referenced number format cannot be resolved as a number format the consumer shall use the number format specified by the value of the val attribute. If the corresponding value of the val attribute is custom, the result is implementation-defined.

If this element is omitted, the level shall be assumed to be of level type decimal.

[Example: Consider the following WordprocessingML fragment for a numbering level in a numbering definition:

<w:lvl w:ilvl="2">  
  <w:start w:val="1" />  
  <w:numFmt w:val="lowerRoman" />  
  <w:lvlRestart w:val="0" />  
  <w:lvlText w:val="%3)" />  
  <w:lvlJc w:val="left" />  
  <w:pPr>  
    <w:ind w:left="1080" w:hanging="360" />  
  </w:pPr>  
  <w:rPr>  
    <w:rFonts w:hint="default" />  
  </w:rPr>  
</w:lvl>  

A numFmt value of lowerLetter indicates that a consumer must use lowercase letters for all numbering of this level: a,b,c… end example]

Parent Elements
lvl (§17.9.6); lvl (§17.9.7)
Attributes Description
format (Custom Defined Number Format) Specifies a custom number format using the syntax defined by the XSLT 1.0 format attribute. This format shall be used for all numbering in the parent object.

[Example: A value of &#x30A2; indicates that a consumer must use Katakana numbering. end example]

The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).
val (Numbering Format Type) Specifies the number format that shall be used for all numbering in the parent object.

[Example: A value of lowerLetter indicates that a consumer must use lowercase letters for each number in this grouping: a,b,c… end example]

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

[Note: The W3C XML Schema definition of this element’s content model (CT_NumFmt) is located in §A.1. end note]

[ISO/IEC 29500-1 1st Edition]

numFmt (Endnote Numbering Format)

This element specifies the numbering format which shall be used to determine the footnote or endnote reference mark value for all automatically numbered footnote and endnote reference marks (those without the suppressRef attribute set).

If this element is omitted, then the numbering format shall be assume to be decimal.

[Example: Consider the following footnote reference with the number format set to upper case letters:

c9c58ccd-2ea5-4b4b-af92-ca83a0d136e0

This footnote numbering format is specified by the following WordprocessingML:

<w:footnotePr>  
  <w:numFmt w:val="upperLetter" />  
</w:footnotePr>  

end example]

Parent Elements
endnotePr (§17.11.4); endnotePr (§17.11.5)
Attributes Description
format (Custom Defined Number Format) Specifies a custom number format using the syntax defined by the XSLT 1.0 format attribute. This format shall be used for all numbering in the parent object.

[Example: A value of &#x30A2; indicates that a consumer must use Katakana numbering. end example]

The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).
val (Numbering Format Type) Specifies the number format that shall be used for all numbering in the parent object.

[Example: A value of lowerLetter indicates that a consumer must use lowercase letters for each number in this grouping: a,b,c… end example]

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

[Note: The W3C XML Schema definition of this element’s content model (CT_NumFmt) is located in §A.1. end note]

[ISO/IEC 29500-1 1st Edition]

numFmt (Footnote Numbering Format)

This element specifies the numbering format which shall be used to determine the footnote or endnote reference mark value for all automatically numbered footnote and endnote reference marks (those without the suppressRef attribute set).

If this element is omitted, then the numbering format shall be assume to be decimal.

[Example: Consider the following footnote reference with the number format set to upper case letters:

c9c58ccd-2ea5-4b4b-af92-ca83a0d136e0

This footnote numbering format is specified by the following WordprocessingML:

<w:footnotePr>  
  <w:numFmt w:val="upperLetter" />  
</w:footnotePr>  

end example]

Parent Elements
footnotePr (§17.11.12); footnotePr (§17.11.11)
Attributes Description
format (Custom Defined Number Format) Specifies a custom number format using the syntax defined by the XSLT 1.0 format attribute. This format shall be used for all numbering in the parent object.

[Example: A value of &#x30A2; indicates that a consumer must use Katakana numbering. end example]

The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).
val (Numbering Format Type) Specifies the number format that shall be used for all numbering in the parent object.

[Example: A value of lowerLetter indicates that a consumer must use lowercase letters for each number in this grouping: a,b,c… end example]

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

[Note: The W3C XML Schema definition of this element’s content model (CT_NumFmt) is located in §A.1. end note]

� ISO/IEC29500: 2008.

Constructors

NumberingFormat() NumberingFormat() NumberingFormat()

Initializes a new instance of the NumberingFormat class.

Properties

ChildElements ChildElements ChildElements

Gets all the child nodes of the current element.

(Inherited from OpenXmlElement)
ExtendedAttributes ExtendedAttributes ExtendedAttributes

Gets all extended attributes (attributes not defined in the schema) of the current element.

(Inherited from OpenXmlElement)
FirstChild FirstChild 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)
Format Format Format

format, this property is only available in Office2010.Represents the following attribute in the schema: w:format

HasAttributes HasAttributes HasAttributes

Gets a boolean value that indicates whether the current element has any attributes.

(Inherited from OpenXmlElement)
HasChildren HasChildren HasChildren

Gets a value that indicates whether the current element has any child elements.

(Inherited from OpenXmlLeafElement)
InnerText InnerText InnerText

Gets the concatenated values of the node and all of its children.

(Inherited from OpenXmlElement)
InnerXml InnerXml InnerXml

Gets or sets the markup that only represents child elements of the current element.

(Inherited from OpenXmlLeafElement)
LastChild LastChild 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)
LocalName LocalName LocalName

Gets the local name of the element.

MCAttributes MCAttributes MCAttributes

Sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element.

(Inherited from OpenXmlElement)
NamespaceDeclarations NamespaceDeclarations 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 NamespaceUri NamespaceUri

Gets the namespace URI of the current element.

(Inherited from OpenXmlElement)
OpenXmlElementContext OpenXmlElementContext OpenXmlElementContext

Gets the OpenXmlEementContext of the current element.

(Inherited from OpenXmlElement)
OuterXml OuterXml OuterXml

Gets the markup that represents the current element and all of its child elements.

(Inherited from OpenXmlElement)
Parent Parent Parent

Gets the parent element of the current element.

(Inherited from OpenXmlElement)
Prefix Prefix Prefix

Gets the namespace prefix of current element.

(Inherited from OpenXmlElement)
Val Val Val

Numbering Format Type.Represents the following attribute in the schema: w:val

XmlQualifiedName XmlQualifiedName XmlQualifiedName

Gets the qualified name of the current element.

(Inherited from OpenXmlElement)
XName XName XName

Gets the qualified name of the current element.

(Inherited from OpenXmlElement)

Methods

AddAnnotation(Object) AddAnnotation(Object) AddAnnotation(Object)

Adds an object to the current OpenXmlElement element's list of annotations.

(Inherited from OpenXmlElement)
AddNamespaceDeclaration(String, String) AddNamespaceDeclaration(String, String) AddNamespaceDeclaration(String, String)

Adds a namepace declaration to the current node.

(Inherited from OpenXmlElement)
Ancestors() Ancestors() Ancestors()

Enumerates all of the current element's ancestors.

(Inherited from OpenXmlElement)
Ancestors<T>() Ancestors<T>() Ancestors<T>()

Enumerates only the current element's ancestors that have the specified type.

(Inherited from OpenXmlElement)
Annotation(Type) Annotation(Type) Annotation(Type)

Get the first annotation object of the specified type from the current OpenXmlElement element.

(Inherited from OpenXmlElement)
Annotation<T>() Annotation<T>() Annotation<T>()

Get the first annotation object of the specified type from the current OpenXmlElement element.

(Inherited from OpenXmlElement)
Annotations(Type) Annotations(Type) Annotations(Type)

Gets a collection of annotations with the specified type for the current OpenXmlElement element.

(Inherited from OpenXmlElement)
Annotations<T>() Annotations<T>() Annotations<T>()

Gets a collection of annotations with the specified type for the current OpenXmlElement element.

(Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>) Append(IEnumerable<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[]) Append(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) AppendChild<T>(T) AppendChild<T>(T)

Appends the specified element to the end of the current element's list of child nodes.

(Inherited from OpenXmlElement)
ClearAllAttributes() ClearAllAttributes() ClearAllAttributes()

Clears all of the attributes, including both known attributes and extended attributes.

(Inherited from OpenXmlElement)
Clone() Clone() Clone()

Creates a duplicate of the current node.

(Inherited from OpenXmlElement)
CloneNode(Boolean) CloneNode(Boolean) CloneNode(Boolean)

Creates a duplicate of this node.

Descendants() Descendants() Descendants()

Enumerates all of the current element's descendants.

(Inherited from OpenXmlElement)
Descendants<T>() Descendants<T>() Descendants<T>()

Enumerate all of the current element's descendants of type T.

(Inherited from OpenXmlElement)
Elements() Elements() Elements()

Enumerates all of the current element's children.

(Inherited from OpenXmlElement)
Elements<T>() Elements<T>() Elements<T>()

Enumerates only the current element's children that have the specified type.

(Inherited from OpenXmlElement)
ElementsAfter() ElementsAfter() 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() ElementsBefore() 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) GetAttribute(String, String) GetAttribute(String, String)

Gets an Open XML attribute with the specified tag name and namespace URI.

(Inherited from OpenXmlElement)
GetAttributes() GetAttributes() GetAttributes()

Gets a list that contains a copy of all the attributes.

(Inherited from OpenXmlElement)
GetEnumerator() GetEnumerator() GetEnumerator()

Returns an enumerator that iterates through the child collection.

(Inherited from OpenXmlElement)
GetFirstChild<T>() GetFirstChild<T>() GetFirstChild<T>()

Finds the first child element in type T.

(Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement) InsertAfter<T>(T, OpenXmlElement) InsertAfter<T>(T, OpenXmlElement)

Inserts the specified element immediately after the specified reference element.

(Inherited from OpenXmlElement)
InsertAfterSelf<T>(T) InsertAfterSelf<T>(T) InsertAfterSelf<T>(T)

Inserts the specified element immediately after the current element.

(Inherited from OpenXmlElement)
InsertAt<T>(T, Int32) InsertAt<T>(T, Int32) 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) InsertBefore<T>(T, OpenXmlElement) InsertBefore<T>(T, OpenXmlElement)

Inserts the specified element immediately before the specified reference element.

(Inherited from OpenXmlElement)
InsertBeforeSelf<T>(T) InsertBeforeSelf<T>(T) InsertBeforeSelf<T>(T)

Inserts the specified element immediately before the current element.

(Inherited from OpenXmlElement)
IsAfter(OpenXmlElement) IsAfter(OpenXmlElement) IsAfter(OpenXmlElement)

Determines if the current element appears after a specified element in document order.

(Inherited from OpenXmlElement)
IsBefore(OpenXmlElement) IsBefore(OpenXmlElement) IsBefore(OpenXmlElement)

Determines if the current element appears before a specified element in document order.

(Inherited from OpenXmlElement)
LookupNamespace(String) LookupNamespace(String) LookupNamespace(String)

Resolves the namespace prefix in the context of the current node.

(Inherited from OpenXmlElement)
LookupPrefix(String) LookupPrefix(String) LookupPrefix(String)

Finds the corresponding prefix for a namespace uri in the current element scope.

(Inherited from OpenXmlElement)
NextSibling() NextSibling() 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>() NextSibling<T>() 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) PrependChild<T>(T) PrependChild<T>(T)

Inserts the specified element at the beginning of the current element's list of child elements.

(Inherited from OpenXmlElement)
PreviousSibling() PreviousSibling() 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>() PreviousSibling<T>() 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() Remove() Remove()

Removes the current element from its parent.

(Inherited from OpenXmlElement)
RemoveAllChildren() RemoveAllChildren() RemoveAllChildren()

Removes all child elements of the current element.

(Inherited from OpenXmlLeafElement)
RemoveAllChildren<T>() RemoveAllChildren<T>() RemoveAllChildren<T>()

Remove all of the current element's child elements that are of type T.

(Inherited from OpenXmlElement)
RemoveAnnotations(Type) RemoveAnnotations(Type) RemoveAnnotations(Type)

Removes the annotations of the specified type from the current OpenXmlElement element.

(Inherited from OpenXmlElement)
RemoveAnnotations<T>() RemoveAnnotations<T>() RemoveAnnotations<T>()

Removes the annotations with the specified type from the current OpenXmlElement element.

(Inherited from OpenXmlElement)
RemoveAttribute(String, String) RemoveAttribute(String, String) RemoveAttribute(String, String)

Removes the attribute from the current element.

(Inherited from OpenXmlElement)
RemoveChild<T>(T) RemoveChild<T>(T) RemoveChild<T>(T)

Removes the specified child element from the current element's list of child elements.

(Inherited from OpenXmlElement)
RemoveNamespaceDeclaration(String) RemoveNamespaceDeclaration(String) RemoveNamespaceDeclaration(String)

Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix.

(Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T) ReplaceChild<T>(OpenXmlElement, T) 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) SetAttribute(OpenXmlAttribute) 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>) SetAttributes(IEnumerable<OpenXmlAttribute>) 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) WriteTo(XmlWriter) WriteTo(XmlWriter)

Saves the current node to the specified XmlWriter.

(Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator() IEnumerable.GetEnumerator() IEnumerable.GetEnumerator() Inherited from OpenXmlElement

Applies to