Share via

EmbedRegularFont Class

  • Article

Regular Font Style Embedding.When the object is serialized out as xml, its qualified name is w:embedRegular.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.FontRelationshipType
        DocumentFormat.OpenXml.Wordprocessing.EmbedRegularFont

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

Syntax

'Declaration
Public Class EmbedRegularFont _
    Inherits FontRelationshipType
'Usage
Dim instance As EmbedRegularFont

public class EmbedRegularFont : FontRelationshipType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.8.3.6 embedRegular (Regular Font Style Embedding)

This element specifies information about the embedded font storage for the regular form of a font, when it is embedded. This form is used when neither bold nor italics is applied to a text run.

If this element is omitted, then no regular form of the font is stored in the document.

[Example: Consider a WordprocessingML document in which the Arial font has been embedded in the file. This status would be specified using the following WordprocessingML:

<w:font w:name="Arial">
…
<w:embedRegular r:id="rId13" />
</w:font>

The embedRegular element specifies that the embedded font targeted with the relationship with ID rId13 can be used to retrieve the regular form of the embedded Arial font. end example]

Parent Elements

font (§17.8.3.10)

Attributes

Description

fontKey (Embedded Font Obfuscation Key)

Specifies the key which was used to obfuscate this embedded font. This key can be used to retrieve the embedded font for the purposes of viewing this WordprocessingML document only, using the algorithm described in §17.8.1.

If this attribute is omitted, then no key is provided for this font.

[Example: Consider a WordprocessingML document in which the Arial font has been embedded in the file. This status would be specified using the following WordprocessingML:

<w:font w:name="Arial">
…
<w:embedRegular r:id="rId10" w:fontKey="{302EE813-EB4A-4642-A93A-89EF99B2457E}" />
</w:font>

The fontKey attribute has a value of {302EE813-EB4A-4642-A93A-89EF99B2457E}, therefore the embedded Arial font targeted with the relationship with ID rId10 can be retrieved if needed by using this key and the algorithm above. end example]

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

id (Relationship to Part)

Namespace: .../officeDocument/2006/relationships

Specifies the relationship ID to a specified part.

The specified relationship shall match the relationship type required by the parent element:

  • https://schemas.openxmlformats.org/officeDocument/2006/customXml for the contentPart element

  • https://schemas.openxmlformats.org/officeDocument/2006/relationships/footer for the footerReference element

  • https://schemas.openxmlformats.org/officeDocument/2006/relationships/header for the headerReference element

  • https://schemas.openxmlformats.org/officeDocument/2006/relationships/font for the embedBold, embedBoldItalic, embedItalic, or embedRegular elements

  • https://schemas.openxmlformats.org/officeDocument/2006/relationships/printerSettings for the printerSettings element

  • https://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink for the longDesc or hyperlink element

[Example: Consider an XML element which has the following id attribute:

<… r:id="rId10" />

The markup specifies the associated relationship part with relationship ID rId1 contains the corresponding relationship information for the parent XML element. end example]

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

subsetted (Embedded Font Is Subsetted)

Specifies that the embedded font targeted by the id attribute has been subsetted. Subsetting is a mechanism by which only the glyphs used in the contents of this WordprocessingML document are stored in an embedded font, in order to prevent the file from becoming unnecessarily large from the use of a small number of glyphs from a large embedded font.

If this attribute is omitted, then the embedded font target by the id attribute shall not be handled as though it is subsetted.

[Example: Consider a WordprocessingML document in which the Arial font has been embedded in the file after subsetting. This status would be specified using the following WordprocessingML:

<w:font w:name="Arial">
…
<w:embedRegular r:id="rId10" w:subsetted="true" />
</w:font>

The subsetted attribute has a value of true, therefore the embedded Arial font targeted with the relationship with ID rId10 must be treated as a subsetted font. end example]

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

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

EmbedRegularFont Members

DocumentFormat.OpenXml.Wordprocessing Namespace