• Api Documentation
Show / Hide Table of Contents
  • pdftron
    • PDFNet
    • PDFNet.CharacterOrdering
    • PDFNet.CMSType
    • PDFNet.ConnectionErrorHandlingMode
    • PDFNet.ConnectionErrorProcDelegate
  • pdftron.Common
    • ByteRange
    • Matrix2D
    • PDFNetException
    • PDFNetException.ErrorCodes
    • ProgressMonitor
  • pdftron.Crypto
    • AlgorithmIdentifier
    • AlgorithmParams
    • DigestAlgorithm
    • DigestAlgorithm.Type
    • ObjectIdentifier
    • ObjectIdentifier.Predefined
    • RSASSAPSSParams
    • X501AttributeTypeAndValue
    • X501DistinguishedName
    • X509Certificate
    • X509Extension
  • pdftron.FDF
    • FDFDoc
    • FDFField
    • FDFFieldIterator
    • XFDFExportOptions
  • pdftron.Filters
    • ASCII85Encode
    • Filter
    • Filter.ReferencePos
    • FilterReader
    • FilterWriter
    • FlateEncode
    • MappedFile
    • MappedFile.OpenMode
    • MemoryFilter
    • StreamAdapterFilter
  • 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.EventType
    • Annot.Flag
    • Annot.Type
    • Bookmark
    • CADConvertOptions
    • CADConvertOptions.LayoutSortOrder
    • CADModule
    • CancelRequestRenderThread
    • 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.WPFConverterOptions
    • Convert.WPFConverterOptions.DrawHeaderFooter
    • Convert.XODOutputOptions
    • Convert.XODOutputOptions.AnnotationOutputFlag
    • Convert.XPSOutputCommonOptions
    • Convert.XPSOutputOptions
    • CubicCurveBuilder
    • DataExtractionModule
    • DataExtractionModule.DataExtractionEngine
    • DataExtractionOptions
    • Date
    • Destination
    • Destination.FitType
    • DiffOptions
    • DigitalSignatureField
    • DigitalSignatureField.DocumentPermissions
    • DigitalSignatureField.FieldPermissions
    • DigitalSignatureField.SubFilterType
    • DigitalSignatureFieldIterator
    • DisallowedChange
    • DisallowedChange.Type
    • DocumentConversion
    • DocumentConversionResult
    • DownloadedType
    • 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
    • HTTPRequestOptions
    • Image
    • Image.InputFilter
    • Image2RGB
    • KeyStrokeActionResult
    • KeyStrokeEventData
    • 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.EventType
    • Page.Rotate
    • PageIterator
    • PageLabel
    • PageLabel.Style
    • PageSet
    • PageSet.Filter
    • PathData
    • PathData.PathSegmentType
    • PatternColor
    • PatternColor.TilingType
    • PatternColor.Type
    • PDF2HtmlReflowParagraphsModule
    • PDF2WordModule
    • PDFDC
    • PDFDCEX
    • PDFDoc
    • PDFDoc.EventType
    • PDFDoc.ExtractFlag
    • PDFDoc.InsertFlag
    • PDFDoc.SignaturesVerificationStatus
    • PDFDocInfo
    • PDFDocViewPrefs
    • PDFDocViewPrefs.PageLayout
    • PDFDocViewPrefs.PageMode
    • PDFDocViewPrefs.ViewerPref
    • PDFDraw
    • PDFNetInternalTools
    • PDFNetInternalToolsLogBackend
    • PDFNetInternalToolsLogLevel
    • PDFRasterizer
    • PDFRasterizer.ColorPostProcessMode
    • PDFRasterizer.OverprintPreviewMode
    • PDFRasterizer.Type
    • PDFViewAnnotationEditPermissionDelegate
    • PDFViewCtrl
    • PDFViewCtrl.LinkInfo
    • PDFViewCtrl.PagePresentationMode
    • PDFViewCtrl.PageViewMode
    • PDFViewCtrl.PanelType
    • PDFViewCtrl.PDFViewCtrlWindowType
    • PDFViewCtrl.PDFViewFindTextAsyncDelegate
    • PDFViewCtrl.PDFViewRenderWorkerDelegate
    • PDFViewCtrl.Selection
    • PDFViewCtrl.TextSelectionMode
    • PDFViewCtrl.ToolMode
    • PDFViewCurrentPageDelegate
    • PDFViewDownloadDelegate
    • PDFViewErrorDelegate
    • PDFViewThumbAsyncDelegate
    • PDFViewWPF
    • PDFViewWPF.ActionEventArgs
    • PDFViewWPF.CurrentPageNumberChangedHandler
    • PDFViewWPF.CurrentScrollChangedHandler
    • PDFViewWPF.CurrentZoomChangedHandler
    • PDFViewWPF.FindTextFinsihedHandler
    • PDFViewWPF.LayoutChangedHandler
    • PDFViewWPF.LinkInfo
    • PDFViewWPF.OnActionEventHandler
    • PDFViewWPF.OnConversionEventHandler
    • PDFViewWPF.OnRenderFinishedEventHandler
    • PDFViewWPF.OnSetdocHandler
    • PDFViewWPF.OnThumbnailGeneratedEventHandler
    • PDFViewWPF.OverprintPreviewMode
    • PDFViewWPF.PagePresentationMode
    • PDFViewWPF.PageViewMode
    • PDFViewWPF.PDFViewWPFConversionType
    • PDFViewWPF.Selection
    • PDFViewWPF.TextSelectionMode
    • 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
    • Separation
    • Shading
    • Shading.Type
    • ShapedText
    • ShapedText.FailureReason
    • ShapedText.ShapingStatus
    • Stamper
    • Stamper.HorizontalAlignment
    • Stamper.SizeType
    • Stamper.TextAlignment
    • Stamper.VerticalAlignment
    • StructuredOutputModule
    • SVGConvertOptions
    • SVGParser
    • TemplateDocument
    • TemplateDocumentResult
    • TextDiffOptions
    • TextExtractor
    • TextExtractor.CharRange
    • TextExtractor.Line
    • TextExtractor.ProcessingFlags
    • TextExtractor.Style
    • TextExtractor.Word
    • TextExtractor.XMLOutputFlags
    • TextRange
    • TextSearch
    • TextSearch.ResultCode
    • TextSearch.SearchMode
    • TileInTransit
    • TimestampingConfiguration
    • TimestampingResult
    • TrustVerificationResult
    • VerificationOptions
    • VerificationOptions.CertificateTrustFlag
    • VerificationOptions.SignatureVerificationSecurityLevel
    • VerificationOptions.TimeMode
    • VerificationResult
    • VerificationResult.DigestStatus
    • VerificationResult.DocumentStatus
    • VerificationResult.ModificationPermissionsStatus
    • VerificationResult.TrustStatus
    • ViewChangeCollection
    • ViewerOptimizedOptions
    • 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.Details
    • AnnotManager
    • AnnotTile
    • BlendEffect
  • 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
    • CreateDelegate
    • DictIterator
    • DocSnapshot
    • NameTree
    • NameTreeIterator
    • NumberTreeIterator
    • Obj
    • Obj.ObjType
    • ObjSet
    • PDFTronCustomSecurityHandler
    • ResultSnapshot
    • SDFDoc
    • SDFDoc.SaveOptions
    • SecurityDescriptor
    • SecurityHandler
    • SecurityHandler.Permission
    • SecurityManager
    • SecurityManagerSingleton
    • SignatureHandler
    • SignatureHandlerId
    • StdSecurityHandler
    • StdSecurityHandler.AlgorithmType
    • UndoManager

