Api

The main class of the PDF API. Use it to get the current document and to create page content, such as paragraphs, tables, images, annotations, and form fields.

Methods

The following table lists the available methods.

Method	Returns	Description
CentimetersToPoints	number	Converts centimeters to points.
Color	ApiColor	Creates an ApiColor from a universal input.
CreateBlipFill	ApiFill	Creates a blip fill to apply to the object using the selected image as the object background.
CreateBullet	ApiBullet	Creates a bullet for a paragraph with the character or symbol specified with the sSymbol parameter.
CreateCaretAnnot	ApiCaretAnnotation	Creates caret annotation.
CreateChart	ApiChart	Creates a chart with the parameters specified.
CreateCheckboxField	ApiCheckboxField	Creates a checkbox field.
CreateCircleAnnot	ApiCircleAnnotation	Creates circle annotation.
CreateComboboxField	ApiComboboxField	Creates a combobox field.
CreateCustomGeometry	ApiGeometry	Creates a new custom geometry.
CreateDateField	ApiTextField	Creates a text date field.
CreateFreeTextAnnot	ApiFreeTextAnnotation	Creates freeText annotation.
CreateGradientStop	ApiGradientStop	Creates a gradient stop used for different types of gradients.
CreateHighlightAnnot	ApiHighlightAnnotation	Creates highlight annotation.
CreateImage	ApiImage	Creates an image with the parameters specified.
CreateImageField	ApiButtonField	Creates a image field.
CreateInkAnnot	ApiInkAnnotation	Creates ink annotation.
CreateLineAnnot	ApiLineAnnotation	Creates line annotation.
CreateLinearGradientFill	ApiFill	Creates a linear gradient fill to apply to the object using the selected linear gradient as the object background.
CreateListboxField	ApiListboxField	Creates a listbox field.
CreateNoFill	ApiFill	Creates no fill and removes the fill from the element.
CreateNumbering	ApiBullet	Creates a bullet for a paragraph with the numbering character or symbol specified with the numType parameter.
CreateParagraph	ApiParagraph	Creates a new paragraph.
CreatePatternFill	ApiFill	Creates a pattern fill to apply to the object using the selected pattern as the object background.
CreatePolyLineAnnot	ApiPolyLineAnnotation	Creates polyline annotation.
CreatePolygonAnnot	ApiPolygonAnnotation	Creates polygon annotation.
CreatePresetColor	ApiPresetColor	Creates a color selecting it from one of the available color presets.
CreatePresetGeometry	ApiGeometry | null	Creates a geometry using one of the available preset shapes.
CreateRGBColor	ApiRGBColor	Creates an RGB color setting the appropriate values for the red, green and blue color components.
CreateRadialGradientFill	ApiFill	Creates a radial gradient fill to apply to the object using the selected radial gradient as the object background.
CreateRadiobuttonField	ApiRadiobuttonField	Creates a radiobutton field.
CreateRedactAnnot	ApiRedactAnnotation	Creates redact annotation.
CreateRichParaPr	ApiParaPr	Creates the empty rich paragraph properties.
CreateRichParagraph	ApiRichParagraph	Creates a new rich paragraph.
CreateRichRun	ApiRichRun	Creates a new rich run.
CreateRichTextPr	ApiTextPr	Creates the empty rich text properties.
CreateRun	ApiRun	Creates a new smaller text block to be inserted to the current paragraph or table.
CreateSchemeColor	ApiSchemeColor	Creates a complex color scheme selecting from one of the available schemes.
CreateShape	ApiShape	Creates a shape with the parameters specified.
CreateSolidFill	ApiFill	Creates a solid fill to apply to the object using a selected solid color as the object background.
CreateSquareAnnot	ApiSquareAnnotation	Creates square annotation.
CreateStampAnnot	ApiStampAnnotation	Creates stamp annotation.
CreateStrikeoutAnnot	ApiStrikeoutAnnotation	Creates strikeout annotation.
CreateStroke	ApiStroke	Creates a stroke adding shadows to the element.
CreateTable	ApiTable	Creates a table.
CreateTextAnnot	ApiTextAnnotation	Creates text annotation.
CreateTextField	ApiTextField	Creates a text field.
CreateTextPr	ApiTextPr	Creates the empty text properties.
CreateUnderlineAnnot	ApiUnderlineAnnotation	Creates underline annotation.
EmusToMillimeters	mm	Converts English Metric Units (EMUs) to millimeters.
EmusToPoints	number	Converts EMUs (English Metric Units) to points.
GetByInternalId	object	Returns the object by it's internal ID.
GetDocument	ApiDocument	Creates a text field with the specified text field properties.
GetFullName	string	Returns the full name of the currently opened file.
HexColor	ApiColor	Creates a color from a HEX string.
InchesToPoints	number	Converts inches to points.
LinesToPoints	number	Converts lines to points (1 line = 12 points).
MillimetersToEmus	EMU	Converts millimeters to English Metric Units (EMUs).
MillimetersToPixels	number	Converts millimeters to pixels.
MillimetersToPoints	number	Converts millimeters to points.
PicasToPoints	number	Converts picas to points.
PixelsToEmus	number	Converts pixels to EMUs (English Metric Units).
PixelsToPoints	number	Converts pixels to points.
PointsToCentimeters	number	Converts points to centimeters.
PointsToEmus	number	Converts points to EMUs (English Metric Units).
PointsToInches	number	Converts points to inches.
PointsToLines	number	Converts points to lines (1 line = 12 points).
PointsToMillimeters	number	Converts points to millimeters.
PointsToPicas	number	Converts points to picas (1 pica = 12 points).
PointsToPixels	number	Converts points to pixels.
PointsToTwips	number	Converts points to twips.
RGB	ApiColor	Creates an RGB color from red, green and blue components.
RGBA	ApiColor	Creates an RGBA color from red, green, blue and alpha components.
ThemeColor	ApiColor	Creates a theme color.
TwipsToPoints	number	Converts twips to points.
attachEvent	None	Subscribes to the specified event and calls the callback function when the event fires.
detachEvent	None	Unsubscribes from the specified event.