LanguageId Class

Language ID for Phonetic Guide.When the object is serialized out as xml, its qualified name is w:lid.

Inheritance Hierarchy

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

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

Syntax

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

Remarks

[ISO/IEC 29500-1 1st Edition]

17.3.3.14 lid (Language ID for Phonetic Guide)

This element specifies the language which shall be used for this phonetic guide.

[Example: Consider a run of phonetic guide text which is using Japanese as it language. This constraint is specified using the following WordprocessingML:

<w:rubyPr>
…
<w:lid w:val="ja-JP"/>
  …
</w:rubyPr>

The lid property is ja-JP for the phonetic guide, so the phonetic guide is specified to be Japanese. end example]

Parent Elements

rubyPr (§17.3.3.28)

Attributes

Description

val (Language Code)

Specifies an identifier for a specific language.

This code is interpreted in the context of the parent XML element.

[Example: Consider an object which must specify the English(Canada) language. That object would use an identifier of en-CA to specify this language. end example]

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

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

[ISO/IEC 29500-1 1st Edition]

17.5.2.20 lid (Date Picker Language ID)

This element specifies the language ID which shall be used for displaying a calendar for the current date picker structured document tag, if a user interface is present for the structured document tag.

If this element is omitted, then the language ID shall be the language ID of the run contents of the parent structured document tag.

[Example: Consider the following structured document tag properties:

<w:sdtPr>
<w:date w:fullDate="2006-01-01T06:30:00Z">
<w:lid w:val="ja-JP"/>
</w:date>
</w:sdtPr>

The calendar language ID for a calendar which can be displayed in the document must be the default calendar format for the Japanese (Japan) language format (ja-JP). end example]

Parent Elements

date (§17.5.2.7)

Attributes

Description

val (Language Code)

Specifies an identifier for a specific language.

This code is interpreted in the context of the parent XML element.

[Example: Consider an object which must specify the English(Canada) language. That object would use an identifier of en-CA to specify this language. end example]

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

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

[ISO/IEC 29500-1 1st Edition]

17.14.17 lid (Merge Field Name Language ID)

This element specifies the language ID for the language which was used to generate the merge field name which was associated with a given column in the data source, as specified by the fieldMapData element (§17.14.15). This element specifies that when this field mapping is processed by an application, it shall interpret the merge field name as the name for the specified language.

If this element is omitted, then the mapped field names specified in the current document can be interpreted using any method desired by the consuming application (i.e. no language data is included with the field mapping information).

[Example: Consider the following WordprocessingML fragment for a field mapping for a document to be merged to an external data source. If the merge field name stored in the file corresponds with the U.S. English version of the merge field names, that information would be stored as follows:

<w:fieldMapData>
<w:name w:val="Title" />
<w:mappedName w:val="Courtesy Title" />
<w:column w:val="3" />
<w:lid w:val="en-US" />
…
</w:fieldMapData>

The lid element specifies that the mapping of the data contained in the fourth column of external data source named Title to the WordprocessingML of 'Courtesy Title', must be associated with the U.S. English language as specified by the val attribute equal to en-US. end example]

Parent Elements

fieldMapData (§17.14.15)

Attributes

Description

val (Language Code)

Specifies an identifier for a specific language.

This code is interpreted in the context of the parent XML element.

[Example: Consider an object which must specify the English(Canada) language. That object would use an identifier of en-CA to specify this language. end example]

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

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

LanguageId Members

DocumentFormat.OpenXml.Wordprocessing Namespace