IPdfTagOptions Interface

Represents the IPdfTag settings used by PdfDocument.tag method.

Heirarchy

IPdfTagOptions

Properties

Optional actual

actual: string

Text that is an exact replacement for the tag element and its children.

The default value is undefined which means that the tag element has no replacement.

Optional alt

alt: string

An alternative description of the tag element and its children in human-redable form.

The default value is undefined which means that the tag element does not have an alternative description.

Optional expanded

expanded: string

The expanded form of an abbreviation (PDF 1.5)

The default value is undefined which means that the tag element does not have the expanded form of an abbreviation.

Optional lang

lang: string

A language code specifying the natural language for all text in the tag element.

The language code is a 2-character ISO 639 language code (e.g. "en" for English or "ja" for Japanese) followed by an optional 2-character ISO 3166 country code (e.g. "US" for the United States or "JP" for Japan). For example: "en", "en-US", "ja-JP".

The default value is undefined which means that the tag element does not have the default natural language.

Optional title

title: string

The title of the tag element, a text string representing it in human-redable form.

The default value is undefined which means that the tag element has no title.