Documents for PDF .NET Edition
GrapeCity.Documents.Pdf Assembly / GrapeCity.Documents.Pdf.Annotations Namespace / WidgetAnnotation Class
Properties Methods

In This Topic
    WidgetAnnotation Class Members
    In This Topic

    The following tables list the members exposed by WidgetAnnotation.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyGets the actual justification to be used in displaying the annotation’s text.  
    Public PropertyGets or sets the annotation’s appearance state, which selects the applicable appearance stream from an appearance sub-dictionary. Note! If you change this property then GcPdf will NOT automatically generates appearance content streams in AppearanceStreams. See PDF specification for more details. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets the AppearanceStreams object that allows to define this annotation's appearance streams. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets the list of embedded files associated with this GrapeCity.Documents.Pdf.Graphics.FormXObject. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets or sets the annotation's background color.  
    Public Property  
    Public PropertyGets the ButtonAppearance object that specifies the look of the widget if it is linked with a push button field.  
    Public PropertyGets or sets the style of check mark that is used if this WidgetAnnotation is linked with a GrapeCity.Documents.Pdf.AcroForms.CheckBoxField or a GrapeCity.Documents.Pdf.AcroForms.RadioButtonField.

    Note that this property works over the ButtonAppearance.Caption property, for example if CheckStyle is CheckStyle.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 PropertyGets or sets the 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. In either case, this text is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets the DefaultAppearance object that specifies the visual properties (font, font size etc.) used to format the content of this annotation.  
    Public PropertyGets the GrapeCity.Documents.Pdf.GcPdfDocument owning this annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets the WidgetAnnotation.TriggerEvents object that specifies the events for this annotation.  
    Public PropertyGets the GrapeCity.Documents.Pdf.AcroForms.Field associated with this annotation.  
    Public PropertyGets or sets the flags specifying various characteristics of the annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets or sets the annotation’s highlighting mode.  
    Public PropertyGets 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 GrapeCity.Documents.Pdf.AcroForms.Field.Justification is used. See PDF specification for details.

     
    Public PropertyGets or sets a value indicating whether the annotation can be deleted or its properties (including position and size) can 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. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets or sets a value indicating whether the contents of the annotation can 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.  
    Public PropertyGets or sets the name of the annotation. If WidgetAnnotation is used with GrapeCity.Documents.Pdf.AcroForms.RadioButtonField then Name is used as a value.  
    Public PropertyGets or sets the GrapeCity.Documents.Pdf.Page that contains this annotation.

    Note that an annotation may be referenced by several pages. In that case this property returns the first element in the Pages collection.

    When setting this property, the following applies:

    • If the new value is null, this annotation is removed from all pages.
    • Otherwise, this annotation is assigned exclusively to the specified page.

    (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets the list of pages that reference this annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets or sets the annotation rectangle, defining the location of the annotation on a page. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets or sets the GrapeCity.Documents.Text.TextFormat object that specifies the font, font size and color used to format the content of this annotation.

    Note that only Font, FontSize and ForeColor will be used when building appearance streams, all other TextFormat properties will be ignored. Note also that if a property is specified on DefaultAppearance, the corresponding TextFormat property will also be ignored.

    This property is deprecated, DefaultAppearance should be used instead.

    An appropriate font can be found for example by using methods such as GrapeCity.Documents.Text.FontCollection.FindFamilyName on the GrapeCity.Documents.Text.FontCollection.SystemFonts collection.

     
    Public PropertyGets or sets arbitrary data associated with the current annotation.

    Note that this data is runtime only and is not persisted in the PDF.

    (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Top
    Public Methods
     NameDescription
    Public MethodCreates an instance of GrapeCity.Documents.Pdf.Graphics.FormXObject that can be used to define the annotation's appearance stream.

    Note that when this method is called, the annotation must already have been added to the document, otherwise an exception will be thrown.

    (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Top
    See Also