PdfButtonWidgetFacade.IconOptions Property

Retrieves the button widget’s icon options.

Assembly : DevExpress.Pdf.v25.2.Core.dll

Declaration

C#
VB.NET

csharp

public PdfButtonWidgetIconOptions IconOptions { get; }

Public ReadOnly Property IconOptions As PdfButtonWidgetIconOptions

Property Value

Type	Description
PdfButtonWidgetIconOptions

The object that contains button icon options.

Remarks

Use the following methods to specify a button icon:

SetNormalIcon – Specifies the button icon displayed when the button is not clicked.
SetAlternateIcon – Specifies the button icon displayed when the user clicks the button, but before the button is released.
SetRolloverIcon – Specifies the button icon displayed when the mouse pointer hovers over the button.

The code sample below specifies a normal icon and its scale options:

C#
VB.NET

csharp

using (PdfDocumentProcessor pdfDocumentProcessor = new PdfDocumentProcessor())
{
    pdfDocumentProcessor.LoadDocument("Documents//FormDemo.pdf");

    PdfDocumentFacade documentFacade = pdfDocumentProcessor.DocumentFacade;
    PdfAcroFormFacade acroForm = documentFacade.AcroForm;

    //Change all form fields' color settings:
    var fields = acroForm.GetFields();
    foreach (PdfFormFieldFacade field in fields)
    {
        ChangeFormFieldColor(field);
    }

    //Obtain button form field parameters:
    PdfButtonFormFieldFacade pushButton = acroForm.GetButtonFormField("Submit");
    PdfButtonWidgetFacade buttonWidget = pushButton.Widgets[0];

    //Specify a button icon and set its options:
    buttonWidget.SetNormalIcon("Documents//submit_3802014.png");
    buttonWidget.IconOptions.FitToAnnotationBounds = true;
    buttonWidget.IconOptions.ScaleCondition = PdfIconScalingCircumstances.BiggerThanAnnotationRectangle;
    buttonWidget.TextPosition = PdfWidgetAnnotationTextPosition.NoCaption;
}

Using pdfDocumentProcessor As New PdfDocumentProcessor()
  pdfDocumentProcessor.LoadDocument("Documents//FormDemo.pdf")

  Dim documentFacade As PdfDocumentFacade = pdfDocumentProcessor.DocumentFacade
  Dim acroForm As PdfAcroFormFacade = documentFacade.AcroForm

  'Change all form fields' color settings:
  Dim fields = acroForm.GetFields()
  For Each field As PdfFormFieldFacade In fields
    ChangeFormFieldColor(field)
  Next field

  'Obtain button form field parameters:
  Dim pushButton As PdfButtonFormFieldFacade = acroForm.GetButtonFormField("Submit")
  Dim buttonWidget As PdfButtonWidgetFacade = pushButton.Widgets(0)

  'Specify a button icon and set its options:
  buttonWidget.SetNormalIcon("Documents//submit_3802014.png")
  buttonWidget.IconOptions.FitToAnnotationBounds = True
  buttonWidget.IconOptions.ScaleCondition = PdfIconScalingCircumstances.BiggerThanAnnotationRectangle
  buttonWidget.TextPosition = PdfWidgetAnnotationTextPosition.NoCaption
End Using