Click or drag to resize

LineAnnotation Class

The LineAnnotation represents a single line on the page
Inheritance Hierarchy
SystemObject
  Atalasoft.PdfDoc.Generating.AnnotationsBaseAnnotation
    Atalasoft.PdfDoc.Generating.AnnotationsBaseMarkupAnnotation
      Atalasoft.PdfDoc.Generating.AnnotationsLineAnnotation

Namespace:  Atalasoft.PdfDoc.Generating.Annotations
Assembly:  Atalasoft.PdfDoc (in Atalasoft.PdfDoc.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
Syntax
public class LineAnnotation : BaseMarkupAnnotation

The LineAnnotation type exposes the following members.

Constructors
  NameDescription
Public methodLineAnnotation
Initializes a new instance of the LineAnnotation class.
Public methodLineAnnotation(PdfPoint, PdfPoint)
Initializes a new instance of the LineAnnotation class with the two end points.
Top
Properties
  NameDescription
Public propertyAdditionalActions
Gets the additional actions associated with the annotation. These are generally only used by widget annotations.
(Inherited from BaseAnnotation.)
Public propertyAnnotationType
Gets the type of the original PDF annotation if this annotation was imported from a file. This is generally only useful if the annotation was a type not recognized or not currently modeled by DotPdf
(Inherited from BaseAnnotation.)
Public propertyAppearance
Gets or sets the AppearanceSet for the annotation. This property defaults to null (no appearance set).
(Inherited from BaseAnnotation.)
Public propertyAuthorName
Gets or sets the name of the author of the annotation.
(Inherited from BaseMarkupAnnotation.)
Public propertyBorder
Gets or sets the AnnotationBorder for this annotation.
(Inherited from BaseAnnotation.)
Public propertyBorderStyle
Gets or sets the BorderStyle for the annotation.
(Inherited from BaseAnnotation.)
Public propertyBounds
Gets or sets the bounding rectangle for this annotation.
(Inherited from BaseAnnotation.)
Public propertyCaptionOffset
Gets or sets the caption offset from its normal position.
Public propertyCaptionPositioning
Gets or sets the caption positioning. Captions can be positioned inline or above the line.
Public propertyClickActions
Gets the set of actions performed when the annotation has been clicked.
(Inherited from BaseAnnotation.)
Public propertyColor
Gets or sets the color of the annotation. The meaning of this color varies based on the annotation type. It may represent the background color of the annotation's icon (if any) when closed, the title bar of the annotation's pop-up window, the border color of the annotation.
(Inherited from BaseAnnotation.)
Public propertyContents
Gets or sets the text contents of the annotation. How contents is used depends on the annotation type. For example a StickyNoteAnnotation will use Contents to represent text the user has entered.
(Inherited from BaseAnnotation.)
Public propertyCreationDate
Gets the creation date of the annotation. When a new BaseMarkupAnnotation is constructed the CreationDate is automatically set to the current date and time. When a BaseMarkupAnnotation is read from a file, the CreationDate will reflect the date in the file.
(Inherited from BaseMarkupAnnotation.)
Public propertyDefaultAppearanceState
Gets or sets the name of the default appearance state for the annotation. In annotations that may have multiple possible states (say, "On" of "Off") this the name of the default state. In an annotation's "normal" state, this corresponds to Appearance.Normal[DefaultAppearanceState].
(Inherited from BaseAnnotation.)
Public propertyDocumentRevision
Gets the revision of the document in which this widget was found.
(Inherited from BaseAnnotation.)
Public propertyEndPt
Gets or sets the end point. Bounds are updated automatically after setting.
Public propertyEnforceReadyOnlyWithException
Gets or sets a value indicating whether to enforce ready only with the ReadOnly propery with an exception.
(Inherited from BaseAnnotation.)
Public propertyHidden
Gets or sets a value indicating whether this BaseAnnotation is hidden. A hidden annotation is neither displayed nor printed by a viewer under any circumstances. Default is false.
(Inherited from BaseAnnotation.)
Public propertyInReplyTo
Gets or sets the BaseAnnotation that this annotation is in reply to.
(Inherited from BaseMarkupAnnotation.)
Public propertyInReplyToRelation
Gets or sets the relationship of this annotation to its InReplyTo. Default is Reply.
(Inherited from BaseMarkupAnnotation.)
Public propertyIntent
Gets or sets the intent of the annotation. Set automatically where required.
(Inherited from BaseMarkupAnnotation.)
Public propertyInternalColor
Gets or sets the fill color. This color is used to fill in closed endings.
Public propertyInvisible
Gets or sets a value indicating whether this BaseAnnotation is invisible. Invisibility specifically means that if the annotation is not recognized by the viewer, then it should not be displayed, otherwise the viewer may make a substitute appearance for the annotation. Default is false.
(Inherited from BaseAnnotation.)
Public propertyIsCaptioned
Gets or sets a value indicating whether this instance is captioned. If a line is captioned, the Contents will be used as a caption.
Public propertyIsDirty
Gets or sets a value indicating whether the annotation is dirty and in need of being written.
(Inherited from BaseAnnotation.)
Protected propertyIsParentRequired
Gets a value indicating whether this instance requires the parent property.
(Inherited from BaseAnnotation.)
Public propertyIsReadOnlyOrFieldReadOnly
Determines whether the annotation is read only if either ReadOnly is true or if this object implements IFormElement, if IsFieldReadOnly is true.
(Inherited from BaseAnnotation.)
Public propertyIsTransparent
Gets or sets a value indicating whether this instance is transparent. This is an indication that there was no Color specified for the annotation.
(Inherited from BaseAnnotation.)
Public propertyLeaderLineExtensionLength
Gets or sets the length of the leader line extension.
Public propertyLeaderLineLength
Gets or sets the length of the leader line.
Public propertyLeaderLineOffset
Gets or sets the leader line offset.
Public propertyLineEnding
Gets the line endings for this line. The 0th entry is the ending for the StartPt and the 1st entry is for the EndPt.
Public propertyLocked
Gets or sets a value indicating whether this BaseAnnotation is locked. A locked annotation may not be deleted or have its properties changed, but its contents (such as a form field) may still be editable.
(Inherited from BaseAnnotation.)
Public propertyModificationDate
Gets or sets the modification date for this annotation. DotPdf does not update this property. It is the client's responsibility to change it.
(Inherited from BaseAnnotation.)
Public propertyName
Gets or sets the name of the annotation. This name is meant to be a unique identifier for the annotation and may be use in scripts in PdfJavaScriptAction objects that want to find an annotation.
(Inherited from BaseAnnotation.)
Public propertyNoRotate
Gets or sets a value indicating whether the annotation should be rotated when a page is rotated. Default is false.
(Inherited from BaseAnnotation.)
Public propertyNoView
Gets or sets a value indicating whether the annotation is viewable and will interact with the user. This is different from hidden in that an annotation NoView set to true can be printed. This is a way, for example, to put watermarks on a page that only show when printed. Default is false.
(Inherited from BaseAnnotation.)
Public propertyNoZoom
Gets or sets a value indicating whether the annotation's appearance is scaled when the page is zoomed in. Default is false.
(Inherited from BaseAnnotation.)
Public propertyParentPage
Gets or sets the parent page that contains this annotation.
(Inherited from BaseAnnotation.)
Public propertyPopup
Gets or sets the a popup annotation for this annotation. A popup annotation can either be hidden or shown and allows extra information about an annotation to be shown. When adding a popup annotation to another annotation, the popup will need to be added to the same Annotations collection. When attached to a BaseMarkupAnnotation, the PopupAnnotation will project the text content and author of the BaseMarkupAnnotation.
(Inherited from BaseMarkupAnnotation.)
Public propertyPrint
Gets or sets a value indicating whether this BaseAnnotation is printed. Default is false.
(Inherited from BaseAnnotation.)
Public propertyReadOnly
Gets or sets a value indicating whether the annotation can interact with the user. Default is false.
(Inherited from BaseAnnotation.)
Public propertyRichTextContent
The Contents property can also be represented as rich text. Rich text is content that may include a subset of XHTML markup include body, p, i, b, and span tags. When setting the RichTextContent property, you should also set the Contents property to the plain text equivalent with no markup.
(Inherited from BaseMarkupAnnotation.)
Public propertyStartPt
Gets or sets the start point. Bounds are updated automatically after setting.
Public propertyToggleNoView
Gets or sets a value indicating whether to toggle the sense of the NoView property. This might be used to make an annotation visible when the mouse enters it.
(Inherited from BaseAnnotation.)
Public propertyTransparency
Gets or sets the transparency of the annotation. 1.0 means fully transparent and 0.0 means fully opaque. Default is 0.
(Inherited from BaseMarkupAnnotation.)
Public propertyUsage
Gets or sets the intended LineUsageKind of the line
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetRichTextContent (Inherited from BaseMarkupAnnotation.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasAppearance
Determines whether this instance has at least 1 element in the Normal appearance set.
(Inherited from BaseAnnotation.)
Public methodMakeRepairContext
Makes the repair context for repairing problems in this annotation object. An object implementing IValidatable should at least return an empty RepairContext object.
(Inherited from BaseAnnotation.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNotifyResourceRenamed
This method is called when a global resourec has been renamed, allowing the resource consumer to update to the new name. Annotations defer this to their appearance, if any.
(Inherited from BaseAnnotation.)
Public methodResourcesUsed
Reports a list of all resources consumed by the object of the given class.
(Inherited from BaseAnnotation.)
Protected methodThrowIfReadOnlyT
If EnforceReadyOnlyWithException is true and ReadOnly is true, throw an InvalidOperationException, otherwise return value.
(Inherited from BaseAnnotation.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodValidate
Validates the annotation and accumulates any problems.
(Inherited from BaseAnnotation.)
Protected methodValidateActionList
Validates the action list.
(Inherited from BaseAnnotation.)
Protected methodValidateActions
Validates the actions.
(Inherited from BaseAnnotation.)
Protected methodValidateProperties
Validates the properties for the CaretAnnotation.
(Overrides BaseMarkupAnnotationValidateProperties(ProblemList, PageRepairContext).)
Top
See Also