UIPriority Class

Optional User Interface Sorting Order.When the object is serialized out as xml, its qualified name is w:uiPriority.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.UIPriority

Namespace:  DocumentFormat.OpenXml.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
Public Class UIPriority _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As UIPriority
public class UIPriority : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

17.7.2.19 uiPriority (Optional User Interface Sorting Order)

This element specifies a number which can be used to sort the set of style definitions in a user interface when this document is loaded by an application and the recommended setting is specified in the stylePaneSortMethod element (§17.15.1.86). If this element is set, then this priority shall be used to sort all available styles in ascending value order.

If this element is omitted, then the style shall not have an associated priority value and shall be sorted to the end of the list of style definitions (more or less equivalent to a priority value of infinity) when the recommended sort order setting is specified.

[Example: Consider a style with a primary name of Comment Style that should have an associated priority value of ten. This requirement would be specified using the following WordprocessingML:

<w:style … w:styleId="CStyle">
<w:name w:val="Comment Style"/>
<w:uiPriority w:val="10"/>
…
</w:style>

The uiPriority element specifies that this style definition should be sorted into the list of styles using a value of 10 when the styles are listed in recommended order using the stylePaneSortMethod element (§17.15.1.86). end example]

Parent Elements

style (§17.7.4.17)

Attributes

Description

val (Decimal Number Value)

Specifies that the contents of this attribute contains a decimal number.

The contents of this decimal number are interpreted based on the context of the parent XML element.

[Example: Consider the following numeric WordprocessingML property of simple type ST_DecimalNumber:

<… w:val="1512645511" />

The value of the val attribute is a decimal number whose value must be interpreted in the context of the parent element. end example]

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

[Note: The W3C XML Schema definition of this element’s content model (CT_DecimalNumber) is located in §A.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.

See Also

Reference

UIPriority Members

DocumentFormat.OpenXml.Wordprocessing Namespace