RunProperties Class

Run Properties.When the object is serialized out as xml, its qualified name is w:rPr.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Wordprocessing.RunProperties

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(WebHidden))> _
<ChildElementInfoAttribute(GetType(Shading))> _
<ChildElementInfoAttribute(GetType(FitText))> _
<ChildElementInfoAttribute(GetType(RunStyle))> _
<ChildElementInfoAttribute(GetType(RunFonts))> _
<ChildElementInfoAttribute(GetType(Bold))> _
<ChildElementInfoAttribute(GetType(BoldComplexScript))> _
<ChildElementInfoAttribute(GetType(Italic))> _
<ChildElementInfoAttribute(GetType(ItalicComplexScript))> _
<ChildElementInfoAttribute(GetType(Caps))> _
<ChildElementInfoAttribute(GetType(SmallCaps))> _
<ChildElementInfoAttribute(GetType(Strike))> _
<ChildElementInfoAttribute(GetType(DoubleStrike))> _
<ChildElementInfoAttribute(GetType(Outline))> _
<ChildElementInfoAttribute(GetType(Shadow))> _
<ChildElementInfoAttribute(GetType(Emboss))> _
<ChildElementInfoAttribute(GetType(Imprint))> _
<ChildElementInfoAttribute(GetType(NoProof))> _
<ChildElementInfoAttribute(GetType(SnapToGrid))> _
<ChildElementInfoAttribute(GetType(Vanish))> _
<ChildElementInfoAttribute(GetType(Color))> _
<ChildElementInfoAttribute(GetType(Spacing))> _
<ChildElementInfoAttribute(GetType(CharacterScale))> _
<ChildElementInfoAttribute(GetType(Kern))> _
<ChildElementInfoAttribute(GetType(Position))> _
<ChildElementInfoAttribute(GetType(FontSize))> _
<ChildElementInfoAttribute(GetType(FontSizeComplexScript))> _
<ChildElementInfoAttribute(GetType(Highlight))> _
<ChildElementInfoAttribute(GetType(Underline))> _
<ChildElementInfoAttribute(GetType(TextEffect))> _
<ChildElementInfoAttribute(GetType(Border))> _
<ChildElementInfoAttribute(GetType(Properties3D), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(VerticalTextAlignment))> _
<ChildElementInfoAttribute(GetType(RightToLeftText))> _
<ChildElementInfoAttribute(GetType(ComplexScript))> _
<ChildElementInfoAttribute(GetType(Emphasis))> _
<ChildElementInfoAttribute(GetType(Languages))> _
<ChildElementInfoAttribute(GetType(EastAsianLayout))> _
<ChildElementInfoAttribute(GetType(SpecVanish))> _
<ChildElementInfoAttribute(GetType(Glow), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Shadow), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Reflection), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(TextOutlineEffect), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(FillTextEffect), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Scene3D), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Ligatures), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(NumberingFormat), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(NumberSpacing), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(StylisticSets), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(ContextualAlternatives), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(RunPropertiesChange))> _
Public Class RunProperties _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As RunProperties

