Initializes a new instance of the PdfListFieldItem class.
Initializes a new instance of the PdfListFieldItem class.
The text to be displayed.
The value of the item.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Gets the first page of the document
let page: PdfPage = document.getPage(0) as PdfPage;
// Access the PDF form
let form: PdfForm = document.form;
// Create a new list box field
let field: PdfListBoxField = new PdfListBoxField(page, 'list1', {x: 100, y: 60, width: 100, height: 50});
// Add list items to the field.
field.addItem(new PdfListFieldItem('English', 'English'));
field.addItem(new PdfListFieldItem('French', 'French'));
field.addItem(new PdfListFieldItem('German', 'German'));
// Sets the selected index
field.selectedIndex = 2;
// Sets the flag indicates whether the list box allows multiple selections.
field.multiSelect = true;
// Add the field into PDF form
form.add(field);
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Initializes a new instance of the PdfListFieldItem class.
The text to be displayed.
The value of the item.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Gets the first page of the document
let page: PdfPage = document.getPage(0) as PdfPage;
// Access the PDF form
let form: PdfForm = document.form;
// Create a new list box field
let field: PdfListBoxField = new PdfListBoxField(page, 'list1', {x: 100, y: 60, width: 100, height: 50});
// Add list items to the field.
field.addItem(new PdfListFieldItem('English', 'English'));
field.addItem(new PdfListFieldItem('French', 'French'));
field.addItem(new PdfListFieldItem('German', 'German'));
// Sets the selected index
field.selectedIndex = 2;
// Sets the flag indicates whether the list box allows multiple selections.
field.multiSelect = true;
// Add the field into PDF form
form.add(field);
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();The field.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Gets the first page of the document
let page: PdfPage = document.getPage(0) as PdfPage;
// Access the PDF form
let form: PdfForm = document.form;
// Create a new list box field
let field: PdfListBoxField = new PdfListBoxField(page, 'list1', {x: 100, y: 60, width: 100, height: 50});
// Create and add list items to the field.
let item: PdfListFieldItem = new PdfListFieldItem('English', 'English', field);
// Add list items to the field.
field.addItem(new PdfListFieldItem('French', 'French'));
field.addItem(new PdfListFieldItem('German', 'German'));
// Sets the selected index
field.selectedIndex = 2;
// Sets the flag indicates whether the list box allows multiple selections.
field.multiSelect = true;
// Add the field into PDF form
form.add(field);
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Gets the author of the annotation.
Author.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the author of the annotation.
let author: string = annotation.author;
// Destroy the document
document.destroy();Sets the author of the annotation.
Author.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the author of the annotation.
annotation.author = ‘Syncfusion’;
// Destroy the document
document.destroy();Author.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the author of the annotation.
let author: string = annotation.author;
// Destroy the document
document.destroy();Gets the back color of the annotation.
Color as R, G, B color array in between 0 to 255.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access the text box field at index 0
let field: PdfField = document.form.fieldAt(0);
// Gets the back color of the annotation
let backColor: number[] = field.itemAt(0).backColor;
// Destroy the document
document.destroy();Sets the back color of the annotation.
Array with R, G, B, A color values in between 0 to 255. For optional A (0-254), it signifies transparency.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access the text box field at index 0
let field: PdfField = document.form.fieldAt(0);
// Sets the background color of the field item
field.itemAt(0).backColor = [255, 0, 0];
// Sets the background color of the field item to transparent
field.itemAt(1).backColor = [0, 0, 0, 0];
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Color as R, G, B color array in between 0 to 255.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access the text box field at index 0
let field: PdfField = document.form.fieldAt(0);
// Gets the back color of the annotation
let backColor: number[] = field.itemAt(0).backColor;
// Destroy the document
document.destroy();Gets the border of the annotation.
Annotation border.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the border of the annotation.
let border: PdfAnnotationBorder = annotation.border;
// Destroy the document
document.destroy();Sets the border of the annotation.
Border.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Initializes a new instance of the ` PdfAnnotationBorder ` class.
let border: PdfAnnotationBorder = new PdfAnnotationBorder ();
//Sets the width of the annotation border.
border.width = 10;
//Sets the style of the annotation border.
border.style = PdfBorderStyle.dashed;
//Sets the dash pattern of the annotation border.
border.dash = [1, 2, 1];
// Sets the border to the PDF annotation
annotation.border = border;
// Destroy the document
document.destroy();Annotation border.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the border of the annotation.
let border: PdfAnnotationBorder = annotation.border;
// Destroy the document
document.destroy();Gets the border color of the annotation.
Color as R, G, B color array in between 0 to 255.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Gets the border color of the annotation.
let borderColor: number[] = annotation.borderColor;
// Destroy the document
document.destroy();Sets the border color of the annotation.
Array with R, G, B, A color values in between 0 to 255. For optional A (0-254), it signifies transparency.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Sets the border color of the annotation.
annotation.borderColor = [255,255,255];
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Color as R, G, B color array in between 0 to 255.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Gets the border color of the annotation.
let borderColor: number[] = annotation.borderColor;
// Destroy the document
document.destroy();Gets the bounds of the annotation.
Bounds.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Gets the bounds of the annotation.
let bounds : {x: number, y: number, width: number, height: number} = annotation.bounds;
// Destroy the document
document.destroy();Sets the bounds of the annotation.
Bounds
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Sets the bounds of the annotation.
annotation.bounds = {0, 0, 50, 50};
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Bounds.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Gets the bounds of the annotation.
let bounds : {x: number, y: number, width: number, height: number} = annotation.bounds;
// Destroy the document
document.destroy();Gets the caption of the annotation.
Annotation caption.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the caption of the annotation.
let caption: PdfAnnotationCaption = annotation.caption;
// Destroy the document
document.destroy();Sets the caption of the annotation.
Annottion caption.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Create and set annotation caption values
annotation.caption = new PdfAnnotationCaption(true, PdfLineCaptionType.inline, [10, 10]);
// Destroy the document
document.destroy();Annotation caption.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the caption of the annotation.
let caption: PdfAnnotationCaption = annotation.caption;
// Destroy the document
document.destroy();Gets the flag to indicate whether the field item is checked or not.
Checked or not.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access check box field
let field: PdfCheckBoxField = document.form.fieldAt(0) as PdfCheckBoxField;
// Access first item of check box field
let item: PdfStateItem = field.itemAt(0) as PdfStateItem;
// Gets the flag to indicate whether the field item is checked or not.
let checked: boolean = item.checked;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Sets the flag to indicate whether the field item is checked or not.
Checked or not.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access check box field
let field: PdfCheckBoxField = document.form.fieldAt(0) as PdfCheckBoxField;
// Access first item of check box field
let item: PdfStateItem = field.itemAt(0) as PdfStateItem;
// Sets the style of the annotation
item.checked = true;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Checked or not.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access check box field
let field: PdfCheckBoxField = document.form.fieldAt(0) as PdfCheckBoxField;
// Access first item of check box field
let item: PdfStateItem = field.itemAt(0) as PdfStateItem;
// Gets the flag to indicate whether the field item is checked or not.
let checked: boolean = item.checked;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Gets the fore color of the annotation.
Color as R, G, B color array in between 0 to 255.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Gets the fore color of the annotation.
let color: number[] = annotation.color;
// Destroy the document
document.destroy();Sets the fore color of the annotation.
Color as R, G, B color array in between 0 to 255.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Sets the fore color of the annotation.
annotation.color = [255,255,255];
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Color as R, G, B color array in between 0 to 255.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Gets the fore color of the annotation.
let color: number[] = annotation.color;
// Destroy the document
document.destroy();Gets the creation date of the annotation.
Creation date.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the creation date of the annotation.
let creationDate: Date = annotation.creationDate;
// Destroy the document
document.destroy();Sets the creation date of the annotation.
Creation date.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Set the creation date of the annotation.
annotation.creationDate = new Date();
// Destroy the document
document.destroy();Creation date.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the creation date of the annotation.
let creationDate: Date = annotation.creationDate;
// Destroy the document
document.destroy();Gets the flags of the annotation.
Annotation flag.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the flags of the annotation.
let flag: PdfAnnotationFlag = annotation.flags;
// Destroy the document
document.destroy();Sets the flags of the annotation.
flag value.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the flags of the annotation.
annotation.flags = PdfAnnotationFlag.print;
// Destroy the document
document.destroy();Annotation flag.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the flags of the annotation.
let flag: PdfAnnotationFlag = annotation.flags;
// Destroy the document
document.destroy();Gets the boolean flag indicating whether the annotation have been flattened or not.
Flatten.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the boolean flag indicating whether the annotation have been flattened or not.
let flatten: boolean = annotation.flatten;
// Destroy the document
document.destroy();Sets the boolean flag indicating whether the annotation have been flattened or not.
Flatten.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the boolean flag indicating whether the annotation have been flattened or not.
annotation.flatten = true;
// Destroy the document
document.destroy();Flatten.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the boolean flag indicating whether the annotation have been flattened or not.
let flatten: boolean = annotation.flatten;
// Destroy the document
document.destroy();Gets the boolean flag indicating whether annotation's popup have been flattened or not.
Flatten Popup.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the boolean flag indicating whether annotation's popup have been flattened or not.
let flattenPopups: boolean = annotation.flattenPopups;
// Destroy the document
document.destroy();Sets the boolean flag indicating whether the annotation’s popup have been flattened or not.
Flatten Popup.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the boolean flag indicating whether the annotation’s popup have been flattened or not.
annotation.flattenPopups = false;
// Destroy the document
document.destroy();Flatten Popup.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the boolean flag indicating whether annotation's popup have been flattened or not.
let flattenPopups: boolean = annotation.flattenPopups;
// Destroy the document
document.destroy();Gets the font of the item.
font.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Access the form field at index 0
let field: PdfTextBoxField = document.form.fieldAt(0) as PdfTextBoxField;
// Get the first item of the field
let item: PdfWidgetAnnotation = field.itemAt(0);
// Gets the font of the item.
let font: PdfFont = item.font;
// Destroy the document
document.destroy();Sets the font of the item.
font.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Access the form field at index 0
let field: PdfTextBoxField = document.form.fieldAt(0) as PdfTextBoxField;
// Get the first item of the field
let item: PdfWidgetAnnotation = field.itemAt(0);
// Set the font of the item.
item.font = new PdfStandardFont(PdfFontFamily.helvetica, 12, PdfFontStyle.bold);
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();font.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Access the form field at index 0
let field: PdfTextBoxField = document.form.fieldAt(0) as PdfTextBoxField;
// Get the first item of the field
let item: PdfWidgetAnnotation = field.itemAt(0);
// Gets the font of the item.
let font: PdfFont = item.font;
// Destroy the document
document.destroy();Gets the highlight mode of the annotation.
Highlight mode.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Gets the highlight mode of the annotation.
let highlightMode: PdfHighlightMode = annotation.highlightMode;
// Destroy the document
document.destroy();Sets the highlight mode of the annotation.
Highlight mode.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Sets the highlight mode of the annotation.
annotation.highlightMode = PdfHighlightMode.noHighlighting;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Highlight mode.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Gets the highlight mode of the annotation.
let highlightMode: PdfHighlightMode = annotation.highlightMode;
// Destroy the document
document.destroy();Gets the inner color of the annotation.
R, G, B color values in between 0 to 255.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the inner color of the annotation.
let innerColor: number[] = annotation.innerColor;
// Destroy the document
document.destroy();Sets the inner color of the annotation.
R, G, B color values in between 0 to 255.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the inner color of the annotation.
annotation.innerColor = [255, 0, 0];
// Destroy the document
document.destroy();R, G, B color values in between 0 to 255.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Gets the inner color of the annotation.
let innerColor: number[] = annotation.innerColor;
// Destroy the document
document.destroy();Gets the PdfLayer of the annotation.
PDF layer to the annotation.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Get the first page of the document
let page: PdfPage = document.getPage(0);
// Access the first annotation on the page
let annotation: PdfAnnotation = page.annotations.at(0);
// Get the layer of the annotation
let layer: PdfLayer = annotation.layer;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Set the PdfLayer to the annotation.
PDF layer to the annotation.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Get the first page of the document
let page: PdfPage = document.getPage(0);
// Access the collection of layers in the document
let layers: PdfLayerCollection = document.layers;
// Add a new layer to the document with the name 'Layer1'
let layer: PdfLayer = layers.add('Layer1');
// Access the first annotation on the page
let annotation: PdfAnnotation = page.annotations.at(0);
// Assign the layer to the annotation
annotation.layer = layer;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();PDF layer to the annotation.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Get the first page of the document
let page: PdfPage = document.getPage(0);
// Access the first annotation on the page
let annotation: PdfAnnotation = page.annotations.at(0);
// Get the layer of the annotation
let layer: PdfLayer = annotation.layer;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Gets the modification date of the annotation.
Modified date.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the modified date of the annotation.
let modifiedDate: Date = annotation.modifiedDate;
// Destroy the document
document.destroy();Sets the modification date of the annotation.
Modified date.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Set the modified date of the annotation.
annotation.modifiedDate = new Date();
// Destroy the document
document.destroy();Modified date.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the modified date of the annotation.
let modifiedDate: Date = annotation.modifiedDate;
// Destroy the document
document.destroy();Gets the name of the annotation.
Name.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the name of the annotation.
let name: string = annotation.name;
// Destroy the document
document.destroy();Sets the name of the annotation.
Name.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the name of the annotation.
annotation.name = 'LineAnnotation';
// Destroy the document
document.destroy();Name.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the name of the annotation.
let name: string = annotation.name;
// Destroy the document
document.destroy();Gets the opacity of the annotation.
Opacity in between 0 t0 1.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the opacity of the annotation.
let opacity: number = annotation.opacity;
// Destroy the document
document.destroy();Sets the opacity of the annotation.
opacity in between 0 t0 1.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the opacity of the annotation.
annotation.opacity = 0.5;
// Destroy the document
document.destroy();Opacity in between 0 t0 1.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the opacity of the annotation.
let opacity: number = annotation.opacity;
// Destroy the document
document.destroy();Gets the page object (Read only).
page object.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access check box field
let field: PdfCheckBoxField = document.form.fieldAt(0) as PdfCheckBoxField;
// Access first item of check box field
let item: PdfWidgetAnnotation = field.itemAt(0);
// Gets the page object.
let page: PdfPage = item.page;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Gets the rotation angle of the annotation.
Rotation angle as number.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Gets the rotation angle of the annotation.
let rotate: number = annotation.rotate;
// Destroy the document
document.destroy();Sets the rotation angle of the annotation.
Rotation angle as number.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Sets the rotation angle of the annotation.
annotation.rotate = 90;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Rotation angle as number.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Gets the rotation angle of the annotation.
let rotate: number = annotation.rotate;
// Destroy the document
document.destroy();Gets the rotation of the annotation.
Rotation angle.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the rotation angle of the annotation.
let rotationAngle: PdfRotationAngle = annotation.rotationAngle;
// Destroy the document
document.destroy();Sets the rotation of the annotation.
rotation angle.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the rotation angle of the annotation.
annotation.rotationAngle = PdfRotationAngle.angle180;
// Destroy the document
document.destroy();Rotation angle.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the rotation angle of the annotation.
let rotationAngle: PdfRotationAngle = annotation.rotationAngle;
// Destroy the document
document.destroy();Gets the flag to indicate whether the field item is selected or not (Read only).
Selected or not.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Gets the first page of the document
let page: PdfPage = document.getPage(0) as PdfPage;
// Access the PDF form
let form: PdfForm = document.form;
// Create a new radio button list field
let field: PdfListBoxField = form.fieldAt(0) as PdfListBoxField;
// Access first list field item
let item: PdfListFieldItem = field.itemAt(0);
// Gets the flag to indicate whether the field item is selected or not.
let selected: boolean = item.selected;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Gets the style of annotation.
Style of annotation.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access check box field
let field: PdfCheckBoxField = document.form.fieldAt(0) as PdfCheckBoxField;
// Access first item of check box field
let item: PdfStateItem = field.itemAt(0) as PdfStateItem;
// Gets the style of the annotation
let style: PdfCheckBoxStyle = item.style;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Sets the style of annotation.
Style of annotation.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access check box field
let field: PdfCheckBoxField = document.form.fieldAt(0) as PdfCheckBoxField;
// Access first item of check box field
let item: PdfStateItem = field.itemAt(0) as PdfStateItem;
// Sets the style of the annotation
item.style = PdfCheckBoxStyle.check;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Style of annotation.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access check box field
let field: PdfCheckBoxField = document.form.fieldAt(0) as PdfCheckBoxField;
// Access first item of check box field
let item: PdfStateItem = field.itemAt(0) as PdfStateItem;
// Gets the style of the annotation
let style: PdfCheckBoxStyle = item.style;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Gets the subject of the annotation.
Subject.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the subject of the annotation.
let subject: string = annotation.subject;
// Destroy the document
document.destroy();Sets the subject of the annotation.
Subject.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
// Sets the subject of the annotation.
annotation.subject = 'Line Annotation';
// Destroy the document
document.destroy();Subject.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfLineAnnotation = page.annotations.at(0) as PdfLineAnnotation;
//Get the subject of the annotation.
let subject: string = annotation.subject;
// Destroy the document
document.destroy();Gets the text of the annotation.
Text.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Gets the first page of the document
let page: PdfPage = document.getPage(0) as PdfPage;
// Access the PDF form
let form: PdfForm = document.form;
// Create a new radio button list field
let field: PdfListBoxField = form.fieldAt(0) as PdfListBoxField;
// Access first list field item
let item: PdfListFieldItem = field.itemAt(0);
// Gets the text of the list field item
let text: string = item.text;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Sets the text of the annotation.
Text.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Gets the first page of the document
let page: PdfPage = document.getPage(0) as PdfPage;
// Access the PDF form
let form: PdfForm = document.form;
// Create a new radio button list field
let field: PdfListBoxField = form.fieldAt(0) as PdfListBoxField;
// Access first list field item
let item: PdfListFieldItem = field.itemAt(0);
// Sets the text of the list field item
item.text = '1-9';
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Text.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Gets the first page of the document
let page: PdfPage = document.getPage(0) as PdfPage;
// Access the PDF form
let form: PdfForm = document.form;
// Create a new radio button list field
let field: PdfListBoxField = form.fieldAt(0) as PdfListBoxField;
// Access first list field item
let item: PdfListFieldItem = field.itemAt(0);
// Gets the text of the list field item
let text: string = item.text;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Gets the text alignment of the annotation.
Text alignment.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Gets the text alignment of the annotation.
let textAlignment: PdfTextAlignment = annotation.textAlignment;
// Destroy the document
document.destroy();Sets the text alignment of the annotation.
Text alignment.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Sets the text alignment of the annotation.
annotation.textAlignment = PdfTextAlignment.left;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Text alignment.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Get the first page
let page: PdfPage = document.getPage(0) as PdfPage;
// Get the first annotation of the page
let annotation: PdfWidgetAnnotation = page.annotations.at(0) as PdfWidgetAnnotation;
// Gets the text alignment of the annotation.
let textAlignment: PdfTextAlignment = annotation.textAlignment;
// Destroy the document
document.destroy();Gets the visibility.
Field visibility option.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access the form field at index 0
let field: PdfField = document.form.fieldAt(0);
// Gets the visibility.
let visibility: PdfFormFieldVisibility = field.itemAt(0).visibility;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Sets the visibility.
Visibility option.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access the form field at index 0
let field: PdfField = document.form.fieldAt(0);
// Sets the visibility.
let field.itemAt(0).visibility = PdfFormFieldVisibility.hiddenPrintable;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Field visibility option.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access the form field at index 0
let field: PdfField = document.form.fieldAt(0);
// Gets the visibility.
let visibility: PdfFormFieldVisibility = field.itemAt(0).visibility;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Gets the values associated with the specified key.
Key.
Values associated with the key.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Gets the values associated with the key 'Author'.
let values: string[] = document.getPage(0).annotations.at(0).getValues('Author');
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Set the boolean flag to create a new appearance stream for annotations.
Set appearance.
Nothing.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Set the boolean flag to create a new appearance stream for annotations.
document.getPage(0).annotations.at(0).setAppearance(true);
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Sets the values associated with the specified key.
Key.
Value associated with the key..
Nothing.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access the annotation at index 0
let annotation: PdfAnnotation = document.getPage(0).annotations.at(0);
// Set Unknown state and model
annotation.setValues('State', 'StateModel');
annotation.setValues('StateModel', 'CustomState');
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Parse an existing item of the field.
Widget dictionary.
PDF cross reference.
Field object.
Widget.
Generated using TypeDoc
PdfListBoxItemclass represents the list and combo box field item objects.// Load an existing PDF document let document: PdfDocument = new PdfDocument(data); // Gets the first page of the document let page: PdfPage = document.getPage(0) as PdfPage; // Access the PDF form let form: PdfForm = document.form; // Create a new list box field let field: PdfListBoxField = new PdfListBoxField(page, 'list1', {x: 100, y: 60, width: 100, height: 50}); // Add list items to the field. field.addItem(new PdfListFieldItem('English', 'English')); field.addItem(new PdfListFieldItem('French', 'French')); field.addItem(new PdfListFieldItem('German', 'German')); // Sets the selected index field.selectedIndex = 2; // Sets the flag indicates whether the list box allows multiple selections. field.multiSelect = true; // Add the field into PDF form form.add(field); // Save the document document.save('output.pdf'); // Destroy the document document.destroy();