ILine Interface |
The purpose of a line annotation (PDF 1.3) is to display a single straight
line on the page. When opened, it shall display a pop-up window containing
the text of the associated note.
Namespace: pdftron.PDF.Annots
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255
Syntaxpublic interface ILine : IAnnot, IMarkup
The ILine type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | DeleteCustomData | Deletes custom data associated with the given key.
(Inherited from IAnnot.) |
| Flatten | Flatten/Merge the existing annotation appearances with the page content and
delete this annotation from a given page.
Annotation 'flattening' refers to the operation that changes active annotations
(such as markup, widgets, 3D models, etc.) into a static area that is part of the
PDF document, just like the other text and images in the document.
(Inherited from IAnnot.) |
| GetAnnotType | Gets the type.
(Inherited from IAnnot.) |
| GetAppearance | Gets the annotation’s appearance for the given combination of annotation
and appearance states.
(Inherited from IAnnot.) |
| GetAppearance(AnnotAnnotationState) | Gets the annotation’s appearance for the given combination of annotation
and appearance states.
(Inherited from IAnnot.) |
| GetAppearance(AnnotAnnotationState, String) | Gets the annotation’s appearance for the given combination of annotation
and appearance states.
(Inherited from IAnnot.) |
| GetBorderEffect | Gets the Border Effect of the Markup Annotation.
(Inherited from IMarkup.) |
| GetBorderEffectIntensity | Sets the Border Effect of the Markup Annotation.
(Optional; PDF 1.5 )
(Inherited from IMarkup.) |
| GetBorderStyle | Gets the border style for the annotation. Typically used for Link annotations.
(Inherited from IAnnot.) |
| GetCaptionPosition | Gets the caption position of a line.
|
| GetColorAsCMYK | Gets an annotation's color.
(Inherited from IAnnot.) |
| GetColorAsGray | Gets an annotation's color.
(Inherited from IAnnot.) |
| GetColorAsRGB | Gets the annotation’s active appearance state.
(Inherited from IAnnot.) |
| GetColorCompNum | Gets the color space the annotation's color is represented in.
(Inherited from IAnnot.) |
| GetContentRect | Gets the inner bounding rectangle of the Square.
(Optional; PDF 1.5)
(Inherited from IMarkup.) |
| GetContents | Gets the contents.
(Inherited from IAnnot.) |
| GetCreationDates | Gets the creation date of the Markup Annotation
(Inherited from IMarkup.) |
| GetCustomData | Returns custom data associated with the given key.
(Inherited from IAnnot.) |
| GetDate | Gets an annotation's last modified date.
(Inherited from IAnnot.) |
| GetEndPoint | Gets the coordinates of the end of a line.
|
| GetEndStyle | Gets the ending syle of the end of a line.
|
| GetFlag | Gets the flag.
(Inherited from IAnnot.) |
| GetIntentType | Gets the intent type of the line.
|
| GetInteriorColor | Sets the interior color of the Square.
(Optional; PDF 1.4 )
(Inherited from IMarkup.) |
| GetInteriorColorCompNum | Gets the number indicating interior color space of the Square.
(Inherited from IMarkup.) |
| GetLeaderLineExtensionLength | Gets the leader line extension length of a line.
|
| GetLeaderLineLength | Gets the leader line length of a line. *
|
| GetLeaderLineOffset | Gets the leader line offset length of a line.
|
| GetOpacity | Gets the contant opacity value corresponding to the annotation.
(Inherited from IMarkup.) |
| GetOptionalContent | Gets optional content of an annotation.
(Inherited from IAnnot.) |
| GetPadding | Gets the rectangle difference of the Square.
(Optional; PDF 1.5)
(Inherited from IMarkup.) |
| GetPage | Gets the page the annotation is associated with.
(Inherited from IAnnot.) |
| GetPopup | Gets the Popup object associated with this Markup annotation.
(Inherited from IMarkup.) |
| GetRect | Gets the rect.
(Inherited from IAnnot.) |
| GetRotation | Gets the rotation value of the annotation. The Rotation specifies the number of degrees by which the
annotation shall be rotated counterclockwise relative to the page.
The value shall be a multiple of 90.
(Inherited from IAnnot.) |
| GetSDFObj | Gets the SDFObj.
(Inherited from IAnnot.) |
| GetShowCaption | Gets the option of whether to show caption.
|
| GetStartPoint | Gets the coordinates of the start of a line.
|
| GetStartStyle | Gets the ending syle of the start of a line.
|
| GetStructParent | Gets the struct parent of an annotation.
(Required if the annotation is a structural content item; PDF 1.3)
(Inherited from IAnnot.) |
| GetSubject | Gets subject of the Markup Annotation.
(Inherited from IMarkup.) |
| GetTextHOffset | Gets the horizontal offset of the caption.
|
| GetTextVOffset | Gets the vertical offset of the caption.
|
| GetTitle | Gets the title of the Markup Annotation.
(Inherited from IMarkup.) |
| GetTriggerAction | Get the Action associated with the selected Annot Trigger event
(Inherited from IAnnot.) |
| GetUniqueID | Gets the unique ID.
(Inherited from IAnnot.) |
| IsMarkup | Checks if is markup.
(Inherited from IAnnot.) |
| IsValid | Checks if is valid.
(Inherited from IAnnot.) |
| RefreshAppearance | Regenerates the appearance stream for the annotation.
This method can be used to auto-generate the annotation appearance after creating
or modifying the annotation without providing an explicit appearance or
setting the "NeedAppearances" flag in the AcroForm dictionary.
(Inherited from IAnnot.) |
| RefreshAppearance(RefreshOptions) | A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
(Inherited from IAnnot.) |
| RemoveAppearance | Removes the annotation's appearance
(Inherited from IAnnot.) |
| RemoveAppearance(AnnotAnnotationState) | Removes the annotation's appearance for the given combination of annotation
and appearance states.
(Inherited from IAnnot.) |
| RemoveAppearance(AnnotAnnotationState, String) | Removes the annotation's appearance for the given combination of annotation
and appearance states.
(Inherited from IAnnot.) |
| Resize | Resize.
(Inherited from IAnnot.) |
| SetAppearance(Obj) | Sets the annotation’s appearance for the given combination of annotation
and appearance states.
(Optional; PDF 1.2)
(Inherited from IAnnot.) |
| SetAppearance(Obj, AnnotAnnotationState) | Removes the annotation's appearance for the given combination of annotation
and appearance states.
(Inherited from IAnnot.) |
| SetAppearance(Obj, AnnotAnnotationState, String) | Sets the annotation’s appearance for the given combination of annotation
and appearance states.
(Optional; PDF 1.2)
(Inherited from IAnnot.) |
| SetBorderEffectIntensity | Sets the Border Effect Intensity of the Markup Annotation.
(Optional; valid only if Border effect is Cloudy)
(Inherited from IMarkup.) |
| SetBorderStyle | Sets the border style for the annotation. Typically used for Link annotations.
(Inherited from IAnnot.) |
| SetCaptionPosition | Sets the caption position of a line.
(PDF 1.7)
|
| SetColor(ColorPt) | Sets an annotation's color.
(Optional; PDF 1.1)
(Inherited from IAnnot.) |
| SetColor(ColorPt, Int32) | Sets an annotation's color.
(Optional; PDF 1.1)
(Inherited from IAnnot.) |
| SetContentRect | Sets the inner bounding rectangle of the Square.
(Optional; PDF 1.5)
(Inherited from IMarkup.) |
| SetContents | Sets the contents.
(Inherited from IAnnot.) |
| SetCreationDates | Sets the creation date of the Markup Annotation.
(Optional; PDF 1.5 )
(Inherited from IMarkup.) |
| SetCustomData | Sets the custom data associated with the specified key.
(Inherited from IAnnot.) |
| SetDate | Sets an annotation's last modified date.
(Inherited from IAnnot.) |
| SetDateToNow |
Sets an annotation's modification date and time to the current time.
This corresponds to the value of the "M" field of annotation dictionary(PDF 1.1)
(Inherited from IAnnot.) |
| SetEndPoint | Sets the coordinates of the end of a line.
|
| SetEndStyle | Sets the ending syle of the end of a line
(Optional; PDF 1.4)
|
| SetFlag | Sets the value of given Flag.
(Inherited from IAnnot.) |
| SetIntentType | Sets the intent type of the line.
(For PDF 1.6)
|
| SetInteriorColor | Gets the interior color of the Square.
(Inherited from IMarkup.) |
| SetLeaderLineExtensionLength | Sets the leader line extension length of a line.
(PDF 1.6)
|
| SetLeaderLineLength | Sets the leader line length of a line.
(PDF 1.6)
|
| SetLeaderLineOffset | Sets the leader line offset length of a line.
(PDF 1.7)
|
| SetOpacity | Sets the contant opacity value corresponding to the annotation.
(Optional; PDF 1.4 )
(Inherited from IMarkup.) |
| SetOptionalContent | Sets optional content of an annotation.
(Optional, PDF1.5).
(Inherited from IAnnot.) |
| SetPadding | Sets the rectangle difference of the Square.
(Optional; PDF 1.5)
(Inherited from IMarkup.) |
| SetPage | Sets the reference to a page the annotation is associated with.
(Optional PDF 1.3; not used in FDF files)
(Inherited from IAnnot.) |
| SetPopup | Sets the Popup object associated with this Markup annotation.
(Optional; PDF 1.3 )
(Inherited from IMarkup.) |
| SetRect | Sets the size and location of an annotation on its page.
(Inherited from IAnnot.) |
| SetRotation | Sets the rotation value of the annotation. The Rotation specifies the number of degrees by which the
annotation shall be rotated counterclockwise relative to the page.
The value shall be a multiple of 90.
(Optional)
(Inherited from IAnnot.) |
| SetShowCaption | Sets the option of whether to show caption.
|
| SetStartPoint | Sets the coordinates of the start of a line.
|
| SetStartStyle | Sets the ending syle of the start of a line
(Optional; PDF 1.4.)
|
| SetStructParent | Sets the struct parent of an annotation.
(Required if the annotation is a structural content item; PDF 1.3)
(Inherited from IAnnot.) |
| SetSubject | Sets subject of the Markup Annotation.
(Optional; PDF 1.5 )
(Inherited from IMarkup.) |
| SetTextHOffset | Sets the horizontal offset of the caption.
(For PDF 1.7 )
|
| SetTextVOffset | Sets the vertical offset of the caption.
(For PDF 1.7 )
|
| SetTitle | Sets the title of the Markup Annotation.
(Optional; PDF 1.1)
(Inherited from IMarkup.) |
| SetUniqueID | Sets the unique identifier for this annotation.
(Inherited from IAnnot.) |
See Also