Foxit PDF SDK
|
Public Member Functions | |
PolyLine () | |
Constructor. | |
PolyLine (Annot annot) | |
Constructor, with parent class object. More... | |
Markup.EndingStyle | GetLineEndStyle () |
Get line ending style of the end point. More... | |
Markup.EndingStyle | GetLineStartStyle () |
Get line ending style of the start point. More... | |
float | GetMeasureConversionFactor (Markup.MeasureType measure_type) |
Get the conversion factor for measuring. More... | |
string | GetMeasureRatio () |
Get the scale ratio string for measuring. More... | |
string | GetMeasureRatioW () |
Get the scale ratio string for measuring. More... | |
string | GetMeasureUnit (Markup.MeasureType measure_type) |
Get the label for displaying the units for measuring. More... | |
string | GetMeasureUnitW (Markup.MeasureType measure_type) |
Get the label for displaying the units for measuring. 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 | SetMeasureConversionFactor (Markup.MeasureType measure_type, float factor) |
Set the conversion factor for measuring. More... | |
void | SetMeasureRatio (string ratio) |
Set the scale ratio string for measuring. More... | |
void | SetMeasureUnit (Markup.MeasureType measure_type, string unit) |
Set the label for displaying the units for measuring. 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. More... | |
Markup () | |
Constructor. | |
Note | AddReply () |
Add a new reply to the end of reply list. More... | |
void | AddRichText (string content, RichTextStyle style) |
Add a new rich text string to the end. More... | |
Note | AddStateAnnot (string title, 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... | |
string | GetRichTextContent (int index) |
Get text string of a rich text string specified by index. More... | |
int | GetRichTextCount () |
Get the count of rich text strings. More... | |
RichTextStyle | GetRichTextStyle (int index) |
Get style data of a rich text string specified by index. More... | |
NoteArray | GetStateAnnots (Markup.StateModel model) |
Get all state annotations in a specified state model. More... | |
string | GetSubject () |
Get subject string. More... | |
string | GetTitle () |
Get title string. More... | |
void | InsertRichText (int index, string content, RichTextStyle style) |
Insert a new rich text string to the place which is specified by index. 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 the state annotations. More... | |
bool | RemoveReply (int index) |
Remove a reply by index. More... | |
void | RemoveRichText (int index) |
Remove a rich text string specified 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 | SetRichTextContent (int index, string content) |
Set text string of a rich text string specified by index. More... | |
void | SetRichTextStyle (int index, RichTextStyle style) |
Set style data of a rich text string specified by index. 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 annotation object. More... | |
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 (Matrix2D matrix) |
Get annotation rectangle in device coordinate system. More... | |
PDFDictionary | GetDict () |
Get annotation's dictionary object. More... | |
Matrix2D | GetDisplayMatrix (Matrix2D page_display_matrix) |
Get the display matrix, from PDF coordinate system to targeted device coordinate system. 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 | HasProperty (Annot.Property property) |
Whether current annotation has the specified annotation's property. 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] (foxit.pdf.PDFPage). 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 |
Constructor, with parent class object.
[in] | annot | Parent class object. |
|
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 the conversion factor for measuring.
A polyline annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
[in] | measure_type | Measure type. Please refer to values starting from foxit.pdf.annots.Markup.MeasureType.e_MeasureTypeX and this should be one of these values. |
|
inline |
Get the scale ratio string for measuring.
A polyline annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Scale ratio string expresses the scale ratio of the drawing in the region. Please refer to P745 in <PDF Reference 1.7> for more details.
|
inline |
Get the scale ratio string for measuring.
A polyline annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Scale ratio string expresses the scale ratio of the drawing in the region. Please refer to P745 in <PDF Reference 1.7> for more details.
|
inline |
Get the label for displaying the units for measuring.
A polyline annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
[in] | measure_type | Measure type. Please refer to values starting from foxit.pdf.annots.Markup.MeasureType.e_MeasureTypeX and this would be one of these values. |
|
inline |
Get the label for displaying the units for measuring.
A polyline annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
[in] | measure_type | Measure type. Please refer to values starting from foxit.pdf.annots.Markup.MeasureType.e_MeasureTypeX and this would be one of these values. |
|
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.
[in] | ending_style | The line ending style for the end point to be set. Please refer to values starting from foxit.pdf.annots.Markup.EndingStyle.e_EndingStyleNone and this 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.
[in] | starting_style | The line ending style for the start point to be set.Please refer to values starting from foxit.pdf.annots.Markup.EndingStyle.e_EndingStyleNone and this should be one of these values. |
|
inline |
Set the conversion factor for measuring.
A polyline annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
[in] | measure_type | Measure type. Please refer to values starting from foxit.pdf.annots.Markup.MeasureType.e_MeasureTypeX and this should be one of these values. |
[in] | factor | The conversion factor. |
|
inline |
Set the scale ratio string for measuring.
A polyline annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Scale ratio string expresses the scale ratio of the drawing in the region. Please refer to P745 in <PDF Reference 1.7> for more details.
[in] | ratio | A UTF-8 byte string expressing the scale ratio. The string should be like: "1/4 in = 1 ft", indicating that 1/4 inches in default user space is equivalent to 1 foot in real-world measurements. |
|
inline |
Set the label for displaying the units for measuring.
A polyline annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
[in] | measure_type | Measure type. Please refer to values starting from foxit.pdf.annots.Markup.MeasureType.e_MeasureTypeX and this would be one of these values. |
[in] | unit | A UTF-8 text string that specifies a label for displaying the units. |
|
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".
[in] | 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.
[in] | vertexes | A valid point array of vertexes. It should contains at least 2 points as vertexes. |