WebPageEncoding Class

Output Encoding When Saving as Web Page.When the object is serialized out as xml, its qualified name is w:encoding.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.String255Type
        DocumentFormat.OpenXml.Wordprocessing.WebPageEncoding

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

Syntax

'Declaration
Public Class WebPageEncoding _
    Inherits String255Type
'Usage
Dim instance As WebPageEncoding
public class WebPageEncoding : String255Type

Remarks

[ISO/IEC 29500-1 1st Edition]

17.15.2.14 encoding (Output Encoding When Saving as Web Page)

This element specifies the encoding which shall be used for the contents of this WordprocessingML document when it is saved as an HTML web page. The set of encodings supported by this element shall be derived from the standard set of character set definitions provided at http://www.iana.org/assignments/character-sets.

If this element is omitted, then the default encoding for the current system shall be used when this document is saved as a web page. If the value of the val attribute is unknown or supported by an application, then the default encoding for the current system shall be used when this document is saved as a web page.

[Example: Consider a WordprocessingML document which contains the following content within the web settings part:

<w:webSettings>
<w:encoding w:val="utf-8" />
</w:webSettings>

The encoding element's val attribute has a value of utf-8, which specifies that this document must be encoded in the UTF-8 format when it is saved as a web page. end example]

Parent Elements

webSettings (§17.15.2.46)

Attributes

Description

val (String Value)

Specifies that its contents contain a string.

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

[Example: Consider the following WordprocessingML fragment:

<w:pPr>
  <w:pStyle w:val="heading1" /> 
</w:pPr>

The value of the val attribute is the ID of the associated paragraph style's styleId.

However, consider the following fragment:

<w:sdtPr>
  <w:alias w:val="SDT Title Example" />
  …
</w:sdtPr>

In this case, the decimal number in the val attribute is the caption of the parent structured document tag. In each case, the value is interpreted in the context of the parent element. end example]

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

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

WebPageEncoding Members

DocumentFormat.OpenXml.Wordprocessing Namespace