Class RefreshOptions

Inheritance

object

OptionsBase

RefreshOptions

Inherited Members

OptionsBase.mObjSet

OptionsBase.ColorPtToNumber(ColorPt)

OptionsBase.ColorPtFromNumber(double)

OptionsBase.GetArray(string)

OptionsBase.PutNumber(string, double)

OptionsBase.PutBool(string, bool)

OptionsBase.PutText(string, string)

OptionsBase.PutRect(string, Rect)

OptionsBase.PushBackNumber(string, double)

OptionsBase.PushBackBool(string, bool)

OptionsBase.PushBackText(string, string)

OptionsBase.PushBackRect(string, Rect)

OptionsBase.RectFromArray(Obj)

OptionsBase.insertRectCollection(string, RectCollection, int)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: pdftron.PDF

Assembly: PDFNet.dll

Syntax

public class RefreshOptions : OptionsBase

Constructors

RefreshOptions()

Constructor.

Declaration

public RefreshOptions()

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.

Declaration

public bool GetDrawBackgroundOnly()

Returns

Type	Description
bool	the current value for DrawBackgroundOnly.

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.

Declaration

public bool GetRefreshExisting()

Returns

Type	Description
bool	the current value for RefreshExisting.

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.

Declaration

public bool GetUseNonStandardRotation()

Returns

Type	Description
bool	the current value for UseNonStandardRotation.

GetUseRoundedCorners()

Gets the value UseRoundedCorners from the options object Whether we should use the corner radii specified in Annot.BorderStyle. Off by default.

Declaration

public bool GetUseRoundedCorners()

Returns

Type	Description
bool	the current value for UseRoundedCorners.

SetDrawBackgroundOnly(bool)

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.

Declaration

public RefreshOptions SetDrawBackgroundOnly(bool value)

Parameters

Type	Name	Description
bool	value	the new value for DrawBackgroundOnly.

Returns

Type	Description
RefreshOptions	this object, for call chaining

SetRefreshExisting(bool)

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.

Declaration

public RefreshOptions SetRefreshExisting(bool value)

Parameters

Type	Name	Description
bool	value	value the new value for RefreshExisting.

Returns

Type	Description
RefreshOptions	this object, for call chaining

SetUseNonStandardRotation(bool)

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.

Declaration

public RefreshOptions SetUseNonStandardRotation(bool value)

Parameters

Type	Name	Description
bool	value	value the new value for UseNonStandardRotation.

Returns

Type	Description
RefreshOptions	this object, for call chaining

SetUseRoundedCorners(bool)

Sets the value for UseRoundedCorners in the options object Whether we should use the corner radii specified in Annot.BorderStyle. Off by default.

Declaration

public RefreshOptions SetUseRoundedCorners(bool value)

Parameters

Type	Name	Description
bool	value	value the new value for UseRoundedCorners.

Returns

Type	Description
RefreshOptions	this object, for call chaining