Aspose::Pdf::Annotations::RedactionAnnotation class
Contents
[
Hide
]RedactionAnnotation class
Represents Redact annotation.
class RedactionAnnotation : public Aspose::Pdf::Annotations::MarkupAnnotation
Methods
| Method | Description |
|---|---|
| Accept(System::SharedPtr<AnnotationSelector>) override | Accepts visitor object to process the annotation. |
| BaseParagraph() | |
| virtual ChangeAfterResize(System::SharedPtr<Matrix>) | Update parameters and appearance, according to the matrix transform. |
| ClearState() | Clears state and state model for the annotation. For example, clears the review status for an annotation. Note, the state stored in other text annotation which has state and statemodel keys. |
| Clone() override | Clones this instance. Virtual method. Always return null. |
| Flatten() | Places annotation contents directly on the page, annotation object will be removed. |
| get_Actions() | Gets list of annotatation actions. |
| virtual get_ActiveState() | Gets current annotation appearance state. |
| get_Alignment() | Annotation alignment. This property is obsolete. Use HorizontalAligment instead. |
| get_AnnotationType() override | Gets type of annotation. |
| get_Appearance() | Gets appearance dictionary of the annotation. |
| get_Border() const | Gets annotation border characteristics. Border |
| get_BorderColor() | Gets color of border which is drawn when redaction is not active. |
| get_Characteristics() | Gets annotation characteristics. |
| get_Color() | Gets annotation color. |
| get_Contents() | Gets annotation text. |
| get_CreationDate() | Gets date and time when annotation was created. |
| get_DefaultAppearance() | Gets the default appearance string to be used in formatting the text. |
| get_FillColor() | Gets color to fill annotation. |
| get_Flags() | Flags of the annotation. |
| get_FontSize() const | Gets font size for OverlayText. |
| get_FullName() | Gets full qualified name of the annotation. |
| virtual get_Height() | Gets height of the annotation. |
| get_HorizontalAlignment() override | Gets text alignment for annotation. |
| virtual get_Hyperlink() | Gets the fragment hyperlink(for pdf generator). |
| get_InReplyTo() | A reference to the annotation that this annotation is “in reply to”. Both annotations must be on the same page of the document. |
| get_IsFirstParagraphInColumn() const | Gets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) |
| get_IsInLineParagraph() const | Gets a paragraph is inline. Default is false.(for pdf generation) |
| get_IsInNewPage() const | Gets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) |
| get_IsKeptWithNext() const | Gets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation) |
| get_Margin() | Gets a outer margin for paragraph (for pdf generation) |
| get_Modified() | Gets date and time when annotation was recently modified. |
| get_Name() | Gets annotation name on the page. |
| get_Opacity() | Gets the constant opacity value to be used in painting the annotation. |
| get_OverlayText() | Gets text to print on redact annotation. |
| virtual get_PageIndex() | Gets index of page which contains annotation. |
| get_Popup() | Pop-up annotation for entering or editing the text associated with this annotation. |
| get_QuadPoint() | An array of 8xN numbers specifying the coordinates of content region that is intended to be removed. |
| virtual get_Rect() | Gets annotation rectangle. |
| get_Repeat() | If true overlay text will be repated on the annotation. |
| get_ReplyType() | A string specifying the relationship (the “reply type”) between this annotation and one specified by InReplyTo. |
| get_RichText() | Gets a rich text string to be displayed in the pop-up window when the annotation is opened. |
| get_States() | Gets appearance dictionary of annotation. |
| get_Subject() | Gets text representing desciption of the object. |
| get_TextAlignment() | Gets. Alignment of Overlay Text. |
| get_TextHorizontalAlignment() | Gets text alignment for annotation. |
| get_Title() override | Gets a text that shall be displayed in title bar of annotation. |
| static get_UpdateAppearanceOnConvert() | If true, annotation appearance will be updated before converting PF document into image. This allows convert fields correctly but probably demand more time. |
| static get_UseFontSubset() | If this property set to true, fonts will be added to document as subsets. Default value is true. |
| virtual get_VerticalAlignment() | Gets a vertical alignment of paragraph. |
| virtual get_Width() | Gets width of the annotation. |
| get_ZIndex() const | Gets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page. |
| GetRectangle(bool) | Returns rectangle of annotation taking into consideration page rotation. |
| GetState() | Gets the state of the annotation. Note, the state stored in other text annotation which has state and statemodel keys. |
| GetStateModel() | Gets the state model of the annotation. Note, the state stored in other text annotation which has state and statemodel keys. |
| MarkupAnnotation(System::SharedPtr<Document>) | Constructor for markup annotation. |
| Redact() | Flattens annotation and redacts page contents (i.e. removes text and image under redacted annotation) |
| RedactionAnnotation(System::SharedPtr<Document>) | Constructor for RedactionAnnotation. For using in Generator. |
| RedactionAnnotation(System::SharedPtr<Aspose::Pdf::Page>, System::SharedPtr<Rectangle>) | Constructor for RedactAnnotation. |
| virtual set_ActiveState(System::String) | Sets current annotation appearance state. |
| set_Alignment(TextAlignment) | Annotation alignment. This property is obsolete. Use HorizontalAligment instead. |
| set_Border(System::SharedPtr<Aspose::Pdf::Annotations::Border>) | Sets annotation border characteristics. Border |
| set_BorderColor(System::SharedPtr<Aspose::Pdf::Color>) | Sets color of border which is drawn when redaction is not active. |
| set_Color(System::SharedPtr<Aspose::Pdf::Color>) | Sets annotation color. |
| set_Contents(System::String) | Sets annotation text. |
| set_DefaultAppearance(System::String) | Sets the default appearance string to be used in formatting the text. |
| set_FillColor(System::SharedPtr<Aspose::Pdf::Color>) | Sets color to fill annotation. |
| set_Flags(AnnotationFlags) | Flags of the annotation. |
| set_FontSize(float) | Sets font size for OverlayText. |
| virtual set_Height(double) | Sets height of the annotation. |
| set_HorizontalAlignment(Aspose::Pdf::HorizontalAlignment) override | Sets text alignment for annotation. |
| virtual set_Hyperlink(System::SharedPtr<Aspose::Pdf::Hyperlink>) | Sets the fragment hyperlink(for pdf generator). |
| set_InReplyTo(System::SharedPtr<Annotation>) | A reference to the annotation that this annotation is “in reply to”. Both annotations must be on the same page of the document. |
| set_IsFirstParagraphInColumn(bool) | Sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) |
| set_IsInLineParagraph(bool) | Sets a paragraph is inline. Default is false.(for pdf generation) |
| set_IsInNewPage(bool) | Sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) |
| set_IsKeptWithNext(bool) | Sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation) |
| set_Margin(System::SharedPtr<MarginInfo>) | Sets a outer margin for paragraph (for pdf generation) |
| set_Modified(System::DateTime) | Sets date and time when annotation was recently modified. |
| set_Name(System::String) | Sets annotation name on the page. |
| set_Opacity(double) | Sets the constant opacity value to be used in painting the annotation. |
| set_OverlayText(System::String) | Sets text to print on redact annotation. |
| set_Popup(System::SharedPtr<PopupAnnotation>) | Pop-up annotation for entering or editing the text associated with this annotation. |
| set_QuadPoint(System::ArrayPtr<System::SharedPtr<Point>>) | An array of 8xN numbers specifying the coordinates of content region that is intended to be removed. |
| virtual set_Rect(System::SharedPtr<Rectangle>) | Sets annotation rectangle. |
| set_Repeat(bool) | If true overlay text will be repated on the annotation. |
| set_ReplyType(Aspose::Pdf::Annotations::ReplyType) | A string specifying the relationship (the “reply type”) between this annotation and one specified by InReplyTo. |
| set_RichText(System::String) | Sets a rich text string to be displayed in the pop-up window when the annotation is opened. |
| set_Subject(System::String) | Gets text representing desciption of the object. |
| set_TextAlignment(Aspose::Pdf::HorizontalAlignment) | Sets. Alignment of Overlay Text. |
| set_TextHorizontalAlignment(Aspose::Pdf::HorizontalAlignment) | Sets text alignment for annotation. |
| set_Title(System::String) override | Sets a text that shall be displayed in title bar of annotation. |
| static set_UpdateAppearanceOnConvert(bool) | If true, annotation appearance will be updated before converting PF document into image. This allows convert fields correctly but probably demand more time. |
| static set_UseFontSubset(bool) | If this property set to true, fonts will be added to document as subsets. Default value is true. |
| virtual set_VerticalAlignment(Aspose::Pdf::VerticalAlignment) | Sets a vertical alignment of paragraph. |
| virtual set_Width(double) | Sets width of the annotation. |
| set_ZIndex(int32_t) | Sets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page. |
| SetMarkedState(bool) | Sets Marked and Unmarked state for the annotation. Note, the state stored in other text annotation which has state and statemodel keys. |
| SetReviewState(AnnotationState, System::String) | Sets the review state for an annotation. Marked and Unmarked states are ignored as they do not belong to the Review StateModel. Note, the state stored in other text annotation which has state and statemodel keys. |
| SetReviewState(AnnotationState) | Sets the review state for an annotation. Marked and Unmarked states are ignored as they do not belong to the Review StateModel. The state is set by the user who created the target annotation. The value is taken from the Title property of the target annotation. Note, the state stored in other text annotation which has state and statemodel keys. |
See Also
- Class MarkupAnnotation
- Namespace Aspose::Pdf::Annotations
- Library Aspose.PDF for C++