Skip to content

# PDFVisualPushButtonWidget

Namespace: O2S.Components.PDF4NET.View.Forms

Defines a pushbutton widget that is displayed in a control.

    public class PDFVisualPushButtonWidget : PDFVisualFieldWidget

Inheritance Object → PDFVisualAnnotation → PDFVisualFieldWidget → PDFVisualPushButtonWidget

## Constructors

### PDFVisualPushButtonWidget(PDFPushButtonWidget)

Initializes a new PDFVisualPushButtonWidget object.

    public PDFVisualPushButtonWidget(PDFPushButtonWidget fieldWidget)

Parameters

`fieldWidget` PDFPushButtonWidget
The underlying field widget.

## Properties

### Align

Gets or sets the caption alignment.

    public PDFStringHorizontalAlign Align { get; set; }

Property Value

PDFStringHorizontalAlign
The aligment of the widget caption.

### Annotation

Gets the underlying PDF annotation.

    public PDFAnnotation Annotation { get; }

Property Value

PDFAnnotation
A PDF annotation.

### BackgroundColor

Gets or sets the widget background color.

    public PDFColor BackgroundColor { get; set; }

Property Value

PDFColor
A specifying the widget's background color.

Exceptions

ArgumentOutOfRangeException
Thrown when the property is set to a color other than Gray, RGB or CMYK.

### BorderColor

Gets or sets the widget border color.

    public PDFColor BorderColor { get; set; }

Property Value

PDFColor
A specifying the widget's border color.

Exceptions

ArgumentOutOfRangeException
Thrown when the property is set to a color other than Gray, RGB or CMYK.

### BorderDashPattern

Gets or sets the array that represents the dash pattern when the PDFVisualFieldWidget.BorderStyle property is set to .

    public Double[] BorderDashPattern { get; set; }

Property Value

Double[]
An array of double values specifying the style of the dashed line.

### BorderStyle

Gets or sets the widget border style.

    public PDFAnnotationBorderStyle BorderStyle { get; set; }

Property Value

PDFAnnotationBorderStyle
A enum specifying the style of the widget border.

### BorderWidth

Gets or sets the widget border width.

    public double BorderWidth { get; set; }

Property Value

Double
A specifying the widget's border width.

### Caption

Gets or sets the widget caption.

    public string Caption { get; set; }

Property Value

String
The text displayed on the pushbutton widget.

### DisplayRectangle

Gets or sets the visual rectangle of this annotation.

    public PDFDisplayRectangle DisplayRectangle { get; set; }

Property Value

PDFDisplayRectangle
A that represents the position and size of the annotation on the page.

Remarks

The visual rectangle is relative to the top left corner of the page.

### HighlightMode

Gets or sets the highlighting of the button widget.

    public PDFPushButtonHighlightMode HighlightMode { get; set; }

Property Value

PDFPushButtonHighlightMode
A that specifies how the pushbutton widget is highlighted when it is clicked.

### Icon

Gets or sets the widget icon.

    public PDFFormXObject Icon { get; set; }

Property Value

PDFFormXObject
A that represents the widget icon.

### IconLayout

Gets or sets the layout for the widget icon.

    public PDFPushButtonIconLayout IconLayout { get; set; }

Property Value

PDFPushButtonIconLayout
A that specifies the layout of the icon within the widget appearance.

### IconSize

Gets or sets the display size of the widget icon.

    public PDFSize IconSize { get; set; }

Property Value

PDFSize
A that represents the size used to draw the icon on the widget.

Remarks

The icon is scaled to fit the display size.

### NormalAppearance

Gets or sets the annotation normal appearance.

    public PDFAnnotationAppearance NormalAppearance { get; set; }

Property Value

PDFAnnotationAppearance
A specifying how the annotation is presented visually on the page.

### PushButtonWidget

Gets the underlying pushbutton widget.

    public PDFPushButtonWidget PushButtonWidget { get; }

Property Value

PDFPushButtonWidget
A object representing the non-visual pushbutton widget.

### Tag

Gets or sets an object that contains user-defined data associated with the annotation.

    public object Tag { get; set; }

Property Value

Object

Remarks

This property can be used to store any custom information relevant to the annotation at runtime. The value is not used by the annotation itself and is intended solely for application-specific data.
NOTE: The value of this property is not persisted in the PDF file.

### VisualField

Gets the visual field that owns this widget.

    public PDFVisualField VisualField { get; internal set; }

Property Value

PDFVisualField
A PDFVisualField descendant that represents a field in the PDF document.

### VisualPage

Gets the page that owns the anotation.

    public PDFVisualPage VisualPage { get; internal set; }

Property Value

PDFVisualPage
The PDFVisualPage that owns the annotation.

### Widget

Gets the underlying field widget.

    public PDFFieldWidget Widget { get; }

Property Value

PDFFieldWidget
A object representing the non-visual field widget.