Click or drag to resize

PdfButtonAppearance Class

Represents an appearance settings for a PdfButtonField.
Inheritance Hierarchy
SystemObject
  SautinSoft.Pdf.AnnotationsPdfAppearance
    SautinSoft.Pdf.FormsPdfFieldAppearance
      SautinSoft.Pdf.FormsPdfButtonAppearance

Namespace: SautinSoft.Pdf.Forms
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.11.26
Syntax
public sealed class PdfButtonAppearance : PdfFieldAppearance

The PdfButtonAppearance type exposes the following members.

Properties
 NameDescription
Public propertyBackgroundColor Gets or sets the background color of the button appearance.
Public propertyBorderColor Gets or sets the border color of the button appearance.
Public propertyBorderDashPattern Gets or sets the border dash pattern of the button appearance.
Public propertyBorderStyle Gets or sets the border style of the button appearance.
Public propertyBorderWidth Gets or sets the border thickness of the button appearance.
Public propertyFontColor Gets or sets the font color of the button appearance text.
Public propertyFontFace Gets or sets the font face of the button appearance text.
Public propertyFontSize

Gets or sets the font size of the button appearance text.

A zero value for size means that the font shall be auto-sized: its size shall be computed as a function of the size of the annotation rectangle.

Public propertyIcon Gets or sets the icon.
Public propertyIconAlignment

Gets or sets the two numbers that shall be between 0.0 and 1.0 indicating the fraction of leftover space to allocate at the left and bottom of the Icon.

A value of (0.0, 0.0) shall position the icon at the bottom-left corner of the annotation rectangle.

A value of (0.5, 0.5) shall center it within the rectangle.

This entry shall be used only if the icon is scaled proportionally.

Public propertyIconFitToBounds(Optional; PDF 1.5) If , indicates that the button appearance shall be scaled to fit fully within the bounds of the annotation without taking into consideration the line width of the border.
Public propertyIconScaleCondition Gets or sets the condition under which the Icon shall be scaled inside the annotation rectangle.
Public propertyIconScaleProportional

Gets or sets a value indicating whether to scale the Icon to fit the width or height of the annotation rectangle while maintaining the icon's original aspect ratio.

If the required horizontal and vertical scaling factors are different, the smaller of the two is used, centering the icon within the annotation rectangle in the other dimension.

If , the Icon is scaled to fill the annotation rectangle exactly, without regard to its original aspect ratio (ratio of width to height).

Public propertyLabel Gets or sets the label.
Public propertyLabelPlacement Gets or sets the placement of the Label relative to its Icon.
Top
Methods
 NameDescription
Public methodGetIcon Gets the icon for the specified appearance trigger.
Public methodGetLabel Gets the label for the specified appearance trigger.
Public methodSetIcon Sets the icon for the specified appearance trigger.
Public methodSetLabel Sets the label for the specified appearance trigger.
Top
See Also