• Api Documentation
Show / Hide Table of Contents
  • pdftron
    • PDFNet
    • PDFNet.CharacterOrdering
    • PDFNet.CMSType
    • PDFNet.ConnectionErrorHandlingMode
    • PDFNet.ConnectionErrorProc
    • PDFNet.ConnectionErrorProcNative
    • PDFNetLoader
  • pdftron.Common
    • ByteRange
    • Iterator<T>
    • Matrix2D
    • PDFNetException
    • PDFNetException.ErrorCodes
    • ProgressMonitor
    • Utility
  • pdftron.Crypto
    • AlgorithmIdentifier
    • AlgorithmParams
    • DigestAlgorithm
    • DigestAlgorithm.Type
    • ObjectIdentifier
    • ObjectIdentifier.Predefined
    • RSASSAPSSParams
    • X501AttributeTypeAndValue
    • X501DistinguishedName
    • X509Certificate
    • X509Extension
  • pdftron.FDF
    • FDFDoc
    • FDFField
    • FDFFieldIterator
    • XFDFExportOptions
  • pdftron.Filters
    • Filter
    • Filter.ReferencePos
    • FilterReader
    • FilterWriter
    • FlateEncode
    • MappedFile
    • MappedFile.OpenMode
    • MemoryFilter
  • pdftron.Layout
    • ContentElement
    • ContentNode
    • ContentNodeIterator
    • FlowDocument
    • List
    • List.NumberFormat
    • ListItem
    • Paragraph
    • Paragraph.TextJustification
    • Table
    • TableCell
    • TableCell.CellAlignmentHorizontal
    • TableCell.CellAlignmentVertical
    • TableRow
    • TextRun
    • TextStyledElement
  • pdftron.PDF
    • Action
    • Action.FormActionFlag
    • Action.Type
    • ActionParameter
    • AdvancedImagingConvertOptions
    • AdvancedImagingModule
    • Annot
    • Annot.AnnotationState
    • Annot.BorderStyle
    • Annot.BorderStyle.Style
    • Annot.Flag
    • Annot.Type
    • BitmapInfo
    • Bookmark
    • CADConvertOptions
    • CADConvertOptions.LayoutSortOrder
    • CADModule
    • CharData
    • CharIterator
    • CMSSignatureOptions
    • ColorPt
    • ColorSpace
    • ColorSpace.Type
    • ContentReplacer
    • ConversionOptions
    • Convert
    • Convert.EPUBOutputOptions
    • Convert.ExcelOutputOptions
    • Convert.ExcelOutputOptions.SearchableImageSetting
    • Convert.FlattenFlag
    • Convert.FlattenThresholdFlag
    • Convert.HTMLOutputOptions
    • Convert.HTMLOutputOptions.ContentReflowSetting
    • Convert.HTMLOutputOptions.SearchableImageSetting
    • Convert.OutputOptionsOCR
    • Convert.OutputOptionsOCR.LanguageChoice
    • Convert.OutputOptionsOCR.PreferredOCREngine
    • Convert.PowerPointOutputOptions
    • Convert.PowerPointOutputOptions.SearchableImageSetting
    • Convert.Printer
    • Convert.Printer.Mode
    • Convert.SVGOutputOptions
    • Convert.TiffOutputOptions
    • Convert.WordOutputOptions
    • Convert.WordOutputOptions.SearchableImageSetting
    • Convert.WordOutputOptions.WordOutputFormat
    • Convert.XODOutputOptions
    • Convert.XODOutputOptions.AnnotationOutputFlag
    • Convert.XPSOutputCommonOptions
    • Convert.XPSOutputOptions
    • DataExtractionModule
    • DataExtractionModule.DataExtractionEngine
    • DataExtractionOptions
    • Date
    • Destination
    • Destination.FitType
    • DiffOptions
    • DigitalSignatureField
    • DigitalSignatureField.DocumentPermissions
    • DigitalSignatureField.FieldPermissions
    • DigitalSignatureField.SubFilterType
    • DigitalSignatureFieldIterator
    • DisallowedChange
    • DisallowedChange.Type
    • DocumentConversion
    • DocumentConversionResult
    • Element
    • Element.Type
    • ElementBuilder
    • ElementReader
    • ElementWriter
    • ElementWriter.WriteMode
    • EmbeddedTimestampVerificationResult
    • Field
    • Field.EventType
    • Field.Flag
    • Field.TextJustification
    • Field.Type
    • FieldIterator
    • FileSpec
    • Flattener
    • Flattener.FlattenMode
    • Flattener.Threshold
    • Font
    • Font.Encoding
    • Font.StandardType1Font
    • Font.Type
    • FontCharCodeIterator
    • Function
    • Function.Type
    • GeometryCollection
    • GeometryCollectionSnappingMode
    • GSChangesIterator
    • GState
    • GState.BlendMode
    • GState.GStateAttribute
    • GState.LineCap
    • GState.LineJoin
    • GState.RenderingIntent
    • GState.TextRenderingMode
    • Highlights
    • HTML2PDF
    • HTML2PDF.Proxy
    • HTML2PDF.Proxy.Type
    • HTML2PDF.TOCSettings
    • HTML2PDF.WebPageSettings
    • HTML2PDF.WebPageSettings.ErrorHandling
    • Image
    • Image.InputFilter
    • Image2RGB
    • Image2RGBA
    • MergeXFDFOptions
    • OCRModule
    • OCROptions
    • OfficeToPDFOptions
    • OfficeToPDFOptions.StructureTagLevel
    • Optimizer
    • Optimizer.ImageSettings
    • Optimizer.ImageSettings.CompressionMode
    • Optimizer.ImageSettings.DownsampleMode
    • Optimizer.MonoImageSettings
    • Optimizer.MonoImageSettings.CompressionMode
    • Optimizer.MonoImageSettings.DownsampleMode
    • Optimizer.OptimizerSettings
    • Optimizer.TextSettings
    • OptionsBase
    • Page
    • Page.Box
    • Page.Rotate
    • PageIterator
    • PageLabel
    • PageLabel.Style
    • PageSet
    • PageSet.Filter
    • PathData
    • PathData.PathSegmentType
    • PatternColor
    • PatternColor.TilingType
    • PatternColor.Type
    • PDF2HtmlReflowParagraphsModule
    • PDF2WordModule
    • PDFDoc
    • PDFDoc.ExtractFlag
    • PDFDoc.FlattenAnnotationFlag
    • PDFDoc.InsertFlag
    • PDFDoc.SignaturesVerificationStatus
    • PDFDocGenerator
    • PDFDocInfo
    • PDFDocViewPrefs
    • PDFDocViewPrefs.PageLayout
    • PDFDocViewPrefs.PageMode
    • PDFDocViewPrefs.ViewerPref
    • PDFDraw
    • PDFDraw.PixelFormat
    • PDFNetInternalTools
    • PDFNetInternalToolsLogBackend
    • PDFNetInternalToolsLogLevel
    • PDFRasterizer
    • PDFRasterizer.ColorPostProcessMode
    • PDFRasterizer.OverprintPreviewMode
    • PDFRasterizer.Type
    • Point
    • Print
    • PrinterMode
    • PrinterMode.DuplexMode
    • PrinterMode.NUp
    • PrinterMode.NUpPageOrder
    • PrinterMode.Orientation
    • PrinterMode.OutputColor
    • PrinterMode.OutputQuality
    • PrinterMode.PaperSize
    • PrinterMode.PrintContentTypes
    • PrinterMode.ScaleType
    • PrintToPdfModule
    • PrintToPdfOptions
    • QuadPoint
    • Rect
    • RectCollection
    • Redactor
    • Redactor.Appearance
    • Redactor.Redaction
    • Reflow
    • RefreshOptions
    • Shading
    • Shading.Type
    • ShapedText
    • ShapedText.FailureReason
    • ShapedText.ShapingStatus
    • Stamper
    • Stamper.HorizontalAlignment
    • Stamper.SizeType
    • Stamper.TextAlignment
    • Stamper.VerticalAlignment
    • StructuredOutputModule
    • SVGConvertOptions
    • TemplateDocument
    • TemplateDocumentResult
    • TextDiffOptions
    • TextExtractor
    • TextExtractor.CharRange
    • TextExtractor.Line
    • TextExtractor.ProcessingFlags
    • TextExtractor.Style
    • TextExtractor.Word
    • TextExtractor.XMLOutputFlags
    • TextRange
    • TextSearch
    • TextSearch.ResultCode
    • TextSearch.SearchMode
    • TimestampingConfiguration
    • TimestampingResult
    • TrustVerificationResult
    • VerificationOptions
    • VerificationOptions.CertificateTrustFlag
    • VerificationOptions.SignatureVerificationSecurityLevel
    • VerificationOptions.TimeMode
    • VerificationResult
    • VerificationResult.DigestStatus
    • VerificationResult.DocumentStatus
    • VerificationResult.ModificationPermissionsStatus
    • VerificationResult.TrustStatus
    • ViewChangeCollection
    • ViewerOptimizedOptions
    • WebFontDownloader
    • WordToPDFOptions
  • pdftron.PDF.Annots
    • Caret
    • CheckBoxWidget
    • Circle
    • ComboBoxWidget
    • FileAttachment
    • FileAttachment.Icon
    • FreeText
    • FreeText.IntentName
    • Highlight
    • Ink
    • Line
    • Line.CapPos
    • Line.EndingStyle
    • Line.IntentType
    • Link
    • Link.HighlightingMode
    • ListBoxWidget
    • Markup
    • Markup.BorderEffect
    • Movie
    • Polygon
    • PolyLine
    • PolyLine.IntentType
    • Popup
    • PushButtonWidget
    • RadioButtonGroup
    • RadioButtonWidget
    • Redaction
    • Redaction.QuadForm
    • RubberStamp
    • RubberStamp.Icon
    • Screen
    • Screen.IconCaptionRelation
    • Screen.ScaleCondition
    • Screen.ScaleType
    • SignatureWidget
    • Sound
    • Sound.Icon
    • Square
    • Squiggly
    • StrikeOut
    • Text
    • Text.Icon
    • TextMarkup
    • TextWidget
    • Underline
    • Watermark
    • Widget
    • Widget.HighlightingMode
    • Widget.IconCaptionRelation
    • Widget.ScaleCondition
    • Widget.ScaleType
  • pdftron.PDF.OCG
    • Config
    • Context
    • Context.OCDrawMode
    • Group
    • OCMD
    • OCMD.VisibilityPolicyType
  • pdftron.PDF.PDFA
    • PDFACompliance
    • PDFACompliance.Conformance
    • PDFACompliance.ErrorCode
    • PDFAOptions
  • pdftron.PDF.Struct
    • ContentItem
    • ContentItem.Type
    • SElement
    • STree
  • pdftron.SDF
    • DictIterator
    • DocSnapshot
    • NameTree
    • NameTreeIterator
    • NumberTreeIterator
    • Obj
    • Obj.ObjType
    • ObjSet
    • PDFTronCustomSecurityHandler
    • ResultSnapshot
    • SDFDoc
    • SDFDoc.SaveOptions
    • SecurityHandler
    • SecurityHandler.AlgorithmType
    • SecurityHandler.Permission
    • SignatureHandler
    • SignatureHandlerId
    • UndoManager

