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

In This Topic
    RedactAnnotation Class Members
    In This Topic

    The following tables list the members exposed by RedactAnnotation.

    Public Constructors
     NameDescription
    Public ConstructorInitializes a new instance of the RedactAnnotation class.  
    Top
    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. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets the AppearanceStreams object that allows defining this annotation's appearance streams. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets a list of GrapeCity.Documents.Common.Quadrilateral structures defining the annotation area. If not empty, these quadrilaterals denote the content region that is intended to be removed. If this entry is empty, the AnnotationBase.Rect entry denotes the content region that is intended to be removed.  
    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 color, it used as color of popup window, lines color etc. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    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 or sets the date and time when the annotation was created. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyGets the GrapeCity.Documents.Pdf.GcPdfDocument owning this annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets or sets the flags specifying various characteristics of the annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets or sets the justification to be used in displaying the overlay text. See PDF specification for details.  
    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.

    (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    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. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets or sets the outline color used to highlight the annotation rectangle.  
    Public PropertyGets or sets the color used to fill the annotation rectangle.  
    Public PropertyGets or sets the date and time when the annotation was modified. (Inherited from GrapeCity.Documents.Pdf.Annotations.AnnotationBase)
    Public PropertyGets 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 Property (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyGets the DefaultAppearance object that specifies the visual properties (font, font size etc.) used to format the overlay text.  
    Public PropertyGets or sets the overlay fill color with which to fill the redacted region after the affected content has been removed.  
    Public PropertyGets or sets the overlay text that should be drawn over the redacted region after the affected content has been removed.  
    Public PropertyGets or sets a value indicating whether the text specified by OverlayText should be repeated to fill the redacted region after the affected content has been removed.  
    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 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 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 annotation referenced by this annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyGets or sets the relationship (reference type) between this annotation and the annotation specified by the ReferenceAnnotation property. The referenced annotation should be on the same page with the current annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    Public PropertyGets 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 PropertyGets or sets the text representing a short description of the subject being addressed by the annotation. (Inherited from GrapeCity.Documents.Pdf.Annotations.MarkupAnnotation)
    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)
    Public PropertyGets 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 MethodTessellates a polygon specified by its vertices into triangles, and adds those triangles to this annotation's Area.  
    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