[ChildElementInfoAttribute(typeof(WebHidden))]
[ChildElementInfoAttribute(typeof(Shading))]
[ChildElementInfoAttribute(typeof(FitText))]
[ChildElementInfoAttribute(typeof(RunStyle))]
[ChildElementInfoAttribute(typeof(RunFonts))]
[ChildElementInfoAttribute(typeof(Bold))]
[ChildElementInfoAttribute(typeof(BoldComplexScript))]
[ChildElementInfoAttribute(typeof(Italic))]
[ChildElementInfoAttribute(typeof(ItalicComplexScript))]
[ChildElementInfoAttribute(typeof(Caps))]
[ChildElementInfoAttribute(typeof(SmallCaps))]
[ChildElementInfoAttribute(typeof(Strike))]
[ChildElementInfoAttribute(typeof(DoubleStrike))]
[ChildElementInfoAttribute(typeof(Outline))]
[ChildElementInfoAttribute(typeof(Shadow))]
[ChildElementInfoAttribute(typeof(Emboss))]
[ChildElementInfoAttribute(typeof(Imprint))]
[ChildElementInfoAttribute(typeof(NoProof))]
[ChildElementInfoAttribute(typeof(SnapToGrid))]
[ChildElementInfoAttribute(typeof(Vanish))]
[ChildElementInfoAttribute(typeof(Color))]
[ChildElementInfoAttribute(typeof(Spacing))]
[ChildElementInfoAttribute(typeof(CharacterScale))]
[ChildElementInfoAttribute(typeof(Kern))]
[ChildElementInfoAttribute(typeof(Position))]
[ChildElementInfoAttribute(typeof(FontSize))]
[ChildElementInfoAttribute(typeof(FontSizeComplexScript))]
[ChildElementInfoAttribute(typeof(Highlight))]
[ChildElementInfoAttribute(typeof(Underline))]
[ChildElementInfoAttribute(typeof(TextEffect))]
[ChildElementInfoAttribute(typeof(Border))]
[ChildElementInfoAttribute(typeof(Properties3D), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(VerticalTextAlignment))]
[ChildElementInfoAttribute(typeof(RightToLeftText))]
[ChildElementInfoAttribute(typeof(ComplexScript))]
[ChildElementInfoAttribute(typeof(Emphasis))]
[ChildElementInfoAttribute(typeof(Languages))]
[ChildElementInfoAttribute(typeof(EastAsianLayout))]
[ChildElementInfoAttribute(typeof(SpecVanish))]
[ChildElementInfoAttribute(typeof(Glow), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Shadow), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Reflection), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(TextOutlineEffect), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(FillTextEffect), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Scene3D), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Ligatures), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(NumberingFormat), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(NumberSpacing), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(StylisticSets), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(ContextualAlternatives), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(RunPropertiesChange))]
public class RunProperties : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

• RunStyle <w:rStyle>

• RunFonts <w:rFonts>

• Bold <w:b>

• BoldComplexScript <w:bCs>

• Italic <w:i>

• ItalicComplexScript <w:iCs>

• Caps <w:caps>

• SmallCaps <w:smallCaps>

• Strike <w:strike>

• DoubleStrike <w:dstrike>

• Outline <w:outline>

• Shadow <w:shadow>

• Emboss <w:emboss>

• Imprint <w:imprint>

• NoProof <w:noProof>

• SnapToGrid <w:snapToGrid>

• Vanish <w:vanish>

• WebHidden <w:webHidden>

• Color <w:color>

• Spacing <w:spacing>

• CharacterScale <w:w>

• Kern <w:kern>

• Position <w:position>

• FontSize <w:sz>

• FontSizeComplexScript <w:szCs>

• Highlight <w:highlight>

• Underline <w:u>

• TextEffect <w:effect>

• Border <w:bdr>

• Shading <w:shd>

• FitText <w:fitText>

• VerticalTextAlignment <w:vertAlign>

• RightToLeftText <w:rtl>

• ComplexScript <w:cs>

• Emphasis <w:em>

• Languages <w:lang>

• EastAsianLayout <w:eastAsianLayout>

• SpecVanish <w:specVanish>

• DocumentFormat.OpenXml.Office2010.Word.Glow <w14:glow>

• DocumentFormat.OpenXml.Office2010.Word.Shadow <w14:shadow>

• DocumentFormat.OpenXml.Office2010.Word.Reflection <w14:reflection>

• DocumentFormat.OpenXml.Office2010.Word.TextOutlineEffect <w14:textOutline>

• DocumentFormat.OpenXml.Office2010.Word.FillTextEffect <w14:textFill>

• DocumentFormat.OpenXml.Office2010.Word.Scene3D <w14:scene3d>

• DocumentFormat.OpenXml.Office2010.Word.Properties3D <w14:props3d>

• DocumentFormat.OpenXml.Office2010.Word.Ligatures <w14:ligatures>

