PDFTron WebViewer

Class: RefreshOptions

Core.PDFNet.PDFDoc. RefreshOptions

new RefreshOptions()

Options for PDFNet.PDFDoc.RefreshAnnotAppearances or PDFNet.Annot.refreshAppearanceRefreshOptions

Methods

getDrawBackgroundOnly()

Gets the value DrawBackgroundOnly from the options object If true draw only the background and border, which can be useful when generating the rest of the annotation content elsewhere. Off by default.
Returns:
the current value for DrawBackgroundOnly.
Type
boolean

getRefreshExisting()

Gets the value RefreshExisting from the options object Whether we should refresh annotations with existing appearances. Defaults to false when used in PDFDoc.RefreshAnnotAppearances and true when used in Annot.RefreshAppearance.
Returns:
the current value for RefreshExisting.
Type
boolean

getUseNonStandardRotation()

Gets the value UseNonStandardRotation from the options object Whether we should use rotation in the annotation even if it is not a multiple of 90. Off by default.
Returns:
the current value for UseNonStandardRotation.
Type
boolean

getUseRoundedCorners()

Gets the value UseRoundedCorners from the options object Whether we should use the corner radii specified in Annot.BorderStyle. Off by default.
Returns:
the current value for UseRoundedCorners.
Type
boolean

setDrawBackgroundOnly(value)

Sets the value for DrawBackgroundOnly in the options object If true draw only the background and border, which can be useful when generating the rest of the annotation content elsewhere. Off by default.
Parameters:
Name Type Description
value boolean the new value for DrawBackgroundOnly
Returns:
this object, for call chaining
Type
Core.PDFNet.PDFDoc.RefreshOptions

setRefreshExisting(value)

Sets the value for RefreshExisting in the options object Whether we should refresh annotations with existing appearances. Defaults to false when used in PDFDoc.RefreshAnnotAppearances and true when used in Annot.RefreshAppearance.
Parameters:
Name Type Description
value boolean the new value for RefreshExisting
Returns:
this object, for call chaining
Type
Core.PDFNet.PDFDoc.RefreshOptions

setUseNonStandardRotation(value)

Sets the value for UseNonStandardRotation in the options object Whether we should use rotation in the annotation even if it is not a multiple of 90. Off by default.
Parameters:
Name Type Description
value boolean the new value for UseNonStandardRotation.
Returns:
this object, for call chaining
Type
Core.PDFNet.PDFDoc.RefreshOptions

setUseRoundedCorners(value)

Sets the value for UseRoundedCorners in the options object Whether we should use the corner radii specified in Annot.BorderStyle. Off by default.
Parameters:
Name Type Description
value boolean the new value for UseRoundedCorners.
Returns:
this object, for call chaining
Type
Core.PDFNet.PDFDoc.RefreshOptions