Class PushButtonWidget

An object representing a push button used in a PDF Form.

Inheritance
object
Annot
Widget
PushButtonWidget
Implements
IDisposable
Inherited Members
Widget.Create(SDFDoc, Rect, Field)
Widget.GetField()
Widget.GetHighlightingMode()
Widget.SetHighlightingMode(Widget.HighlightingMode)
Widget.GetAction()
Widget.SetAction(Action)
Widget.GetBorderColorCompNum()
Widget.GetBorderColor()
Widget.SetBorderColor(ColorPt, int)
Widget.GetBackgroundColorCompNum()
Widget.GetBackgroundColor()
Widget.SetBackgroundColor(ColorPt, int)
Widget.GetStaticCaptionText()
Widget.SetStaticCaptionText(string)
Widget.GetRolloverCaptionText()
Widget.SetRolloverCaptionText(string)
Widget.GetMouseDownCaptionText()
Widget.SetMouseDownCaptionText(string)
Widget.GetStaticIcon()
Widget.SetStaticIcon(Obj)
Widget.GetRolloverIcon()
Widget.SetRolloverIcon(Obj)
Widget.GetMouseDownIcon()
Widget.SetMouseDownIcon(Obj)
Widget.GetScaleType()
Widget.SetScaleType(Widget.ScaleType)
Widget.GetIconCaptionRelation()
Widget.SetIconCaptionRelation(Widget.IconCaptionRelation)
Widget.GetScaleCondition()
Widget.SetScaleCondition(Widget.ScaleCondition)
Widget.GetHIconLeftOver()
Widget.SetHIconLeftOver(double)
Widget.GetVIconLeftOver()
Widget.SetVIconLeftOver(double)
Widget.GetFitFull()
Widget.SetFitFull(bool)
Widget.SetTextColor(ColorPt, int)
Widget.GetTextColor()
Widget.GetTextColorCompNum()
Widget.SetFontSize(double)
Widget.GetFontSize()
Widget.SetFont(Font)
Widget.GetFont()
Annot.Dispose()
Annot.Dispose(bool)
Annot.GetHandleInternal()
Annot.GetRefHandleInternal()
Annot.CreateInternal(IntPtr, object)
Annot.Create(SDFDoc, Annot.Type, Rect)
Annot.op_Assign(Annot)
Annot.Equals(object)
Annot.IsValid()
Annot.GetSDFObj()
Annot.GetType()
Annot.IsMarkup()
Annot.GetRect()
Annot.GetVisibleContentBox()
Annot.SetRect(Rect)
Annot.GetContents()
Annot.SetContents(string)
Annot.GetPage()
Annot.SetPage(Page)
Annot.GetUniqueID()
Annot.SetUniqueID(string)
Annot.GetDate()
Annot.SetDate(Date)
Annot.GetFlag(Annot.Flag)
Annot.SetFlag(Annot.Flag, bool)
Annot.GetBorderStyle()
Annot.SetBorderStyle(Annot.BorderStyle)
Annot.GetAppearance()
Annot.GetAppearance(Annot.AnnotationState)
Annot.GetAppearance(Annot.AnnotationState, string)
Annot.SetAppearance(Obj)
Annot.SetAppearance(Obj, Annot.AnnotationState)
Annot.SetAppearance(Obj, Annot.AnnotationState, string)
Annot.RemoveAppearance()
Annot.RemoveAppearance(Annot.AnnotationState)
Annot.RemoveAppearance(Annot.AnnotationState, string)
Annot.Flatten(Page)
Annot.GetActiveAppearanceState()
Annot.SetActiveAppearanceState(string)
Annot.GetColorAsRGB()
Annot.GetColorAsCMYK()
Annot.GetColorAsGray()
Annot.GetColorCompNum()
Annot.SetColor(ColorPt, int)
Annot.SetColor(ColorPt)
Annot.GetStructParent()
Annot.SetStructParent(int)
Annot.GetOptionalContent()
Annot.SetOptionalContent(Obj)
Annot.Resize(Rect)
Annot.GetRotation()
Annot.SetRotation(int)
Annot.RefreshAppearance()
Annot.GetCustomData(string)
Annot.SetCustomData(string, string)
Annot.DeleteCustomData(string)
object.Equals(object, object)
object.GetHashCode()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: pdftron.PDF.Annots
Assembly: PDFTronDotNet.dll
Syntax
public class PushButtonWidget : Widget, IDisposable