Class TextWidget

An object representing a Text Box used in a PDF Form.

Inheritance
object
Annot
Widget
TextWidget
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.GetTextColor()
Widget.GetTextColorCompNum()
Widget.SetTextColor(ColorPt, int)
Widget.GetFontSize()
Widget.SetFontSize(double)
Widget.GetFont()
Widget.SetFont(Font)
Annot.GetTriggerAction(Annot.EventType)
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.AnnotationState, string)
Annot.GetAppearance(Annot.AnnotationState)
Annot.GetAppearance()
Annot.SetAppearance(Obj, Annot.AnnotationState, string)
Annot.SetAppearance(Obj, Annot.AnnotationState)
Annot.SetAppearance(Obj)
Annot.RemoveAppearance(Annot.AnnotationState, string)
Annot.RemoveAppearance(Annot.AnnotationState)
Annot.RemoveAppearance()
Annot.Flatten(Page)
Annot.GetActiveAppearanceState()
Annot.SetActiveAppearanceState(string)
Annot.GetColorAsRGB()
Annot.GetColorAsCMYK()
Annot.GetColorAsGray()
Annot.GetColorCompNum()
Annot.SetColor(ColorPt)
Annot.SetColor(ColorPt, int)
Annot.GetStructParent()
Annot.SetStructParent(int)
Annot.GetOptionalContent()
Annot.SetOptionalContent(Obj)
Annot.Resize(Rect)
Annot.GetRotation()
Annot.SetRotation(int)
Annot.RefreshAppearance(RefreshOptions)
Annot.RefreshAppearance()
Annot.GetCustomData(string)
Annot.SetCustomData(string, string)
Annot.DeleteCustomData(string)
Annot.Dispose()
object.ToString()
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.MemberwiseClone()
Namespace: pdftron.PDF.Annots
Assembly: PDFNet.dll
Syntax
public class TextWidget : Widget, IDisposable

Constructors

TextWidget(Annot)

Creates a Text Widget annotation and initialize it using given annotation object.

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

The annotation object to use.

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

TextWidget(Obj)

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

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

The object to use to initialize the Text Widget

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 Text Widget annotation, in the specified document.

Declaration
public static TextWidget 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
TextWidget

A newly created blank Text Widget annotation.

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

Create(PDFDoc, Rect, string)

Creates a new Text Widget annotation, in the specified document.

Declaration
public static TextWidget 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 Text widget.

Returns
Type Description
TextWidget

A newly created blank Text Widget annotation.

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

Create(PDFDoc, Rect, Field)

Creates a new Text Widget annotation, in the specified document.

Declaration
public static TextWidget Create(PDFDoc doc, Rect pos, Field field)
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.

Field field

the field for which to create a Text Widget.

Returns
Type Description
TextWidget

A newly created blank Widget annotation.

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

Dispose(bool)

Declaration
[HandleProcessCorruptedStateExceptions]
protected override void Dispose(bool A_0)
Parameters
Type Name Description
bool A_0
Overrides
Widget.Dispose(bool)

~TextWidget()

Declaration
protected ~TextWidget()

GetText()

Retrieves the text content of the Text Widget.

Declaration
public string GetText()
Returns
Type Description
string

The Text Widget contents

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

SetText(string)

Sets the text content of the Text Widget.

Declaration
public void SetText(string text)
Parameters
Type Name Description
string text

The text to be displayed in the Text Widget.

Exceptions
Type Condition
PDFNetException

PDFNetException the PDFNet exception

Implements

IDisposable
In This Article
Back to top Generated by DocFX