RunProperties Class

  • Article

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

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Drawing.TextCharacterPropertiesType
        DocumentFormat.OpenXml.Drawing.RunProperties

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

Syntax

'Declaration
Public Class RunProperties _
    Inherits TextCharacterPropertiesType
'Usage
Dim instance As RunProperties

public class RunProperties : TextCharacterPropertiesType

Remarks

The following table lists the possible child types:

  • Outline <a:ln>

  • NoFill <a:noFill>

  • SolidFill <a:solidFill>

  • GradientFill <a:gradFill>

  • BlipFill <a:blipFill>

  • PatternFill <a:pattFill>

  • GroupFill <a:grpFill>

  • EffectList <a:effectLst>

  • EffectDag <a:effectDag>

  • Highlight <a:highlight>

  • UnderlineFollowsText <a:uLnTx>

  • Underline <a:uLn>

  • UnderlineFillText <a:uFillTx>

  • UnderlineFill <a:uFill>

  • LatinFont <a:latin>

  • EastAsianFont <a:ea>

  • ComplexScriptFont <a:cs>

  • SymbolFont <a:sym>

  • HyperlinkOnClick <a:hlinkClick>

  • HyperlinkOnMouseOver <a:hlinkMouseOver>

  • RightToLeft <a:rtl>

  • ExtensionList <a:extLst>

[ISO/IEC 29500-1 1st Edition]

21.1.2.3.9 rPr (Text Run Properties)

This element contains all run level text properties for the text runs within a containing paragraph.

[Example: Consider the DrawingML shown below.

<a:p>
…
<a:rPr u="sng"/>
…
<a:t>Some Text</a:t>
…
</a:p>

The run of text described above is formatting with a single underline of text matching color. end example]

Parent Elements

br (§21.1.2.2.1); fld (§21.1.2.2.4); r (§21.1.2.3.8)

Child Elements

Subclause

blipFill (Picture Fill)

§20.1.8.14

cs (Complex Script Font)

§21.1.2.3.1

ea (East Asian Font)

§21.1.2.3.3

effectDag (Effect Container)

§20.1.8.25

effectLst (Effect Container)

§20.1.8.26

extLst (Extension List)

§20.1.2.2.15

gradFill (Gradient Fill)

§20.1.8.33

grpFill (Group Fill)

§20.1.8.35

highlight (Highlight Color)

§21.1.2.3.4

hlinkClick (Click Hyperlink)

§21.1.2.3.5

hlinkMouseOver (Mouse-Over Hyperlink)

§21.1.2.3.6

latin (Latin Font)

§21.1.2.3.7

ln (Outline)

§20.1.2.2.24

noFill (No Fill)

§20.1.8.44

pattFill (Pattern Fill)

§20.1.8.47

rtl (Right to Left Run)

§21.1.2.2.8

solidFill (Solid Fill)

§20.1.8.54

sym (Symbol Font)

§21.1.2.3.10

uFill (Underline Fill)

§21.1.2.3.12

uFillTx (Underline Fill Properties Follow Text)

§21.1.2.3.13

uLn (Underline Stroke)

§21.1.2.3.14

uLnTx (Underline Follows Text)

§21.1.2.3.15

Attributes

Description

altLang (Alternative Language)

Specifies the alternate language to use when the generating application is displaying the user interface controls. If this attribute is omitted, than the lang attribute is used here.

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

b (Bold)

Specifies whether a run of text is formatted as bold text. If this attribute is omitted, than a value of 0, or false is assumed.

[Example: Consider the DrawingML shown below.

<a:p>
…
<a:rPr b="1"/>
…
<a:t>Some Text</a:t>
…
</a:p>

The above run of text is formatted as bold text. end example]

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

baseline (Baseline)

Specifies the baseline for both the superscript and subscript fonts. The size is specified using a percentage where 1% is equal to 1 percent of the font size and 100% is equal to 100 percent font of the font size.

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

bmk (Bookmark Link Target)

Specifies the link target name that is used to reference to the proper link properties in a custom XML part within the document.

The possible values for this attribute are defined by the W3C XML Schema string datatype.

cap (Capitalization)

Specifies the capitalization that is to be applied to the text run. This is a render-only modification and does not affect the actual characters stored in the text run. This attribute is also distinct from the toggle function where the actual characters stored in the text run are changed.

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

dirty (Dirty)

Specifies that the content of a text run has changed since the proofing tools have last been run. Effectively this flags text that is to be checked again by the generating application for mistakes such as spelling, grammar, etc.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