• DocumentFormat.OpenXml.Office2010.Word.NumberingFormat <w14:numForm>

• DocumentFormat.OpenXml.Office2010.Word.NumberSpacing <w14:numSpacing>

• DocumentFormat.OpenXml.Office2010.Word.StylisticSets <w14:stylisticSets>

• DocumentFormat.OpenXml.Office2010.Word.ContextualAlternatives <w14:cntxtAlts>

• RunPropertiesChange <w:rPrChange>

[ISO/IEC 29500-1 1st Edition]

17.3.2.28 rPr (Run Properties)

This element specifies a set of run properties which shall be applied to the contents of the parent run after all style formatting has been applied to the text. These properties are defined as direct formatting, since they are directly applied to the run and supersede any formatting from styles.

This formatting is applied at the following location in the style hierarchy:

• Document defaults

• Table styles

• Numbering styles

• Paragraph styles

• Character styles

• Direct formatting (this element)

[Example: Consider a run which should have a set of run formatting properties. This set of properties is specified in the run properties as follows:

<w:r>
  <w:rPr>
    <w:b />
    <w:imprint />
    <w:lang w:val="en-ca" /> 
  </w:rPr>
</w:r>

The rPr element specifies the properties which are applied to the current run - in this case, bold formatting on the run contents using the b element (§17.3.2.1), an imprinted (engraved) text effect using the imprint element (§17.3.2.18), and that this text should be interpreted as English (Canada) when spell or grammar checking the run text using the lang element (§17.3.2.20). end example]

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

[ISO/IEC 29500-1 1st Edition]

17.5.2.27 rPr (Run Properties For Structured Document Tag Contents)

This element specifies the set of run properties which shall be applied to the text entered into the parent structured document tag in replacement of placeholder text. When placeholder text is present in a structured document tag, its formatting is often different than the desired underlying formatting, and this element specifies the formatting which shall be used for non-placeholder text contents when they are initially added to the control.

If this element is not present, the inserted is unformatted, as with any other run of text - it shall not inherit the properties of the placeholder text.

[Example: Consider the following structured document tag:

<w:sdt>
<w:sdtPr>
<w:placeholder>
<w:docPart w:val="TestPlaceholderDocPart"/>
</w:placeholder>
<w:showingPlcHdr/>
<w:rPr>
<w:rStyle w:val="UserName"/>
</w:rPr>
…
</w:sdtPr>
<w:sdtContent>
<w:r>
<w:rPr>
<w:rStyle w:val="PlaceholderText"/>
</w:rPr>
<w:t>[Type Your Name Here]</w:t>
</w:r>
</w:sdtContent>
</w:sdt>

This structured document tag specifies that its current contents are placeholder text via the showingPlcHdr element (§17.5.2.39), and that text has the PlaceholderText character style applied to it.

Now, assume that that style created grey shaded text (typical for placeholder text). This formatting would clearly not be desirable for any text entered into the structured document tag. Therefore, when this text is added, the rPr element in the sdtPr is used to store the formatting on the resulting text.

In this example, the text which initially populates the control shall be formatted with the UserName character style. end example]

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

[ISO/IEC 29500-1 1st Edition]

17.5.2.28 rPr (Structured Document Tag End Character Run Properties)

This element specifies the set of run properties which shall be applied to the character present to delimit the end of the structured document tag's contents. When these properties are applied, they shall be applied in addition to the run properties specified for the entire structured document tag via the rPr element (§17.5.2.27) stored in the tag's main property container.

If this element is not present, the inserted closing tag shall be formatting identically to the start tag.