Constructors

PushButtonWidget(Annot)

Creates a Push Button Widget annotation and initialize it using given annotation object.

Declaration
public PushButtonWidget(Annot ann)
Parameters
Type Name Description
Annot ann

the annotation from which to create a Push Button Widget

Remarks

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

PushButtonWidget(Obj)

Creates a Push Button Widget annotation and initialize it using given Cos/SDF object.

Declaration
public PushButtonWidget(Obj d)
Parameters
Type Name Description
Obj d

The object to use to initialize the PushButtonWidget

Remarks

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Methods

Create(PDFDoc, Rect)

Creates a new PushButton widget annotation, in the specified document.

Declaration
public static PushButtonWidget Create(PDFDoc doc, Rect pos)
Parameters
Type Name Description
PDFDoc doc

The document to which the annotation is added.

Rect pos

A rectangle specifying the annotation's bounds, specified in user space coordinates.

Returns
Type Description
PushButtonWidget

A newly created default Push Button Widget annotation.

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

Create(PDFDoc, Rect, string)

Creates a new Push Button Widget annotation, in the specified document.

Declaration
public static PushButtonWidget Create(PDFDoc doc, Rect pos, string field_name)
Parameters
Type Name Description
PDFDoc doc

The document to which the annotation is added.

Rect pos

A rectangle specifying the annotation's bounds, specified in user space coordinates.

string field_name

The name of the field for which to create a PushButton widget

Returns
Type Description
PushButtonWidget

A newly created default Push Button Widget annotation.

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

Create(PDFDoc, Rect, Field)

Creates a new Push Button Widget annotation, in the specified document.

Declaration
public static PushButtonWidget Create(PDFDoc doc, Rect pos, Field field)
Parameters
Type Name Description
PDFDoc doc

A document to which the annotation is added.

Rect pos

A rectangle specifying the annotation's bounds, specified in user space coordinates.

Field field

the field for which to create a Push Button Widget

Returns
Type Description
PushButtonWidget

A newly created default Push Button Widget annotation.

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

Implements

IDisposable
In This Article
Back to top Generated by DocFX