[]
        
(Showing Draft Content)

GrapeCity.Documents.Pdf.Annotations.WidgetAnnotation

Class WidgetAnnotation

Namespace
GrapeCity.Documents.Pdf.Annotations
Assembly
GcDocs.Pdf.dll

Represents a widget annotation used in interactive forms to represent the appearance of fields and to manage user interactions.

public class WidgetAnnotation : AnnotationBase, IOwnedObject, IContentItem, IPdfDict, ActionHide.ILinkedObject
Inheritance
object
WidgetAnnotation
Implements
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Extension Methods

Constructors

WidgetAnnotation()

Initializes a new instance of the WidgetAnnotation class.

public WidgetAnnotation()

WidgetAnnotation(Page, RectangleF)

Initializes a new instance of the WidgetAnnotation class.

public WidgetAnnotation(Page page, RectangleF rect)

Parameters

page Page

The page containing created annotation.

rect System.Drawing.RectangleF

The annotation's bounds on the page.

Properties

Activate

Gets or sets an action to be performed when the annotation is activated.

public ActionBase Activate { get; set; }

Property Value

ActionBase

ActualJustification

Gets the actual justification to be used in displaying the annotation’s text.

public VariableTextJustification ActualJustification { get; }

Property Value

VariableTextJustification
See Also

BackColor

Gets or sets the annotation's background color.

public Color BackColor { get; set; }

Property Value

System.Drawing.Color

Border

public Border Border { get; set; }

Property Value

Border

ButtonAppearance

Gets the ButtonAppearance object that specifies the look of the widget if it is linked with a push button field.

public ButtonAppearance ButtonAppearance { get; }

Property Value

ButtonAppearance

CheckStyle

Gets or sets the style of check mark that is used if this WidgetAnnotation is linked with a CheckBoxField or a RadioButtonField.

Note that this property works over the Caption property, for example if CheckStyle is Cross, then ButtonAppearance.Caption will be "8".

If the value of this property is null, it indicates that ButtonAppearance.Caption contains an unknown value.
public CheckStyle? CheckStyle { get; set; }

Property Value

CheckStyle?

DefaultAppearance

Gets the DefaultAppearance object that specifies the visual properties (font, font size etc.) used to format the content of this annotation.

public DefaultAppearance DefaultAppearance { get; }

Property Value

DefaultAppearance

Events

Gets the WidgetAnnotation.TriggerEvents object that specifies the events for this annotation.

public WidgetAnnotation.TriggerEvents Events { get; }

Property Value

WidgetAnnotation.TriggerEvents

Field

Gets the Field associated with this annotation.

public Field Field { get; }

Property Value

Field

Highlighting

Gets or sets the annotation’s highlighting mode.

public HighlightingMode Highlighting { get; set; }

Property Value

HighlightingMode

Justification

Gets or sets the justification to be used in displaying the annotation’s text.

Note that if this property is not specified (the value is null) then Justification is used. See PDF specification for details.

public VariableTextJustification? Justification { get; set; }

Property Value

VariableTextJustification?

Name

Gets or sets the name of the annotation. If WidgetAnnotation is used with RadioButtonField then Name is used as a value.

public string Name { get; set; }

Property Value

string

RotationAngle

Gets or sets the angle, in degrees, by which the widget annotation is rotated counterclockwise relative to the page. The value must be a multiple of 90.

public float RotationAngle { get; set; }

Property Value

float