[Example: Consider the following structured document tag:

<w:sdt>
<w:sdtPr>
<w:placeholder>
<w:docPart w:val="TestPlaceholderDocPart"/>
</w:placeholder>
<w:showingPlcHdr/>
<w:rPr>
<w:rStyle w:val="UserName"/>
</w:rPr>
…
</w:sdtPr>
<w:sdtEndPr>
<w:rPr>
<w:b/>
      <w:i/>
</w:rPr>
</w:sdtEndPr>
<w:sdtContent>
…
</w:sdtContent>
</w:sdt>

The rPr elements under the tag's properties specify that this structured document tag specifies that its start character must have formatting in the character style UserName, and that the end character must have the formatting in the character style UserName as well as bold and italic direct formatting. end example]

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

[ISO/IEC 29500-1 1st Edition]

17.7.3.4 rPr (Run Properties)

This element specifies the set of run properties which comprise the default run properties for the current WordprocessingML document. [Rationale: The reason that an rPr element is present within the rPrDefault element is to allow for easy repurposing of any set of run properties within a WordprocessingML document - since the run properties are always child elements of a single rPr element, that element can simply be relocated in its entirety to the desired new location without additional modifications. end rationale]

If this element is omitted, then the default run properties for the current document are non-existent (i.e. there are no default run properties, and the defaults are therefore application-defined).

[Example: Consider the following definition for the document defaults for a WordprocessingML document:

<w:docDefaults>
…
<w:rPrDefault>
<w:rPr>
<w:b/>
</w:rPr>
</w:rPrDefault>
</w:docDefaults>

The rPr element as a child of the rPrDefault element contains the set of default run properties for this document - in this case, bold text. end example]

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

[ISO/IEC 29500-1 1st Edition]

17.7.4.2 rPr (Table Style Conditional Formatting Run Properties)

This element specifies the set of run properties which shall be applied to all runs within a table which match the conditional formatting type specified on the parent tblStylePr element. These properties are applied in the order specified via the style hierarchy.

[Example: Consider a table style which contains conditional formatting for its firstRow, defined as follows:

<w:style w:type="table" w:styleId="exampleTableStyle">
…
<w:tblStylePr w:type="firstRow">
<w:rPr>
<w:i/>
</w:rPr>
…
</w:tblStylePr>
</w:style>

The rPr element specified within the tblStylePr element specifies the set of run properties which must be applied to all parts of the table which meet the criteria specified by the type value of firstRow - all of the header rows of the table. In this example, the single run property applied is italics via the i element (§17.3.2.16). end example]

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

[ISO/IEC 29500-1 1st Edition]

17.7.7.1 rPr (Run Properties)

This element specifies the set of run properties which shall be applied to the run.

[Example: Consider a character style defined as follows:

<w:style w:type="character" w:styleId="TestCharStyle">
<w:rPr>
<w:dstrike/>
</w:rPr>
</w:style>

The rPr element specified within the style element specifies the set of run properties which must be applied to the referencing run. In this example, the single run property applied is the fact that the paragraph must be displayed with double strikethrough via the dstrike element (§17.3.2.9). end example]

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

[ISO/IEC 29500-1 1st Edition]

17.9.25 rPr (Numbering Symbol Run Properties)

This element specifies the run properties which shall be applied to the numbering level's text specified in the lvlText element (§17.9.12) when it is applied to paragraphs in this document.

These run properties are applied to all numbering level text used by a given abstract numbering definition and numbering level. It should be noted that run properties specified on a numbered paragraph itself, or on text runs within a numbered paragraph, are separate from the run properties specified by rPr elements within a numbering level, as the latter affects only the numbering text itself, not the remainder of runs in the numbered paragraph.

[Example: Consider the WordprocessingML below which uses the rPr element to specify that the numbering symbol used within a given numbering level should be bold and of a 16 point font size:

<w:lvl w:ilvl="1"> 
  …
  <w:rPr>
    <w:b /> 
    <w:sz w:val="32" /> 
  </w:rPr>
</w:lvl>

The resulting paragraph uses its regular paragraph formatting, but the numbering level text itself must be specifically formatted as bold in 16 point font. end example]

[Note: The W3C XML Schema definition of this element’s content model (CT_RPr) 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

RunProperties Members

DocumentFormat.OpenXml.Wordprocessing Namespace