Click or drag to resize

Widget Class

Interactive forms use widget annotations (PDF 1.2) to represent the appearance of fields and to manage user interactions. As a convenience, when a field has only a single associated widget annotation, the contents of the field dictionary and the annotation dictionary may be merged into a single dictionary containing entries that pertain to both a field and an annotation. NOTE This presents no ambiguity, since the contents of the two kinds of dictionaries do not conflict.
Inheritance Hierarchy
SystemObject
  pdftron.PDF.AnnotsWidget

Namespace:  pdftron.PDF.Annots
Assembly:  pdftron (in pdftron.dll) Version: 255.255.255.255
Syntax
public sealed class Widget : IClosable, 
	IAnnot

The Widget type exposes the following members.

Constructors
  NameDescription
Public methodWidget
Creates a Widget annotation and initialize it using given Cos/SDF object.
Top
Methods
  NameDescription
Public methodClose
Public methodStatic memberCreate
Creates a new Widget annotation, in the specified document.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFlatten
Flatten/Merge the existing annotation appearances with the page content and delete this annotation from a given page. Annotation 'flattening' refers to the operation that changes active annotations (such as markup, widgets, 3D models, etc.) into a static area that is part of the PDF document, just like the other text and images in the document.
Public methodGetAction
Gets the action of the Widget annotation.
Public methodGetAnnotType
Gets the type.
Public methodGetAppearance
Gets the annotation’s appearance for the given combination of annotation and appearance states.
Public methodGetAppearance(AnnotAnnotationState)
Gets the annotation’s appearance for the given combination of annotation and appearance states.
Public methodGetAppearance(AnnotAnnotationState, String)
Gets the annotation’s appearance for the given combination of annotation and appearance states.
Public methodGetBackgroundColor
Gets the background color of the Widget annotation.
Public methodGetBackgroundColorCompNum
Gets the number indicating background color space of the Widget annotation.
Public methodGetBorderColor
Gets the border color of the Widget annotation.
Public methodGetBorderColorCompNum
Gets the number indicating border color space of the Widget annotation.
Public methodGetBorderStyle
Gets the border style for the annotation. Typically used for Link annotations.
Public methodGetColorAsCMYK
Gets an annotation's color.
Public methodGetColorAsGray
Gets an annotation's color.
Public methodGetColorAsRGB
Gets the annotation’s active appearance state.
Public methodGetColorCompNum
Gets the color space the annotation's color is represented in.
Public methodGetContents
Gets the contents.
Public methodGetDate
Gets an annotation's last modified date.
Public methodGetField
Gets the field corresponding to the Widget annotation.
Public methodGetFitFull
Gets the fit full option being used.
Public methodGetFlag
Gets the flag.
Public methodGetFont
Retrieves the font used for displaying text in this Widget.
Public methodGetFontSize
Returns the font size used in this Widget Annotation.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetHIconLeftOver
Gets the horizontal leftover of the icon within the annotatin.
Public methodGetHighlightingMode
Gets the HighlightingMode of the Widget Annotation.
Public methodGetIconCaptionRelation
Gets the Icon and caption relationship of the Widget annotation.
Public methodGetMouseDownCaptionText
Gets the button down caption text of the Widget annotation.
Public methodGetMouseDownIcon
Gets the Mouse Down icon associated with the Widget annotation.
Public methodGetOptionalContent
Gets optional content of an annotation.
Public methodGetPage
Gets the page the annotation is associated with.
Public methodGetRect
Gets the rect.
Public methodGetRolloverCaptionText
Gets the roll over caption text of the Widget annotation.
Public methodGetRolloverIcon
Gets the rollover icon associated with the Widget annotation.
Public methodGetRotation
Gets the rotation value of the annotation.The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90.
Public methodGetScaleCondition
Gets the condition under which the icon should be scaled.
Public methodGetScaleType
Gets the Scale Type of the Widget annotation.
Public methodGetSDFObj
Gets the SDFObj.
Public methodGetStaticCaptionText
Gets static caption text of the Widget annotation.
Public methodGetStaticIcon
Gets the static icon associated with the Widget annotation.
Public methodGetStructParent
Gets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
Public methodGetTextColor
Returns the text color of the Widget Annotation.
Public methodGetTextColorCompNum
Returns the number of color components in the text color of the Widget Annotation.
Public methodGetTriggerAction
Get the Action associated with the selected Annot Trigger event
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUniqueID
Gets the unique ID.
Public methodGetVIconLeftOver
Gets the vertical leftover of the icon within the annotatin.
Public methodIsMarkup
Checks if is markup.
Public methodIsValid
Checks if is valid.
Public methodRefreshAppearance
Regenerates the appearance stream for the annotation. This method can be used to auto-generate the annotation appearance after creating or modifying the annotation without providing an explicit appearance or setting the "NeedAppearances" flag in the AcroForm dictionary.
Public methodRemoveAppearance
Removes the annotation's appearance
Public methodRemoveAppearance(AnnotAnnotationState)
Removes the annotation's appearance for the given combination of annotation and appearance states.
Public methodRemoveAppearance(AnnotAnnotationState, String)
Removes the annotation's appearance for the given combination of annotation and appearance states.
Public methodResize
Resize.
Public methodSetAction
Sets the action of the Widget annotation (Optional; PDF 1.2 )
Public methodSetAppearance(Obj)
Sets the annotation’s appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
Public methodSetAppearance(Obj, AnnotAnnotationState)
Removes the annotation's appearance for the given combination of annotation and appearance states.
Public methodSetAppearance(Obj, AnnotAnnotationState, String)
Sets the annotation’s appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
Public methodSetBackgroundColor
Sets the background color of the Widget. (Optional)
Public methodSetBorderColor
Sets the border color of the Widget. (Optional)
Public methodSetBorderStyle
Sets the border style for the annotation. Typically used for Link annotations.
Public methodSetColor(ColorPt)
Sets an annotation's color. (Optional; PDF 1.1)
Public methodSetColor(ColorPt, Int32)
Sets an annotation's color. (Optional; PDF 1.1)
Public methodSetContents
Sets the contents.
Public methodSetDate
Sets an annotation's last modified date.
Public methodSetFitFull
Sets the fit full option being used. (Optional)
Public methodSetFlag
Sets the value of given Flag.
Public methodSetFont
Specifies a font to be used for text in this Widget
Public methodSetFontSize
Sets the font size of the Widget Annotation.
Public methodSetHIconLeftOver
Sets the horizontal leftover of the icon within the annotatin. (Optional)
Public methodSetHighlightingMode
Sets the HighlightingMode of the Widget Annotation. (Optional)
Public methodSetIconCaptionRelation
Sets the Icon and caption relationship of the Widget annotation. (Optional; pushbutton fields only)
Public methodSetMouseDownCaptionText
Sets the button down caption text of the Widget annotation. (Optional; button fields only)
Public methodSetMouseDownIcon
Sets the Mouse Down icon associated with the Widget annotation. (Optional; button fields only) Sets the Mouse Down icon associated with the Widget annotation.
Public methodSetOptionalContent
Sets optional content of an annotation. (Optional, PDF1.5).
Public methodSetPage
Sets the reference to a page the annotation is associated with. (Optional PDF 1.3; not used in FDF files)
Public methodSetRect
Sets the size and location of an annotation on its page.
Public methodSetRolloverCaptionText
Sets the roll over caption text of the Widget annotation. (Optional; button fields only)
Public methodSetRolloverIcon
Sets the rollover icon associated with the Widget annotation. (Optional; button fields only)
Public methodSetRotation
Sets the rotation value of the annotation.The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90. (Optional)
Public methodSetScaleCondition
Sets the condition under which the icon should be scaled. (Optional)
Public methodSetScaleType
Sets the Scale Type of the Widget annotation. (Optional)
Public methodSetStaticCaptionText
Sets static caption text of the Widget annotation. (Optional; button fields only)
Public methodSetStaticIcon
Sets the static icon associated with the Widget annotation. (Optional; button fields only)
Public methodSetStructParent
Sets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
Public methodSetTextColor
Sets the text color of the Widget Annotation.
Public methodSetUniqueID
Sets the unique identifier for this annotation.
Public methodSetVIconLeftOver
Sets the vertical leftover of the icon within the annotatin. (Optional)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also