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

In This Topic
    AnnotationBase Class Members
    In This Topic

    The following tables list the members exposed by AnnotationBase.

    Public Properties
     NameDescription
    Public PropertyAppearanceStateGets 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.  
    Public PropertyAppearanceStreamsGets the AppearanceStreams object that allows defining this annotation's appearance streams.  
    Public PropertyAssociatedFilesGets the list of embedded files associated with this GrapeCity.Documents.Pdf.Graphics.FormXObject.  
    Public PropertyContentsGets 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.  
    Public PropertyDocGets the GrapeCity.Documents.Pdf.GcPdfDocument owning this annotation.  
    Public PropertyFlagsGets or sets the flags specifying various characteristics of the annotation.  
    Public PropertyLayerGets or sets an object that specifies the layer to which this annotation belongs.

    This can be either an GrapeCity.Documents.Pdf.Layers.OptionalContentGroup or an GrapeCity.Documents.Pdf.Layers.OptionalContentMembership.

     
    Public PropertyLockedGets 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.  
    Public PropertyLockedContentsGets 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 PropertyModifiedDateGets or sets the date and time when the annotation was modified.  
    Public PropertyNameGets or sets the annotation name, a text string uniquely identifying it among all annotations on its page.  
    Public PropertyPageGets 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.

     
    Public PropertyPagesGets the list of pages that reference this annotation.  
    Public PropertyRectGets or sets the annotation rectangle, defining the location of the annotation on a page.  
    Public PropertyUserDataGets or sets arbitrary data associated with the current annotation.

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

     
    Top
    Public Methods
     NameDescription
    Public MethodCreateAppearanceContentStreamCreates 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.

     
    Top
    See Also

    Reference

    AnnotationBase Class
    GrapeCity.Documents.Pdf.Annotations Namespace

     

     

    Copyright © 2021 GrapeCity, Inc. All rights reserved.

    Product Support Forum | Print this page