| SignDocAnnotation Class |
Output of de.softpro.doc.SignDocDocument.getAttachment().
Inheritance HierarchyNamespace: de.softpro.signdocsdk
Assembly: SPSignDoc_4.3_DotNetLib (in SPSignDoc_4.3_DotNetLib.dll) Version: 1.0.6773.37566
SyntaxC#
public sealed class SignDocAnnotation : IDisposable
The SignDocAnnotation type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | addPoint(Point) |
Add a point to the current stroke of a scribble annotation.
This function can be used for annotations of type t_scribble.Each stroke must contain at least two points.
This function uses document(page) coordinates
|
| addPoint(Double, Double) |
Add a point to the current stroke of a scribble annotation.
This function can be used for annotations of type t_scribble.Each stroke must contain at least two points.
This function uses document(page) coordinates
|
| Dispose | Releases all resources used by the SignDocAnnotation |
| getBoundingBox |
Get the bounding box of the annotation.
The bounding box is available for objects returned by getAnnotation() only.
|
| getFont |
Get the font of a text annotation.
|
| getFontSize |
Get the font size of a text annotation.
|
| getName |
Get the name of the annotation.
|
| getPage |
Get the page number of the annotation.
The page number is available for objects returned by SignDocDocument.getAnnotation() only.
|
| getPlainText |
Get the plain text of a text annotation.
|
| getType |
Get the type of the annotation.
|
| newStroke |
Start a new stroke in a scribble annotation.
This function can be used for annotations of type t_scribble.Each stroke must contain at least two points.This function need not be called for the first stroke of a scribble annotation.
|
| setBackgroundColor |
Set the background color of the annotation.
This function can be used for annotations of type t_freetext.
The default background color is white.
|
| setBorderColor |
Set the border color of the annotation.
This function can be used for annotations of type t_freetext.The default border color is black.
|
| setBorderLineWidthInPoints |
Set border line width in points.
This function can be used for annotations of type t_freetext.The default line width for PDF documents is 1 point.
|
| setColor |
Set the color of the annotation.
This function can be used for annotations of types t_line and t_scribble.The default color is black.
|
| setFlags |
Set flags.
This function can be used for annotations of type #t_freetext.
Initially, no flag is set.
|
| setLineEnding |
Set line ending styles.
This function can be used for annotations of type t_line.The default line ending style is le_none.
|
| setLineWidthInPoints |
Set line width in points.
This function can be used for annotations of types t_line and t_scribble.The default line width for PDF documents is 1 point.
|
| setName |
Set the name of the annotation.
In PDF documents, an annotation can have a name. The names of annotations must be unique within a page. By default, annotations are unnamed.
|
| setOpacity |
Set the opacity of the annotation.
This function can be used for annotations of types t_line and t_scribble.
The default opacity is 1.0.Documents conforming to PDF / A must use an opacity of 1.0.
|
| setPlainText |
Set the text of a text annotation.
This function can be used for annotations of type t_freetext.
Any sequence of CR and LF characters in the text starts a new paragraph(ie, text following such a sequence will be placed at the beginning of the next output line).In consequence, empty lines in the input do not produce empty lines in the output.To get an empty line in the output, you have to add a paragraph containing a non - breaking space(0xa0) only:
"Line before empty line\n\u00A0\nLine after empty line" |
See Also