Represents the base class of all annotations. More...

Inheritance diagram for PdfSharp.Pdf.Annotations.PdfAnnotation:

Classes
class	Keys
	Predefined keys of this dictionary. More...

Public Member Functions
void	Delete ()
	Removes an annotation from the document See also PdfAnnotations.Remove(PdfAnnotation) More...

Public Member Functions inherited from PdfSharp.Pdf.PdfDictionary
	PdfDictionary ()
	Initializes a new instance of the PdfDictionary class. More...

	PdfDictionary (PdfDocument document)
	Initializes a new instance of the PdfDictionary class. More...

new PdfDictionary	Clone ()
	Creates a copy of this dictionary. Direct values are deep copied. Indirect references are not modified. More...

IEnumerator	GetEnumerator ()
	Returns an enumerator that iterates through a collection. More...

override string	ToString ()
	Returns a string with the content of this object in a readable form. Useful for debugging purposes only. More...

PdfStream	CreateStream (byte[] value)
	Creates the stream of this dictionary and initializes it with the specified byte array. The function must not be called if the dictionary already has a stream. More...

Public Member Functions inherited from PdfSharp.Pdf.PdfObject
new PdfObject	Clone ()
	Creates a copy of this object. The clone does not belong to a document, i.e. its owner and its iref are null. More...

Public Member Functions inherited from PdfSharp.Pdf.PdfItem
PdfItem	Clone ()
	Creates a copy of this object. More...

Protected Member Functions
	PdfAnnotation ()
	Initializes a new instance of the PdfAnnotation class. More...

	PdfAnnotation (PdfDocument document)
	Initializes a new instance of the PdfAnnotation class. More...

Protected Member Functions inherited from PdfSharp.Pdf.PdfDictionary
	PdfDictionary (PdfDictionary dict)
	Initializes a new instance from an existing dictionary. Used for object type transformation. More...

override object	Copy ()
	This function is useful for importing objects from external documents. The returned object is not yet complete. irefs refer to external objects and directed objects are cloned but their document property is null. A cloned dictionary or array needs a 'fix-up' to be a valid object. More...

Protected Member Functions inherited from PdfSharp.Pdf.PdfObject
	PdfObject ()
	Initializes a new instance of the PdfObject class. More...

	PdfObject (PdfDocument document)
	Initializes a new instance of the PdfObject class. More...

	PdfObject (PdfObject obj)
	Initializes a new instance from an existing object. Used for object type transformation. More...

override object	Copy ()
	Implements the copy mechanism. Must be overridden in derived classes. More...

Properties
PdfAnnotationFlags	Flags `[get, set]`
	Gets or sets the annotation flags of this instance. More...

PdfAnnotations	Parent `[get, set]`
	Gets or sets the PdfAnnotations object that this annotation belongs to. More...

PdfRectangle	Rectangle `[get, set]`
	Gets or sets the annotation rectangle, defining the location of the annotation on the page in default user space units. More...

string	Title `[get, set]`
	Gets or sets the text label to be displayed in the title bar of the annotation’s pop-up window when open and active. By convention, this entry identifies the user who added the annotation. More...

string	Subject `[get, set]`
	Gets or sets text representing a short description of the subject being addressed by the annotation. More...

string	Contents `[get, set]`
	Gets or sets the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form. More...

XColor	Color `[get, set]`
	Gets or sets the color representing the components of the annotation. If the color has an alpha value other than 1, it is ignored. Use property Opacity to get or set the opacity of an annotation. More...

double	Opacity `[get, set]`
	Gets or sets the constant opacity value to be used in painting the annotation. This value applies to all visible elements of the annotation in its closed state (including its background and border) but not to the popup window that appears when the annotation is opened. More...

Properties inherited from PdfSharp.Pdf.PdfDictionary
DictionaryElements	Elements `[get]`
	Gets the hashtable containing the elements of this dictionary. More...

PdfStream	Stream `[get, set]`
	Gets or sets the PDF stream belonging to this dictionary. Returns null if the dictionary has no stream. To create the stream, call the CreateStream function. More...

Properties inherited from PdfSharp.Pdf.PdfObject
virtual PdfDocument	Owner `[get]`
	Gets the PdfDocument this object belongs to. More...

bool	IsIndirect `[get]`
	Indicates whether the object is an indirect object. More...

PdfObjectInternals	Internals `[get]`
	Gets the PdfInternals object of this document, that grants access to some internal structures which are not part of the public interface of PdfDocument. More...

PdfReference	Reference `[get, set]`
	Gets the indirect reference of this object. If the value is null, this object is a direct object. More...

Additional Inherited Members
Protected Attributes inherited from PdfSharp.Pdf.PdfDictionary
DictionaryElements	elements
	The elements of the dictionary. More...

Detailed Description

Represents the base class of all annotations.

Constructor & Destructor Documentation

◆ PdfAnnotation() [1/2]

PdfSharp.Pdf.Annotations.PdfAnnotation.PdfAnnotation ( )

protected

Initializes a new instance of the PdfAnnotation class.

◆ PdfAnnotation() [2/2]

PdfSharp.Pdf.Annotations.PdfAnnotation.PdfAnnotation ( PdfDocument document )

protected

Initializes a new instance of the PdfAnnotation class.

Member Function Documentation

◆ Delete()

void PdfSharp.Pdf.Annotations.PdfAnnotation.Delete ( )

Removes an annotation from the document

See also: PdfAnnotations.Remove(PdfAnnotation)

Property Documentation

◆ Color

XColor PdfSharp.Pdf.Annotations.PdfAnnotation.Color

getset

Gets or sets the color representing the components of the annotation. If the color has an alpha value other than 1, it is ignored. Use property Opacity to get or set the opacity of an annotation.

◆ Contents

string PdfSharp.Pdf.Annotations.PdfAnnotation.Contents

getset

Gets or sets the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form.

◆ Flags

PdfAnnotationFlags PdfSharp.Pdf.Annotations.PdfAnnotation.Flags

getset

Gets or sets the annotation flags of this instance.

◆ Opacity

double PdfSharp.Pdf.Annotations.PdfAnnotation.Opacity

getset

Gets or sets the constant opacity value to be used in painting the annotation. This value applies to all visible elements of the annotation in its closed state (including its background and border) but not to the popup window that appears when the annotation is opened.

◆ Parent

PdfAnnotations PdfSharp.Pdf.Annotations.PdfAnnotation.Parent

getset

Gets or sets the PdfAnnotations object that this annotation belongs to.

◆ Rectangle

PdfRectangle PdfSharp.Pdf.Annotations.PdfAnnotation.Rectangle

getset

Gets or sets the annotation rectangle, defining the location of the annotation on the page in default user space units.

◆ Subject

string PdfSharp.Pdf.Annotations.PdfAnnotation.Subject

getset

Gets or sets text representing a short description of the subject being addressed by the annotation.

◆ Title

string PdfSharp.Pdf.Annotations.PdfAnnotation.Title

getset

Gets or sets the text label to be displayed in the title bar of the annotation’s pop-up window when open and active. By convention, this entry identifies the user who added the annotation.

The documentation for this class was generated from the following file:

PdfSharp.Pdf.Annotations/PdfAnnotation.cs

Classes

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PdfAnnotation() [1/2]

◆ PdfAnnotation() [2/2]

Member Function Documentation

◆ Delete()

Property Documentation

◆ Color

◆ Contents

◆ Flags

◆ Opacity

◆ Parent

◆ Rectangle

◆ Subject

◆ Title