Public Member Functions | |
PolyLine () | |
Constructor. | |
PolyLine (Annot annot) | |
Constructor, with parent class. | |
Markup.EndingStyle | GetLineEndStyle () |
Get line ending style of the end point. More... | |
Markup.EndingStyle | GetLineStartStyle () |
Get line ending style of the start point. More... | |
int | GetStyleFillColor () |
Get fill color for some line ending styles. More... | |
PointFArray | GetVertexes () |
Get vertexes. More... | |
void | SetLineEndStyle (Markup.EndingStyle ending_style) |
Set line ending style of the end point. More... | |
void | SetLineStartStyle (Markup.EndingStyle starting_style) |
Set line ending style of the start point. More... | |
void | SetStyleFillColor (int fill_color) |
Set fill color for some line ending styles. More... | |
void | SetVertexes (PointFArray vertexes) |
Set vertexes. More... | |
![]() | |
Markup (Annot annot) | |
Constructor, with parent class object. | |
Markup () | |
Constructor. | |
Note | AddReply () |
Add a new reply to the end of reply list. More... | |
Note | AddStateAnnot (Markup.StateModel model, Markup.State state) |
Add a new state annotation. More... | |
DateTime | GetCreationDateTime () |
Get creation date time. More... | |
MarkupArray | GetGroupElements () |
Get an element (as markup annotation) from the group that current markup annotation belongs to. More... | |
Markup | GetGroupHeader () |
Get the header annotation (as primary annotation) of the group that current markup annotation belongs to. More... | |
string | GetIntent () |
Get intent name. More... | |
float | GetOpacity () |
Get opacity value. More... | |
Popup | GetPopup () |
Get related pop-up annotation. More... | |
Note | GetReply (int index) |
Get a reply by index. More... | |
int | GetReplyCount () |
Count all replies. More... | |
Note | GetStateAnnot (Markup.StateModel model, int index) |
Get a state annotation, under a specified state model. More... | |
int | GetStateAnnotCount (Markup.StateModel model) |
Get the count of state annotations, under a specified state model. More... | |
string | GetSubject () |
Get subject string. More... | |
string | GetTitle () |
Get title string. More... | |
bool | IsGrouped () |
Check whether current markup annotation is in a group or not. More... | |
bool | RemoveAllReplies () |
Remove all the replies. More... | |
bool | RemoveAllStateAnnots () |
Remove all state annotations. More... | |
bool | RemoveReply (int index) |
Remove a reply by index. More... | |
void | SetCreationDateTime (DateTime date_time) |
Set creation date time. More... | |
void | SetIntent (string intent) |
Set intent name. More... | |
void | SetOpacity (float opacity) |
Set opacity value. More... | |
void | SetPopup (Popup popup) |
Set related pop-up annotation. More... | |
void | SetSubject (string subject) |
Set subject string. More... | |
void | SetTitle (string title) |
Set title string. More... | |
bool | Ungroup () |
Ungroup current markup annotation from the group it belongs to. More... | |
![]() | |
Annot (PDFPage page, PDFDictionary annot_dict) | |
Constructor, with PDF page and annotation's PDF dictionary. More... | |
Annot (Annot annot) | |
Constructor, with another annot object. | |
Annot () | |
Constructor. | |
PDFStream | GetAppearanceStream (Annot.AppearanceType type, string appearance_state) |
Get annotation's appearance stream with specified type and state. More... | |
int | GetBorderColor () |
Get border color. More... | |
BorderInfo | GetBorderInfo () |
Get border information. More... | |
string | GetContent () |
Get content. More... | |
RectI | GetDeviceRect (bool is_transform_icon, Matrix2D matrix) |
Get annotation rectangle in device coordinate system. More... | |
PDFDictionary | GetDict () |
Get annotation's dictionary object. More... | |
int | GetFlags () |
Get annotation flags. More... | |
int | GetIndex () |
Get the index of current annotation in the page which current annotation belongs to. More... | |
DateTime | GetModifiedDateTime () |
Get last modified date time. More... | |
PDFDictionary | GetOptionalContent () |
Get the PDF dictionary of annotation's optional content. More... | |
PDFPage | GetPage () |
Get the related PDF page. More... | |
RectF | GetRect () |
Get rectangle, in PDF coordinate system . More... | |
Annot.Type | GetType () |
Get actual annotation type of current annotation. More... | |
string | GetUniqueID () |
Get unique ID. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | IsMarkup () |
Check if current annotation is a markup annotation. More... | |
bool | Move (RectF rect) |
Move current annotation to a new position, specified by a new rectangle in PDF coordinate system . More... | |
bool | RemoveProperty (Annot.Property property) |
Remove a specified annotation's property. More... | |
bool | ResetAppearanceStream () |
Reset appearance stream. More... | |
void | SetBorderColor (int color) |
Set border color. More... | |
void | SetBorderInfo (BorderInfo border) |
Set border information. More... | |
void | SetContent (string content) |
Set content. More... | |
void | SetFlags (int flags) |
Set annotation flags. More... | |
void | SetModifiedDateTime (DateTime date_time) |
Set last modified date time. More... | |
void | SetUniqueID (string unique_id) |
Set unique ID. More... | |
A polyline annotation (PDF 1.5) is similar to a polygon, except that the first and last vertex are not implicitly connected.
Polyline annotation is a kind of markup annotation, so class PolyLine is derived from class Markup, and also offers functions to get/set polyline annotation's properties and reset appearance stream of a polyline annotation.
For a polyline annotation, vertexes property is required. So please ensure that a polyline annotation has valid vertexes property before resetting its appearance stream; otherwise the polyline annotation cannot be reset appearance stream.
|
inline |
Get line ending style of the end point.
This property has effect on polyline annotation's appearance.
|
inline |
Get line ending style of the start point.
This property has effect on polyline annotation's appearance.
|
inline |
Get fill color for some line ending styles.
This property has effect on polyline annotation's appearance when the line ending style is one of following styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".
|
inline |
Get vertexes.
Vertexes property is required for a polyline annotation and this property has effect on polyline annotation's appearance.
|
inline |
Set line ending style of the end point.
This property has effect on polyline annotation's appearance. If user wants the new line ending style of end point has effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting the new line ending style of end point.
ending_style | The line ending style for the end point to be set. Please refer to e_EndingStyleXXX values and it should be one of these values. |
|
inline |
Set line ending style of the start point.
This property has effect on polyline annotation's appearance. If user wants the new line ending style of start point has effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting the new line ending style of start point.
starting_style | The line ending style for the start point to be set. Please refer to e_EndingStyleXXX values and it should be one of these values. |
|
inline |
Set fill color for some line ending styles.
This property has effect on polyline annotation's appearance when the line ending style of start point or end point is one of following styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".
fill_color | New fill color to be set. Format: 0xRRGGBB. |
|
inline |
Set vertexes.
Vertexes property is required for a polyline annotation and this property has effect on polyline annotation's appearance. If user wants the new vertexes have effect on annotation's appearance, please call function Annot::ResetAppearanceStream after setting the new vertexes.
vertexes | A valid point array of vertexes. It should contains at least 2 points as vertexes. |