Click or drag to resize

BaseAnnotation Class

Represents a base class for all PDF annotation types.
Inheritance Hierarchy
SystemObject
  Atalasoft.PdfDoc.Generating.AnnotationsBaseAnnotation
    More...

Namespace:  Atalasoft.PdfDoc.Generating.Annotations
Assembly:  Atalasoft.PdfDoc (in Atalasoft.PdfDoc.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public abstract class BaseAnnotation : IValidatable, 
	IPdfResourceConsumer

The BaseAnnotation type exposes the following members.

Constructors
  NameDescription
Protected methodBaseAnnotation
Initializes a new instance of the BaseAnnotation class.
Top
Properties
  NameDescription
Public propertyAdditionalActions
Gets the additional actions associated with the annotation. These are generally only used by widget annotations.
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
Public propertyAppearance
Gets or sets the AppearanceSet for the annotation. This property defaults to null (no appearance set).
Public propertyBorder
Gets or sets the AnnotationBorder for this annotation.
Public propertyBorderStyle
Gets or sets the BorderStyle for the annotation.
Public propertyBounds
Gets or sets the bounding rectangle for this annotation.
Public propertyClickActions
Gets the set of actions performed when the annotation has been clicked.
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.
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.
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].
Public propertyDocumentRevision
Gets the revision of the document in which this widget was found.
Public propertyEnforceReadyOnlyWithException
Gets or sets a value indicating whether to enforce ready only with the ReadOnly propery with an exception.
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.
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.
Public propertyIsDirty
Gets or sets a value indicating whether the annotation is dirty and in need of being written.
Protected propertyIsParentRequired
Gets a value indicating whether this instance requires the parent property.
Public propertyIsReadOnlyOrFieldReadOnly
Determines whether the annotation is read only if either ReadOnly is true or if this object implements IFormElement, if IsFieldReadOnly is true.
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.
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.
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.
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.
Public propertyNoRotate
Gets or sets a value indicating whether the annotation should be rotated when a page is rotated. Default is false.
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.
Public propertyNoZoom
Gets or sets a value indicating whether the annotation's appearance is scaled when the page is zoomed in. Default is false.
Public propertyParentPage
Gets or sets the parent page that contains this annotation.
Public propertyPrint
Gets or sets a value indicating whether this BaseAnnotation is printed. Default is false.
Public propertyReadOnly
Gets or sets a value indicating whether the annotation can interact with the user. Default is false.
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.
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.)
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.
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.
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.
Public methodResourcesUsed
Reports a list of all resources consumed by the object of the given class.
Protected methodThrowIfReadOnlyT
If EnforceReadyOnlyWithException is true and ReadOnly is true, throw an InvalidOperationException, otherwise return value.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodValidate
Validates the annotation and accumulates any problems.
Protected methodValidateActionList
Validates the action list.
Protected methodValidateActions
Validates the actions.
Protected methodValidateProperties
Validates the properties of this object and adds any issues to the problems list.
Top
See Also
Inheritance Hierarchy