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

In This Topic
    FreeTextAnnotation Class Members
    In This Topic

    The following tables list the members exposed by FreeTextAnnotation.

    Public Constructors
     NameDescription
    Public ConstructorFreeTextAnnotation ConstructorInitializes a new instance of the FreeTextAnnotation class.  
    Top
    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. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyAppearanceStreamsGets the AppearanceStreams object that allows defining this annotation's appearance streams. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyAssociatedFilesGets the list of embedded files associated with this GrapeCity.Documents.Pdf.Graphics.FormXObject. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyCalloutLineGets or sets an array of four or six numbers specifying a callout line attached to the free text annotation. Six numbers [ x1 y1 x2 y2 x3 y3 ] represent the starting, knee point, and ending coordinates of the line in default user space. Four numbers [ x1 y1 x2 y2 ] represent the starting and ending coordinates of the line.  
    Public PropertyColorGets or sets the annotation color.  
    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. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyCreationDateGets or sets the date and time when the annotation was created. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyDefaultAppearanceGets the DefaultAppearance object that specifies the visual properties (font, font size etc.) used to format the content of the annotation.  
    Public PropertyDocGets the GrapeCity.Documents.Pdf.GcPdfDocument owning this annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyFlagsGets or sets the flags specifying various characteristics of the annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyJustificationGets or sets the justification to be used in displaying the annotation’s text. See PDF specification for details.  
    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.

    (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyLineDashPatternGets or sets the line dash pattern. Null means a solid line.  
    Public PropertyLineEndStyleGets or sets the style of end callout line.  
    Public PropertyLineWidthGets or sets the line width in points.  
    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. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    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. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyModifiedDateGets or sets the date and time when the annotation was modified. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyNameGets or sets the annotation name, a text string uniquely identifying it among all annotations on its page. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyOpacity  
    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.

    (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyPagesGets the list of pages that reference this annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyPopupGets or sets the PopupAnnotation annotation for entering or editing text associated with this annotation. Setting this property changes the PopupAnnotation.Parent property. A separate PopupAnnotation allows defining additional properties of the popup window: color, position etc. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyRectGets or sets the annotation rectangle, defining the location of the annotation on a page. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyReferenceAnnotationGets or sets the annotation referenced by this annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyReferenceTypeGets or sets the relationship (reference type) between this annotation and the annotation specified by the MarkupAnnotation.ReferenceAnnotation property. The referenced annotation should be on the same page with the current annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyRichTextGets or sets the text to be displayed in the pop-up window when the annotation is opened. This text can be formatted using html tags, see PDF specification for details. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyStyleStringGets or sets the default style string. See PDF specification for details.  
    Public PropertySubjectGets or sets the text representing a short description of the subject being addressed by the annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyTextOffsetsGets or sets the GrapeCity.Documents.Common.Offsets structure that defines the numerical differences between two rectangles: the AnnotationBase.Rect and an inner rectangle contained within that rectangle. The inner rectangle is where the FreeTextAnnotation’s text should be displayed.

    Note that if this rectangle is not specified then AnnotationBase.Rect is used as the text rectangle.

     
    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.

    (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyUserNameGets or sets the text label to be displayed in the title bar of the annotation’s pop-up window when open and active. By convention, this entry identifies the user who added the annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    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.

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

    Reference

    FreeTextAnnotation Class
    GrapeCity.Documents.Pdf.Annotations Namespace

     

     

    Copyright © 2021 GrapeCity, Inc. All rights reserved.

    Product Support Forum | Print this page