Document Solutions for PDF
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 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.  
    Public PropertyGets the AppearanceStreams object that allows defining this annotation's appearance streams.  
    Public PropertyGets the list of embedded files associated with this AnnotationBase.  
    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.  
    Public PropertyGets the GrapeCity.Documents.Pdf.GcPdfDocument owning this annotation.  
    Public PropertyGets or sets the flags specifying various characteristics of the annotation.  
    Public PropertyGets 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 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.  
    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 date and time when the annotation was modified.  
    Public PropertyGets or sets the annotation name, a text string uniquely identifying it among all annotations on its page.  
    Public PropertyGets the PDF object ID. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    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.

     
    Public PropertyGets the list of pages that reference this annotation.  
    Public PropertyGets the underlying GrapeCity.Documents.Pdf.Spec.IPdfDict. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfDictWrapper)
    Public PropertyGets the underlying GrapeCity.Documents.Pdf.Spec.IPdfObject. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapper<IPdfDict>)
    Public PropertyGets or sets the rectangle that defines the location and size of the annotation on a page in PDF user space coordinates. The positive X axis extends horizontally to the right, and the positive Y axis extends vertically upward, with the origin usually in the lower left corner of the page.  
    Public PropertyGets or sets the rectangle that defines the location and size of the annotation on a page. The coordinates of the rectangle are relative to the upper left corner of the page's media box, with the Y (vertical) coordinates increasing from top to bottom.

    Note that if the annotation is associated with more than one page, the media box of the first of those pages is used to calculate the rectangle's location.

     
    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.

     
    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.

     
    Public MethodGets the System.IO.Stream object containing the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. Note! The stream should be disposed after usage. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public MethodGets the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public MethodGets the GrapeCity.Documents.Pdf.Spec.PdfStreamInfo object containing the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. Note! The stream should be disposed after usage. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public MethodRemoves all appearance streams associated with the current annotation, and disables generation of appearance steams for this annotation when the document is saved.

    Note that if any property affecting the annotation's appearance (such as Rect) is then changed, the appearance streams will be regenerated. So this method would usually be called after initializing all annotation's properties.

     
    Public MethodForces regeneration of the annotation's appearance streams next time the document is saved.  
    Top
    See Also