Note
Represents a note annotation.
public class Note : TaggablePageElement, IAnnotation, IArea, ICoordinate, ISerializable
Public Class Note
Inherits TaggablePageElement
Implements IAnnotation, IArea, ICoordinate, ISerializable
Inheritance: ObjectPageElementTaggablePageElementNote
Implements: IAnnotation, IArea, ICoordinate, ISerializable
Licensing Info
This class is a full DynamicPDF Core Suite feature. One of the following is required for non-evaluation usage:
- An active DynamicPDF Ultimate Subscription
- An active DynamicPDF Professional or Professional Plus Subscription with DynamicPDF Core Suite selected.
- A DynamicPDF Core Suite for .NET v12.X Developer License.
Examples
The following example will place an icon on the PDF that once clicked, will display text in a separate box.Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements
Module MyModule
Sub Main()
' Create a PDF Document
Dim MyDocument As Document = New Document
' Create a Page and add it to the document
Dim MyPage As Page = New Page
MyDocument.Pages.Add(MyPage)
' Create a note
Dim MyNote As Note = New Note("This is my help note.", 50, 50, _
150, 50, NoteType.Help, False)
' Change the color property
MyNote.Color = RgbColor.Red
' Add the note to the page
MyPage.Elements.Add(MyNote)
MyPage.Elements.Add(New Label("Click on the above icon to view " + _
"the note.", 50, 80, 150, 72, Font.HelveticaBold, 18))
' Save the PDF
MyDocument.Draw("C:\MyDocument.pdf")
End Sub
End Module
using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;
public class Example
{
public static void CreatePDF(string outputPath)
{
// Create a PDF Document
Document document = new Document();
// Create a Page and add it to the document
Page page = new Page();
document.Pages.Add(page);
// Create a note
Note note = new Note("This is my help note.", 50, 50, 150, 50,
NoteType.Help, true);
// Change the color property
note.Color = RgbColor.Red;
// Add the note to the page
page.Elements.Add(note);
page.Elements.Add(new Label("Click on the above icon to view " +
"the note.", 50, 80, 150, 72, Font.HelveticaBold, 18));
// Save the PDF
document.Draw(outputPath);
}
}
Remarks
This class can be used to place a note annotation on the PDF.
Constructors
Note(String, Single, Single, Single, Single) | Initializes a new instance of the Note class. |
Note(String, Single, Single, Single, Single, Boolean) | Initializes a new instance of the Note class. |
Note(String, Single, Single, Single, Single, NoteType) | Initializes a new instance of the Note class. |
Note(String, Single, Single, Single, Single, NoteType, Boolean) | Initializes a new instance of the Note class. |
Properties
Author | Gets or sets the author of the note. |
Color | Gets or sets the color of the note. |
Height | Gets or sets the height of the link. |
ID | Gets or sets the ID of the page element. (Inherited from PageElement) |
IgnoreMargins | Gets or sets ignore margin property. Setting false will consider the margin while placing the page element based on the RelativeTo property. (Inherited from PageElement) |
IsOpen | Gets or sets a value indicating if the note is opened by default. |
NoteType | Gets or sets the type of note. |
RelativeTo | Gets and sets placement of the page element on the page. (Inherited from PageElement) |
Tag | Gets or sets the structure element of the note. |
TagOrder | Gets or sets the tag order of the taggable element. (Inherited from TaggablePageElement) |
Text | Gets or sets the text of the note. |
Width | Gets or sets the width of the link. |
X | Gets or sets the X coordinate of the link. |
Y | Gets or sets the Y coordinate of the link. |
Methods
Draw(PageWriter) | Draws the link to the given PageWriter object. |
DrawAnnotation(DocumentWriter) | Draws the link to the given DocumentWriter object. |
Equals(Object) | Determines whether the specified Object is equal to the current Object . (Inherited from Object) |
GetHashCode() | Serves as a hash function for a particular type. (Inherited from Object) |
GetType() | Gets the Type of the current instance. (Inherited from Object) |
ToString() | Returns a String that represents the current Object . (Inherited from Object) |