DsPdfJS API - v9.1.0
    Preparing search index...

    Class DefaultAppearance

    Represents the default appearance of an annotation.

    Hierarchy (View Summary)

    Index

    Accessors

    • get fontSize(): number | null

      Gets or sets the font size in points.

      In a newly created document the value of this property is null. If the value has not been set when the document is saved (and for fields, the owner field has been added to PdfDocument), a default value is automatically assigned depending on the type of the current object's owner:

      1. TextField, ComboBoxField, CombTextField, ListBoxField, PushButtonField The default font is Helvetica, 9pt, Black.
      2. CheckBoxField, RadioButtonField The default font is ZapfDingbats, 0 (meaning auto-size), Black. (Note that for these field types ZapfDingbats will always be used regardless of the current setting.)
      3. RedactAnnotation, FreeTextAnnotation The default font is Helvetica, 9pt, Black.

      Returns number | null

    • set fontSize(value: number | null): void

      Gets or sets the font size in points.

      In a newly created document the value of this property is null. If the value has not been set when the document is saved (and for fields, the owner field has been added to PdfDocument), a default value is automatically assigned depending on the type of the current object's owner:

      1. TextField, ComboBoxField, CombTextField, ListBoxField, PushButtonField The default font is Helvetica, 9pt, Black.
      2. CheckBoxField, RadioButtonField The default font is ZapfDingbats, 0 (meaning auto-size), Black. (Note that for these field types ZapfDingbats will always be used regardless of the current setting.)
      3. RedactAnnotation, FreeTextAnnotation The default font is Helvetica, 9pt, Black.

      Parameters

      • value: number | null

      Returns void

    • get foreColor(): Color | null

      Gets or sets the foreground color.

      In a newly created document the value of this property is null. If the value has not been set when the document is saved (and for fields, the owner field has been added to PdfDocument), a default value is automatically assigned depending on the type of the current object's owner:

      1. TextField, ComboBoxField, CombTextField, ListBoxField, PushButtonField The default font is Helvetica, 9pt, Black.
      2. CheckBoxField, RadioButtonField The default font is ZapfDingbats, 0 (meaning auto-size), Black. (Note that for these field types ZapfDingbats will always be used regardless of the current setting.)
      3. RedactAnnotation, FreeTextAnnotation The default font is Helvetica, 9pt, Black.

      Returns Color | null

    • set foreColor(value: Color | null): void

      Gets or sets the foreground color.

      In a newly created document the value of this property is null. If the value has not been set when the document is saved (and for fields, the owner field has been added to PdfDocument), a default value is automatically assigned depending on the type of the current object's owner:

      1. TextField, ComboBoxField, CombTextField, ListBoxField, PushButtonField The default font is Helvetica, 9pt, Black.
      2. CheckBoxField, RadioButtonField The default font is ZapfDingbats, 0 (meaning auto-size), Black. (Note that for these field types ZapfDingbats will always be used regardless of the current setting.)
      3. RedactAnnotation, FreeTextAnnotation The default font is Helvetica, 9pt, Black.

      Parameters

      Returns void

    • get id(): number

      Gets the reference to the object.

      Returns number

    • get text(): string | null

      Gets or sets the text representing the appearance as it will be stored in a PDF stream (e.g. "/DF0 10 Tf 0 0 0 rg").

      Please see the PDF specification for details.

      Returns string | null

    • set text(value: string | null): void

      Gets or sets the text representing the appearance as it will be stored in a PDF stream (e.g. "/DF0 10 Tf 0 0 0 rg").

      Please see the PDF specification for details.

      Parameters

      • value: string | null

      Returns void

    Methods

    • Detaches the object from the ObjectManager and deallocates its memory, if possible.

      Returns void