# org.pdfclown.documents.interchange.access.LanguageIdentifier Class Reference

Language identifier [PDF:1.7:10.8.1][RFC 3066]. More...

Inheritance diagram for org.pdfclown.documents.interchange.access.LanguageIdentifier:

List of all members.

## Public Member Functions
virtual object | Clone (Document context)
| Gets a clone of the object, registered inside the given document context.
virtual bool | Delete ()
| Removes the object from its document context.
override bool | Equals (object obj)
override int | GetHashCode ()
| LanguageIdentifier (IList< string > components)
| LanguageIdentifier (params string[] components)
## Static Public Member Functions
static PdfDirectObject | GetBaseObject (PdfObjectWrapper wrapper)
| Gets the PDF object backing the specified wrapper.
static LanguageIdentifier | Wrap (PdfDirectObject baseObject)
| Wraps a language identifier base object into a language identifier object.
## Protected Member Functions
void | CheckCompatibility (object feature)
| Checks whether the specified feature is compatible with the document's conformance version.
virtual PdfString | RetrieveName ()
| Retrieves the name possibly associated to this object, walking through the document's name dictionary.
PdfDirectObject | RetrieveNamedBaseObject ()
| Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.
## Properties
virtual PdfDirectObject | BaseObject`[get, set]`
IList< string > | Components`[get, set]`
1. - | Gets the identifier components: the first one is the primary code. It can be any of the following: a 2-character ISO 639 language code (e.g.,
         en
   - for English); the letter
         i
   - , designating an IANA-registered identifier; the letter
         x
2. - , for private use; the second one is the first subcode. It can be any of the following: a 2-character ISO 3166 country code (e.g.,
         en-US
   - ); a 3-to-8-character subcode registered with IANA (e.g.,
         en-cockney
) private non-registered subcodes; subcodes beyond the first can be any that have been registered with IANA.
PdfIndirectObject | Container`[get]`
| Gets the indirect object containing the base object.
PdfIndirectObject | DataContainer`[get]`
| Gets the indirect object containing the base data object.
Document | Document`[get]`
| Gets the document context.
File | File`[get]`
| Gets the file context.

##

Language identifier [PDF:1.7:10.8.1][RFC 3066].

Language identifiers can be based on codes defined by the International Organization for Standardization in ISO 639 (language code) and ISO 3166 (country code) or registered with the Internet Assigned Numbers Authority (IANA), or they can include codes created for private use.

A language identifier consists of a primary code optionally followed by one or more subcodes (each preceded by a hyphen).

## Constructor & Destructor Documentation

org.pdfclown.documents.interchange.access.LanguageIdentifier.LanguageIdentifier | ( | params string[] | components | ) |

org.pdfclown.documents.interchange.access.LanguageIdentifier.LanguageIdentifier | ( | IList< string > | components | ) |

## Member Function Documentation

void org.pdfclown.objects.PdfObjectWrapper.CheckCompatibility | ( | object | feature | ) | `[protected, inherited]`

Checks whether the specified feature is compatible with the document's conformance version.

Parameters:

  | feature | Entity whose compatibility has to be checked. Supported types: VersionEnum Property name resolvable to an annotated getter method MemberInfo

References org.pdfclown.PDF.Value.

virtual object org.pdfclown.objects.PdfObjectWrapper.Clone | ( | Document | context | ) | `[virtual, inherited]`

Gets a clone of the object, registered inside the given document context.

Parameters:

  | context | Which document the clone has to be registered in.

References org.pdfclown.objects.PdfObjectWrapper.BaseObject, org.pdfclown.objects.PdfObject.Clone(), and org.pdfclown.objects.PdfObjectWrapper.File.

virtual bool org.pdfclown.objects.PdfObjectWrapper.Delete | ( |  | ) | `[virtual, inherited]`

Removes the object from its document context.

The object is no more usable after this method returns.

Returns:
  Whether the object was actually decontextualized (only indirect objects can be decontextualize).

References org.pdfclown.objects.PdfIndirectObject.Delete().

override bool org.pdfclown.objects.PdfObjectWrapper.Equals | ( | object | obj | ) | `[inherited]`

References org.pdfclown.objects.PdfObjectWrapper.Equals().

static PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.GetBaseObject | ( | PdfObjectWrapper< PdfTextString > | wrapper | ) | `[static, inherited]`

Gets the PDF object backing the specified wrapper.

Parameters:

  | wrapper | Object to extract the base from.

References org.pdfclown.objects.PdfObjectWrapper.BaseObject.

override int org.pdfclown.objects.PdfObjectWrapper.GetHashCode | ( |  | ) | `[inherited]`

virtual PdfString org.pdfclown.objects.PdfObjectWrapper.RetrieveName | ( |  | ) | `[protected, virtual, inherited]`

Retrieves the name possibly associated to this object, walking through the document's name dictionary.

PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.RetrieveNamedBaseObject | ( |  | ) | `[protected, inherited]`

Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.

static LanguageIdentifier org.pdfclown.documents.interchange.access.LanguageIdentifier.Wrap | ( | PdfDirectObject | baseObject | ) | `[static]`

Wraps a language identifier base object into a language identifier object.

References org.pdfclown.objects.PdfObject.Resolve().

## Property Documentation

virtual PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.BaseObject`[get, set, inherited]`

Gets the underlying reference object, if available; otherwise, gets the underlying data object.

IList<string> org.pdfclown.documents.interchange.access.LanguageIdentifier.Components`[get, set]`

Gets the identifier components:

1. the first one is the primary code. It can be any of the following:
   - a 2-character ISO 639 language code (e.g.,

         en

     for English);
   - the letter

         i

     , designating an IANA-registered identifier;
   - the letter

         x

     , for private use;
2. the second one is the first subcode. It can be any of the following:
   - a 2-character ISO 3166 country code (e.g.,

         en-US

     );
   - a 3-to-8-character subcode registered with IANA (e.g.,

         en-cockney

     )
   - private non-registered subcodes;
3. subcodes beyond the first can be any that have been registered with IANA.

PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.Container`[get, inherited]`

Gets the indirect object containing the base object.

PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.DataContainer`[get, inherited]`

Gets the indirect object containing the base data object.

Document org.pdfclown.objects.PdfObjectWrapper.Document`[get, inherited]`

Gets the document context.

File org.pdfclown.objects.PdfObjectWrapper.File`[get, inherited]`

Gets the file context.

Copyright 2006-2013 Stefano Chizzolini. For more information, please visit PDF Clown home page.