CheckboxWidgetAnnotation Class

The CheckboxWidgetAnnotation is a button type widget that allows the user to select between one of two possible values. By convention, these values are "Yes" and "Off". Unlike most annotations, CheckBoxWidgetAnnotations needs to have a suite of DrawingTemplate resources associated with it. At a minimum, there needs to be a "Yes" and "Off" entries in the Normal appearance set.

Examples

This is how to set up a set of default appearances for a checkbox:

Copy

checkbox.Appearance.Normal.Add(CheckboxWidgetAnnotation.CheckedValue, "normalChecked");
checkbox.Appearance.Normal.Add(CheckboxWidgetAnnotation.ClearedValue, "normalCleared");

"normalChecked" and "normalCleared" are strings that should be the name of PdfTemplateResource objects in your document's resource collection.

Inheritance Hierarchy

SystemObject
  Atalasoft.PdfDoc.Generating.AnnotationsBaseAnnotation
    Atalasoft.PdfDoc.Generating.AnnotationsBaseWidgetAnnotation
      Atalasoft.PdfDoc.Generating.AnnotationsBaseButtonWidgetAnnotation
        Atalasoft.PdfDoc.Generating.AnnotationsCheckboxWidgetAnnotation

Namespace: Atalasoft.PdfDoc.Generating.Annotations
Assembly: Atalasoft.PdfDoc (in Atalasoft.PdfDoc.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

public class CheckboxWidgetAnnotation : BaseButtonWidgetAnnotation

Public Class CheckboxWidgetAnnotation
	Inherits BaseButtonWidgetAnnotation

The CheckboxWidgetAnnotation type exposes the following members.

Constructors

	Name	Description
	CheckboxWidgetAnnotation	Initializes a new instance of the CheckboxWidgetAnnotation class.
	CheckboxWidgetAnnotation(GlobalResources, PdfBounds, String, String, String)	Initializes a new instance of the CheckboxWidgetAnnotation class and will initialize the default appearances for Normal and Activated for the annotation using "standard" appearances. If the standard appearances have not been installed in the provided resource collection, they will be installed for you.
	CheckboxWidgetAnnotation(GlobalResources, PdfBounds, String, String, String, Boolean)	Initializes a new instance of the CheckboxWidgetAnnotation class.

Top

Properties

	Name	Description
	AdditionalActions	Gets the additional actions associated with the annotation. These are generally only used by widget annotations. (Inherited from BaseAnnotation.)
	AnnotationType	Gets the type of the original PDF annotation if this annotation was imported from a file. This is generally only useful if the annotation was a type not recognized or not currently modeled by DotPdf (Inherited from BaseAnnotation.)
	Appearance	Gets or sets the AppearanceSet for the annotation. This property defaults to null (no appearance set). (Inherited from BaseAnnotation.)
	BackgroundColor	Gets or sets the color of the background. (Inherited from BaseWidgetAnnotation.)
	Border	Gets or sets the AnnotationBorder for this annotation. (Inherited from BaseAnnotation.)
	BorderColor	Gets or sets the color of the border. (Inherited from BaseWidgetAnnotation.)
	BorderStyle	Gets or sets the BorderStyle for the annotation. (Inherited from BaseAnnotation.)
	Bounds	Gets or sets the bounding rectangle for this annotation. (Inherited from BaseAnnotation.)
	Caption	Gets or sets the text displayed on the button. (Inherited from BaseButtonWidgetAnnotation.)
	CheckedValue	Gets the standard checked value string.
	ChildFields	Gets the child fields for this annotation. This will always be null in a BaseWidgetAnnotation (Inherited from BaseWidgetAnnotation.)
	ClearedValue	Gets the standard cleared value string.
	ClickActions	Gets the set of actions performed when the annotation has been clicked. (Inherited from BaseAnnotation.)
	Color	Gets or sets the color of the annotation. The meaning of this color varies based on the annotation type. It may represent the background color of the annotation's icon (if any) when closed, the title bar of the annotation's pop-up window, the border color of the annotation. (Inherited from BaseAnnotation.)
	Contents	Gets or sets the text contents of the annotation. How contents is used depends on the annotation type. For example a StickyNoteAnnotation will use Contents to represent text the user has entered. (Inherited from BaseAnnotation.)
	DefaultAppearanceState	Gets or sets the name of the default appearance state for the annotation. In annotations that may have multiple possible states (say, "On" of "Off") this the name of the default state. In an annotation's "normal" state, this corresponds to Appearance.Normal[DefaultAppearanceState]. (Inherited from BaseAnnotation.)
	DefaultTextAppearance	Gets or sets the default text appearance. (Inherited from BaseWidgetAnnotation.)
	DefaultValue	Gets or sets the default value of the checkbox. Use CheckedValue or ClearedValue to be compatible with convention.
	DefaultValueAsString	Gets the default value as string. (Overrides BaseWidgetAnnotationDefaultValueAsString.)
	DocumentRevision	Gets the revision of the document in which this widget was found. (Inherited from BaseAnnotation.)
	EnforceReadyOnlyWithException	Gets or sets a value indicating whether to enforce ready only with the ReadOnly propery with an exception. (Inherited from BaseAnnotation.)
	FieldAlternateDescription	Gets or sets the field alternate description for display in the UI. (Inherited from BaseWidgetAnnotation.)
	FieldFullName	Gets the fully qualified name of the field. This value is only correct if ParentField has been set. When the parent chain is properly set up, this will return ParentField.FieldFullName + '.' + FieldName (Inherited from BaseWidgetAnnotation.)
	FieldName	Gets or sets the name of the field. (Inherited from BaseWidgetAnnotation.)
	FieldNameForExport	Gets or sets the field name for export. When data from a form is aggregated, if FieldNameForExport is non-null, it will be used in place of FieldName. This allows you to have field values mapped to a different name which may be more suitable for a data collection application. (Inherited from BaseWidgetAnnotation.)
	Hidden	Gets or sets a value indicating whether this BaseAnnotation is hidden. A hidden annotation is neither displayed nor printed by a viewer under any circumstances. Default is false. (Inherited from BaseAnnotation.)
	HighlightAppearance	Gets or sets the highlight appearance. (Inherited from BaseWidgetAnnotation.)
	Invisible	Gets or sets a value indicating whether this BaseAnnotation is invisible. Invisibility specifically means that if the annotation is not recognized by the viewer, then it should not be displayed, otherwise the viewer may make a substitute appearance for the annotation. Default is false. (Inherited from BaseAnnotation.)
	IsDirty	Gets or sets a value indicating whether the annotation is dirty and in need of being written. (Inherited from BaseAnnotation.)
	IsFieldNoExport	Gets or sets a value indicating whether this field should not be export. (Inherited from BaseWidgetAnnotation.)
	IsFieldReadOnly	Gets or sets a value indicating whether this field is read only. (Inherited from BaseWidgetAnnotation.)
	IsFieldRequired	Gets or sets a value indicating whether this field is required. (Inherited from BaseWidgetAnnotation.)
	IsParentRequired	Gets a value indicating whether this instance requires the parent property. (Inherited from BaseAnnotation.)
	IsReadOnlyOrFieldReadOnly	Determines whether the annotation is read only if either ReadOnly is true or if this object implements IFormElement, if IsFieldReadOnly is true. (Inherited from BaseAnnotation.)
	IsTransparent	Gets or sets a value indicating whether this instance is transparent. This is an indication that there was no Color specified for the annotation. (Inherited from BaseAnnotation.)
	Locked	Gets or sets a value indicating whether this BaseAnnotation is locked. A locked annotation may not be deleted or have its properties changed, but its contents (such as a form field) may still be editable. (Inherited from BaseAnnotation.)
	ModificationDate	Gets or sets the modification date for this annotation. DotPdf does not update this property. It is the client's responsibility to change it. (Inherited from BaseAnnotation.)
	Name	Gets or sets the name of the annotation. This name is meant to be a unique identifier for the annotation and may be use in scripts in PdfJavaScriptAction objects that want to find an annotation. (Inherited from BaseAnnotation.)
	NoRotate	Gets or sets a value indicating whether the annotation should be rotated when a page is rotated. Default is false. (Inherited from BaseAnnotation.)
	NoView	Gets or sets a value indicating whether the annotation is viewable and will interact with the user. This is different from hidden in that an annotation NoView set to true can be printed. This is a way, for example, to put watermarks on a page that only show when printed. Default is false. (Inherited from BaseAnnotation.)
	NoZoom	Gets or sets a value indicating whether the annotation's appearance is scaled when the page is zoomed in. Default is false. (Inherited from BaseAnnotation.)
	ParentField	Gets or sets the parent field. When the document is saved, this will be set for you if you haven't set it yourself. (Inherited from BaseWidgetAnnotation.)
	ParentPage	Gets or sets the parent page that contains this annotation. (Inherited from BaseAnnotation.)
	Print	Gets or sets a value indicating whether this BaseAnnotation is printed. Default is false. (Inherited from BaseAnnotation.)
	ReadOnly	Gets or sets a value indicating whether the annotation can interact with the user. Default is false. (Inherited from BaseAnnotation.)
	ToggleNoView	Gets or sets a value indicating whether to toggle the sense of the NoView property. This might be used to make an annotation visible when the mouse enters it. (Inherited from BaseAnnotation.)
	Value	Gets or sets the current value of the checkbox. Use CheckedValue or ClearedValue to be compatible with convention.
	ValueAsString	Gets the value as string. (Overrides BaseWidgetAnnotationValueAsString.)

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasAppearance	Determines whether this instance has at least 1 element in the Normal appearance set. (Inherited from BaseAnnotation.)
	IsValidChildOf	Determines whether this annotation is valid child of the specified form field. Returns true is elem is a GenericFormField or a CheckboxFormField (Overrides BaseWidgetAnnotationIsValidChildOf(IFormElement).)
	MakeRepairContext	Makes the repair context for repairing problems in this annotation object. An object implementing IValidatable should at least return an empty RepairContext object. (Inherited from BaseAnnotation.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NotifyResourceRenamed	This method is called when a global resourec has been renamed, allowing the resource consumer to update to the new name. Annotations defer this to their appearance, if any. (Inherited from BaseAnnotation.)
	ResourcesUsed	Reports a list of all resources consumed by the object of the given class. (Inherited from BaseAnnotation.)
	ThrowIfReadOnlyT	If EnforceReadyOnlyWithException is true and ReadOnly is true, throw an InvalidOperationException, otherwise return value. (Inherited from BaseAnnotation.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Validate	Validates the annotation and accumulates any problems. (Inherited from BaseAnnotation.)
	ValidateActionList	Validates the action list. (Inherited from BaseAnnotation.)
	ValidateActions	Validates the actions. (Inherited from BaseAnnotation.)
	ValidateProperties	Validates the properties of this object and adds any issues to the problems list. (Overrides BaseWidgetAnnotationValidateProperties(ProblemList, PageRepairContext).)

Top

Reference

Atalasoft.PdfDoc.Generating.Annotations Namespace