err (Spelling Error)

Specifies that when this run of text was checked for spelling, grammar, etc. that a mistake was indeed found. This allows the generating application to effectively save the state of the mistakes within the document instead of having to perform a full pass check upon opening the document.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

i (Italics)

Specifies whether a run of text is formatted as italic text. If this attribute is omitted, than a value of 0, or false is assumed.

[Example: Consider the DrawingML shown below.

<a:p>
…
<a:rPr i="1"/>
…
<a:t>Some Text</a:t>
…
</a:p>

The above run of text is formatted as italic text. end example]

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

kern (Kerning)

Specifies the minimum font size at which character kerning occurs for this text run. Whole points are specified in increments of 100 starting with 100 being a point size of 1. For instance a font point size of 12 would be 1200 and a font point size of 12.5 would be 1250. If this attribute is omitted, than kerning occurs for all font sizes down to a 0 point font.

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

kumimoji (Kumimoji)

Specifies whether the numbers contained within vertical text continue vertically with the text or whether they are to be displayed horizontally while the surrounding characters continue in a vertical fashion. If this attribute is omitted, than a value of 0, or false is assumed.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

lang (Language ID)

Specifies the language to be used when the generating application is displaying the user interface controls. If this attribute is omitted, than the generating application can select a language of its choice.

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

noProof (No Proofing)

Specifies that a run of text has been selected by the user to not be checked for mistakes. Therefore if there are spelling, grammar, etc mistakes within this text the generating application should ignore them.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

normalizeH (Normalize Heights)

Specifies the normalization of height that is to be applied to the text run. This is a render-only modification and does not affect the actual characters stored in the text run. This attribute is also distinct from the toggle function where the actual characters stored in the text run are changed. If this attribute is omitted, than a value of 0, or false is assumed.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

smtClean (SmartTag Clean)

Specifies whether or not a text run has been checked for smart tags. This attribute acts much like the dirty attribute dose for the checking of spelling, grammar, etc. A value of true here indicates to the generating application that this text run should be checked for smart tags. If this attribute is omitted, than a value of 0, or false is assumed.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

smtId (SmartTag ID)

Specifies a smart tag identifier for a run of text. This ID is unique throughout the presentation and is used to reference corresponding auxiliary information about the smart tag. [Note: For a complete definition of smart tags, which are semantically identical throughout Office Open XML, see §17.5.1. end note]

[Example: Consider the following DrawingML:

<p:txBody>
  <a:bodyPr/>
  <a:lstStyle/>
  <a:p>
    <a:r>
      <a:rPr lang="en-US" dirty="0" smtId="1"/>
      <a:t>CNTS</a:t>
    </a:r>
    <a:endParaRPr lang="en-US" dirty="0"/>
  </a:p>
</p:txBody>

The text run has a smtId attribute value of 1, which denotes that the text should be inspected for smart tag information, which in this case maps to a stock ticker symbol. end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

spc (Spacing)

Specifies the spacing between characters within a text run. This spacing is specified numerically and should be consistently applied across the entire run of text by the generating application. Whole points are specified in increments of 100 starting with 100 being a point size of 1. For instance a font point size of 12 would be 1200 and a font point size of 12.5 would be 1250. If this attribute is omitted than a value of 0 or no adjustment is assumed.

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

strike (Strikethrough)

Specifies whether a run of text is formatted as strikethrough text. If this attribute is omitted, than no strikethrough is assumed.

[Example: Consider the DrawingML shown below.

<a:p>
…
<a:rPr strike="sngStrike"/>
…
<a:t>Some Text</a:t>
…
</a:p>

The above run of text is formatted as single strikethrough text. end example]

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

sz (Font Size)

Specifies the size of text within a text run. Whole points are specified in increments of 100 starting with 100 being a point size of 1. For instance a font point size of 12 would be 1200 and a font point size of 12.5 would be 1250. If this attribute is omitted, than the value in defRPr should be used.

[Example: Consider the DrawingML shown below.

<a:p>
…
<a:rPr sz="1200"/>
…
<a:t>Some Text</a:t>
…
</a:p>

The above run of text is formatted with a 12 point text size. end example]

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

u (Underline)

Specifies whether a run of text is formatted as underlined text. If this attribute is omitted, than no underline is assumed.

[Example: Consider the DrawingML shown below.

<a:p>
…
<a:rPr u="sng"/>
…
<a:t>Some Text</a:t>
…
</a:p>

The above run of text is formatted as single underline text. end example]

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

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