iText 9.1.0 API
iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance Class Reference

Helper class for setting annotation default appearance. More...

Public Member Functions

  AnnotationDefaultAppearance ()
  Creates the default instance of AnnotationDefaultAppearance. More...
 
virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance  SetFont (StandardAnnotationFont font)
  Sets the AnnotationDefaultAppearance 's default font. More...
 
virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance  SetFont (ExtendedAnnotationFont font)
  Sets the AnnotationDefaultAppearance 's default font. More...
 
virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance  SetFontSize (float fontSize)
  Sets the AnnotationDefaultAppearance 's default font size. More...
 
virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance  SetColor (DeviceRgb rgbColor)
  Sets the AnnotationDefaultAppearance 's default font color. More...
 
virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance  SetColor (DeviceCmyk cmykColor)
  Sets the AnnotationDefaultAppearance 's default font color. More...
 
virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance  SetColor (DeviceGray grayColor)
  Sets the AnnotationDefaultAppearance 's default font color. More...
 
virtual PdfString  ToPdfString ()
  Gets the AnnotationDefaultAppearance 's representation as iText.Kernel.Pdf.PdfString. More...
 

Detailed Description

Helper class for setting annotation default appearance.

Helper class for setting annotation default appearance. The class provides setters for font color, font size and font itself.

Note that only standard font names that do not require font resources are supported.

Note that it is possible to create annotation with custom font name in DA, but this require manual resource modifications (you have to put font in DR of AcroForm and use its resource name in DA) and only Acrobat supports that workflow.

Constructor & Destructor Documentation

◆ AnnotationDefaultAppearance()

iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance.AnnotationDefaultAppearance ( )
inline

Creates the default instance of AnnotationDefaultAppearance.

Creates the default instance of AnnotationDefaultAppearance.

The default font is StandardAnnotationFont.Helvetica . The default font size is 12.

Member Function Documentation

◆ SetColor() [1/3]

virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance.SetColor ( DeviceCmyk  cmykColor )
inlinevirtual

Sets the AnnotationDefaultAppearance 's default font color.

Parameters
cmykColor

iText.Kernel.Colors.DeviceCmyk to be set as the AnnotationDefaultAppearance 's default font color

Returns
this AnnotationDefaultAppearance

◆ SetColor() [2/3]

virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance.SetColor ( DeviceGray  grayColor )
inlinevirtual

Sets the AnnotationDefaultAppearance 's default font color.

Parameters
grayColor

iText.Kernel.Colors.DeviceGray to be set as the AnnotationDefaultAppearance 's default font color

Returns
this AnnotationDefaultAppearance

◆ SetColor() [3/3]

virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance.SetColor ( DeviceRgb  rgbColor )
inlinevirtual

Sets the AnnotationDefaultAppearance 's default font color.

Parameters
rgbColor

iText.Kernel.Colors.DeviceRgb to be set as the AnnotationDefaultAppearance 's default font color

Returns
this AnnotationDefaultAppearance

◆ SetFont() [1/2]

virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance.SetFont ( ExtendedAnnotationFont  font )
inlinevirtual

Sets the AnnotationDefaultAppearance 's default font.

Parameters
font one of extended annotation fonts to be set as the default one for this AnnotationDefaultAppearance
Returns
this AnnotationDefaultAppearance

◆ SetFont() [2/2]

virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance.SetFont ( StandardAnnotationFont  font )
inlinevirtual

Sets the AnnotationDefaultAppearance 's default font.

Parameters
font one of standard annotation fonts to be set as the default one for this AnnotationDefaultAppearance
Returns
this AnnotationDefaultAppearance

◆ SetFontSize()

virtual iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance.SetFontSize ( float  fontSize )
inlinevirtual

Sets the AnnotationDefaultAppearance 's default font size.

Parameters
fontSize font size to be set as the AnnotationDefaultAppearance 's default font size
Returns
this AnnotationDefaultAppearance

◆ ToPdfString()

virtual PdfString iText.Kernel.Pdf.Annot.DA.AnnotationDefaultAppearance.ToPdfString ( )
inlinevirtual

Gets the AnnotationDefaultAppearance 's representation as iText.Kernel.Pdf.PdfString.

Returns
the iText.Kernel.Pdf.PdfString representation of this AnnotationDefaultAppearance