TextWidget Class |
An object representing a Text Box used in a PDF Form.
Inheritance HierarchyNamespace: pdftron.PDF.Annots
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255
Syntaxpublic sealed class TextWidget : IClosable, IAnnot
The TextWidget type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TextWidget | Creates a Text Widget annotation and initialize it using given Cos/SDF object.
|
Methods| Name | Description | |
|---|---|---|
| Close | |
 | Create(PDFDoc, Rect) | Creates a new Text Widget annotation, in the specified document.
|
| Create(PDFDoc, Rect, Field) | Creates a new Text Widget annotation, in the specified document.
|
| Create(PDFDoc, Rect, String) | Creates a new Text Widget annotation, in the specified document.
|
| DeleteCustomData | Deletes custom data associated with the given key.
|
| Equals | (Inherited from Object.) |
| Flatten | 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.
|
| GetAction | Gets the action of the Widget annotation.
|
| GetAnnotType | Gets the type.
|
| GetAppearance | Gets the annotation’s appearance for the given combination of annotation
and appearance states.
|
| GetAppearance(AnnotAnnotationState) | Gets the annotation’s appearance for the given combination of annotation
and appearance states.
|
| GetAppearance(AnnotAnnotationState, String) | Gets the annotation’s appearance for the given combination of annotation
and appearance states.
|
| GetBackgroundColor | Gets the background color of the Widget annotation.
|
| GetBackgroundColorCompNum | Gets the number indicating background color space of the Widget annotation.
|
| GetBorderColor | Gets the border color of the Widget annotation.
|
| GetBorderColorCompNum | Gets the number indicating border color space of the Widget annotation.
|
| GetBorderStyle | Gets the border style for the annotation. Typically used for Link annotations.
|
| GetColorAsCMYK | Gets an annotation's color.
|
| GetColorAsGray | Gets an annotation's color.
|
| GetColorAsRGB | Gets the annotation’s active appearance state.
|
| GetColorCompNum | Gets the color space the annotation's color is represented in.
|
| GetContents | Gets the contents.
|
| GetCustomData | Returns custom data associated with the given key.
|
| GetDate | Gets an annotation's last modified date.
|
| GetField | Gets the field corresponding to the Widget annotation.
|
| GetFitFull | Gets the fit full option being used.
|
| GetFlag | Gets the flag.
|
| GetFont | Retrieves the font used for displaying text in this Widget.
|
| GetFontSize | Returns the font size used in this Widget Annotation.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetHIconLeftOver | Gets the horizontal leftover of the icon within the annotatin.
|
| GetHighlightingMode | Gets the HighlightingMode of the Widget Annotation.
|
| GetIconCaptionRelation | Gets the Icon and caption relationship of the Widget annotation.
|
| GetMouseDownCaptionText | Gets the button down caption text of the Widget annotation.
|
| GetMouseDownIcon | Gets the Mouse Down icon associated with the Widget annotation.
|
| GetOptionalContent | Gets optional content of an annotation.
|
| GetPage | Gets the page the annotation is associated with.
|
| GetRect | Gets the rect.
|
| GetRolloverCaptionText | Gets the roll over caption text of the Widget annotation.
|
| GetRolloverIcon | Gets the rollover icon associated with the Widget annotation.
|
| GetRotation | 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.
|
| GetScaleCondition | Gets the condition under which the icon should be scaled.
|
| GetScaleType | Gets the Scale Type of the Widget annotation.
|
| GetSDFObj | Gets the SDFObj.
|
| GetStaticCaptionText | Gets static caption text of the Widget annotation.
|
| GetStaticIcon | Gets the static icon associated with the Widget annotation.
|
| GetStructParent | Gets the struct parent of an annotation.
(Required if the annotation is a structural content item; PDF 1.3)
|
| GetText | Retrieves the text content of the Text Widget.
|
| GetTextColor | Returns the text color of the Widget Annotation.
|
| GetTextColorCompNum | Returns the number of color components in the text color of the Widget Annotation.
|
| GetTriggerAction | Get the Action associated with the selected Annot Trigger event
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUniqueID | Gets the unique ID.
|
| GetVIconLeftOver | Gets the vertical leftover of the icon within the annotatin.
|
| IsMarkup | Checks if is markup.
|
| IsValid | Creates a Widget annotation and initialize it using given annotation object.
|
| RefreshAppearance | 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.
|
| RefreshAppearance(RefreshOptions) | A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
|
| RemoveAppearance | Removes the annotation's appearance
|
| RemoveAppearance(AnnotAnnotationState) | Removes the annotation's appearance for the given combination of annotation
and appearance states.
|
| RemoveAppearance(AnnotAnnotationState, String) | Removes the annotation's appearance for the given combination of annotation
and appearance states.
|
| Resize | Resize.
|
| SetAction | Sets the action of the Widget annotation
(Optional; PDF 1.2 )
|
| SetAppearance(Obj) | Sets the annotation’s appearance for the given combination of annotation
and appearance states.
(Optional; PDF 1.2)
|
| SetAppearance(Obj, AnnotAnnotationState) | Removes the annotation's appearance for the given combination of annotation
and appearance states.
|
| SetAppearance(Obj, AnnotAnnotationState, String) | Sets the annotation’s appearance for the given combination of annotation
and appearance states.
(Optional; PDF 1.2)
|
| SetBackgroundColor | Sets the background color of the Widget.
(Optional)
|
| SetBorderColor | Sets the border color of the Widget.
(Optional)
|
| SetBorderStyle | Sets the border style for the annotation. Typically used for Link annotations.
|
| SetColor(ColorPt) | Sets an annotation's color.
(Optional; PDF 1.1)
|
| SetColor(ColorPt, Int32) | Sets an annotation's color.
(Optional; PDF 1.1)
|
| SetContents | Sets the contents.
|
| SetCustomData | Sets the custom data associated with the specified key.
|
| SetDate | Sets an annotation's last modified date.
|
| SetDateToNow |
Sets an annotation's modification date and time to the current time.
This corresponds to the value of the "M" field of annotation dictionary(PDF 1.1)
|
| SetFitFull | Sets the fit full option being used.
(Optional)
|
| SetFlag | Sets the value of given Flag.
|
| SetFont | Specifies a font to be used for text in this Widget
|
| SetFontSize | Sets the font size of the Widget Annotation.
|
| SetHIconLeftOver | Sets the horizontal leftover of the icon within the annotatin.
(Optional)
|
| SetHighlightingMode | Sets the HighlightingMode of the Widget Annotation.
(Optional)
|
| SetIconCaptionRelation | Sets the Icon and caption relationship of the Widget annotation.
(Optional; pushbutton fields only)
|
| SetMouseDownCaptionText | Sets the button down caption text of the Widget annotation.
(Optional; button fields only)
|
| SetMouseDownIcon | Sets the Mouse Down icon associated with the Widget annotation.
(Optional; button fields only)
Sets the Mouse Down icon associated with the Widget annotation.
|
| SetOptionalContent | Sets optional content of an annotation.
(Optional, PDF1.5).
|
| SetPage | Sets the reference to a page the annotation is associated with.
(Optional PDF 1.3; not used in FDF files)
|
| SetRect | Sets the size and location of an annotation on its page.
|
| SetRolloverCaptionText | Sets the roll over caption text of the Widget annotation.
(Optional; button fields only)
|
| SetRolloverIcon | Sets the rollover icon associated with the Widget annotation.
(Optional; button fields only)
|
| SetRotation | 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)
|
| SetScaleCondition | Sets the condition under which the icon should be scaled.
(Optional)
|
| SetScaleType | Sets the Scale Type of the Widget annotation.
(Optional)
|
| SetStaticCaptionText | Sets static caption text of the Widget annotation.
(Optional; button fields only)
|
| SetStaticIcon | Sets the static icon associated with the Widget annotation.
(Optional; button fields only)
|
| SetStructParent | Sets the struct parent of an annotation.
(Required if the annotation is a structural content item; PDF 1.3)
|
| SetText | Sets the text content of the Text Widget.
|
| SetTextColor | Sets the text color of the Widget Annotation.
|
| SetUniqueID | Sets the unique identifier for this annotation.
|
| SetVIconLeftOver | Sets the vertical leftover of the icon within the annotatin.
(Optional)
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also