CharacterScale Class

Defines the CharacterScale Class.When the object is serialized out as xml, its qualified name is w:w.

Inheritance Hierarchy

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

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

Syntax

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

Remarks

[ISO/IEC 29500-1 1st Edition]

17.3.2.43 w (Expanded/Compressed Text)

This element specifies the amount by which each character shall be expanded or when the character is rendered in the document. This property has an of stretching or compressing each character in the run, as opposed to the spacing element (§17.3.2.35) which expands/compresses the text by adding additional character pitch but not changing the width of the actual characters displayed on the line.

If this element is not present, the default value is to leave the formatting applied at previous level in the style hierarchy. If this element is never applied in the style hierarchy, then the run shall be displayed at 100% of its normal width.

[Example: Consider a run of text which must be expanded to 200% of its normal width when displaying each character within the contents of the run. This constraint is specified using the following WordprocessingML:

<w:rPr>
<w:w w:val="200"/>
</w:rPr>

This run explicitly declares that the w value is 200, so the contents of this run appear at 200% of their normal character width by stretching the width of each character. end example]

Parent Elements

rPr (§17.3.1.29); rPr (§17.3.1.30); rPr (§17.5.2.28); rPr (§17.9.25); rPr (§17.7.9.1); rPr (§17.7.5.4); rPr (§17.3.2.28); rPr (§17.5.2.27); rPr (§17.7.6.2); rPr (§17.3.2.27)

Attributes

Description

val (Text Expansion/Compression Value)

Specifies that the percentage by which the contents of this run shall be expanded or compressed with respect to its normal (100%) character width.

If this attribute is omitted, then the contents of this run shall be displayed at 100% of its normal size.

[Example: Consider a run of text which must be compressed to 200% when displaying each character within the contents of the run. This constraint is specified using the following WordprocessingML:

<w:rPr>
<w:w w:val="50"/>
</w:rPr>

This run explicitly declares that the w value is 50, so the contents of this run appear at 50% of their normal character width by compressing the width of each character. end example]

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

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

CharacterScale Members

DocumentFormat.OpenXml.Wordprocessing Namespace