|
enum | CapPos { CapPos.e_CapPosInline = 0,
CapPos.e_CapPosTop = 1
} |
| Enumeration for the position type of caption. More...
|
|
enum | EndingStyle {
EndingStyle.e_EndingStyleNone = 0,
EndingStyle.e_EndingStyleSquare = 1,
EndingStyle.e_EndingStyleCircle = 2,
EndingStyle.e_EndingStyleDiamond = 3,
EndingStyle.e_EndingStyleOpenArrow = 4,
EndingStyle.e_EndingStyleClosedArrow = 5,
EndingStyle.e_EndingStyleButt = 6,
EndingStyle.e_EndingStyleROpenArrow = 7,
EndingStyle.e_EndingStyleRClosedArrow = 8,
EndingStyle.e_EndingStyleSlash = 9
} |
| Enumeration for line ending style. More...
|
|
enum | MeasureType {
MeasureType.e_MeasureTypeX = 0,
MeasureType.e_MeasureTypeY = 1,
MeasureType.e_MeasureTypeD = 2,
MeasureType.e_MeasureTypeA = 3,
MeasureType.e_MeasureTypeT = 4,
MeasureType.e_MeasureTypeS = 5
} |
| Enumeration for annotation's measure type. More...
|
|
enum | State {
State.e_StateMarked = 1,
State.e_StateUnmarked = 2,
State.e_StateAccepted = 3,
State.e_StateRejected = 4,
State.e_StateCancelled = 5,
State.e_StateCompleted = 6,
State.e_StateNone = 7
} |
| Enumeration for markup annotation's state. More...
|
|
enum | StateModel { StateModel.e_StateModelMarked = 1,
StateModel.e_StateModelReview = 2
} |
| Enumeration for markup annotation's state model. More...
|
|
enum | AppearanceType { AppearanceType.e_AppearanceTypeNormal = 0,
AppearanceType.e_AppearanceTypeRollover = 1,
AppearanceType.e_AppearanceTypeDown = 2
} |
| Enumeration for the type of annotation's appearance. More...
|
|
enum | Flags {
Flags.e_FlagInvisible = 0x0001,
Flags.e_FlagHidden = 0x0002,
Flags.e_FlagPrint = 0x0004,
Flags.e_FlagNoZoom = 0x0008,
Flags.e_FlagNoRotate = 0x0010,
Flags.e_FlagNoView = 0x0020,
Flags.e_FlagReadOnly = 0x0040,
Flags.e_FlagLocked = 0x0080,
Flags.e_FlagToggleNoView = 0x0100,
Flags.e_FlagLockedContents = 0x0200
} |
| Enumeration for PDF annotation flags. More...
|
|
enum | HighlightingMode {
HighlightingMode.e_HighlightingNone = 0,
HighlightingMode.e_HighlightingInvert = 1,
HighlightingMode.e_HighlightingOutline = 2,
HighlightingMode.e_HighlightingPush = 3,
HighlightingMode.e_HighlightingToggle = 4
} |
| Enumeration for PDF annotation highlighting mode. More...
|
|
enum | MKEntry {
MKEntry.e_MKEntryRotation = 0,
MKEntry.e_MKEntryBorderColor = 1,
MKEntry.e_MKEntryBackgroundColor = 2,
MKEntry.e_MKEntryNormalCaption = 3,
MKEntry.e_MKEntryRolloverCaption = 4,
MKEntry.e_MKEntryDownCaption = 5,
MKEntry.e_MKEntryNormalIcon = 6,
MKEntry.e_MKEntryRolloverIcon = 7,
MKEntry.e_MKEntryDownIcon = 8,
MKEntry.e_MKEntryIconFit = 9,
MKEntry.e_MKEntryIconCaptionRelation = 10
} |
| Enumeration for annotation's MK dictionary (an appearance characteristics) entry. More...
|
|
enum | MKIconCaptionRelation {
MKIconCaptionRelation.e_MKRelationNoIcon = 0,
MKIconCaptionRelation.e_MKRelationNoCaption = 1,
MKIconCaptionRelation.e_MKRelationCaptionBelowIcon = 2,
MKIconCaptionRelation.e_MKRelationCaptionAboveIcon = 3,
MKIconCaptionRelation.e_MKRelationCaptionRight = 4,
MKIconCaptionRelation.e_MKRelationCaptionLeft = 5,
MKIconCaptionRelation.e_MKRelationCaptionOvrlayOnIcon = 6
} |
| Enumeration for icon and caption relative position in annotation's MK dictionary. More...
|
|
enum | Property { Property.e_PropertyModifiedDate = 0,
Property.e_PropertyCreationDate = 1,
Property.e_PropertyBorderColor = 2,
Property.e_PropertyFillColor = 3
} |
| Enumeration for some PDF annotation property. More...
|
|
enum | Type {
Type.e_UnknownType = 0,
Type.e_Note = 1,
Type.e_Link = 2,
Type.e_FreeText = 3,
Type.e_Line = 4,
Type.e_Square = 5,
Type.e_Circle = 6,
Type.e_Polygon = 7,
Type.e_PolyLine = 8,
Type.e_Highlight = 9,
Type.e_Underline = 10,
Type.e_Squiggly = 11,
Type.e_StrikeOut = 12,
Type.e_Stamp = 13,
Type.e_Caret = 14,
Type.e_Ink = 15,
Type.e_PSInk = 16,
Type.e_FileAttachment = 17,
Type.e_Sound = 18,
Type.e_Movie = 19,
Type.e_Widget = 20,
Type.e_Screen = 21,
Type.e_PrinterMark = 22,
Type.e_TrapNet = 23,
Type.e_Watermark = 24,
Type.e_3D = 25,
Type.e_Popup = 26,
Type.e_Redact = 27
} |
| Enumeration for PDF annotation type. More...
|
|
|
| Line () |
| Constructor.
|
|
| Line (Annot annot) |
| Constructor, with parent class object. More...
|
|
void | EnableCaption (bool cap) |
| Set the flag which is used to decide whether the content of current line annotation should be replicated as a caption in the appearance or not. More...
|
|
PointF | GetCaptionOffset () |
| Get caption offset values. More...
|
|
Line.CapPos | GetCaptionPositionType () |
| Get the position type of caption. More...
|
|
PointF | GetEndPoint () |
| Get the end point. More...
|
|
float | GetLeaderLineExtensionLength () |
| Get the length of leader line extension. More...
|
|
float | GetLeaderLineLength () |
| Get the length of leader line. More...
|
|
float | GetLeaderLineOffset () |
| Get the length of leader line offset. 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 | GetMeasureUnit (Markup.MeasureType measure_type) |
| Get the label for displaying the units for measuring. More...
|
|
PointF | GetStartPoint () |
| Get the start point. More...
|
|
int | GetStyleFillColor () |
| Get fill color for ending styles. More...
|
|
bool | HasCaption () |
| Check whether the content of current line annotation should be replicated as a caption in the appearance or not. More...
|
|
void | SetCaptionOffset (PointF offset) |
| Set caption offset values. More...
|
|
void | SetCaptionPositionType (Line.CapPos cap_position) |
| Set the position type of caption. More...
|
|
void | SetEndPoint (PointF point) |
| Set the end point. More...
|
|
void | SetLeaderLineExtensionLength (float extension_length) |
| Set the length of leader line extension. More...
|
|
void | SetLeaderLineLength (float length) |
| Set the length of leader line. More...
|
|
void | SetLeaderLineOffset (float offset) |
| Set the length of leader line offset. More...
|
|
void | SetLineEndStyle (Markup.EndingStyle ending_style) |
| Set line ending style of the end point. More...
|
|
void | SetLineStartStyle (Markup.EndingStyle ending_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 | SetStartPoint (PointF point) |
| Set the start point. More...
|
|
void | SetStyleFillColor (int color) |
| Set fill color for ending styles. 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...
|
|
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 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 | 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 line annotation displays a single straight line on the page.
Line annotation is a kind of markup annotation, so class Line is derived from class Markup , and also offers functions to get/set line annotation's properties and reset appearance stream of a line annotation.
For a line annotation, start point and end point are required. So please ensure that a line annotation has valid start point and end point before resetting its appearance stream; otherwise the line annotation cannot be reset appearance stream.
- Note
- For a newly created line annotation, if user calls function Annot.ResetAppearanceStream directly after setting required start point and end point property and not setting any other properties, the default appearance will be used:
border width = 2.0, border style = foxit.pdf.annots.BorderInfo.Style.e_Solid , border color = 0xFFFF0000 (red), opacity = 1, line starting/ending styles = "None", no caption is enabled.
- See also
- Markup