Reference Guide
GdPicture14 Namespace / GdPicturePDF Class
Methods Events

In This Topic
    GdPicturePDF Class Members
    In This Topic

    The following tables list the members exposed by GdPicturePDF.

    Public Constructors
     NameDescription
    Public ConstructorA standard constructor for the GdPicturePDF class. It initializes an instance of the GdPicturePDF class, which subsequently represents a wrapper for any PDF file. You will need this object to perform all available operations with the current PDF document. Please note that a newly created GdPicturePDF object does not automatically create a new empty PDF document.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Adds a check box form field to the currently selected page of the loaded PDF document according to your preference.  
    Public MethodAdds a circle or an ellipse annotation object to the currently selected page of the loaded PDF document. The subtype attribute of this annotation is "Circle". The required shape is inscribed within the annotation's bounding box. When the annotation is opened, it displays a pop-up window with the content according to what you have specified.

    This method uses the RGB color space for specifying the required color of the annotation object, here it is the border color of the circle or ellipse.

     
    Public MethodOverloaded. Adds a combo box form field to the currently selected page of the loaded PDF document according to your preference.  
    Public MethodAppends a cubic Bézier curve, using two control points, to the current path, defined within a currently selected page of the loaded PDF document. More precisely, this method sets the path construction operator "y". The curve expands the current path from the current point to the end-point (X3, Y3), using (X1, Y1) and (X3, Y3) as the Bézier control points. Be aware of your currently defined graphics state parameters, that subsequent filling and stroking operations applied onto the constructed path put into effect.

    All specified coordinates need to be set in the current units defined in the PDF document with respect to the currently located origin, related to the actual page. You can use the GetMeasurementUnit method to determine the currently defined units and you can use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodAppends a cubic Bézier curve, using two control points, to the current path, defined within a currently selected page of the loaded PDF document. More precisely, this method sets the path construction operator "v". The curve expands the current path from the current point to the end-point (X3, Y3), using the current point and (X2, Y2) as the Bézier control points. Be aware of your currently defined graphics state parameters, that subsequent filling and stroking operations applied onto the constructed path put into effect.

    All specified coordinates need to be set in the current units defined in the PDF document with respect to the currently located origin, related to the actual page. You can use the GetMeasurementUnit method to determine the currently defined units and you can use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodAppends a cubic Bézier curve to the current path, defined within a currently selected page of the loaded PDF document. More precisely, this method sets the path construction operator "c". The curve expands the current path from the current point to the end-point (X3, Y3), using (X1, Y1) and (X2, Y2) as the Bézier control points. Be aware of your currently defined graphics state parameters, that subsequent filling and stroking operations applied onto the constructed path put into effect.

    All specified coordinates need to be set in the current units defined in the PDF document with respect to the currently located origin, related to the actual page. You can use the GetMeasurementUnit method to determine the currently defined units and you can use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodAppends an ellipse, using the sequence of cubic Bézier curves, to the currently constructed path, defined within a currently selected page of the loaded PDF document. Be aware of your currently defined graphics state parameters, that subsequent filling and stroking operations applied onto the constructed path put into effect.

    The ellipse is clearly defined by the center and the dimensions of its bounding box. All these coordinates need to be set in the current units defined in the PDF document with respect to the currently located origin, related to the actual page. You can use the GetMeasurementUnit method to determine the currently defined units and you can use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodOverloaded. Adds a file attachment annotation object to the currently selected page of the loaded PDF document.  
    Public MethodAdds a font from a file to the currently loaded PDF document according to a font file path and other parameters you have specified. The displaying of Unicode characters is supported when using the font added by this method.

    Supported font file formats are:

    * .fon - Font resource file

    * .fnt - Raw bitmap font file

    * .ttf - Raw TrueType file

    * .ttc - East Asian Windows: TrueType font collection

    * .fot - TrueType resource file

    * .otf - PostScript OpenType font

     
    Public MethodOverloaded. Adds a new item to a choice form field specified by its unique form field's identifier.  
    Public MethodOverloaded. Adds a free text annotation object to the currently selected page of the loaded PDF document.  
    Public MethodAppends a subpath, constructed from the specified GraphicsPath object, to a current path defined within a currently selected page of the loaded PDF document. The newly added subpath is built up using the path construction and path-painting operators.

    All coordinates within the defined GraphicsPath object need to be set in the current units defined in the PDF document with respect to the currently located origin, related to the actual page. You can simply use the GetMeasurementUnit method to determine the currently defined units and you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodOverloaded. Adds and draws an image within the currently loaded PDF document using a bitmap object as an image resource.  
    Public MethodOverloaded. Adds an image resource, specified by its unique image identifier, that represents a GdPictureImage object, and subsequently draws this image within the currently loaded PDF document.  
    Public MethodCreates an image resource directly from your JPEG image file without the need of lossy encoding and decoding process. The image resource is subsequently added into the currently loaded PDF document. You can use this resource straightforward, for example, with the DrawImage method. This process allows you to easily draw an image from your JPEG file onto a page within the currently loaded PDF document.  
    Public MethodOverloaded. Creates an image resource directly from your JPEG image stored in the instantiated Stream object without the need of lossy encoding and decoding process. The image resource is subsequently added into the currently loaded PDF document. You can use this resource straightforward, for example, with the DrawImage method. This process allows you to easily draw an image from your JPEG source file onto a page within the currently loaded PDF document.  
    Public MethodAdds a line annotation object on the currently selected page of the loaded PDF document. The subtype attribute of this annotation is "Line". This annotation displays a single straight line according to the defined parameters. When it is opened, it displays a pop-up window with the content according to what you have specified.

    This method uses the RGB color space for specifying the required color of the annotation object, here it is the color of the line.

     
    Public MethodAppends a straight line segment from the current point to the destination point (DstX, DstY) of the path currently under construction, that is defined within a currently selected page of the loaded PDF document. More precisely, this method sets the path construction operator "l" (lowercase L). The new current point of the constructed path is the destination point (DstX, DstY).

    The coordinates of the specified point need to be set in the current units defined in the PDF document with respect to the currently located origin, related to the actual page. You can simply use the GetMeasurementUnit method to determine the currently defined units and you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodOverloaded. Adds an "action ready" link annotation object to the currently selected page of the loaded PDF document. It is a link annotation performing an associated action.  
    Public MethodAdds a link annotation object on the currently selected page of the loaded PDF document. The subtype attribute of this annotation is "Link". This annotation represents a hypertext link annotation, that has associated a go-to-page action (the action of the type GoTo). The destination of the assigned action is the page in the current document according to your preference.

    This method uses the RGB color space for specifying the required color of the annotation object, here it is the color of the annotation's borders.

    For further assistance, please see the Actions section of the GdPicturePDF class in the Reference Guide.

     
    Public MethodAdds a link annotation object on the currently selected page of the loaded PDF document. The subtype attribute of this annotation is "Link". This annotation represents a hypertext link annotation, that has associated the action of the type URI. The destination of the assigned action is the URI (web destination) you have specified.

    This method uses the RGB color space for specifying the required color of the annotation object, here it is the color of the annotation's borders.

    For further assistance, please see the Actions section of the GdPicturePDF class in the Reference Guide.

     
    Public MethodOverloaded. Adds a list box form field to the currently selected page of the loaded PDF document according to your preference.  
    Public MethodAdds a new page labeling range into the currently loaded PDF document according to what you have specified.

    A page labeling range is a series of consecutive pages using the same numbering system. The purpose of page labels is to identify each page visually on the screen or in print. Pages, that are included in the specific labeling range, are defined by the interval starting at the first page specified by the StartPage parameter and always ending at the last page of the document.

    All labeling ranges are simply indexed by an integer value from 0 to GetPageLabelsRangeCount-1.

     
    Public MethodModifies the current transformation matrix (CTM) applying the clockwise rotation by a specified angle to the actual page. The applied rotation affects all subsequent drawing operations on the currently selected page of the loaded PDF document. This method can be particularly useful when you need to write text (or any other kind of page content) on a rotated page without applying the page rotation on the current content, as it is shown on the example below.

    The CTM parameter is part of the graphics state parameters. These parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Graphics State").

     
    Public MethodOverloaded. Adds a push button form field to the currently selected page of the loaded PDF document according to your preference.  
    Public MethodOverloaded. Adds a radio button form field to the currently selected page of the loaded PDF document according to your preference.  
    Public MethodOverloaded. Adds redaction region on the selected page of the loaded PDF document.  
    Public MethodModifies the current transformation matrix (CTM) applying a counterclockwise rotation by a required angle around a specified point, in other words the current coordinate system axes are rotated by this angle counterclockwise. The rotation angle needs to be defined within the interval from 0 to 360. The rotation's center point needs to be expressed in the current units defined in the PDF document, related to the actual page. The applied rotation affects all subsequent drawing operations on the currently selected page of the loaded PDF document.

    The CTM parameter is part of the graphics state parameters. These parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Graphics State").

    You can use the GetMeasurementUnit method to determine the currently defined units and you can use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodAdds an empty signature form field, so called signature placeholder, on the current page of loaded PDF document according to what you have specified. A signature field is intended to be used when digitally signing a document. For further assistance, please see the Digital Signature section of the GdPicturePDF class in the Reference Guide.

    You can subsequently use other methods for assigning more form field properties.

     
    Public MethodAdds a square or a rectangle annotation object on the currently selected page of the loaded PDF document. The subtype attribute of this annotation is "Square". The required shape is inscribed within the annotation's bounding box. When the annotation is opened, it displays a pop-up window with the content according to what you have specified.

    This method uses the RGB color space for specifying the required color of the annotation object, here it is the border color of the square or rectangle.

     
    Public MethodAdds a rubber stamp annotation object on the currently selected page of the loaded PDF document. The subtype attribute of this annotation is "Stamp". This annotation displays text or graphics in the way as if they were stamped on the page according to the defined parameters. When it is opened, it displays a pop-up window with the content according to what you have specified.

    This method uses the RGB color space for specifying the required color of the annotation object.

     
    Public MethodAdds a standard font, one of the standard 14 fonts (Standard Type 1 Fonts), to the currently loaded PDF document. You need to specify the name of the font according to your preference.

    PDF prescribes a set of 14 standard fonts that can be used without prior definition. These include four faces each of three Latin text typefaces (Courier, Helvetica, And Times), as well as two symbolic fonts (Symbol And ITC ZapfDingbats®). These fonts, or suitable substitute fonts with the same metrics, are required to be available in all PDF consumer applications.

     
    Public MethodAdds a text annotation object, so called "sticky note" annotation, on the currently selected page of the loaded PDF document. The subtype attribute of this annotation is "Text". When opened, it displays a pop-up window with text, when closed, it appears as an icon according to what you have specified.

    This method uses the RGB color space for specifying the required (background) color of the annotation object.

    Since each text annotation makes use of an associated pop-up window, adding a text annotation to your document includes at the same adding an annotation object, that represents this pop-up window. The subtype attribute of this annotation is "Popup" and therefore the resulting count of all annotations in your document increases by two. This pop-up annotation object is inscribed in the internal structure of the current document.

     
    Public MethodOverloaded. Adds a text form field to the currently selected page of the loaded PDF document according to your preference.  
    Public MethodModifies the current transformation matrix (CTM) applying the concatenation with the transformation matrix you have specified. The resulting transformation affects all subsequent drawing operations on the currently selected page of the loaded PDF document.

    A transformation matrix is a part of the graphics state and it specifies the relationship between two coordinate spaces. By modifying a transformation matrix, objects can be scaled, rotated, translated, or transformed in other ways. Although the transformation parameters specify a matrix, they are written as six separate numbers. The matrix can represent any linear transformation from one coordinate system to another.

    - Translations are specified as [ 1, 0, 0, 1, tx, ty ], where tx and ty are the distances to translate the origin of the coordinate system in the horizontal and vertical dimensions, respectively.

    - Scaling is obtained by [ sx, 0, 0, sy, 0, 0 ]. This scales the coordinates so that 1 unit in the horizontal and vertical dimensions of the new coordinate system is the same size as sx and sy units, respectively, in the previous coordinate system.

    - Rotations are produced by [ cos a, sin a, -sin a, cos a, 0, 0 ], which has the effect of rotating the coordinate system axes by an angle a counterclockwise.

    - Skew is specified by [ 1, tan a, tan b, 1, 0, 0 ], which skews the x axis by an angle a and the y axis by an angle b.

    For more details, please refer to the PDF Reference, Section "Common Transformations".

     
    Public MethodAdds a TrueType or OpenType system font to the currently loaded PDF document according to a font name and other parameters you have specified. Please note that only ANSI characters are supported when using this font to display some text.

    The TrueType font format has been adopted as a standard font format for the Microsoft Windows operating system. A TrueType font program can be embedded directly in a PDF file as a stream object.

     
    Public MethodAdds a TrueType or OpenType font from a file to the currently loaded PDF document according to a font file path and other parameters you have specified. Please note that only ANSI characters are supported when using this font to display some text.  
    Public MethodAdds an embedded TrueType or OpenType font from a file to the currently loaded PDF document according to a font file path and other parameters you have specified. The displaying of Unicode characters is supported when using the font added by this method.  
    Public MethodOverloaded. Adds a TrueType or OpenType system font with Unicode support to the currently loaded PDF document according to your preference.  
    Public MethodOverloaded. Applies redactions based on regions added using the AddRedactionRegion method.  
    Public MethodOverloaded. Applies the digital signature or the certificate on the current page of the loaded PDF document.  
    Public MethodAttaches the defined structure element (tag), that is identified by its unique tag's identifier, to the specified annotation object, that is identified by its index related to the currently selected page of the loaded PDF document. The required structure element (tag) should be a part of the document's tag structure tree.  
    Public MethodAttaches the defined structure element (tag), that is identified by its unique tag's identifier, to the specified form field object, that is identified by its unique form field's identifier related to the currently loaded PDF document. The required structure element (tag) should be a part of the document's tag structure tree.  
    Public MethodDeskews the current page in the loaded PDF document and returns the calculated skew angle, in degrees. The page is subsequently rotated using this angle to correct the possible skewing if present.

    Deskewing a page can help a lot to do OCR, OMR, barcode detection or just improve the reliability of the page itself. You can benefit from using this method especially for documents mixing vector and raster content.

     
    Public MethodBegins a marked content of operations in the page content associated to a structure element of the required structure type related to the document's tag structure tree of the currently loaded PDF document.  
    Public MethodBegins a marked content sequence of operations in the page content associated to a structure element (tag), that is specified by its unique tag's identifier related to the document's tag structure tree of the currently loaded PDF document.  
    Public MethodBegins a marked content sequence of operations associated to an optional content group specified by its unique identifier.  
    Public MethodBegins a new subpath, defined within a currently selected page of the loaded PDF document, by moving the current point to the newly specified coordinates (DstX, DstY), omitting any connecting line segment. More precisely, this method sets the path construction operator "m".

    The coordinates of the specified point need to be set in the current units defined in the PDF document with respect to the currently located origin, related to the actual page. You can simply use the GetMeasurementUnit method to determine the currently defined units and you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodCreates and begins to define a new form XObject of the subtype Form, that includes all subsequently specified drawing operations until the adjacent EndXObjectForm call. The resulting form XObject is identified by its resource name, which is meant to be used for each further drawing within the currently loaded PDF document. The newly defined form XObject becomes a part of the currently loaded PDF document's content as well.

    A form XObject is a structure within a PDF document, that describes objects (text, images, vectors, etc.) used repetitively in the document to avoid multiple referencing of these objects in the document's content. So you can draw such a form XObject multiple times and it produces the same result on each specified location.

     
    Public Method Clears the cache resources belonging to the loaded PDF document.  
    Public MethodEmpties, that means completely removes, the whole content of the currently selected page in the loaded PDF document. The selected page becomes blank, but it retains its properties, for example, page dimensions or the rotation.  
    Public MethodClears the list off redaction regions previously added using AddRedactionRegion method.  
    Public MethodModifies the currently specified clipping path by intersecting it with the currently constructed path, defined within a currently selected page of the loaded PDF document. This method uses the nonzero winding number rule to determine which regions lie inside the clipping path. In other words, this method sets the clipping path operator "W". The clipping path is part of the graphics state and thus it is affected by the currently specified graphics state parameters (see PDF Reference, Section "Clipping Path Operators").  
    Public MethodModifies the currently specified clipping path by intersecting it with the currently constructed path, defined within a currently selected page of the loaded PDF document. This method uses the even-odd rule to determine which regions lie inside the clipping path. In other words, this method sets the clipping path operator "W*". The clipping path is part of the graphics state and thus it is affected by the currently specified graphics state parameters (see PDF Reference, Section "Clipping Path Operators").  
    Public MethodOverloaded. Clones a specific page within the current document or from another source document into the current one.  
    Public Method  
    Public MethodCloses, fills and then strokes the current path, using the nonzero winding number rule to determine the region to fill, defined within a currently selected page of the loaded PDF document. More precisely, this method sets the path-painting operator "b". The use of this method has the same effect as the use of the sequence of methods ClosePath() and FillAndStrokePath(), and therefore all details related to the ClosePath method and FillAndStrokePath method remain in effect.  
    Public MethodCloses, fills and then strokes the current path, using the even-odd rule (an alternative to the nonzero winding number rule) to determine the region to fill, defined within a currently selected page of the loaded PDF document. More precisely, this method sets the path-painting operator "b*". The use of this method has the same effect as the use of the sequence of methods ClosePath() and FillAndStrokePathOdd(), and therefore all details related to the ClosePath method and FillAndStrokePathOdd method remain in effect.  
    Public MethodCloses and strokes the current path, defined within a currently selected page of the loaded PDF document. More precisely, this method sets the path-painting operator "s". The use of this method has the same effect as the use of the sequence of methods ClosePath() and StrokePath(), and therefore all details related to the StrokePath method remain in effect.  
    Public MethodCloses the currently loaded PDF document and releases any related resources from memory.  
    Public MethodCloses and terminates the current subpath, defined within a currently selected page of the loaded PDF document, by appending a straight line segment from the current point to the starting point of the subpath. More precisely, this method sets the path construction operator "h". If the current subpath is already closed, any other additional "h" operator does nothing (see PDF Reference, Section "Path Construction Operators").  
    Public MethodOverloaded. Converts the currently loaded PDF document to a brand new PDF document that meets the required PDF/A conformance level.  
    Public MethodConverts text input, defined as a string, into a multipage (if required) PDF document.  
    Public MethodOverloaded. Creates a custom sized high quality (HQ) thumbnail of the currently selected page of the loaded PDF document. The current page is converted to an image resource with the size and the background color you have specified, which is subsequently stored as an object of the type GdPictureImage. The created image is clearly recognizable by the returned unique image identifier and you can take advantages of the GdPictureImaging class and its methods for further manipulation with the thumbnail.  
    Public MethodRemoves the pair - the custom information key name and its value - from the custom metadata fields of the currently loaded PDF document according to the specified key name.  
    Public MethodRemoves an embedded (attached) file from your currently loaded PDF document. You need to specify this attachment by its 0-based index.  
    Public MethodRemoves a required item from a choice form field, hereabout a combo box or a list box, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. The item to remove is identified by its index, that simply represents its position in the item's list.

    Please note that if the specified form field does not contain any items, this method will fail.

     
    Public MethodDeletes a specified image and its corresponding image resource from the currently loaded PDF document. The required image is identified by its resource name within the current document. If the specified image is used either elsewhere on the same page or on another page, it is removed from all places within the current document.  
    Public MethodOverloaded. Deletes an optional content group (OCG) entry, specified by its unique identifier, from the currently loaded PDF document. You can also specify if the content of the given layer should be removed or not from the document itself.  
    Public MethodDeletes a page specified by its page number in the currently loaded PDF document.  
    Public MethodRemoves all page labels previously defined by the AddPageLabelsRange method within the currently loaded PDF document. This actually means that all defined page labeling ranges are completely removed from the document.  
    Public MethodRemoves a page labeling range specified by its index, previously defined by the AddPageLabelsRange method, within the currently loaded PDF document.

    It is not allowed (see PDF Reference, Section "Page Labels") to delete the page labeling range with the index 0, if more than one labeling range is defined in the PDF document.

     
    Public MethodDeletes a page PieceInfo dictionary used to hold private application data, if any is defined for the currently selected page of the loaded PDF document.  
    Public MethodDeletes a private tag linked to the currently selected page, previously defined by the SetPagePrivateTag method, specified by its name.  
    Public MethodDeletes a page thumbnail image and its resource, if any is defined for the currently selected page of the loaded PDF document.  
    Public MethodDisposes already used GdPicturePDF object completely. All related resources used by this object are released.

    Please note that this method implicitly calls the CloseDocument method.

     
    Public MethodDraws a circular arc on the currently selected page of the loaded PDF document according to what you have specified. The center point of the angle, that makes the arc, and the radius of the circle, of which the arc is a part, need to be set in the current units defined in the PDF document with respect to the currently located origin, related to the actual page. The arc is clearly defined by the StartAngle and the EndAngle parameters.

    You can simply use the GetMeasurementUnit method to determine the currently defined units and you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodOverloaded. Draws a 1D (one-dimensional, or linear) barcode onto the currently selected page of the loaded PDF document.  
    Public MethodOverloaded. Draws a Aztec Code (a type of 2D barcode) onto the currently selected page of the loaded PDF document.  
    Public MethodOverloaded. Draws a DataMatrix barcode (a matrix 2D code) onto the currently selected page of the loaded PDF document.  
    Public MethodOverloaded. Draws a Micro QR Code (a smaller version of standard QR Code) onto the currently selected page of the loaded PDF document.  
    Public MethodOverloaded. Draws a PDF417 barcode (a stacked linear barcode symbol format) onto the currently selected page of the loaded PDF document.  
    Public MethodOverloaded. Draws a QR code (the trademark for a type of matrix barcode or two-dimensional barcode) onto the currently selected page of the loaded PDF document.  
    Public MethodDraws a circle on the currently selected page of the loaded PDF document according to what you have specified. The center of the circle and its radius need to be set in the current units defined in the PDF document with respect to the currently located origin, related to the actual page. The circle is clearly defined by the center and its radius.

    You can simply use the GetMeasurementUnit method to determine the currently defined units and you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodDraws an ellipse on the currently selected page of the loaded PDF document according to what you have specified. The center of the ellipse and the dimensions of the ellipse's bounding box need to be set in the current units defined in the PDF document with respect to the currently located origin, related to the actual page. The ellipse is clearly defined by the center and the dimensions of its bounding box.

    You can simply use the GetMeasurementUnit method to determine the currently defined units and you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodDraws an image, specified by its resource name, onto the exactly defined area of the currently selected page of the loaded PDF document. The image already needs to be included in the current document as a resource using one of the AddImage... methods().

    The coordinates and the dimensions of the destination area need to be set in the current units defined in the PDF document, related to the actual page, where the required image is to be drawn. You can use the GetMeasurementUnit method to determine the currently defined units and you can use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodDraws a line on the currently selected page of the loaded PDF document according to what you have specified. All coordinates of the starting and ending points of the line need to be set in the current units defined in the PDF document with respect to the currently located origin, related to the actual page. The line is clearly defined by the its starting and ending points. The other line parameters, which you might prefer, for example, the line color or the line width, you are allowed to set by using the SetLineColor(Byte,Byte,Byte) method and the SetLineWidth method.

    You can simply use the GetMeasurementUnit method to determine the currently defined units and you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodDraws content of the page, specified by its page number, from a source PDF document, onto the exactly defined area of the currently selected page of the destination PDF document. The coordinates and the dimensions of the destination area need to be set in the current units defined in the destination PDF document, related to the actual page, where the content of the source page is to be drawn.

    You can use the GetMeasurementUnit method to determine the currently defined units and you can use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodDraws a pie shape, means a sector of a circle, on the currently selected page of the loaded PDF document according to what you have specified. The center point of the pie's circle and the circle's radius need to be set in the current units defined in the PDF document with respect to the currently located origin, related to the actual page. The pie shape (sector) of the circle's area is clearly defined by the StartAngle and the EndAngle parameters.

    You can simply use the GetMeasurementUnit method to determine the currently defined units and you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodDraws a rectangle on the currently selected page of the loaded PDF document according to what you have specified. The starting point (the upper left corner) of the rectangle and its dimensions need to be set in the current units defined in the PDF document with respect to the currently located origin, related to the actual page. The rectangle is clearly defined by the starting point and its width and height.

    You can simply use the GetMeasurementUnit method to determine the currently defined units and you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodDraws required text, rotated by the defined angle counterclockwise, using the specified font on the currently selected page of the loaded PDF document. You also need to set the destination point, expressed in the current units defined in the PDF document, related to the actual page, where the text is to be drawn.

    You can simply use the GetMeasurementUnit method to determine the currently defined units and you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodDraws a rounded rectangle (a rectangle with rounded corners) on the currently selected page of the loaded PDF document according to what you have specified. The starting point (the upper left corner) of the rectangle and its dimensions need to be set in the current units defined in the PDF document with respect to the currently located origin, related to the actual page. The rectangle is clearly defined by the starting point and its width and height.

    You can simply use the GetMeasurementUnit method to determine the currently defined units and you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodDraws required text using the specified font on the currently selected page of the loaded PDF document. You also need to set the destination point, expressed in the current units defined in the PDF document, related to the actual page, where the text is to be drawn.

    You can simply use the GetMeasurementUnit method to determine the currently defined units and you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodOverloaded. Draws aligned text, supporting multiline text as well, using the specified font to fit the defined text box located on the currently selected page of the loaded PDF document according to other parameters you have specified.  
    Public MethodDraws, in other words, wraps, required text using the specified font to fit the defined rectangle located on the currently selected page of the loaded PDF document. You need to set the rectangle coordinates in the current units with respect to the currently located origin defined in the PDF document, at the same all coordinates are related to the actual page, where the text is to be drawn. You are also allowed to specify the text alignment within the defined rectangle and the calculation of the height of the text line. The aim of this method is to respect the rectangle boundaries when drawing text, not to draw entire text.

    You can use the GetMeasurementUnit method to determine the currently defined units together with the GetOrigin method to determine the current origin location and you can also use the SetMeasurementUnit method to reset the units together with the SetOrigin method to reset the origin location according to your preference.

     
    Public MethodDraws an existing form XObject, identified by its resource name within the loaded PDF document, onto the currently selected page according to what you have specified.

    A form XObject is a structure within a PDF document, that describes objects (text, images, vectors, etc.) used repetitively in the document to avoid multiple referencing of these objects in the document's content. Each form XObject is identified by its unique resource name defined when creating the object.

     
    Public MethodDuplicates the currently selected page into the loaded PDF document according to a specified number of copies. All duplicated pages retain its content and the layer structure. They all are appended at the end of the current document and the last page is automatically selected as the current page.

    This method is particularly useful if you want to apply a common page header and footer while keeping the file size as small as possible.

     
    Public MethodOverloaded. Embeds (attaches) a specified file or a file data into the currently loaded PDF document. The embedded file or file data can be displayed in a special viewer panel in most PDF viewers.  
    Public MethodSets the parameter for the current GdPicturePDF object that specifies if PDF documents will be compressed during the save process. The result of this compression is a smaller file size. The compression is enabled by default for each newly created GdPicturePDF object.

    Heavy text and image content can considerably increase the size of the PDF document. During the compression process, the toolkit will remove unused objects and elements. This leads to a significantly reduced file size. Therefore the compression is particularly valuable for large images. This drastic reduction however does not affect any of the file's content but it will make your PDF files compact and easy to open.

    The list of compression algorithms is extensive, for example, JPEG, JPEG2000 or JBIG2 for images, Flate or LZW for text as well as images, etc. The toolkit offers the Deflate compression algorithm.

     
    Public MethodEnds a marked content or a marked content sequence of operations in the page content, that have been previously defined using the BeginMarkedContent or the BeginMarkedContentSequence methods. Both specified marked content and marked content sequence structure elements are related to the document's tag structure tree of the currently loaded PDF document.  
    Public MethodEnds the marked content, that has been previously defined by using the BeginOCGMarkedContent method.  
    Public MethodEnds the current path object, that means empties the current path, defined within a currently selected page of the loaded PDF document, without filling or stroking it. More precisely, this method sets the path-painting no-op operator "n". If the current sub-path is already closed, any other additional "n" operator does nothing (see PDF Reference, Section "Path Construction Operators"). This operator is mostly used with a clipping path operator.  
    Public MethodEnds the current definition of a form XObject, that has been previously created using the BeginXObjectForm method. The newly defined form XObject becomes a part of the currently loaded PDF document's content. You need to use the DrawXObjectForm method to subsequently draw the required form XObject on the page.  
    Public MethodGets the uncompressed content of an embedded file (the content of an attached file) within the currently loaded PDF document, in bytes. You need to specify this attachment by its 0-based index.  
    Public MethodExtracts an image, specified by its number within the currently selected page of the loaded PDF document, into a new GdPictureImage object. The specified image is extracted as a resource to an object of the type GdPictureImage, in other words the image resource becomes independent of the source document. The image is clearly recognizable by the returned unique image identifier and it can be subsequently used outside the source document, for example, you can add this image into another PDF document. It is also possible to take advantages of the GdPictureImaging class and its methods for further manipulation with this image.  
    Public MethodFills and then strokes the current path, defined within a currently selected page of the loaded PDF document, using the nonzero winding number rule to determine the region to fill. More precisely, this method sets the path-painting operator "B". Any sub-paths, that are open, are implicitly closed before being filled (see PDF Reference, Section "Path-Painting Operators").

    The use of this method has the same effect as constructing two identical path objects, painting the first using the FillPath method and the second using the StrokePath method. Therefore all details related to the FillPath and the StrokePath method remain in effect. Be aware of your currently defined graphics state parameters, that both filling and stroking operations put into effect.

     
    Public MethodFills and then strokes the current path, defined within a currently selected page of the loaded PDF document, using the even-odd rule (an alternative to the nonzero winding number rule) to determine the region to fill. More precisely, this method sets the path-painting operator "B*". According to the PDF Reference, any sub-paths, that are open, are implicitly closed before being filled.

    The use of this method has the same effect as the use of the method FillAndStrokePath(), except of the rule used to fill the path. Therefore all details related to the FillAndStrokePath method remain in effect. Be aware of your currently defined graphics state parameters, that both filling and stroking operations put into effect.

     
    Public MethodFills the current path, defined within a currently selected page of the loaded PDF document, using the nonzero winding number rule to determine the region to fill. In other words, this method sets the path-painting operator "f". Any sub-paths, that are open, are implicitly closed before being filled (see PDF Reference, Section "Path-Painting Operators"). By the definition the "f" operator uses the current non-stroking color, previously defined by the SetFillColor(Byte,Byte,Byte) method, to paint the entire region enclosed by the current path.  
    Public MethodFills the current path, defined within a currently selected page of the loaded PDF document, using the even-odd rule (an alternative to the nonzero winding number rule) to determine the region to fill. In other words, this method sets the path-painting operator "f*". Any sub-paths, that are open, are implicitly closed before being filled (see PDF Reference, Section "Path-Painting Operators").By the definition the "f*" Operator uses the current non-stroking color, previously defined by the SetFillColor(Byte,Byte,Byte) method, to paint the entire region enclosed by the current path.  
    Public MethodFlattens the required annotation specified by its index related to the currently selected page of the loaded PDF document.

    Flattening an annotation means removing the annotation object from the document's internal structure and placing its data within the PDF document as regular item, so the previously defined annotation is no longer available for user's interaction.

     
    Public MethodOverloaded. Flattens form fields included in the current PDF document or in the specified page within this document.  
    Public MethodFlattens all visible optional content group entries and removes content of all hidden ones in the currently loaded PDF document. That means content of all visible layers is flattened into the document and content of all hidden layers is removed.  
    Public MethodFlips the content of the currently selected page in the loaded PDF document horizontally or vertically according to your preference.  
    Public MethodOverloaded. Returns, if the background (fill) color attribute is defined for a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodOverloaded. Returns, if the border color attribute is defined for a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodReturns the JavaScript script of the specified JavaScript action. A JavaScript action (introduced in PDF 1.3) causes a script to be compiled and executed by the JavaScript interpreter. JavaScript implements objects, methods, and properties that enable you to manipulate PDF files, modify the appearance of PDF files, etc. You can tie JavaScript code to a specific PDF document, a page or a field, and much more. You can read more about the content and effects of JavaScript scripts in the JavaScript for Acrobat API Reference.  
    Public MethodReturns the action related informations (the application name or the filename and its parameters) of a specified action of the type Launch. A launch action launches an application or opens or prints a document.  
    Public MethodReturns the information (a page number and a page view with the used coordinates) of the destination page of a specified action of the type GoTo, Named or ExplicitDestination. These actions change the view of the currently loaded PDF document to a specified destination.  
    Public MethodReturns the remote destination information (a file, a page number and a page view with the used coordinates) of the specified GoToR action. This action jumps to a destination in another PDF file according to the defined destination parameters.  
    Public MethodReturns the action type of a specified PDF action object in the currently loaded PDF document. A PDF action object defines the characteristics and behavior of an action. Actions can be assigned to links, bookmarks, pages, media clips, and form fields in the PDF document. Please see the PdfActionType enumeration for more details about all supported PDF actions.  
    Public MethodReturns the target (destination) of the specified URI action. A URI action causes a URI to be resolved. A uniform resource identifier (URI) is a string that identifies (resolves to) a resource on the Internet - typically a file that is the destination of a hypertext link. URIs are described in RFC 2396 - Uniform Resource Identifier (URI).  
    Public MethodReturns the action's unique identifier of the action associated with an annotation object, that is specified by its index related to the currently selected page of the loaded PDF document. You can subsequently use the GetActionType method to determine the kind of this action.

    At this time it is supported by the toolkit to only associate one action within one annotation object.

     
    Public MethodReturns the color of a required annotation object specified by its index related to the currently selected page of the loaded PDF document.

    This color is used for the following purposes:

    • The background of the annotation's icon when closed.
    • The title bar of the annotation's pop-up window.
    • The border of a link annotation.
     
    Public MethodReturns the content (text or description) of a required annotation object specified by its index related to the currently selected page of the loaded PDF document.

    It can be displayed text for the annotations, that support displaying text (like free text annotations) or an additional description for the other annotations in readable form. If the specified annotation is associated with an auxiliary pop-up window, it is the content of this pop-up window.

     
    Public MethodReturns the number of all annotation objects contained within the currently selected page of the loaded PDF document.

    The standard annotation types are described in the PDF Reference, Section "Annotation Types". You can subsequently use the GetAnnotationSubType method to find out the correct subtype ("Popup", "Text", "FreeText", etc.) of the specific annotation object.

    Please note that the final count of all annotation objects on the current page also includes all those Popup annotation objects, that are expressly detected in the internal structure of the currently loaded PDF document.

     
    Public MethodReturns the interior color of a required annotation object specified by its index related to the currently selected page of the loaded PDF document.

    This color is used for the following purposes:

    • To specify the interior color with which to fill the annotation’s rectangle or ellipse (for Square or Circle annotation types).
    • To specify the interior color with which to fill the annotation’s line endings (for Line, Polygon or PolyLine annotation types).
     
    Public MethodReturns the flags of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. These flags define various characteristics of the specified annotation.  
    Public MethodReturns the annotation name of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. It is a text string, corresponding to the NM entry in the annotation dictionary (see PDF Reference, Section "Annotation Dictionaries"), uniquely identifying the annotation among all the annotations on its page. You can use this attribute, for example, to precisely identify the annotation in third-party software.  
    Public MethodReturns the opacity value of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. This value is used when painting the annotation and it applies to all visible elements of the annotation in its closed state except of the pop-up window.  
    Public MethodReturns the rectangle (the bounding box) of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. This rectangle defines the location of the annotation on the page expressed in the current units used in this document with respect to the currently defined origin.

    You can use the SetMeasurementUnit method to reset the units and the SetOrigin method to reset the origin's location according to your preference.

     
    Public MethodReturns the subject of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. It is a short text description of the subject being addressed by the specified annotation.  
    Public MethodReturns the subtype of a required annotation object specified by its index related to the currently selected page of the loaded PDF document.  
    Public MethodReturns the title of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. It is the text label that is displayed in the title bar of the annotation's pop-up window, mostly it represents the author of the annotation.  
    Public MethodReturns the type of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. It is always "Annot" for properly defined annotation object. Please use the GetAnnotationSubType method to find out the specific subtype of the required annotation object, as it is shown in the example below.  
    Public MethodReturns the author of the currently loaded PDF document, if any is set in the document information dictionary.  
    Public MethodReturns the action's unique identifier of the action associated with a bookmark item specified by its unique identifier. You can subsequently use the GetActionType method to determine the kind of this action.  
    Public MethodReturns the number of child bookmark items (all descendants on lower level only) contained within a specified bookmark item in the bookmark's hierarchy of the currently loaded PDF document.  
    Public MethodReturns the color (used for the bookmark's text) of a bookmark item specified by its unique identifier.  
    Public MethodReturns the number of all available bookmark items in the currently loaded PDF document.

    Bookmarks (also called outline items in the PDF Reference) are items organized in a tree-structured hierarchy, which serves as a visual table of contents to display the document’s structure to the user.

     
    Public MethodReturns a unique identifier of the first child bookmark item (the first descendant on lower level) contained within a specified bookmark item in the bookmark's hierarchy of the currently loaded PDF document.  
    Public MethodReturns a unique identifier of the next bookmark item located on the same level as a specified bookmark item in the bookmark's hierarchy of the currently loaded PDF document.  
    Public MethodReturns a unique identifier of the parent bookmark item for the specified bookmark in the bookmark's hierarchy of the currently loaded PDF document.  
    Public MethodReturns a unique identifier of the previous bookmark item located on the same level as a specified bookmark item in the bookmark's hierarchy of the currently loaded PDF document.  
    Public MethodReturns a unique identifier of the root bookmark in the currently loaded PDF document.

    Bookmarks (also called outline items in the PDF Reference) are items organized in a tree-structured hierarchy, which serves as a visual table of contents to display the document’s structure to the user. A root bookmark is the first top-level bookmark item in this hierarchy.

     
    Public MethodReturns the style characteristics of the text (used to display the bookmark's title) of a bookmark item specified by its unique identifier. The supported characteristics are italic, bold and bold&italic.  
    Public MethodReturns the title of a bookmark item specified by its unique identifier.  
    Public MethodReturns the date and time the currently loaded PDF document was created, as it is set in the document information dictionary.  
    Public MethodReturns the creator of the currently loaded PDF document, if any is set in the document information dictionary.  
    Public MethodReturns the page number of the currently selected page within the loaded PDF document.  
    Public MethodReturns a string containing the value of the specified custom information key (the custom metadata field) in the currently loaded PDF document.  
    Public MethodReturns a string composed from the names of the custom information keys (custom metadata fields) of the currently loaded PDF document. The included names of the custom information keys are separated with the specified separator.  
    Public MethodGets the number of all embedded (attached) files in your currently loaded PDF document.

    Embedded files, so called File Attachments, can be included as a whole directly to a PDF document. Be aware that PDF documents can also contain attached files as part of the file attachment annotations. You can refer to our examples how to extract embedded files in both ways.

     
    Public MethodGets the creation date of an embedded file (the attachment's creation date) within the currently loaded PDF document. You need to specify this attachment by its 0-based index.  
    Public MethodGets the description of an embedded file (the attachment's description) within the currently loaded PDF document. You need to specify this attachment by its 0-based index.  
    Public MethodGets the modification date of an embedded file (the attachment's modification date) within the currently loaded PDF document. You need to specify this attachment by its 0-based index.  
    Public MethodGets the file name of an embedded file (the attachment's file name) within the currently loaded PDF document. You need to specify this attachment by its 0-based index.  
    Public MethodGets the file size of an embedded file (the size of an attached file) within the currently loaded PDF document, in bytes. You need to specify this attachment by its 0-based index.  
    Public MethodGets the title of an embedded file (the title of an attached file) within the currently loaded PDF document. You need to specify this attachment by its 0-based index.  
    Public MethodReturns the security handler which has been used to encrypt the currently loaded PDF document.

    The file's security handler provides a mechanism that not only implements encryption in PDF documents, but also stores all data related to this process. The PDF specification defines two security handlers: Standard Security Handler and Public-Key Security Handler. Other applications may provide security handlers of their own.

     
    Public MethodReturns the encryption algorithm which has been used to encrypt the currently loaded PDF document.

    The PDF specification defines different algorithms to be used to encrypt and/or decrypt a PDF document's content: RC4 40 bits, RC4 128 bits, AES 128 bits, AES 256 bits.

     
    Public MethodGets the creation date of the embedded file (the attachment's creation date) associated with the specified annotation related to the currently selected page of the loaded PDF document. You need to identify the annotation object by its 0-based index, that is always related to the currently selected page.  
    Public MethodGets the content of the embedded (attached) file associated with the specified annotation related to the currently selected page of the loaded PDF document. You need to identify the annotation object by its 0-based index, that is always related to the currently selected page.

    Be aware that PDF documents can also contain embedded files as a whole. Such files are called File Attachments and they are attached directly to a PDF document. You can refer to our examples how to extract embedded files in both ways.

     
    Public MethodGets the description of the embedded file (the attachment's description) associated with the specified annotation related to the currently selected page of the loaded PDF document. You need to identify the annotation object by its 0-based index, that is always related to the currently selected page.  
    Public MethodGets the file name of the embedded file (the attachment's file name) associated with the specified annotation related to the currently selected page of the loaded PDF document. You need to identify the annotation object by its 0-based index, that is always related to the currently selected page.  
    Public MethodGets the file size of the embedded file (the attachment's file size) associated with the specified annotation related to the currently selected page of the loaded PDF document. You need to identify the annotation object by its 0-based index, that is always related to the currently selected page.  
    Public MethodGets the modification date of the embedded file (the attachment's modification date) associated with the specified annotation related to the currently selected page of the loaded PDF document. You need to identify the annotation object by its 0-based index, that is always related to the currently selected page.  
    Public MethodReturns the number of fonts used in the currently loaded PDF document.

    A font for use with a PDF consumer application is prepared in the form of a program. Such a font program is written in a special-purpose language, that is understood by a specialized font interpreter.

     
    Public MethodReturns, in other words extracts, the embedded font program of the font used in the currently loaded PDF document according to the font index you have specified. You can use the GetFontCount method to determine the number of all used fonts in the PDF document. The font index is simply an integer value from 1 to GetFontCount.

    A font program can be embedded in a PDF file as data contained in a PDF stream object. Such a stream object is also called a font file by analogy with font programs that are available from sources external to the consumer application.

     
    Public MethodReturns the encoding scheme (the base font encoding) of the font used in the currently loaded PDF document according to the font index you have specified. You can use the GetFontCount method to determine the number of all used fonts in the PDF document. The font index is simply an integer value from 1 to GetFontCount.

    The font encoding refers to the mapping of a character code to a particular glyph (character shape) description. Each font in a PDF uses a specific type of encoding, either a standard or a custom one. The following types of encoding are supported by the PDF file format: StandardEncoding, WinAnsiEncoding, MacRomanEncoding, MacExpertEncoding, and PDFDocEncoding. For a font that is embedded in the PDF file, the implicit base encoding is the font program's built-in encoding.

     
    Public MethodReturns the name of the font used in the currently loaded PDF document according to the font index you have specified. You can use the GetFontCount method to determine the number of all used fonts in the PDF document. The font index is simply an integer value from 1 to GetFontCount.

    This name of the font can be used to find the font's definition in the consumer application or its environment. It is also the name that is used when printing to a PostScript output device.

     
    Public MethodReturns the type of the font used in the currently loaded PDF document according to the font index you have specified. You can use the GetFontCount method to determine the number of all used fonts in the PDF document. The font index is simply an integer value from 1 to GetFontCount.

    For example, the most popular font types are TrueType and Adobe's Type 1, another are Type 3, Composite fonts and OpenType.

     
    Public MethodReturns the action's unique identifier of the action associated with a form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. You can subsequently use the GetActionType method to determine the kind of this action.

    At this time it is supported by the toolkit to only associate one action within one form field.

     
    Public MethodReturns the alternate title (the alternate field name) of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.

    This alternate name is used in place of the actual field name wherever the field must be identified in the user interface (such as in error or status messages referring to the field). This text is also useful when extracting the document’s content in support of accessibility to users with disabilities or for other purposes. For example, it can be displayed as the field's tooltip when users are hovering with the mouse over the field.

     
    Public MethodOverloaded. Returns the background (fill) color, if any is defined, of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodOverloaded. Returns the border color, if any is defined, of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodOverloaded. Returns the style of the line used to draw the border of check boxes and radio buttons. The required form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodOverloaded. Returns the graphical style of a checkmark used to represent the checked state of check boxes and radio buttons. The required form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodOverloaded. Returns, if a required form field, here a check box or a radio button, is checked, in other words, if it's checked state is On. The form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodReturns the number of the immediate children of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. For further assistance, please refer to the PDF Reference, Section "Interactive Forms".  
    Public MethodReturns the unique form field identifier of an immediate child, specified by its index related to the required parent form field. This parent form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. For further assistance, please refer to the PDF Reference, Section "Interactive Forms".  
    Public MethodReturns the clone number of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. These clone numbers distinguish kids form fields belonging to one parent form field, if they have the same partial name (it is the feature supported by Acrobat when creating identically named form fields).  
    Public MethodReturns, if the Comb flag of a required form field, here a text field, is set. The text field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.

    If this flag is set, then the text field is automatically divided into as many equally spaced positions, or combs, as the value of maximum length of the field's text defines, and the text is laid out into those combs. This flag is meaningful only if the MaxLen attribute is defined for the text form field and if the Multiline, Password, and FileSelect flags are not set.

     
    Public MethodOverloaded. Returns, if a required form field, here a check box or a radio button, is checked by default. The form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodReturns the default value of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. It is a value to which the form field reverts when it is reset, that means reset-form action is executed. The format of this value is the same as defined for the field's current value attribute.  
    Public MethodReturns, if the DoNotScroll flag of a required form field, here a text field, is set. The text field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.

    If this flag is set, then the text field does not scroll to include more text than fits within its rectangle. Once the field is full, no further text is accepted.

     
    Public MethodReturns, if the DoNotSpellCheck flag of a required form field, hereabout a text field or an editable combo box, is set. The required form field object is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields and editable combo boxes, so this method is explicitly applicable to text and combo box form field objects.

    If this flag is set, then text entered in the form field is not spell-checked.

     
    Public MethodReturns, if the FileSelect flag of a required form field, here a text field, is set. The text field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.

    If this flag is set, then the text entered in the text field represents the pathname of a file whose content are to be submitted as the value of the text field. By submission it is meant the use of the submit-form action, unfortunately the GdPicturePDF doesn't support this feature yet. The current value of the specified text field always represents the text entered in this field, please do not confuse it with the content of the file, whose pathname represents the text field value.

     
    Public MethodOverloaded. Returns the color of the font used to display text or the checkmark in a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodReturns the resource name of the font used to display text in a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. This attribute is not restricted to any form fields, even if the form field's appearance doesn't display text. For further assistance, please refer to the PDF Reference, Section "Interactive Forms" .  
    Public MethodReturns the font properties, namely font family name, font style and a standard font flag, of the font used to display text in a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. The font related attributes are not restricted to any form fields, even if the form field's appearance doesn't display text. For further assistance, please refer to the PDF Reference, Section "Interactive Forms".  
    Public MethodOverloaded. Returns the size, in points, of the font used to display text or the checkmark in a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodReturns the fully qualified field name of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.

    The fully qualified field name is constructed from the partial field name of the specified field and all of its ancestors, separated by a period (.) . For a field with no parent, the partial and fully qualified names are the same. For further assistance, please refer to the PDF Reference, Section "Field Names".

     
    Public MethodReturns the fully qualified field name, which is completed with a '#' and the corresponding clone number, of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. The clone numbers distinguish full titles of all kids form fields belonging to one parent form field. For a field with no parent, the fully qualified name and that with clone number are the same.  
    Public MethodReturns the unique form field identifier of a form field specified by its index related to the currently loaded PDF document. You always have to apply this identifier when working with the specified form field object.  
    Public MethodReturns, if the CommitOnSelChange flag of a required form field, hereabout a choice field, is set. The required form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to choice fields, so this method is explicitly applicable to combo box and list box form field objects.

    If this flag set, the new value is committed as soon as a selection is made with the pointing device. This option enables applications to perform an action once a selection is made, without requiring the user to exit the field. If this flag is not set, the new value is not committed until the user exits the field.

     
    Public MethodReturns the number of all items included in the required choice form field, hereabout a combo box or a list box, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As said, this method is only applicable to combo boxes and list boxes.  
    Public MethodReturns, if the Edit flag of a required form field, here a combo box, is set. The combo box field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to combo boxes, so this method is explicitly applicable to combo box form field objects.

    If this flag is set, the combo box includes an editable text box as well as a drop-down list, if this flag is not set, the combo box includes only a drop-down list. In other words, if the flag is set, the combo box is editable and allows to enter custom text.

     
    Public MethodReturns, if the Sort flag of a required form field, hereabout a choice field, is set. The required form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to choice fields, so this method is explicitly applicable to combo box and list box form field objects.

    If this flag is set, the field's items should be sorted alphabetically. Be aware that this flag is only bear in mind when creating or processing forms within applications, not by PDF viewer. Viewers should simply display the options in the order in which the corresponding items are added in the form field.

     
    Public MethodReturns the text of a required item of a choice form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. The item is identified by its index, that simply represents its position in the item's list.

    The item's text is the string to be displayed as the name of the specified option, it can be different than the item's (export) value.

     
    Public MethodReturns the (export) value of a specific item of a choice form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. The item is identified by its index, that simply represents its position in the item's list.

    The item's value is an export value assigned to the specified option, it can be different than the item's text.

     
    Public MethodReturns the location on the page of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. This location is represented by the bounding box of the form field on that page, where the form field is currently located. The coordinates of the field's bounding box are expressed in the current units used in this document with respect to the currently defined origin.

    You can use the SetMeasurementUnit method to reset the units and the SetOrigin method to reset the origin's location according to your preference.

     
    Public MethodReturns the defined maximum length of the field's text, in characters, of a required form field, here a text field. The text field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.  
    Public MethodReturns, if the Multiline flag of a required form field, here a text field, is set. The text field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.

    If this flag is set, then the text field can contain multiple lines of text. It it is not set, the field's text is restricted to a single line.

     
    Public MethodReturns, if the MultiSelect flag of a required form field, here a list box, is set. The list box is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to list boxes, so this method is explicitly applicable to list box form field objects.

    If this flag is set, more than one of the field's items may be selected simultaneously, if this flag is not set, no more than one item may be selected.

     
    Public MethodReturns the normal caption of a required form field, here a button form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this attribute is only specific to button form fields, so this method is explicitly applicable to button form field objects.

    This caption is displayed when the button form field is not interacting with the user.

     
    Public MethodOverloaded. Returns the string representation of the normal appearance of a required form field, hereabout a radio button or a check box, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodReturns the number of that page, where the required form field is located. The form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. The page is strictly given when adding the form field, it is the currently selected page. Already added form fields can't be moved between pages.  
    Public MethodReturns, if the Password flag of a required form field, here a text field, is set. The text field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.

    If this flag is set, then the text field is intended for entering a secure password that should not be echoed visibly to the screen. Instead, the characters typed from the keyboard should be displayed in some unreadable form, usually asterisks.

     
    Public MethodReturns, if the RadiosInUnison flag of a required form field, here a radio button, is set. The radio button group is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to radio button fields, so this method is explicitly applicable to radio button form field objects.

    If this flag is set, a group of radio buttons within a radio button field that use the same value for the On state will turn on and off in unison; that is if one is checked, they are all checked. If this flag is not set, the buttons are mutually exclusive.

     
    Public MethodReturns, if the ReadOnly flag of a required form field is set. The form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document.

    If this flag is set, then the user may not change the value of the field. Likewise, the field will not interact with the user in any way, for example, it will not respond to mouse clicks or mouse motion, etc.

     
    Public MethodReturns, if the Required flag of a required form field is set. The form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document.

    If this flag is set, then the field must have a value at the time it is exported by a submit-form action. Unfortunately the GdPicturePDF doesn't support this feature yet.

     
    Public MethodReturns, if the RichText flag of a required form field, here a text field, is set. The text field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.

    If this flag is set, then the value of this text field should be represented as a rich text string. For further assistance, please refer to the PDF Reference, Section "Rich Text Strings".

     
    Public MethodReturns the counterclockwise rotation, in degrees, of a specified form field, relative to the page, where the form field is located. The required form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. The resulting value is always a multiple of 90.  
    Public MethodReturns the total number of all form fields in the currently loaded PDF document. Form fields are interactive objects for gathering information from users through the PDF document.

    Please use the GetFormFieldId method to retrieve the unique form field identifier in order to correctly identify the specific form field object.

     
    Public MethodReturns the value of NeedAppearances flag related to interactive form fields, if any are present in the currently loaded PDF document.

    Sometimes fields may contain values that are not know until the document is viewed. This flag specifies whether to construct appearance streams and appearance dictionaries for form fields in the loaded document to properly render the document when viewing.

     
    Public MethodReturns the justification, in other words the mode of the text alignment used when displaying text in a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodReturns the title (the name) of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodReturns the type of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.

    PDF Reference (see Section "Interactive Forms") defines these field types: Button Fields - these are push buttons, check boxes and radio buttons, Text Fields, Choice Fields - these are combo boxes and list boxes, and Signature Fields.

     
    Public MethodOverloaded. Returns the current value of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodReturns the defined visibility, either on screen or in print, of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodReturns the input file path of your source document, if it has been loaded using the LoadFromFile method.  
    Public MethodReturns the keywords associated with the currently loaded PDF document, if any are set in the document information dictionary.  
    Public MethodReturns the currently used measurement units defined in the loaded PDF document. Please note that you need to create or load the PDF document properly to get the valid value, otherwise the value is undefined.  
    Public MethodReturns the metadata of the currently loaded PDF document, if any are stored in the PDF.

    The toolkit supports XMP format of metadata, which is the standard for embedding metadata in files. For further assistance, please refer to the core XMP specification published as ISO standard 16684-1.

     
    Public MethodReturns the date and time the currently loaded PDF document was most recently modified, as it is set in the document information dictionary.  
    Public MethodReturns a unique identifier of an optional content group according to the index you have specified. You can use the GetOCGCount method to determine the number of all OCG entries (layers) used in the PDF document.  
    Public MethodReturns the number of the optional content group (OCG) entries defined in the currently loaded PDF document.

    Optional Content Groups, also knows as Layers, are a very effective tool to control the visibility of the page content, that can be selectively viewed or hidden, by users or viewers.

     
    Public MethodReturns the value of the Export state setting of an optional content group specified by its unique identifier.

    The Export state indicates, if the content in this group is exported, when the document (or part of it) is saved by a viewer application to a format, that does not support optional content (for example, an earlier version of PDF or a raster image format).

     
    Public MethodReturns, if the value of the Intent setting of an optional content group, specified by its unique identifier, is View.

    The Intent setting provides a way to distinguish between different intended uses of optional content. PDF 1.5 defines two names, View and Design, to indicate the intended use of the graphics in the optional content group.

     
    Public MethodReturns the value of the Locked state setting of an optional content group specified by its unique identifier.

    The Locked state indicates, if this group is for information only. Producers can use this state to prevent the visibility of this group from being changed by users.

     
    Public MethodReturns the value of the Print state setting of an optional content group specified by its unique identifier.

    The Print state indicates, if the content of this group is printable.

     
    Public MethodReturns the title of an optional content group, in other words the name of a layer, specified by its unique identifier. This name is presented in the viewer's user interface.  
    Public MethodReturns the value of the View state setting of an optional content group specified by its unique identifier.

    The View state indicates the onscreen visibility, that means if the content of this group is viewable.

     
    Public MethodReturns the maximum magnification factor of an optional content group, specified by its unique identifier.

    It is the maximum value of a defined range of magnifications below which the content of this optional content group is best viewed.

     
    Public MethodReturns the minimum magnification factor of an optional content group, specified by its unique identifier.

    It is the minimum value of a defined range of magnifications at which the content of this optional content group is best viewed.

     
    Public MethodReturns the origin's location of the currently used coordinate system defined in the loaded PDF document. Please note that you need to create or load the PDF document properly to get the valid value, otherwise the value is undefined.  
    Public Method Returns whether an external OCR engine must be used by this instance.  
    Public MethodReturns the boundaries, expressed in the current units used in this document, of the specified page box of the currently selected page of the loaded PDF document.

    You can simply use the GetMeasurementUnit method to determine the currently defined units or you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodReturns the whole content (in the form of postscript data) of the current page in the loaded PDF document.  
    Public MethodReturns the number of pages in the currently loaded PDF document.  
    Public MethodReturns the page height of the currently selected page in the loaded PDF document expressed in the current units used in this document.

    You can simply use the GetMeasurementUnit method to determine the currently defined units or you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodReturns the bit depth of an image, specified by its index within the currently selected page of the loaded PDF document.  
    Public MethodReturns the color space of an image, specified by its index within the currently selected page of the loaded PDF document.  
    Public MethodReturns the coordinates, related to the current page, of an image, specified by its index within the currently selected page of the loaded PDF document.

    The coordinates are expressed in the currently defined units in the PDF document with respect to the currently defined origin, related to the actual page. You can use the SetMeasurementUnit method to reset the units and the SetOrigin method to reset the origin's location according to your preference.

     
    Public MethodReturns the number of all images contained within the currently selected page of the loaded PDF document.  
    Public MethodReturns the filters used to encode an image, specified by its index within the currently selected page of the loaded PDF document.  
    Public MethodReturns the type of the image masking of an image, specified by its index within the currently selected page of the loaded PDF document.  
    Public MethodReturns the resource name of an image, specified by its index within the currently selected page of the loaded PDF document. The returned resource name is strictly bounded to the current document and can be only used inside this document, for example, when drawing etc.  
    Public MethodReturns the vertical and the horizontal resolution (DPI) of an image, specified by its index within the currently selected page of the loaded PDF document.  
    Public MethodReturns the width and the height of an image, specified by its index within the currently selected page of the loaded PDF document. Both dimensions are constantly expressed in pixels.  
    Public MethodReturns the page label associated with a page specified by its page number within the currently loaded PDF document. If no page labeling range is defined using the AddPageLabelsRange method, the value of the current page number as string is returned by default.  
    Public MethodReturns the properties of a specific page labeling range of the currently loaded PDF document.  
    Public MethodReturns the number of all page labeling ranges, previously defined by the AddPageLabelsRange method, in the currently loaded PDF document.  
    Public MethodTranslates a link index (only related to the currently selected page in the loaded PDF document) to an annotation index in order to allow working with this link object through the given set of methods related to the annotation objects. In a PDF document, a link is a subtype of the annotation type representing either a hypertext link to a destination elsewhere in the document or an action to be carried out.  
    Public MethodReturns the number of links (link objects) stored within the currently selected page of the loaded PDF document.  
    Public MethodGets the metadata of the currently selected page in the loaded PDF document.  
    Public MethodReturns a value for the private tag linked with the currently selected page of the loaded PDF document, specified by its name.  
    Public MethodReturns the actual page rotation in the clockwise direction, in degrees, of the currently selected page in the loaded PDF document.

    This value expresses the number of degrees by which the current page should be rotated clockwise when displayed or printed. It must always be a multiple of 90.

     
    Public MethodReturns the whole text, regardless if visible or hidden, of the current page of the loaded PDF document.

    Just to inform you, that you can use the GuessPageTextRotation method to determine if the presented text is rotated on the current page.

     
    Public MethodReturns the text, regardless if visible or hidden, contained within a specific area of the current page of the loaded PDF document. You have to specify the required page area as a rectangle. This rectangle is defined by its top left coordinates and by its width and height in inches.

    Just to inform you, that you can use the GuessPageTextRotation method to determine if all text is rotated on the current page.

     
    Public MethodOverloaded. Returns the whole text, regardless if visible or hidden, of the current page of the loaded PDF document including the text properties such as the bounding box coordinates, the font information, the text mode and the text size. The extracted text from the current page is divided by words. Each word together with its text and font properties is recorded in one separated line. The space character (between the words in text) is also considered as a word. Two or more spaces in a row are considered as one word. The resulting string for one word is formatted this way:

    the horizontal (X) coordinate of the top left point of the rendering area + [FieldSeparator] +

    the vertical (Y) coordinate of the top left point of the rendering area + [FieldSeparator] +

    the horizontal (X) coordinate of the top right point of the rendering area + [FieldSeparator] +

    the vertical (Y) coordinate of the top right point of the rendering area + [FieldSeparator] +

    the horizontal (X) coordinate of the bottom right point of the rendering area + [FieldSeparator] +

    the vertical (Y) coordinate of the bottom right point of the rendering area + [FieldSeparator] +

    the horizontal (X) coordinate of the bottom left point of the rendering area + [FieldSeparator] +

    the vertical (Y) coordinate of the bottom left point of the rendering area + [FieldSeparator] +

    extracted word + [FieldSeparator] +

    font name + [FieldSeparator] +

    font box height + [FieldSeparator] +

    text mode + [FieldSeparator] +

    text size + EOL

    The rendering area means the rectangle area on the page where the extracted word is really situated (rendered). You can use the provided coordinates to easily calculate the dimensions of this area and the text rotation angle, for more details please refer to the second example below. You can also benefit from using the GuessPageTextRotation method if the presented text is rotated in various angles on the current page.

    The result for the current page should contain exactly the same number of lines as is the count of all words including the space-words in the text on that page.

     
    Public MethodOverloaded. Creates a custom sized high quality (HQ) thumbnail as an image resource of the currently selected page of the loaded PDF document and subsequently stores it within an object of the type GdPictureImage.  
    Public MethodReturns the user space unit value defined for the currently selected page in the loaded PDF document. It is the positive number specifying the size of default user space units, in multiples of 1/72 inch. The default value is 1.

    Please note that you need to create or load the PDF document properly to get the valid value, otherwise the method does nothing. At the same, the specified value only relates to the currently selected page.

     
    Public MethodReturns the page width of the currently selected page in the loaded PDF document expressed in the current units used in this document.

    You can simply use the GetMeasurementUnit method to determine the currently defined units or you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodReturns the PDF or PDF/A conformance of the currently loaded PDF document.

    PDF/A is an ISO-standardized version of the PDF specialized for the digital preservation of electronic documents. It is a subset of the PDF standard which excludes those PDF features that give rise to concerns about security and the ability to archive documents long term.

     
    Public MethodReturns the producer of the currently loaded PDF document, if any is set in the document information dictionary.  
    Public MethodReturns if the provided access permission is granted within the currently loaded PDF document.  
    Public MethodReturns the number of applied digital signatures to the currently loaded PDF document.  
    Public MethodRetrieves available information about the applied digital signature specified by its index in the currently loaded PDF document, as well as about the used certificate (digital ID). This method also checks the certificate validity and if the document has been altered or corrupted since it was signed.  
    Public MethodReturns the status of the last executed operation with the current GdPicturePDF object.  
    Public MethodReturns the subject of the currently loaded PDF document, if any is set in the document information dictionary.  
    Public MethodReturns a unique identifier of the root (top-level element) in the the document's logical structure hierarchy, so-called tag's structure tree, in the currently loaded PDF document. If the root element does not exist yet, the toolkit will create a new structure element at the very top of the forming structure tree.

    At this time, the toolkit only identifies and supports the standard structure type, so-called tag type, named Document as the root element of the document's tag structure tree.

     
    Public MethodOverloaded. Calculates the height of the specified font in the currently defined units within the loaded PDF document.  
    Public MethodCalculates the width of entered text, using the font you have specified, in the currently defined units within the loaded PDF document.

    You can use the GetMeasurementUnit method to determine the currently defined units and you can also use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodReturns the title of the currently loaded PDF document, if any is set in the document information dictionary.  
    Public MethodReturns the version of the PDF specification to which the currently loaded PDF document conforms.  
    Public MethodReturns the document's layout mode setting, specifying the page layout to be used when the document is opened in Adobe Reader or Acrobat viewer.  
    Public MethodReturns the document's page mode setting, specifying how to display the document on exiting full-screen mode when viewing the document in Adobe Reader or Acrobat viewer. This setting is only meaningful if the value returned by the GetViewerPageMode method is PdfViewerPageMode.PdfViewerPageModeFullScreen. It is ignored otherwise.  
    Public MethodGets the unique action identifier of the action defined in the OpenAction entry in the PDF document's catalog. If this action is set, it defines a destination to be displayed or an action to be carried out when the document is opened. If it is absent, the document should be opened to the top of the first page at the default magnification factor.  
    Public MethodReturns the document's page mode setting, specifying how the document should be displayed when opened in Adobe Reader or Acrobat viewer.  
    Public MethodFinds out if the specified viewer preference setting is enabled or not. These preferences, if defined, control the way the document is to be presented on the screen in Adobe Reader or Acrobat viewer.  
    Public MethodCalculates the total height, expressed in the current units defined in the loaded PDF document, of the given text, which will fit the defined rectangle when trying to wrap the text inside this rectangle, with respect to other parameters you have specified. You can subsequently use the DrawWrappedText method to draw the text inside the required rectangle. Please find more details in the documentation of the mentioned method.  
    Public MethodCalculates the number of text lines of the given text, which will fit the rectangle with the defined width, when trying to wrap the text inside this rectangle, with respect to other parameters you have specified. You can subsequently use the DrawWrappedText method to draw the text inside the required rectangle. Please find more details in the documentation of the mentioned method.  
    Public MethodReturns the prevailing text rotation in the clockwise direction, in degrees, based on all text presented on the currently selected page of the loaded PDF document. The returned value will always be a multiple of 90.

    The resulting rotation value is measured considering all presented text on the page. Each single text rotation is recognised and the most represented (prevailing) value is returned.

    Be aware that the text rotation is calculated relative to the page, that said the current page rotation is not considered here. You can use the NormalizePage method to eliminate the potential page rotation before computing the text rotation.

     
    Public Method  
    Public MethodReturns if the currently loaded PDF document contains XFA form fields.

    XFA stands for XML Forms Architecture, which is Adobe’s proprietary XML-based form technology and it has not been standardized in any public specification. With introducing the first version of PDF 2.0 as ISO-32000-2 published in May 2017, XFA entries have been officially excluded from this specification Therefore this format is not supported by GdPicturePDF and we will never support it in the future as well.

    Please note that you may encounter potential rendering problems when viewing a PDF document with XFA forms using GdPicturePDF. Probably you will see this fallback message introduced by Adobe: "If this message is not eventually replaced by the proper content of the document, your PDF viewer may not be able to display this type of document."

     
    Public MethodIncreases the full PDF version number of the currently loaded PDF document to the version number you have specified.

    The PDF version number uses a form M.m, where M is the major version number and m is the minor version number. This version is stated in the PDF header, which is the first line in the PDF file.

    Please note that you have to specify the full version number using this method. For example, for increasing to the version 1.6, you have to set the Version parameter to 1.6, or for increasing to 2.0 you have to set the Version parameter to 2.0.

     
    Public MethodOverloaded. Inserts a blank page specified by its size and its position into the currently loaded PDF document.  
    Public MethodReturns if the currently loaded PDF document is encrypted or not using the standard security handler encryption mechanism. This approach allows you to define access permissions and up to two passwords - an user password and an owner password. You can use the SetPassword method to decrypt the PDF documents. Once this method has been applied, the currently loaded document remains decrypted for subsequent use.

    Please read more about providing the passwords in the SetPassword method.

     
    Public MethodReturns if the font, used in the currently loaded PDF document, according to the font index you have specified, is embedded. You can use the GetFontCount method to determine the number of all used fonts in the PDF document. The font index is simply an integer value from 1 to GetFontCount.

    Font embedding means that a full copy of the entire character set of a font is stored in the PDF. A font program can be embedded in a PDF file as data contained in a PDF stream object (also called a font file). Such font programs are subject to copyright, and the copyright owner may impose conditions under which a font program can be used.

     
    Public MethodChecks whether the currently loaded PDF document is a valid linearized PDF file.  
    Public MethodReturns if the password provided with the SetPassword method was the owner password. You only need to provide the correct password once when using the SetPassword method. Any other subsequent attempt to set a password using this method will fail.

    Please read more about the password and permissions security in the IsEncrypted method and in the SetPassword method.

     
    Public MethodOverloaded. These methods check up if the currently selected page of the loaded PDF is entirely image-based.  
    Public MethodChecks whether the currently loaded PDF document is a portable collection, so called PDF Portfolio.

    A PDF Portfolio contains multiple files put together into a single PDF file. The files in a PDF Portfolio can be in a wide range of file types created in different applications, but the original files hold their individual identities. You can open, read, edit, and format each component file independently of the other component files in the PDF Portfolio.

     
    Public MethodChecks whether the currently loaded PDF document conforms to Tagged PDF conventions.  
    Public MethodLoads the source document according to a file path you have specified. A PDF file is loaded straightforward, a text file is converted into the PDF document. No other file formats are allowed. You can also specify, if the file will be loaded into memory or not according to the next file operation. Be aware that the file is locked for another use if the parameter LoadInMemory is set to false.  
    Public MethodLoads the source document according to a file path you have specified. A PDF file is loaded straightforward, a text file is converted into the PDF document. No other file formats are allowed. You can also specify an access to the loaded file, which can be read or read/write according to the next file operation. This method can be useful if you need to allow access to the required file from more sources.  
    Public MethodLoads the PDF document from a previously instantiated IStream object according to what you have specified. The only supported file format for the input stream object is the PDF format.  
    Public MethodLoads the PDF document from a previously instantiated Stream object according to what you have specified. The only supported file format for the input stream is the PDF format.  
    Public MethodMaps your custom (newly defined) structure type name to the already existing structure type name. Structure type names are identified and mapped through the so-called RoleMap entry in the structure tree root element, that should be a part of the document's tag structure tree related to the currently loaded PDF document.

    All standard structure type names (tag's names) (see PDF Reference, Section "Standard Structure Types") may be used in the PDF/UA-1 conformed documents. If other names are used, a mapping of those custom names to the standard type names must be provided in the document's RoleMap entry. This way a structure tree element (tag) name is always mapped to its corresponding name in the role map, if there is one defined.

     
    Public MethodOverloaded. These methods allow you to merge two PDF documents according to the way they are currently stored. Both documents are merged using the Merge2Documents(GdPicturePDF,GdPicturePDF) method and all mentioned details remain in effect.  
    Public MethodOverloaded. These methods allow you to merge several PDF documents at once. Please read more details about the PDF/A compliance of the resulting document below.  
    Public Method  
    Public MethodMoves one specified bookmark item just before or just after another specified (destination) bookmark item within the level of the destination bookmark in the bookmark's hierarchy.  
    Public MethodMoves a specified bookmark item down one item within the current level in the bookmark's hierarchy.  
    Public MethodMoves a specified bookmark item up one item within the current level in the bookmark's hierarchy.  
    Public MethodMoves a specified page to a destination page within the currently loaded PDF document. Moving a page means that the specified page takes on the page number, that is equal to the destination page number. Please note that the destination page doesn't change its position in the document. The current page is automatically set to the moved page after successful moving.  
    Public MethodCreates a new action of the type GoTo. A go-to action changes the view to a specified destination (page, location, and magnification factor) in the currently loaded PDF document.  
    Public MethodCreates a new action of the type GoToR. A go-to remote action jumps to a destination in another PDF file instead of the current file, as it is for an ordinary go-to action. In other words, a GoToR action changes the view to a specified destination (page, location, and magnification factor) in a specified file.  
    Public MethodCreates a new action of the type JavaScript. A JavaScript action (introduced in PDF 1.3) causes a script to be compiled and executed by the JavaScript interpreter. JavaScript implements objects, methods, and properties that enable you to manipulate PDF files, modify the appearance of PDF files, etc. You can tie JavaScript code to a specific PDF document, a page or a field, and much more. You can read more about the content and effects of JavaScript scripts in the JavaScript for Acrobat API Reference.  
    Public MethodCreates a new action of the type Launch. A launch action launches an application or opens or prints a document.  
    Public MethodCreates a new action of the type Named. A named action is a simple action defined by its name that PDF viewer applications are expected to support. See the PdfActionNamed enumeration for the predefined named actions.  
    Public MethodCreates a new action of the type URI. A URI action causes a URI to be resolved. A uniform resource identifier (URI) is a string that identifies (resolves to) a resource on the Internet - typically a file that is the destination of a hypertext link. URIs are described in RFC 2396 - Uniform Resource Identifier (URI).  
    Public MethodCreates and appends a new bookmark item to the exisiting bookmark's hierarchy of the currently loaded PDF document.  
    Public MethodCreates a new optional content group (OCG) entry, means a layer, in the currently loaded PDF document.

    Optional Content Groups, also knows as Layers, are a very effective tool to control the visibility of the page content, that can be selectively viewed or hidden, by users or viewers.

     
    Public MethodOverloaded. Adds a new page specified by its size into the currently loaded PDF document as the last page.  
    Public MethodOverloaded. This method prepares a brand new empty PDF document within a GdPicturePDF object. You will always need an object of the GdPicturePDF class to create a new PDF document.  
    Public MethodCreates a new structure element of the defined structure type in the document's tag structure tree as a child of the specified parent element, that is a part of the document's logical structure hierarchy in the currently loaded PDF document.  
    Public MethodNormalizes the currently selected page in the loaded PDF document, in other words all the page boundary boxes are adjusted to the physical size of the page (means the CropBox property is equal to the MediaBox property) and the page's rotation is reset to 0. The actual page rendering is not changed.  
    Public MethodRuns the optical character recognition (OCR) on the currently selected page of the loaded PDF document according to what you have specified. The recognized text is added as invisible text on the page. The page orientation is automatically detected.

    This method involves a rasterization process so any existing visible text within the current page will become a part of the image of that page before the OCR process starts. The same applies to the invisible text contained within the current page. It is not kept because of the rasterization process, which simply means any invisible text is removed from the page before the OCR process starts.

    This method uses one thread when processing. You can also benefit from using several OCR related events like BeforePageOcr, OcrPagesProgress and OcrPagesDone.

     
    Public MethodOverloaded. Runs the optical character recognition (OCR) on the specified page range of the loaded PDF document using a defined number of threads. All these overloads are running asynchronously.  
    Public MethodOptimizes fonts used in the currently loaded PDF document in order to minimize its file size for archiving.

    This method is useful primarily for PDF documents intended for storing or archiving to reduce its file size. The toolkit replaces the fully embedded fonts included in the document with their corresponding subsets and removes all other unnecessary data found in the existing font files as well. Be aware that subsequent editing of such optimized document may lead to insufficient rendering.

     
    Public MethodReturns if the currently selected page of the loaded PDF contains any kind of vector content, for example paths, lines, rectangles, Bezier curves, clipping paths, etc.

    A vector-based PDF uses line segments to define all of the geometry on the page. The display of the geometry remains sharp when you zoom in to see details of the drawing, and measurements and takeoffs (as well as their calibration) are more precise in a vector PDF.

     
    Public MethodOverloaded. These methods check up if the currently selected page of the loaded PDF contains text, regardless if visible or hidden.  
    Public MethodOverloaded. These methods convert a common PDF document into a PDF Portfolio file, so called portable collection. You can easily specify the way your PDF Portfolio file will display on opening.  
    Public MethodRemoves all informations related to a PDF Portfolio from the currently loaded PDF Portfolio document and converts this file to a common PDF document. The collected files are embedded one by one into the source document. You can use the GetEmbeddedFileCount method to check the number of embedded files.  
    Public MethodPrints the currently loaded PDF document to the active printer using the actual paper size.  
    Public MethodOverloaded. Invokes the standard Windows Print dialog box allowing you to print the current document by choosing additional settings.  
    Public MethodOverloaded. Invokes the standard Windows Print dialog box allowing you to print the current document by choosing additional settings, while document's page size is automatically adjusted to the actual paper size.  
    Public MethodPrints the currently loaded PDF document to the active printer. The size of the document's pages is automatically adjusted to the actual paper size.  
    Public MethodReturns the name of the printer, that is currently selected as the active printer, means the printer, which is subsequently used when printing the loaded PDF document.

    It is mostly the default printer, if not set otherwise. However, you can use the PrintSetActivePrinter method to select your preferred printer for next print jobs without affecting any other installed printers.

     
    Public MethodReturns the value of an image alignment setting of the active printer. This value determines how the image is aligned when printing.  
    Public MethodReturns the printer collate setting of the active printer. This property determines, whether the printed document is collated.

    true will print a complete copy of the document before the first page of the next copy is printed. false will print each page by the number of copies specified before printing the next page.

     
    Public MethodReturns the printer color mode setting of the active printer. This property determines whether the output will print in color or in monochrome.  
    Public MethodReturns the printer copies setting of the active printer, that means the number of copies to be printed.  
    Public MethodReturns the printer document name setting of the active printer. You can use it to display during the next print process (for example, in a print status dialog box or printer queue) while printing the document.  
    Public MethodReturns the printer duplex mode setting of the active printer. This property determines whether a page is printed on both sides (if the printer supports this feature).  
    Public MethodReturns the error description of the last executed print operation, that has failed specifically with the GdPictureStatus.PrintingException error.  
    Public MethodReturns the physical margins (x and y coordinates), that are part of the default page settings property of the active printer. Both margins are used as defaults for all pages to be printed.  
    Public MethodReturns the printer orientation setting of the active printer. This property determines the page orientation when printing.  
    Public MethodReturns the paper source, means the paper tray, from which the printer gets paper, used by the active printer. The value is determined through the PaperSource.Kind property of the default page settings.  
    Public MethodReturns the height of the paper to be used by the active printer.  
    Public MethodReturns the current paper size, means the type of the paper, to be used by the active printer. The value is determined through the PaperSize.Kind property of the default page settings.  
    Public MethodReturns the width of the paper to be used by the active printer.  
    Public MethodReturns the name of the printer according to the index you have specified.

    You can use the PrintGetPrintersCount method to determine the number of all available printers. The printer index is simply an integer value from 1 to PrintGetPrintersCount.

     
    Public MethodReturns the number of all available (installed) printers on the computer.  
    Public MethodReturns the printer settings of the active printer.

    As explained in the PrintGetActivePrinter or the PrintSetActivePrinter methods, none of the available printers or their properties are affected using any of the print methods of this class.

     
    Public MethodReturns the printer quality setting of the active printer. This setting matches the PrinterResolutionKind property included in the PrinterSettings.PrinterResolutions parameter of the active printer.  
    Public MethodReturns the status of the last executed print operation with the current GdPicturePDF object.

    If the returned status is specifically GdPictureStatus.PrintingException, you can use the PrintGetLastError method to find out more details.

     
    Public MethodSets the printer, identified by its name, as the active printer, that means makes it the currently selected printer, which is subsequently used when printing the loaded PDF document. The specified printer is used to execute all next print jobs using the print methods of this class, if not set otherwise, without affecting any other installed printers.

    You can use the PrintGetActivePrinter method to retrieve the currently selected printer, denoted as the active printer for print methods of this class. At the same this printer utilizes all by you altered printer settings without affecting the installed printers.

     
    Public MethodSets up the value of an image alignment setting of the active printer. This value determines how the image is aligned when printing.  
    Public MethodSets up the auto-rotation property of the active printer, that determines, if the pages are automatically rotated to fit on the output medium when printing.  
    Public MethodSets up the printer collate setting of the active printer. This property determines, whether the printed document is collated.

    Setting it to true will print a complete copy of the document before the first page of the next copy is printed. Setting it to false will print each page by the number of copies specified before printing the next page.

     
    Public MethodSets up the printer color mode setting of the active printer. This property determines whether the output will print in color or in monochrome.  
    Public MethodSets up the printer copies setting of the active printer, that means the number of copies to be printed.  
    Public MethodSets up the printer document name setting of the active printer. You can use it to display during the next print process (for example, in a print status dialog box or printer queue) while printing the document.  
    Public MethodSets up the printer duplex mode setting of the active printer. This property determines whether a page is printed on both sides (if the printer supports this feature).  
    Public MethodSets up the required range of pages you want to print during the next print process using the active printer.  
    Public MethodSets up the printer orientation setting of the active printer. This property determines the page orientation when printing.  
    Public MethodSets up the required selection of pages you want to print during the next print process using the active printer.

    The specified pages selection will not take into account if you will print using the PrintDialog or the PrintDialogFit methods.

     
    Public MethodOverloaded. Sets up the paper source, from which the active printer gets paper.  
    Public MethodSets the paper size, means the type of the paper, to be used by the active printer.  
    Public MethodEnables or disables the pre-rasterization parameter which specifies whether the pages of the currently loaded PDF document must be pre-rasterized before being printed using the active printer. Enabling the pre-rasterization can dramatically improve the performance with printer drivers non-optimized for vector graphics rendering.

    You can also define the rendering resolution using the PrintSetPreRasterizationDPI method when pre-rasterization is enabled.

     
    Public MethodSpecifies the rendering resolution to be used when pre-rasterization is enabled using the PrintSetPreRasterization method. Enabling the pre-rasterization and setting the proper DPI can dramatically improve the performance with printer drivers non-optimized for vector graphics rendering.  
    Public MethodSets up the printer settings of the active printer.

    As explained in the PrintGetActivePrinter or the PrintSetActivePrinter methods, none of the available printers or their properties are affected using any of the print methods of this class.

     
    Public MethodSets up the printer quality setting of the active printer. This setting matches the PrinterResolutionKind property included in the PrinterSettings.PrinterResolutions parameter of the active printer.

    If the required Quality parameter is identified within the set of PrinterSettings.PrinterResolutions property items of the active printer, then the currently defined active printer resolution is filled up with the specified resolution attributes provided by the corresponding printer resolution item.

     
    Public MethodEnables or disables showing the progress indicator during the print process. The printing progress bar is displayed by default.  
    Public MethodSets up the standard paper size, means the type of the paper, to be used by the active printer.  
    Public MethodSets up a custom paper size to be used by the active printer.  
    Public MethodPrompts the printer driver to show the printer settings dialog box of the active printer.  
    Public Method  
    Public MethodRemoves the required annotation object specified by its index related to the currently selected page of the loaded PDF document.  
    Public MethodRemoves a specified bookmark item (with all its descendants) from a bookmark's hierarchy of the currently loaded PDF document.  
    Public MethodRemoves all bookmark items (whole bookmark's hierarchy) from the currently loaded PDF document. The bookmark's section (known as "Outlines" entry) is also removed from the document's catalog.  
    Public MethodRemoves a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodRemoves all form fields included in the currently loaded PDF document.  
    Public Method  
    Public MethodRemoves all JavaScript scripts from the specified objects, that are included in the currently loaded PDF document. You can identify all required objects using the Options parameter according to your preference. Please refer to the GetActionJavaScript method for more details.  
    Public MethodRemoves the specified page box of the currently selected page of the loaded PDF document.  
    Public MethodRemoves a link specified by its index related to the currently selected page of the loaded PDF document.  
    Public MethodRemoves all links embedded within the currently selected page of the loaded PDF document.  
    Public MethodRemoves a digital signature specified by its index from the currently loaded PDF document.  
    Public MethodRemoves all text contained in specified area on currently selected page of the loaded PDF document.  
    Public MethodRemoves all unused resources from the currently loaded PDF document in order to minimize its file size mostly after splitting or removing pages.

    This method is particularly useful when you remove pages or split large PDF documents to smaller ones. Sometimes it happens that shared document resources are transferred to single pages when splitting, or they have been left unused after removing their source pages. You can simply use this method to eliminate such redundant resources and to reduce the file size if necessary.

     
    Public MethodRemoves XFA form fields data resource for all form fields in currently loaded PDF document.

    XFA stands for XML Forms Architecture, which is Adobe’s proprietary XML-based form technology and it has not been standardized in any public specification. With introducing the first version of PDF 2.0 as ISO-32000-2 published in May 2017, XFA entries have been officially excluded from this specification Therefore this format is not supported by GdPicturePDF and we will never support it in the future as well.

    Please note that you may encounter potential rendering problems when viewing a PDF document with XFA forms using GdPicturePDF. Probably you will see this fallback message introduced by Adobe: "If this message is not eventually replaced by the proper content of the document, your PDF viewer may not be able to display this type of document."

     
    Public MethodOverloaded. Renders the currently selected page of the loaded PDF document to an image resource and then stores it within an object of the type GdPictureImage.  
    Public MethodOverloaded. Renders the currently selected page of the loaded PDF document to an image resource and then stores it within an object of the type GdPictureImage. The method's behaviour is specific for pages, which are entirely image-based. In addition, the page retains its rotation, if any is defined.  
    Public MethodAttempts to repair malformed PDF document.  
    Public MethodOverloaded. Replaces a destination image, specified by its resource name, located in the currently loaded PDF document, by the newly added source image, specified by its unique image identifier, that refers to an object of the type GdPictureImage.  
    Public MethodReplaces an image, specified by its resource name and the unique image identifier as well, located on the current page of the loaded PDF document, by compressing this image using the advanced mixed raster content (MRC) compression mechanism and draws a resulting image on the entire page surface.

    Please note that both parameters relate to the same image located on the current page. At the same, this method can be used for image-based pages only, as the MRC engine always draws resulting images on the entire page surface. The attached example demonstrates the proper use of the method.

     
    Public MethodResets, in other words completely removes the current selection of a required form field, here a radio button. That means no child button in a group of radio buttons within a radio button field stays selected using this method. The radio button group or the child radio button in this group is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As said, this method is explicitly applicable to radio button form field objects and their child buttons as well.  
    Public MethodResets, in other words completely removes the currently defined default selection of a required form field, here a radio button. That means no child button in a group of radio buttons within a radio button field stays selected by default using this method. The radio button group or the child radio button in this group is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As said, this method is explicitly applicable to radio button form field objects and their child buttons as well.  
    Public MethodResets the graphics state parameters to their default configuration. For example, any specified transformation is canceled, the fill color and the stroke color are set to their default values, etc. It's a good practice to call this method before adding new data to the currently loaded PDF document.

    The graphics on a PDF page are described by a sequence of draw operators, graphics state operators, and marked-content operators. The graphics state operators change the graphics state (set the line width, dash pattern, fill color, font size etc.) and the result of draw operators are affected by the graphics state.

    According to the PDF Reference, Section "Graphics State", a PDF consumer application maintains an internal data structure called the graphics state that holds current graphics control parameters. These parameters define the global framework within which the graphics operators execute. For example, the fill operator implicitly uses the current color parameter, and the stroke operator additionally uses the current line width parameter from the graphics state. The graphics state is initialized at the beginning of each page with the values specified in the PDF Reference, Section "Graphics State".

     
    Public MethodResizes the currently selected page in the loaded PDF document according to the newly specified page width and page height.  
    Public MethodRestores the graphics state previously saved by the SaveGraphicsState method. Restoring the graphics state means removing the most recently saved graphics state from the graphics state stack and making it the current graphics state. Please note that SaveGraphicsState and following RestoreGraphicsState calls need to be applied on the same page, in other words changing the current page between these two calls causes incorrect behaviour of the graphics state.

    The graphics on a PDF page are described by a sequence of draw operators, graphics state operators, and marked-content operators. The graphics state operators change the graphics state (set the line width, dash pattern, fill color, font size etc) and the result of draw operators are affected by the graphics state. Please see also the ResetGraphicsState method for more details.

     
    Public MethodRotates clockwise the currently selected page of the loaded PDF document. The rotation angle can be set to 90, 180 or 270 degrees.  
    Public MethodRotates counterclockwise the whole content of the currently selected page in the loaded PDF document through an angle you have specified.  
    Public MethodRotates clockwise all pages of the currently loaded PDF document. The rotation angle can be set to 90, 180 or 270 degrees.  
    Public MethodSaves the current graphics state on the graphics state stack. You can use the RestoreGraphicsState method to reset the previously defined graphics state. Please note that SaveGraphicsState and following RestoreGraphicsState calls need to be applied on the same page, in other words changing the current page between these two calls causes incorrect behaviour of the graphics state.

    The graphics on a PDF page are described by a sequence of draw operators, graphics state operators, and marked-content operators. The graphics state operators change the graphics state (set the line width, dash pattern, fill color, font size etc) and the result of draw operators are affected by the graphics state. Please see also the ResetGraphicsState method for more details.

     
    Public MethodOverloaded. These methods save your currently loaded PDF document to a file in several ways according to your preference.  
    Public MethodSaves the currently loaded PDF document to a specified file using incremental updates. This incremental saving feature (see PDF Reference for Incremental updates) executes very quick save and ensures the document content persistence, but it also produces bigger file than the standard save process. We suggest to use this method only if you perform small modifications on large documents.

    The content of a PDF file can be updated incrementally without rewriting the entire file. Changes are appended to the end of the file, leaving its original content intact. The main advantage to updating a file in this way is that small changes to a large document can be saved quickly (see PDF Reference, Section "Incremental updates").

     
    Public MethodOverloaded. These methods save your currently loaded PDF document to a Stream object in several ways according to your preference.  
    Public MethodSaves the currently loaded PDF document to an instantiated Stream object using incremental updates. This incremental saving feature (see PDF Reference for Incremental updates) executes very quick save and ensures the document content persistence, but it also produces bigger file than the standard save process. We suggest to use this method only if you perform small modifications on large documents.

    The content of a PDF file can be updated incrementally without rewriting the entire file. Changes are appended to the end of the file, leaving its original content intact. The main advantage to updating a file in this way is that small changes to a large document can be saved quickly (see PDF Reference, Section "Incremental updates").

     
    Public MethodScales (multiplies) the currently selected page in the loaded PDF document according to the specified scale factors for both page width and page height.  
    Public MethodSearches for all occurrences of a given regular expression pattern within the currently loaded PDF document and adds redaction region for every occurrence found.  
    Public MethodOverloaded. Searches for an occurrence of a given text expression within the current page of the loaded PDF document applying either the Ordinal or the InvariantCulture comparison.  
    Public MethodSearches for an occurrence of a given regular expression pattern within the current page of the loaded PDF document according to the parameters you have specified. This method returns bounding box surrounding the searched expression or set of bounding boxes in case the searched expression spans across multiple lines, defined by its top left coordinates and by its width and height in inches, if the expression has been found.  
    Public MethodSelects a specified page (means sets as the current page) in the currently loaded PDF document.  
    Public MethodAssociates a specified action (identified with a unique action identifier) with a required annotation object, that is specified by its index related to the currently selected page of the loaded PDF document.

    At this time it is supported by the toolkit to only associate one action within one annotation object.

     
    Public MethodOverloaded. Sets the (background) color of a required annotation object specified by its index related to the currently selected page of the loaded PDF document.  
    Public MethodSets the content (text or description) of a required annotation object specified by its index related to the currently selected page of the loaded PDF document.

    It can be displayed text for the annotations, that support displaying text (like free text annotations) or an additional description for the other annotations in readable form. If the specified annotation is associated with an auxiliary pop-up window, it is the content of this pop-up window.

     
    Public MethodOverloaded. Sets the fill (interior) color of a required annotation object specified by its index related to the currently selected page of the loaded PDF document.  
    Public MethodSets the flags of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. These flags define various characteristics of the specified annotation.  
    Public MethodSets the annotation name of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. It is a text string, corresponding to the NM entry in the annotation dictionary (see PDF Reference, Section "Annotation Dictionaries"), uniquely identifying the annotation among all the annotations on its page. You can use this attribute, for example, to precisely identify the annotation in third-party software.  
    Public MethodSets the opacity value of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. This value is used when painting the annotation and it applies to all visible elements of the annotation in its closed state except of the pop-up window.  
    Public MethodSets the rectangle (the bounding box) of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. This rectangle defines the location of the annotation on the page expressed in the current units used in this document with respect to the currently defined origin. You can use the SetMeasurementUnit method to reset the units and the SetOrigin method to reset the origin's location according to your preference.  
    Public MethodSets the subject of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. It is a short text description of the subject being addressed by the specified annotation.  
    Public MethodSets the title of a required annotation object specified by its index related to the currently selected page of the loaded PDF document. It is the text label that is displayed in the title bar of the annotation's pop-up window, mostly it represents the author of the annotation.  
    Public MethodSets up a new author of the currently loaded PDF document into the document information dictionary and in the document catalog's metadata as well.

    If the loaded PDF document contains metadata stored in the Metadata entry in the document catalog, the newly specified Author property is synchronized with those metadata. That means, you will be able to see the changed value of this property using the Acrobat's Document Properties dialogue box.

     
    Public MethodSets the blending mode, that defines the function used in the compositing formula to customize the blending operation for all subsequent drawing operations. The initial value is set to normal.

    Blending modes are used to determine how two layers are blended into each other (affect one another) through more complex methods. Some blending modes exist to create special effects, some are used to give you more control when using adjustment layers to correct photographs.

    The blend mode parameter is one of the graphics state parameters. These parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Graphics State").

     
    Public MethodAssociates a specified action (identified with a unique action identifier) with a specified bookmark item (identified with a unique bookmark identifier).  
    Public MethodOverloaded. Sets the color to be used for displaying the bookmark's title.  
    Public MethodSets the style characteristics of the text to be used for displaying the bookmark's title of a bookmark item specified by its unique identifier. The supported characteristics are: plain (normal text), italic, bold, bold&italic.  
    Public MethodSets the title of a bookmark item specified by its unique identifier.  
    Public MethodOverloaded. Sets the certificate contained in the digital ID file and decrypts the currently loaded PDF document using the associated public key.  
    Public MethodSets the scheme to be used to compress bitonal image data within the currently loaded PDF document.

    Please note that firstly you need to create or load the PDF document to allow this setting to work properly. Secondly, you need to set the compression scheme before adding the required image to the current document.

     
    Public MethodSets the scheme to be used to compress color image data within the currently loaded PDF document. The default value is PdfCompression.PdfCompressionJPEG.

    Please note that firstly you need to create or load the PDF document to allow this setting to work properly. Secondly, you need to set the compression scheme before adding the required image to the current document.

     
    Public MethodSets up a new creator of the currently loaded PDF document into the document information dictionary and in the document catalog's metadata as well.

    If the loaded PDF document contains metadata stored in the Metadata entry in the document catalog, the newly specified Creator property is synchronized with those metadata. That means, you will be able to see the changed value of this property using the Acrobat's Document Properties dialogue box.

     
    Public MethodAdds the pair - the custom information key name and its value - to already defined custom metadata fields of the currently loaded PDF document.  
    Public MethodSets the transparency level (the current non-stroking alpha constant) for all subsequent filling (non-stroking) operations, means those with the defined Fill parameter, like the DrawCircle method or the DrawRectangle method. This constant specifies the constant shape or constant opacity value. The initial value is set to 255.

    The alpha constant parameter is one of the graphics state parameters. These parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Graphics State").

     
    Public MethodOverloaded. Sets the fill color to be used by all subsequent filling operations.  
    Public MethodAssociates a specified action (identified with a unique action identifier) with a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. At this time it is supported by the toolkit to only associate one action within one form field.  
    Public MethodSets the alternate title (the alternate field name) of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.

    This alternate name is used in place of the actual field name wherever the field must be identified in the user interface (such as in error or status messages referring to the field). For example, it can be displayed as the field's tooltip when users are hovering with the mouse over the field.

    This text is also useful when extracting the document’s content in support of accessibility to users with disabilities or for other purposes. For the proper usage, please refer to the AttachTagToFormField method.

     
    Public MethodOverloaded. Sets the background (fill) color of a required form field specified by its unique form field's identifier related to the currently loaded PDF document.  
    Public MethodOverloaded. Sets the border color of a required form field specified by its unique form field's identifier related to the currently loaded PDF document.  
    Public MethodOverloaded. Sets the style of the line used to draw the border of check boxes and radio buttons. The required form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodOverloaded. Sets the graphical style of a checkmark used to represent the checked state of check boxes and radio buttons. The required form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodOverloaded. Checks or unchecks a required form field, here a check box or a radio button, in other words toggles the field's checked state to On or Off. The form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodSets the Comb flag of a required form field, here a text field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitely applicable to text form field objects.

    If this flag is set, then the text field is automatically divided into as many equally spaced positions, or combs, as the value of maximum length of the field's text defines, and the text is laid out into those combs. This flag is meaningful only if the MaxLen attribute is defined for the text form field and if the Multiline, Password, and FileSelect flags are not set.

     
    Public MethodOverloaded. Sets, if a required form field, here a check box or a radio button, is checked by default. The form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodSets the default value of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. It is a value to which the form field reverts when it is reset, that means reset-form action is executed. The format of this value is the same as defined for the field's current value attribute.  
    Public MethodSets the DoNotScroll flag of a required form field, here a text field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.

    If this flag is set, then the text field does not scroll to include more text than fits within its rectangle. Once the field is full, no further text is accepted.

     
    Public MethodSets the DoNotSpellCheck flag of a required form field, hereabout a text field or an editable combo box, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields and editable combo boxes, so this method is explicitly applicable to text and combo box form field objects.

    If this flag is set, then text entered in the form field is not spell-checked.

     
    Public MethodSets the FileSelect flag of a required form field, here a text field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.

    If this flag is set, then the text entered in the text field represents the pathname of a file whose content are to be submitted as the value of the text field. By submission it is meant the use of the submit-form action, unfortunately the GdPicturePDF doesn't support this feature yet. The current value of the specified text field always represents the text entered in this field, please do not confuse it with the content of the file, whose pathname represents the text field value.

     
    Public MethodOverloaded. Sets the color used to display text or the checkmark in a required form field specified by its unique form field's identifier related to the currently loaded PDF document.  
    Public MethodSets the resource name of the font used to display text in a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. The usage of this attribute is not restricted to any form fields, even if the form field's appearance doesn't display text. For further assistance, please refer to the PDF Reference, Section "Interactive Forms".  
    Public MethodOverloaded. Sets the size, in points, of the font used to display text or the checkmark in a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodSets the CommitOnSelChange flag of a required form field, hereabout a choice field. The required form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to choice fields, so this method is explicitly applicable to combo box and list box form field objects.

    If this flag set, the new value is committed as soon as a selection is made with the pointing device. This option enables applications to perform an action once a selection is made, without requiring the user to exit the field. If this flag is not set, the new value is not committed until the user exits the field. Be aware that it is only allowed to set this flag if the MultiSelect flag is not set for a list box, otherwise the method will fail.

     
    Public MethodSets the Edit flag of a required form field, here a combo box, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to combo boxes, so this method is explicitly applicable to combo box form field objects.

    If this flag is set, the combo box includes an editable text box as well as a drop-down list, if this flag is not set, the combo box includes only a drop-down list. In other words, if the flag is set, the combo box is editable and allows to enter custom text.

     
    Public MethodSets the Sort flag of a required form field, hereabout a choice field. The required form field is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to choice fields, so this method is explicitly applicable to combo box and list box form field objects.

    If this flag is set, the field's items should be sorted alphabetically. Be aware that this flag is only bear in mind when creating or processing forms within applications, not by PDF viewer. Viewers should simply display the options in the order in which the corresponding items are added in the form field.

     
    Public MethodSets the location on the page of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. This location is represented by the bounding box of the form field on that page, where the form field is currently located. The coordinates of the field's bounding box are expressed in the current units used in this document with respect to the currently defined origin. The page, where the form field is located, is not affected in any way using this method.

    You can use the SetMeasurementUnit method to reset the units and the SetOrigin method to reset the origin's location according to your preference.

     
    Public MethodSets the maximum length of the text, in characters, allowed to enter into a required form field, here a text field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.  
    Public MethodSets the Multiline flag of a required form field, here a text field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.

    If this flag is set, then the text field can contain multiple lines of text. It it is not set, the field's text is restricted to a single line.

     
    Public MethodSets the MultiSelect flag of a required form field, here a list box, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to list boxes, so this method is explicitly applicable to list box form field objects.

    If this flag is set, more than one of the field's items may be selected simultaneously, if this flag is not set, no more than one item may be selected. If you set this flag to false when it has been previously set to true, the current selection is removed and the last item in the list box is selected by default.

    Be aware that it is only allowed to set this flag if the CommitOnSelChange flag is not set for a list box, otherwise the method will fail.

     
    Public MethodOverloaded. Removes the background (fill) color attribute of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodOverloaded. Removes the border color attribute of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodSets the normal caption of a required form field, here a button form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this attribute is only specific to button form fields, so this method is explicitly applicable to button form field objects.

    This caption is displayed when the button form field is not interacting with the user.

     
    Public MethodOverloaded. Sets the string representation of the normal appearance of a required form field, hereabout a radio button or a check box, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodAdds a required form field to be the content of an optional content group, specified by its unique identifier.  
    Public MethodSets the Password flag of a required form field, here a text field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.

    If this flag is set, then the text field is intended for entering a secure password that should not be echoed visibly to the screen. Instead, the characters typed from the keyboard should be displayed in some unreadable form, usually asterisks.

     
    Public MethodSets the RadiosInUnison flag of a required form field, here a radio button. The radio button group is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to radio button fields, so this method is explicitly applicable to radio button form field objects.

    If this flag is set, a group of radio buttons within a radio button field, that use the same value for the On state (radio button's choice attribute), will turn on and off in unison; that is if one is checked, they are all checked. If this flag is not set, the buttons in the group are mutually exclusive.

    If you set this flag to true for a required radio button group, no radio button in the group is selected as On. If you set the flag to false, the first radio button in the group is selected as On.

     
    Public MethodSets the ReadOnly flag of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.

    If this flag is set, then the user may not change the value of the field. Likewise, the field will not interact with the user in any way, for example, it will not respond to mouse clicks or mouse motion, etc.

     
    Public MethodSets the Required flag of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.

    If this flag is set, then the field must have a value at the time it is exported by a submit-form action. Unfortunately the GdPicturePDF doesn't support this feature yet.

     
    Public MethodSets the RichText flag of a required form field, here a text field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document. As stated, this flag is only specific to text fields, so this method is explicitly applicable to text form field objects.

    If this flag is set, then the value of this text field should be represented as a rich text string. For further assistance, please refer to the PDF Reference, Section "Rich Text Strings".

     
    Public MethodSets the counterclockwise rotation, in degrees, of a specified form field, relative to the page, where the form field is located. The required form field object is specified by its unique form field's identifier and it is related to the currently loaded PDF document.

    The value of the parameter Rotation must be always a multiple of 90, otherwise the method will fail. The default value is 0.

     
    Public MethodSets the value of NeedAppearances flag related to interactive form fields in the currently loaded PDF document.

    Sometimes fields may contain values that are not know until the document is viewed. This flag specifies whether to construct appearance streams and appearance dictionaries for form fields in the loaded document to properly render the document when viewing.

     
    Public MethodSets the justification, in other words the mode of the text alignment, used when displaying text in a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodSets the title (the name) of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodOverloaded. Sets the current value of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodSets the specified visibility, either on screen or in print, of a required form field, that is specified by its unique form field's identifier and it is related to the currently loaded PDF document.  
    Public MethodAdds a required image resource to be the content of an optional content group, specified by its unique identifier.  
    Public MethodChanges the level of quality (compression rate or quality score) used to compress JPEG2000 image within the currently loaded PDF document. You can set the Quality parameter in two ways. Positive values specify the compression rate and negative values define the quality score.

    Please note that firstly you need to create or load the PDF document to allow this setting to work properly. Secondly, you need to set the required value before adding the source image to the current document.

     
    Public MethodChanges the level of quality used to compress JPEG image within the currently loaded PDF document.

    Please note that firstly you need to create or load the PDF document to allow this setting to work properly. Secondly, you need to set the compression level before adding the required image to the current document.

     
    Public MethodSets up new keywords associated with the currently loaded PDF document into the document information dictionary and in the document catalog's metadata as well.

    If the loaded PDF document contains metadata stored in the Metadata entry in the document catalog, the newly specified Keywords are synchronized with those metadata. That means, you will be able to see the changed value of this property using the Acrobat's Document Properties dialogue box. At the same, if you need to add and store any kind of structured information into your existing document, you can also use the SetMetadata method instead.

    Please use comma or semi-colon as word separators in the specified Keywords parameter for single keywords.

     
    Public MethodSets up the natural language used for text or for optional content in the currently loaded PDF document.

    This language serves to support the accessibility of documents to users with disabilities, specifically to enable proper vocalization, for example, through a screen reader or other text-to-speech engines. For further assistance, please refer to the PDF Reference, Section "Natural Language Specification".

     
    Public MethodSets the transparency level (the current stroking alpha constant) for all subsequent stroking operations, means those with the defined Stroke parameter, like the DrawCircle method or the DrawRectangle method. This constant specifies the constant shape or constant opacity value. The initial value is set to 255.

    The alpha constant parameter is one of the graphics state parameters. These parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Graphics State").

     
    Public MethodSets the line cap style. The line cap style specifies the shape to be used at the ends of open subpaths (and dashes, if any) when they are stroked. This style is subsequently used for example, when drawing a line with the DrawLine method(). The initial value is set to square butt cap (0).

    The line cap parameter is one of the graphics state parameters. These parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Graphics State").

     
    Public MethodOverloaded. Sets the line color to be used by all subsequent stroking operations.  
    Public MethodOverloaded. Sets the dash pattern to be used when paths are stroked.  
    Public MethodSets the line join style. The line join style specifies the shape to be used at the corners of paths that are stroked, for example, when you subsequently use the DrawRectangle method. The initial value is set to miter join style (0).

    The line join parameter is one of the graphics state parameters. These parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Graphics State").

     
    Public MethodRemoves (resets) the currently defined dash pattern previously set by the SetLineDash(Single,Single) method to the initial value, which is a solid line. The dash pattern is used when paths are stroked, for example, when you use the DrawLine method or the DrawRectangle method.

    The line dash pattern parameter is one of the graphics state parameters. These parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Graphics State").

     
    Public MethodSets the line width (the line thickness, or in other words the pen size) used by all subsequent stroking operations, like the DrawLine method or the DrawRectangle method. The specified value need to be expressed in the current units defined in the PDF document. The initial value is set to 1.0.

    The line width parameter is one of the graphics state parameters. These parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Graphics State").

    You can use the GetMeasurementUnit method to determine the currently defined units and you can use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodSets the measurement units to be used for the currently loaded PDF document. Please note that you need to create or load the PDF document properly to set the valid value, otherwise the value will remain undefined.  
    Public MethodSets up a metadata of the currently loaded PDF document according to what you have specified.

    The toolkit supports XMP format of metadata, which is the standard for embedding metadata in files. For further assistance, please refer to the core XMP specification published as ISO standard 16684-1.

     
    Public MethodSets the resolution of the background layer of the image, which is subsequently processed by the MRC engine, for example using the AddImageFromGdPictureImage(Int32,PdfAdvancedImageCompression) method.

    The predefined value is -1, which means that the original resolution of the input image is used.

     
    Public MethodEnables the use of enhanced smoothing technique when processing the image compression by the MRC engine, for example using the AddImageFromGdPictureImage(Int32,PdfAdvancedImageCompression) method.

    Smoothing improves the contrast of the image by reducing noise. That means the produced image is less pixelated, but it's file size can increase. The predefined value is true.

     
    Public MethodSets up the value of the Export state setting of an optional content group specified by its unique identifier.

    The Export state indicates, if the content in this group is exported, when the document (or part of it) is saved by a viewer application to a format, that does not support optional content (for example, an earlier version of PDF or a raster image format).

     
    Public MethodSets up the value of the Locked state setting of an optional content group specified by its unique identifier.

    The Locked state indicates, if this group is for information only. Producers can use this state to prevent the visibility of this group from being changed by users.

     
    Public MethodSets up the value of the Print state setting of an optional content group specified by its unique identifier.

    The Print state indicates, if the content of this group is printable.

     
    Public MethodSets up the title of an optional content group, in other words the name of a layer, specified by its unique identifier. This name is presented in the viewer's user interface.  
    Public MethodSets up the value of the View state setting of an optional content group specified by its unique identifier.

    The View state indicates the onscreen visibility, that means if the content of this group is viewable.

     
    Public MethodSets up the maximum magnification factor of an optional content group, specified by its unique identifier.

    It is the maximum value of a defined range of magnifications below which the content of this optional content group is best viewed.

     
    Public MethodSets up the minimum magnification factor of an optional content group, specified by its unique identifier.

    It is the minimum value of a defined range of magnifications at which the content of this optional content group is best viewed.

     
    Public Method Specifies whether the OCR engine must automatically detect the page orientation.  
    Public MethodSets the new origin's location of the currently used coordinate system defined in the loaded PDF document. Please note that you need to create or load the PDF document properly to set the valid value, otherwise the value will remain undefined.  
    Public Method Specifies whether an external OCR engine must be used by this instance.  
    Public MethodSets the new boundaries, expressed in the current units used in this document, of the required page box of the currently selected page of the loaded PDF document.

    You can simply use the GetMeasurementUnit method to determine the currently defined units or you can easily use the SetMeasurementUnit method to reset the units according to your preference.

     
    Public MethodSets the content in the form of postscript data of the current page in the loaded PDF document.  
    Public MethodModifies the numeric portion value of the first page label of the labeling range, specified by its index, of the currently loaded PDF document.  
    Public MethodModifies the label prefix of the labeling range, specified by its index, of the currently loaded PDF document.  
    Public MethodModifies the starting page of the labeling range, specified by its index, of the currently loaded PDF document.  
    Public MethodModifies the style of the labeling range, specified by its index, of the currently loaded PDF document.  
    Public MethodOverloaded. Sets up the metadata of the currently selected page.  
    Public MethodDefines a private tag linked with the currently selected page in the loaded PDF document, specified by its name and value.

    Tags provide an additional information that allow page content to be extracted and reused for other purposes.

     
    Public MethodSets the user space unit value defined for the currently selected page in the loaded PDF document. It is the positive number specifying the size of default user space units, in multiples of 1/72 inch. The default value is 1.

    Please note that you need to create or load the PDF document properly to set the valid value, otherwise the method does nothing. At the same, the specified value only relates to the currently selected page.

     
    Public MethodDecrypts the currently loaded PDF document with entering the password (an user password or an owner password) you have specified. Once the correct password is provided (it does not matter if an user password or an owner password), the PDF document becomes decrypted for subsequent use and any other attempt to set a password will fail.

    Please read more about the password and permissions security in the IsEncrypted method.

     
    Public MethodDetermines if all subsequent modifications of the current page of the loaded PDF document are prepend or append. The initial value is set to false, means the prepend mode is disabled.

    This method can be particularly useful if you need to append content on the background of the page, for example drawing an image behind existing text.

     
    Public MethodSets up a new producer of the currently loaded PDF document into the document information dictionary and in the document catalog's metadata as well.

    If the loaded PDF document contains metadata stored in the Metadata entry in the document catalog, the newly specified Producer property is synchronized with those metadata. That means, you will be able to see the changed value of this property using the Acrobat's Document Properties dialogue box.

     
    Public MethodOverloaded. Sets the certificate contained in the digital ID file for the subsequent signing of the currently loaded PDF document.  
    Public MethodSets up the certificate, contained in the digital ID, from a Smart Card reader. This certificate is later used for the subsequent signing of the currently loaded PDF document.  
    Public MethodSets up the certificate, contained in the digital ID, from a Smart Card reader, specified by its serial number. This certificate is later used for the subsequent signing of the currently loaded PDF document.  
    Public MethodSets up the certificate, contained in the digital ID stored in the Windows Certificate Store (the current user's store or the local machine's store), specified by its serial number. This certificate is later used for the subsequent signing of the currently loaded PDF document.  
    Public MethodSpecifies the level of the signature certification to be used for subsequent signing of the currently loaded PDF document.

    A value of PdfSignatureCertificationLevel.NotCertified defines the standard (ordinary) recipient digital signature, while other values introduce an author or certifying signatures (modification detection and prevention). Hence PDF files can be certified only once, but if permissions allow, can be digitally signed many times.

    Regarding certifying signatures, the level means the author’s specification of which changes to the document will invalidate the signature. A value of PdfSignatureCertificationLevel.NoChanges indicates that the document is intended to be final; that is, any changes invalidate the signature. The values PdfSignatureCertificationLevel.FormFilling and PdfSignatureCertificationLevel.FormFillingAndAnnotations permit modifications that are appropriate for form field or comment workflow.

     
    Public MethodSpecifies the hash algorithm to be used for the subsequent signing of the currently loaded PDF document. Now the SHA-256 algorithm is used as the standard, although with some old certificates you will still need to use SHA-1.

    You can find more details about the SHA algorithms in RFC 6234 US Secure Hash Algorithms (SHA And SHA-based HMAC And HKDF).

     
    Public MethodSets up the additional signature information.  
    Public MethodSets up the coordinates and dimensions of the signature's bounding box within the current page of the loaded PDF document. This is the location, where the signature is placed after the successful signing of the current document. If you omit this method in the signing process, or you set the width or the height to 0, the signature will not be drawn, that means it becomes invisible on the current page.  
    Public MethodOverloaded. Sets up the coordinates and dimensions of the signature's bounding box within the current page of the loaded PDF document using the signature placeholder, in other words previously added empty signature form field.  
    Public MethodSets up the required image to be drawn within the signature's bounding box. The specified resource will be applied during the subsequent signing process. If the applied signature is invisible, the image will not be drawn. If you also set the text using the SetSignatureText(String,String,Single,Color,TextAlignment,TextAlignment,Boolean) method, the image will be situated at the right side within the signature's bounding box.  
    Public MethodOverloaded. Sets up the text to be displayed within the signature's bounding box.  
    Public MethodSpecifies the Time Stamp Server and the corresponding credentials, if you want to use timestamping for the subsequent signing of the currently loaded PDF document.  
    Public MethodSpecifies whether the validity of the signature will be displayed using the corresponding graphic icon (validation mark) after the signing of the currently loaded PDF document. The predefined icon, that represents the current validity of the signature, is subsequently drawn within the signature's bounding box after the successful signing.  
    Public MethodSets up a new subject of the currently loaded PDF document into the document information dictionary and in the document catalog's metadata as well.

    If the loaded PDF document contains metadata stored in the Metadata entry in the document catalog, the newly specified Subject property is synchronized with those metadata. That means, you will be able to see the changed value of this property using the Acrobat's Document Properties dialogue box.

     
    Public MethodSets the actual text of a structure element (tag) specified by its unique (tag's) identifier, that is a part of the document's tag structure tree related to the currently loaded PDF document.

    It is an exact replacement text for such content, that is represented in a nonstandard way. Generally, it should apply to as small piece of content as possible.

     
    Public MethodSets the alternate description of the structure element (tag) specified by its unique (tag's) identifier, that is a part of the document's tag structure tree related to the currently loaded PDF document.

    It is a text string in the readable form providing for items, located in the PDF document, that do not translate naturally into the text, such as images, formulas, actual form field names or annotations displaying text and others.

     
    Public MethodOverloaded. Creates a new attribute for a structure element (tag) specified by its unique (tag's) identifier, that is a part of the document's tag structure tree related to the currently loaded PDF document.  
    Public MethodSets the natural language for all text in the structure element (tag) specified by its unique (tag's) identifier, that is a part of the document's tag structure tree related to the currently loaded PDF document. You can override the document's natural language by setting this property for the single structure element if needed.

    For further assistance, please refer to the PDF Reference, Section "Language Specification Hierarchy".

     
    Public MethodSets the title of the structure element (tag) specified by its unique (tag's) identifier, that is a part of the document's tag structure tree related to the currently loaded PDF document.

    It is a text string in the readable form representing the specific structure element (tag), for example, Section 1 or Volume 1, etc.

     
    Public MethodSets the character spacing to be used when drawing text onto the currently loaded PDF document. This value defines a distance between adjacent characters in a line of text. It is a number expressed in unscaled text space units (points). The initial value is set to 0.

    The character spacing parameter is one of the text state parameters, that only affect text. The text state parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Text State Parameters and Operators").

     
    Public MethodSets text decoration style for all subsequent text drawing operations.  
    Public MethodSets the various settings of the text search/extraction engine for further use when searching or extracting text from the currently loaded PDF document.

    Please note that you need to create or load the PDF document to allow these settings to work properly. At the same, the settings are reset to an undefined value (TextExtractionOptions.Default), when creating or loading a new PDF document.

     
    Public MethodSets the text rendering mode to be used when drawing text onto the currently loaded PDF document. The text rendering mode specifies whether drawing text causes glyph outlines to be stroked, filled, used as a clipping boundary, or some combination of the three. The initial value is set to fill mode.

    The text rendering mode parameter is one of the text state parameters, that only affect text. The text state parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Text State Parameters and Operators").

     
    Public MethodSet the text rise to be used when drawing text onto the currently loaded PDF document. The text rise parameter specifies the distance, in unscaled text space units (points), to move the baseline up (positive values) or down (negative values) from its default location. Adjustments to the baseline are useful for drawing superscripts or subscripts. The initial value (the default location of the baseline) is set to 0.

    The text rise parameter is one of the text state parameters, that only affect text. The text state parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Text State Parameters and Operators").

     
    Public MethodSets the horizontal scaling to be used when drawing text onto the currently loaded PDF document. This value adjusts the width of glyphs by stretching or compressing them in the horizontal direction. It is specified as a percentage of the normal width of the glyphs. The initial value is set to 100 (the normal width).

    The horizontal scaling parameter is one of the text state parameters, that only affect text. The text state parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Text State Parameters and Operators").

     
    Public MethodSets the current text size (the font size, actually) to be used when drawing text onto the currently loaded PDF document. The initial value is set to 12.

    The text size parameter is one of the text state parameters, that only affect text. The text state parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Text State Parameters and Operators").

     
    Public MethodSets text underline color for all subsequent text drawing operations.  
    Public MethodSets text underline distance from text for all subsequent text drawing operations.  
    Public MethodSets text underline style for all subsequent text drawing operations if the PdfTextDecorationStyle.Underline is used.  
    Public MethodSets text underline width for all subsequent text drawing operations.  
    Public MethodSets the word spacing to be used when drawing text on the currently loaded PDF document. This value defines a distance between adjacent words in a line of text. It is a number expressed in unscaled text space units (points). The initial value is set to 0.

    The word spacing parameter is one of the text state parameters, that only affect text. The text state parameters are initialized to their default values at the beginning of each page (see PDF Reference, Section "Text State Parameters and Operators").

     
    Public MethodSets up a new title of the currently loaded PDF document into the document information dictionary and into the document catalog's metadata as well.

    If the loaded PDF document contains metadata stored in the Metadata entry in the document catalog, the newly specified Title property is synchronized with those metadata. That means, you will be able to see the changed value of this property using the Acrobat's Document Properties dialogue box.

     
    Public MethodSets the document's layout mode setting, specifying the page layout to be used when the document is opened in Adobe Reader or Acrobat viewer.  
    Public MethodSets the document's page mode setting, specifying how to display the document on exiting full-screen mode when viewing the document in Adobe Reader or Acrobat viewer. This setting is only meaningful if the value returned by the GetViewerPageMode method is PdfViewerPageMode.PdfViewerPageModeFullScreen. It is ignored otherwise.  
    Public MethodSets the specified action in the OpenAction entry in the PDF document's catalog. This property defines a destination to be displayed or an action to be carried out when the document is opened. If this entry is absent, the document should be opened to the top of the first page at the default magnification factor.  
    Public MethodSets the document's page mode setting, specifying how the document should be displayed when opened in Adobe Reader or Acrobat viewer.  
    Public MethodSets up different viewer preference settings. These preferences, if defined, control the way the document is to be presented on the screen in Adobe Reader or Acrobat viewer.  
    Public MethodStrokes the current path, in other words paints a line along the current path, defined within a currently selected page of the loaded PDF document. This method sets the path-painting operator "S". Each straight or curved segment in the current path is painted and also be aware that each of the path's sub-paths is handled separately (see PDF Reference, Section "Path-Painting Operators"). By the definition the results of the "S" operator depend on the current settings of the graphics state parameters, for example the line width or the line color, as well as the line pattern or the line join style, etc.  
    Public MethodSwaps two pages specified by their page numbers within the currently loaded PDF document, that means the specified pages change their position with one another in the document.  
    Public MethodTries to remove the embedded font program data of font, used in the currently loaded PDF document, according to the font index you have specified, if the font is embedded. You can use the GetFontCount method to determine the number of all used fonts in the PDF document. The font index is simply an integer value from 1 to GetFontCount.

    Font embedding means that a full copy of the entire character set of a font is stored in the PDF. A font program can be embedded in a PDF file as data contained in a PDF stream object (also called a font file). Embedded fonts ensure that all of the font informations needed to correctly visualize the document are always present. Removing this information might lead to decrease of the document quality and in rare cases to loss of information.

    Certain types of fonts like font subsets or fonts with custom character mapping can not be unembedded using this method.

     
    Top
    Public Events
     NameDescription
    Public EventThis event is raised right after a page has been successfully printed.

    Please check the corresponded GdPicturePDF.AfterPdfPrintPageEventHandler for given parameters.

     
    Public EventThis event is raised just before the specified page is going to be processed using the OcrPage or the OcrPages(String,Int32,String,String,String,Single) methods.

    Please check the corresponded GdPicturePDF.BeforePageOcrEventHandler for given parameters.

     
    Public EventThis event is raised right before a page is to be printed.

    Please check the corresponded GdPicturePDF.BeforePdfPrintPageEventHandler for given parameters.

     
    Public Event  
    Public EventThis event is raised after the whole OCR process, invoked by the OcrPage or the OcrPages(String,Int32,String,String,String,Single) methods, has been terminated.

    Please check the corresponded GdPicturePDF.OcrPagesDoneEventHandler for given parameters.

     
    Public EventThis event is raised immediately after the specified page has been processed using the OcrPage or the OcrPages(String,Int32,String,String,String,Single) methods.

    Please check the corresponded GdPicturePDF.OcrPagesProgressEventHandler for given parameters.

     
    Public EventThis event is raised when a specified image is ready to be sent to the OCR engine during the process invoked by the OcrPage or the OcrPages(String,Int32,String,String,String,Single) methods. It is fired after the BeforePageOcr event. This event is particularly useful to apply your specific custom pre-processing to the image before recognizing it.

    Please check the corresponded GdPicturePDF.PageBitmapOcrReadyEventHandler for given parameters.

     
    Top
    See Also