PDFCheckBoxWidget¶
Namespace: O2S.Components.PDF4NET.Forms
Defines an interactive check box widget.
Inheritance Object → PDFAnnotation → PDFFieldWidget → PDFCheckWidget → PDFCheckBoxWidget
Remarks
The check box widget is the visual representation of a check box field on a PDF page.
Constructors¶
PDFCheckBoxWidget()¶
Initializes a new PDFCheckBoxWidget object.
Properties¶
AppearanceFont¶
Gets or sets the widget appearance font.
Property Value
PDFFont
The font used for displaying the widget content.
Remarks
If this property is null, the PDFFieldWidget.Font property is used for displaying the field content.
BackgroundColor¶
Gets or sets the widget background color.
Property Value
PDFColor
The widget background color.
Exceptions
ArgumentOutOfRangeException
Thrown when the property is set to a color other than Gray, RGB or CMYK.
Blur¶
Gets or sets the blur action.
Property Value
PDFAction
An action that shall be performed when the widget loses the input focus.
BorderColor¶
Gets or sets the widget border color.
Property Value
PDFColor
The widget border color.
Exceptions
ArgumentOutOfRangeException
Thrown when the property is set to a color other than Gray, RGB or CMYK.
BorderDashPattern¶
Gets or sets the array that represents the dash pattern when the PDFFieldWidget.BorderStyle property is set to PDFAnnotationBorderStyle.Dashed.
Property Value
Double[]
An array of double values specifying the style of the dashed line.
BorderStyle¶
Gets or sets the widget border style.
Property Value
PDFAnnotationBorderStyle
A PDFAnnotationBorderStyle enum specifying the style of the widget border.
BorderWidth¶
Gets or sets the widget border width.
Property Value
Double
The width of widget border.
Exceptions
ArgumentOutOfRangeException
Thrown when this property is set to a negative value.
Checked¶
Gets or set a value indicating whether the check widget is in the checked state.
Property Value
Boolean
True if the check widget is in the checked state; otherwise, false.
CheckedStateDownAppearance¶
Gets or sets the pressed visual appearance for the widget in checked state.
Property Value
PDFAnnotationAppearance
The pressed visual appearance of the widget in checked state.
Remarks
The visual appearance of the widget in checked state when the user presses the widget.
CheckedStateNormalAppearance¶
Gets or sets the normal visual appearance for the widget in checked state.
Property Value
PDFAnnotationAppearance
The normal visual appearance of the widget in checked state.
Remarks
The visual appearance of the widget in checked state when the user does not interact with the widget.
CheckedStateRolloverAppearance¶
Gets or sets the rollover visual appearance for the widget in checked state.
Property Value
PDFAnnotationAppearance
The rollover visual appearance of the widget in checked state.
Remarks
The visual appearance of the widget in checked state when the user hovers the mouse over the widget.
CheckStyle¶
Gets or sets the style of the checked widget.
Property Value
PDFCheckStyle
A PDFCheckStyle that represents the style of the checked widget.
Contents¶
Gets or sets the annotation contents.
Property Value
String
Text to be displayed for the annotation or, if this type of annotation
does not display text, an alternate description of the annotation's contents
in human-readable form.
CosDictionary¶
Gets the COS dictionary asssociated with this object.
Property Value
PDFCosDictionary
The internal COS dictionary.
Remarks
Incorrect manipulation of the information in the COS dictionary can lead to invalid PDF files.
CreationDate¶
Gets or sets the annotation creation date.
Property Value
DateTime
The date and time when the annotation was created.
DisplayRectangle¶
Gets or sets the visual rectangle of this annotation object.
Property Value
PDFDisplayRectangle
A PDFDisplayRectangle that represents the position and size of the annotation.
Remarks
The visual rectangle is relative to the top left corner of the page and can be set only after the annotation has been added to the page.
ExportValue¶
Gets or sets the widget's export value.
Property Value
String
The symbolic value associated with the check widget.
Remarks
When the form data is exported as FDF/XFDF/HTML or XML and the check widget is checked then this value is written to exported data stream.
Field¶
Gets the parent field.
Property Value
PDFField
The parent field of the widget.
Focus¶
Gets or sets the focus action.
Property Value
PDFAction
An action that shall be performed when the widget receives the input focus.
Font¶
Gets or sets the widget font.
Property Value
PDFFont
The font used for editing the widget content.
Guid¶
Gets the annotation GUID.
Property Value
Guid
A Guid object that uniquely identifies the annotation.
HasStandardAppearance¶
Gets a flag indicating whether the annotation appearance has been created by the library internally or it has been set externally.
Property Value
Hidden¶
Gets or sets a value indicating whether to display the annotation or not.
Property Value
Boolean
If true, do not display or print the annotation or allow it to
interact with the user.
ID¶
Gets or sets the annotation ID.
Property Value
String
A unique value representing the ID
Invisible¶
Gets or sets a value indicating whether the annotation should be displayed if it does not belong to one of the standard annotation types.
Property Value
Locked¶
Gets or sets a value indicating whether the annotation should be modified.
Property Value
Boolean
If true, do not allow the annotation to be deleted or its properties (including
position and size) to be modified by the user. However, this flag does not restrict
changes to the annotation’s contents, such as the value of a form field.
LockedContents¶
Gets or sets a value indicating whether the annotation contents should be modified.
Property Value
Boolean
If true, do not allow the contents of the annotation to be modified by the user.
This flag does not restrict deletion of the annotation or changes to other
annotation properties, such as position and size.
ModifiedDate¶
Gets or sets the annotation modified date.
Property Value
DateTime
The date and time when the annotation was most recently modified.
MouseDown¶
Gets or sets the mouse down action.
Property Value
PDFAction
An action to be performed when the mouse button is pressed inside the annotation's active area.
MouseEnter¶
Gets or sets the mouse enter action.
Property Value
PDFAction
An action to be performed when the cursor enters the annotation's active area.
MouseLeave¶
Gets or sets the mouse leave action.
Property Value
PDFAction
An action to be performed when the cursor exits the annotation's active area.
MouseUp¶
Gets or sets the mouse up action.
Property Value
PDFAction
An action to be performed when the mouse button is released inside the annotation's active area.
NormalAppearance¶
Gets or sets the annotation normal appearance.
Property Value
PDFAnnotationAppearance
A PDFAnnotationAppearance specifying how the annotation is presented visually on the page.
NoRotate¶
Gets or sets a value indicating whether the annotation should be rotated when the page is rotated.
Property Value
Boolean
If true, do not rotate the annotation's appearance to match the rotation of the page.
NoView¶
Gets or sets a value indicating whether the annotation should be displayed.
Property Value
Boolean
If true, do not display the annotation on the screen or allow it
to interact with the user. The annotation may be printed (depending on
the PDFAnnotation.Print property), but should be considered hidden for the purposes
of onscreen display and user interaction.
NoZoom¶
Gets or sets a value indicating whether the annotation should be scaled to current page zoom.
Property Value
Boolean
If true, do not scale the annotation's appearance to match the zoom of the page.
Page¶
Gets the annotation page.
Property Value
PDFPage
A PDFPage that represents the page contianing the annotation.
PageClose¶
Gets or sets the page close action.
Property Value
PDFAction
An action to be performed when the page containing the annotation is closed
(for example, when the user navigates to the next or previous page, or follows
a link annotation or outline item).
PageInvisible¶
Gets or sets the page invisible action.
Property Value
PDFAction
An action to be performed when the page containing the annotation
is no longer visible in the viewer application's user interface.
PageOpen¶
Gets or sets the page open action.
Property Value
PDFAction
An action to be performed when the page containing the annotation is opened
(for example, when the user navigates to it from the next or previous page or by means
of a link annotation or outline item).
PageVisible¶
Gets or sets the page visible action.
Property Value
PDFAction
An action to be performed when the page containing the annotation
becomes visible in the viewer application's user interface.
Popup¶
Gets or sets the associated popup annotation.
Property Value
PDFPopupAnnotation
A PDFPopupAnnotation used for editing the content of the annotation.
Print¶
Gets or sets a value indicating whether the annotation should be printed.
Property Value
Boolean
If true, print the annotation when the page is printed. If clear,
never print the annotation, regardless of whether it is displayed
on the screen.
ReadOnly¶
Gets or sets a value indicating whether the annotation is read only.
Property Value
Boolean
If true, do not allow the annotation to interact with the user.
Rotation¶
Gets or sets the widget rotation angle.
Property Value
Int32
The widget rotation angle in degrees.
Exceptions
ArgumentOutOfRangeException
Thrown when the value being set is not one of the accepted values.
Remarks
The accepted values for this property are 0, 90, 180 and 270 degrees.
TabOrder¶
Gets or sets the widget's tab order.
Property Value
Int32
The position of the widget that defines the navigation between the fields using TAB key.
TextColor¶
Gets or sets the widget text color.
Property Value
PDFColor
The widget text color.
Exceptions
ArgumentOutOfRangeException
Thrown when the property is set to a color other than Gray, RGB or CMYK.
ToggleNoView¶
Gets or sets a value indicating whether the interpretation of NoView property should be reversed.
Property Value
Boolean
If true, invert the interpretation of the NoView property for certain events.
Type¶
Gets the type of the annotation.
Property Value
PDFAnnotationType
A PDFAnnotationType that represents the annotation type.
UncheckedStateDownAppearance¶
Gets or sets the pressed visual appearance for the widget in unchecked state.
Property Value
PDFAnnotationAppearance
The pressed visual appearance of the widget in unchecked state.
Remarks
The visual appearance of the widget in unchecked state when the user presses the widget.
UncheckedStateNormalAppearance¶
Gets or sets the normal visual appearance for the widget in unchecked state.
Property Value
PDFAnnotationAppearance
The normal visual appearance of the widget in unchecked state.
Remarks
The visual appearance of the widget in unchecked state when the user does not interact with the widget.
UncheckedStateRolloverAppearance¶
Gets or sets the rollover visual appearance for the widget in unchecked state.
Property Value
PDFAnnotationAppearance
The rollover visual appearance of the widget in unchecked state.
Remarks
The visual appearance of the widget in unchecked state when the user hovers the mouse over the widget.
Visibility¶
Gets or sets the field widget visibility.
Property Value
PDFFieldWidgetVisibility
A PDFFieldWidgetVisibility that represents the visibility of the field widget.