Class ColorBarAnnotation

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).

public sealed class ColorBarAnnotation : PrinterMarkAnnotation

Constructors

NameDescription
ColorBarAnnotation(Page, Rectangle, ColorsOfCMYK)Creates new ColorBar annotation on the specified page.

Properties

NameDescription
Actions { get; }Gets list of annotatation actions.
virtual ActiveState { get; set; }Gets or sets current annotation appearance state.
override AnnotationType { get; }Gets type of annotation.
Appearance { get; }Gets appearance dictionary of the annotation.
Border { get; set; }Gets or sets annotation border characteristics. Border
Characteristics { get; }Gets annotation characteristics.
Color { get; set; }Gets or sets annotation color.
ColorOfCMYK { get; set; }Gets or sets color (one of cyan, magenta, yellow, black) for which the annotation is drawing.
Contents { get; set; }Gets or sets annotation text.
Flags { get; set; }Flags of the annotation.
FullName { get; }Gets full qualified name of the annotation.
virtual Height { get; set; }Gets or sets height of the annotation.
virtual Hyperlink { get; set; }Gets or sets the fragment hyperlink(for pdf generator).
IsFirstParagraphInColumn { get; set; }Gets or sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation)
IsInLineParagraph { get; set; }Gets or sets a paragraph is inline. Default is false.(for pdf generation)
IsInNewPage { get; set; }Gets or sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation)
IsKeptWithNext { get; set; }Gets or sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation)
Margin { get; set; }Gets or sets a outer margin for paragraph (for pdf generation)
Modified { get; set; }Gets or sets date and time when annotation was recently modified.
Name { get; set; }Gets or sets annotation name on the page.
virtual PageIndex { get; }Gets index of page which contains annotation.
virtual Rect { get; set; }Gets or sets annotation rectangle.
States { get; }Gets appearance dictionary of annotation.
TextHorizontalAlignment { get; set; }Gets or sets text alignment for annotation.
virtual VerticalAlignment { get; set; }Gets or sets a vertical alignment of paragraph
virtual Width { get; set; }Gets or sets width of the annotation.
ZIndex { get; set; }Gets or 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.

Methods

NameDescription
override Accept(AnnotationSelector)Accepts visitor object to process the annotation.
override ChangeAfterResize(Matrix)Update parameters and appearance, according to the matrix transform and moving outside of TrimBox if nesseary.
virtual Clone()Clones this instance. Virtual method. Always return null.
virtual Flatten()Places annotation contents directly on the page, annotation object will be removed.
GetRectangle(bool)Returns rectangle of annotation taking into consideration page rotation.

See Also