Aspose::Pdf::Annotations::ColorBarAnnotation class
Contents
[
Hide
]ColorBarAnnotation class
Class representing ColorBarAnnotation annotation. Property Color ignored, instead used ColorsOfCMYK color. On creation, the ratio of width and height determines the orientation of the annotation - horizontal or vertical. Next, it checks that the annotation rectangle is outside the TrimBox, and if not, then it is shifted to the nearest location outside the TrimBox, taking into account the orientation of the annotation. It is possible to reduce the width (height) so that the annotation fits outside the TrimBox. If there is no space for the layout, the width/height can be set to zero (in this case, the annotation is present on the page, but not displayed).
class ColorBarAnnotation : public Aspose::Pdf::Annotations::PrinterMarkAnnotation
Methods
| Method | Description |
|---|---|
| Accept(System::SharedPtr<AnnotationSelector>) override | Accepts visitor object to process the annotation. |
| static AddPrinterMarks(System::SharedPtr<Document>, PrinterMarksKind) | Adds printer’s marks to all pages in the specified document. |
| static AddPrinterMarks(System::SharedPtr<Aspose::Pdf::Page>, PrinterMarksKind) | Adds printer’s marks to the specified page. |
| BaseParagraph() | |
| ChangeAfterResize(System::SharedPtr<Matrix>) override | Update parameters and appearance, according to the matrix transform and moving outside of TrimBox if nesseary. |
| Clone() override | Clones this instance. Virtual method. Always return null. |
| ColorBarAnnotation(System::SharedPtr<Aspose::Pdf::Page>, System::SharedPtr<Rectangle>, ColorsOfCMYK) | Creates new ColorBar annotation on the specified page. |
| 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_Characteristics() | Gets annotation characteristics. |
| get_Color() | Gets annotation color. |
| get_ColorOfCMYK() const | Gets color (one of cyan, magenta, yellow, black) for which the annotation is drawing. |
| get_Contents() | Gets annotation text. |
| get_Flags() | Flags of the annotation. |
| 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_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. |
| virtual get_PageIndex() | Gets index of page which contains annotation. |
| virtual get_Rect() | Gets annotation rectangle. |
| get_States() | Gets appearance dictionary of annotation. |
| get_TextHorizontalAlignment() | Gets text alignment for 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. |
| 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_Color(System::SharedPtr<Aspose::Pdf::Color>) | Sets annotation color. |
| set_ColorOfCMYK(ColorsOfCMYK) | Sets color (one of cyan, magenta, yellow, black) for which the annotation is drawing. |
| set_Contents(System::String) | Sets annotation text. |
| set_Flags(AnnotationFlags) | Flags of the annotation. |
| 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_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. |
| virtual set_Rect(System::SharedPtr<Rectangle>) | Sets annotation rectangle. |
| set_TextHorizontalAlignment(Aspose::Pdf::HorizontalAlignment) | Sets text alignment for 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. |
See Also
- Class PrinterMarkAnnotation
- Namespace Aspose::Pdf::Annotations
- Library Aspose.PDF for C++