Aspose.PDF Save options for export to APS XML format. Load options for PdfXml format. Save options for PdfXml format. Enumeration describes associated files relationship. Source Data Alternative Supplement Unspecified EncryptedPayload None Class incapsulates basic actions wuth page/annotation/field interactive actions Removes all actions of the annotation. Represents base class for operator collection. Gets operator by its index. Index of operator. Numbering is starts from 1. Operator from requested index Returns enumerator for collection Collection enumerator Copies operators into operators list. Array with operators which must to be copied. This array must be Object[] or Operator[]. Starting index from which operators will be copied Gets count of operators in the collection. Returns true if collection is read only. Indicates wheather collection is limited to fast text extraction Suppresses update contents data. The contents stream is not updated until ResumeUpdate is called. Resumes document update. Updates contents stream in case there are any pending changes. Inserts operator into collection. Index where new operator must be added Operator which will be insterted Adds new operator into collection. Operator which must be added Removes operator from collection. Clears collection. Cancels last update. This method may be called when the change should not raise contents update. Specifies color type of elements on page. RGB color type. Grayscale color type. Black and white color type. Undefined color type value. Provides methods for COM clients to load a document into Aspose.Pdf. Use the ComHelper class to load a document from a file or stream into a Document object in a COM application. The Document class provides a default constructor to create a new document and also provides overloaded constructors to load a document from a file or stream. If you are using Aspose.Words from a .NET application, you can use all of the Document constructors directly, but if you are using Aspose.Pdf from a COM application, only the default Document constructor is available. Initialize and return new Document instance from the stream. Stream with pdf document. Document object Initialize and return new Document instance from the stream. Input stream object, corresponding pdf is password protected. User or owner password. Document object Initialize and return new Document instance from the stream. Stream with pdf document. if set to true inner stream is closed before exit; otherwise, is not. Document object Initialize and return new Document instance from the stream. Stream with pdf document. User or owner password. if set to true inner stream is closed before exit; otherwise, is not. Document object Open and return an existing document from a stream providing necessary converting to get pdf document. Input stream to convert into pdf document. Represents properties for converting into pdf document. Document object Just create and return Document using . The same as . The name of the pdf document file. Document object Initialize and return new instance of the class for working with encrypted document. Document file name. User or owner password. Document object Initialize new instance of the class for working with encrypted document. Document file name. User or owner password. if set to true inner stream is closed before exit; otherwise, is not. Document object Open an existing document from a file providing necessary converting oprions to get pdf document. Input file to convert into pdf document. Represents properties for converting into pdf document. Document object The Aspose.Pdf.Engine.CommonData.Text.CMaps is a root namespace for all CMap classes. The namespace handles AsyncTask processing. The namespace provides helper classes and methods to work with different brush types. The namespace contains exceptions thrown by one of the compression algorithms supported. The namespace contains exceptions thrown by any of the core Imaging components. The Aspose.Pdf.Engine.Presentation.Graphics.CoreExceptions namespace contains Aspose.Pdf.Engine.Presentation.Graphics exceptions. The namespace provides different helper classes for color dithering. The namespace DIB header processing. The namespace contains EXIF enumerations. The namespace contains EXIF related helper classes and methods. The namespace contains EXIF related helper classes and methods. The namespace contains extension methods. The namespace handles Bmp file format processing. The namespace handles Bmp file format processing. The logical structures, used to support bitmap header. The namespace handles Dicom file format processin The namespace contains Gif file format entities. The namespace handles Gif file format processing. The namespace handles Gif file format processing. The namespace handles Jpeg2000 file format processing. The namespace handles Jpeg file format processing. The namespace contains Tiff file format enumerations. The namespace contains Tiff file format stream handling classes. The namespace contains Tiff file format tag factory helper classes and interfaces. The namespace handles Tiff file format processing. The namespace handles Tiff file format processing. The namespace handles Tiff file format processing. The namespace contains Tiff file format tag classes. The namespace contains classes suitable for export, save or creation of different file formats. The namespace handles Psd file format processing. The namespace handles Filter options. The namespace handles Tiff file format processing. The namespace contains memory management routines. The namespace contains Multithreading classes. The namespace is the core for nested namespaces and the most basic objects used for Aspose.Pdf.Engine.Presentation.Graphics processing. The namespace contains classes for adjustment of color palette to the image colors and visa versa. The namespace contains progress handler classes The namespace contains different shape segments which combine shapes. The namespace contains different shapes combined from shape segments. Namespace contains different stream sources which are suitable for input or output data flow. The namespace contains XMP related helper classes and methods. The Aspose.Pdf.Engine.Presentation.Graphics.Xmp namespace contains namespaces used in RDF document. The namespace contains Dublin Core metadata related helper classes, constants and methods. The namespace contains related helper classes, constants and methods used with Adobe PDF documents. The namespace contains related helper classes, constants and methods used by Adobe Photoshop. The namespace contains the XMP Basic Schema related helper classes, constants and methods that provide basic descriptive information. The namespace contains XMP related helper classes, constants and methods used by the Adobe dynamic media group. The namespace contains related helper classes, constants and methods that is primarily used by digital asset management (DAM) systems. The namespace contains related to rights management helper classes, constants and methods. These properties specify information regarding the legal restrictions associated with a resource. The namespace contains classes that represent the basic type values of XMP properties. The namespace contains classes that represent the structures containing the characteristics of a colorant (swatch) used in a document. The namespace contains classes that represent the structure containing dimensions for a drawn object. The namespace contains classes that represent the structure containing the characteristics of a font used in a document. The namespace contains classes that represent the complex type values of XMP properties. The namespace contains class that is a high level event that occured in the processing of this document. The namespace contains class that is a multiple part reference to a resource. Used to indicate prior versions, originals of renditions, originals for derived documents, and so on. The namespace contains class that is a thumbnail image for a file. The namespace contains classes that describe one version of a document. The namespace contains classes that represent the derived type values of XMP properties. The namespace contains classes that represent the values of XMP properties in three basic categories: basic types, complex and derived types. The Aspose.Pdf.Presentation namespace provides classes that allow to interact with document presentation. Represents single font file source. Initializes a new instance of class. Font file byte array. Font file byte array. Check if font file source objects are equal. Font file source object which will be compared. True if both objects are font file sources targeted to the same file. Releases internal resources. Represents single font file source. Initializes a new instance of class. Path to the font file. Path to the font file. Check if font file source objects are equal. Font file source object which will be compared. True if both objects are font file sources targeted to the same file. Represents the folder that contains font files. Initializes a new instance of class. Path to the folder. Path to the folder that contains font files. Check if folder font source objects are equal. Folder font source object which will be compared. True if both objects are folder font sources targeted to the same folder. Represents a base class fot font source. Represents font sources collection. Gets the number of object elements actually contained in the collection. Gets an object that can be used to synchronize access to the collection. Gets a value indicating whether access to the collection is synchronized (thread safe). Returns an enumerator for the entire collection. Enumerator object. Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array Array of objects which will be copied. Starting index from which copying will be started. Adds new font source object to the collection. Font source. Clears the font source collection. Deletes the font source element. FontSource object that will be deleted. Gets the font element at the specified index. Index within the collection. Fout source object. Determines whether an element is in the collection FontSource object to search. Deletes the font source element. FontSource object that will be deleted. Represents all fonts installed to the system. Check if system font source objects are equal. System font source object which will be compared. True if both objects are system font sources, false otherwise. Represents a base class for custom font substitution strategy. Substitutes original font with another font. The class CustomFontSubstitutionBase should be inherited to implement custom font substitution logic. TrySubstitute method should be overridden properly: Must return true in case substitution is required. substitutionFont must be set to valid Font object. Must return false in case no substitution is required. substitutionFont may be set to null. Original font specification. Substitution font. True in case substitution was successfull. Represents original font specification. Provides info related to original font such as , flag. Also provides flag that helps to check is the substitution will anyway happen with the font and the user may override the default substitution logic. Gets original font name. Gets a value that indicates whether the font is embedded. Gets a value that indicates that the substitution is unavoidable. Returns true in case substitution was requested because of absence of the original font or in case original font cannot be used in context of some task. In case user ignores the flag and doesn't substitute the font - default font substitution procedure is performed. But it provides opportunity for the user to alternate standard font substitution procedure and set better font to the system. Returns false in case original font is present, valid, but it is allowed for the user to substitute it. Represents a class for font substitution strategy that substitutes fonts with system fonts. Initializes a new instance of class. Target font categories to substitute with system fonts Gets or sets substitution font categories that should be substituted with system fonts. Gets or sets default substitution font. The font is used when no other valid substitution were found but initial font belongs to target substitution category (). Represents font categories that can be substituted. The fonts that are named the same as system fonts. Those fonts are mostly safe to be substituted with the same named system fonts. All embedded fonts are substituted. Represents a base class fot font substitution strategies. Represents font substitution strategies collection. Gets the number of object elements actually contained in the collection. Gets an object that can be used to synchronize access to the collection. Gets a value indicating whether access to the collection is synchronized (thread safe). Returns an enumerator for the entire collection. Enumerator object Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array Array of objects which will be copied. Starting index from which copying will be started. Adds new font substitution object to the collection. Font substitution strategy. Clears the font substitution collection. Determines whether an element is in the collection FontSubstitution object to search. Deletes the font substitution element. FontSubstitution object to delete. Gets the font element at the specified index. Index within the collection. FontSubstitution object. Represents a class for simple font substitution strategy. Gets original font name that should be substituted with Gets font name that should substitute the Initializes a new instance of class. Original font name. Substitution font name. Substitution forced by DefaultFontName save option. Useful properties to tune Font behaviour Sometimes it's not possible to embed desired font into document. There are many reasons, for example license restrictions or when desired font was not found on destination computer. When this situation comes it's not simply to detect, because desired font is embedded via set of property flag Font.IsEmbedded = true; Of course it's possible to read this property immediately after it was set but it's not convenient approach. Flag NotifyAboutFontEmbeddingError enforces exception mechanism for cases when attempt to embed font became failed. If this flag is set an exception of type will be thrown. By default false. The Aspose.Pdf.Text namespace provides classes that allow to extract text, add text, manipulate existing text of a document. It also contain classes that allow to extract, replace, substitute fonts of a document. Represents a paragraph. Points of polygon that describes paragraph. Starting point is lower left corner of the paragraph. And next points are in anti-clockwise sequence. Points of secondary polygon describes paragraph continuation. It will not be null if the paragraph is continued in the next column or page. Starting point is lower left corner of the paragraph. And next points are in anti-clockwise sequence. List of page numbers on which the paragraph is continued. It will match with page where the paragraph started if it is continuing in the next column on the same page. Collection of not empty objects of the paragraph. The object provides access to the search occurrence text, text properties, and allows to edit text and change the text state (font, font size, color etc). Lines of paragraph. Each line represented by list of text fragments. The object provides access to the search occurrence text, text properties, and allows to edit text and change the text state (font, font size, color etc). Gets text object that the object represents. Represents a markup section - the rectangular region of a page that contains text and can be visually divided from another text blocks. Section rectangle Collection of not empty objects that are inside the section. The object provides access to the search occurrence text, text properties, and allows to edit text and change the text state (font, font size, color etc). Collection of objects that are inside the section. Page markup represented by collections of and . Gets processed page number. Gets processed page rectangle. Gets collection of that was found on the page. Gets collection of that was found on the page. Gets collection of that was found on the page. The object provides access to the search occurrence text, text properties, and allows to edit text and change the text state (font, font size, color etc). Gets or sets value that indicates whether starting text lines of a next section may be treated as continuation of the last paragraph of a previous section. Represents an absorber object of page structure objects such as sections and paragraphs. Performs search for sections and paragraphs of text and provides access for rectangles and polydons that describes it in text coordinate space. Also performs text segments search and provides access to search results via collections grouped by structure elements. When the search is completed the collection will contains objects that represents page structure by collections of and . The object provides access to the search occurrence text, text properties, and allows to edit text and change the text state (font, font size, color etc). The example demonstrates how to find first text segment of each paragraph on the first PDF document page and highlight it. // Open document Document doc = new Document("input.pdf"); // Create ParagraphAbsorber object ParagraphAbsorber absorber = new ParagraphAbsorber(); // Accept the absorber for first page absorber.Visit(doc.Pages[1]); // Get markup object of first page PageMarkup markup = absorber.PageMarkups[0]; // Loop through structure elements of the page text to find first text fragment of each paragraph foreach (MarkupSection section in markup.Sections) { foreach (MarkupParagraph paragraph in section.Paragraphs) { TextFragment fragment = paragraph.Fragments[0]; // Update text properties fragment.TextState.BackgroundColor = Color.LightBlue; } } // Save document doc.Save(GetOutputPath("output.pdf")); Initializes a new instance of the that performs search for sections/paragraphs of the document or page. Initializes a new instance of the that performs search for sections/paragraphs of the document or page. See property for more hints about the parameter. Number of sequential searches for more fine elements of structure that will be performed. Gets collection of that were absorbed. Gets or sets value that instructs how many times sequential searches for more fine elements of structure will be performed. Default search depth is 3. It means three searches for horizontally divided sections (headers, paragraphs etc) and three searches for vertically divided ones (columns). Increasing of this value may lead to minor decreasing performance with no visible changes in search result. Decreasing of this value may lead to incorrect determination of paragraphs in sections. We are not recommend to set value less than default if you aren't desire to get only 'rough' elements of page structure. Gets or sets value that indicates whether starting text lines of a next section may be treated as continuation of the last paragraph of a previous section. Performs search on the specified . Pdf pocument page object. Represents cell of table that exist on the page Gets collection of objects that describes text containing in the cell Gets rectangle that describes position of the cell on page Represents row of table that exist on the page Gets readonly IList containing cells of the row Gets rectangle that describes position of the row on page Represents table that exist on the page Gets readonly IList containing rows of the table Gets rectangle that describes position of the table on page Gets number of the page containing this table This interface represents an element of existing table extracted by TableAbsorber. Gets rectangle that describes position of table element on the page Represents an absorber object of table elements. Performs search and provides access to search results via collection. The example demonstrates how to find table on the first PDF document page and replace the text in a table cell. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TableAbsorber object to find tables TableAbsorber absorber = new TableAbsorber(); // Visit first page with absorber absorber.Visit(pdfDocument.Pages[1]); // Get access to first table on page, their first cell and text fragments in it TextFragment fragment = absorber.TableList[0].RowList[0].CellList[0].TextFragments[1]; // Change text of the first text fragment in the cell fragment.Text = "hi world"; // Save document doc.Save(@"D:\Tests\output.pdf"); Gets or sets text search options. Allows to define several options that will be used during search text containing in tables. Returns readonly IList containing tables that were found Initializes a new instance of the with text search options. Performs searching for tables and provides access to the tables via object. Text search options Initializes a new instance of the . Performs searching for tables and provides access to the tables via object. Extracts tables on the specified page The example demonstrates how to extract table on the first PDF document page. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TableAbsorber object to find tables TableAbsorber absorber = new TableAbsorber(); // Visit first page with absorber absorber.Visit(pdfDocument.Pages[1]); // Get access to first table on page, their first cell and text fragments in it TextFragment fragment = absorber.TableList[0].RowList[0].CellList[0].TextFragments[1]; // Change text of the first text fragment in the cell fragment.Text = "hi world"; // Save document doc.Save(@"D:\Tests\output.pdf"); Pdf pocument page object. Removes an from the page. to remove. Please take into account it changes TableList collection. In case removing/replacing tables in loop please use copy of TableList collection. Replaces an with on the page. Pdf pocument page object. to be replaced. to replace old table. Please take into account it changes TableList collection. In case removing/replacing tables in loop please use copy of TableList collection. Enumerates the tab alignment types. Text aligned left from tab stop Text aligned center from tab stop Text aligned right from tab stop Enumerates the tab leader types. Solid tab leader. Dash tab leader. Dot tab leader. No tab leader. Represents a custom Tab stop position in a paragraph. Initializes a new instance of the class. Initializes a new instance of the class with specified position. The position of the tab stop. Gets or sets a float value that indicates the tab stop position. Gets or sets a enum that indicates the tab leader type. Gets or sets a enum that indicates the tab tab alignment type. Gets value indicating that this instance is already attached to and became readonly Represents a collection of objects. Gets value indicating that this instance is already attached to and became readonly. Initializes a new instance of the class and add it to the TabStops collection. The new object. Initializes a new instance of the class with specified position and add it to the TabStops collection. The position of the tab stop. The new object. Add instance of the class to the TabStops collection. The object. Initializes a new instance of the class with specified position and add it to the TabStops collection. The position of the tab stop. The new object. Initializes a new instance of the class with specified position and leader type and add it to the TabStops collection. The position of the tab stop. The leader type of the tab stop. The new object. Clones a new objects. The new object. Gets or sets a object from the collection according to TabStop index. Zero-based index of element in collection. object. Describes the text extraction error has appeared in the PDF document. Brief description of the error. Expanded description of the error. Location of the error. Key (PDF name) of the Font object that is used for showing text that causes extraction error. Readable (internal) name of the Font object that is used for showing text that causes extraction error. Text that was actually extracted. Represents the location in the PDF document where text extraction error has appeared. Location of the PDF document where text extraction error has appeared. Number of the document page where text extraction error has located. Type of the PDF object (Page or xForm) in which contents stream text extraction error has located. Key (name) of the PDF Form XObject in which contents stream text extraction error has located. Not empty if ObjectType == 'xForm'. Index of text showing operator in the contents stream (operator collection) that causes text extraction error. Text showing operator that causes text extraction error. Key (name) of the PDF Font object that is used for showing of the operator that causes text extraction error. Key (name) of the PDF Font object that is used for showing of the operator that causes text extraction error. The text rendering mode, Tmode, determines whether showing text shall cause glyph outlines to be stroked, filled, used as a clipping boundary, or some combination of the three. Fill text. Stroke text. Fill, then stroke text. Neither fill nor stroke text (invisible). Fill text and add to path for clipping (see 9.3.6, "Text Rendering Mode,"). Stroke text and add to path for clipping. Fill, then stroke text and add to path for clipping. Add text to path for clipping. Represents an absorber object of fonts. Performs search for fonts and provides access to search results via collection. Gets collection of search occurrences that are presented with objects. Performs search in the specified range of pages of the document. Pdf pocument object. Pdf pocument start page. Pdf document page count Performs search on the specified document. Pdf pocument object. Represents CharInfo objects collection. Provides access to positioning information of text segment characters. The example demonstrates how to iterate throught all the characters and retrieve the charact //open document Document pdfDocument = new Document(inFile); //create TextFragmentAbsorber object to collect all the text objects of the page TextFragmentAbsorber textFragmentAbsorber = new TextFragmentAbsorber(); //accept the absorber for all the pages pdfDocument.Pages[1].Accept(textFragmentAbsorber); //get the extracted text fragments TextFragmentCollection textFragmentCollection = textFragmentAbsorber.TextFragments; //loop through the fragments foreach (TextFragment textFragment in textFragmentCollection) { //loop through the segments foreach (TextSegment textSegment in textFragment.Segments) { //loop through the characters for (int i = 1; i <= textSegment.Text.Length; i++) { CharInfo charInfo = textSegment.Characters[i]; // print character position and rectangle info Console.WriteLine("XIndent : {0} ", charInfo.Position.XIndent); Console.WriteLine("YIndent : {0} ", charInfo.Position.YIndent); Console.WriteLine("Width : {0} ", charInfo.Rectangle.Width); Console.WriteLine("Height : {0} ", charInfo.Rectangle.Height); } } } Gets the number of object elements actually contained in the collection. Gets an object that can be used to synchronize access to the collection. Gets a value indicating whether access to the collection is synchronized (thread safe). Gets a value indicating whether collection is read-only Returns an enumerator for the entire collection. Enumerator object. Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array Array of objects which will be copied. Starting index from which copying will be started. Collection is read-only. Always throws NotImplementedException. Collection is read-only. Always throws NotImplementedException. Determines whether the collection contains a specific value. The object to locate in the collection true if item is found in the collection; otherwise, false. Collection is read-only. Always throws NotImplementedException. Gets the CharInfo element at the specified index. Index within the collection. CharInfo object. Supported font types enumeration. TTF font type OTF font type Represents a position object Gets the X coordinate of the object Gets the Y coordinate of the object Initializes a new instance of class X coordinate value. Y coordinate value. Gets string representation for the current object. String representration of the Position object. Determines whether the specified object is equal to the current object. Object that is checked for equality. True in case objects are equal. Represents text formatting options Initializes new instance of the object for the specified word wrap mode. Word wrap mode. Initializes new instance of the object with undefined word wrap mode. Gets or sets word wrap mode. Default value is WordWrapMode.NoWrap Defines word wrapping strategies No wrapping is performed Discretionary hyphenation is performed. Allows breaking words in the middle. Word wrapping only wraps complete words. If the complete word cannot be wrapped, attempts to use discretionary hyphenation WordWrapMode not set. Wrapping strategie of upper level structure (table cell, paragraph etc.) will be used. Gets or sets line spacing mode. Default value is LineSpacingMode.FontSize Defines line spacing specifics Line spacing is font size Line spacing is a full space between descender and ascender Gets or sets subsequent lines indent value. Gets or sets first line indent value. Represents text paragraphs as multiline text object. The example demonstrates how to create text paragraph object and append it to the Pdf page. Document doc = new Document(inFile); Page page = (Page)doc.Pages[1]; // create text paragraph TextParagraph paragraph = new TextParagraph(); // set the paragraph rectangle paragraph.Rectangle = new Rectangle(100, 600, 200, 700); // set word wrapping options paragraph.FormattingOptions.WrapMode = TextFormattingOptions.WordWrapMode.ByWords; // append string lines paragraph.AppendLine("the quick brown fox jumps over the lazy dog"); paragraph.AppendLine("line2"); paragraph.AppendLine("line3"); // append the paragraph to the Pdf page with the TextBuilder TextBuilder textBuilder = new TextBuilder(page); textBuilder.AppendParagraph(paragraph); // save Pdf document doc.Save(outFile); Gets or sets vertical alignment for the text inside paragrph's . VerticalAlignment.None is equal to VerticalAlignment.Bottom. Gets or sets subsequent lines indent value. If set to a non-zero value, it has an advantage over the FormattingOptions.SubsequentLinesIndent value. Gets or sets subsequent lines indent value. If set to a non-zero value, it has an advantage over the FormattingOptions.SubsequentLinesIndent value. Gets or sets value whether text is justified. Gets or sets horizontal alignment for the text inside paragrph's . HorizontalAlignment.None is equal to HorizontalAlignment.Left. Gets or sets formatting options. Gets or sets position of the paragraph. Gets rectangle of the text placed to the paragraph. Gets or sets rectangle of the paragraph. Gets or sets the padding. Gets or sets rotation angle in degrees. Begins the editing of the TextParagraph. Improves performance of TextParagraph population. Any layout calculation is suspended until EndEdit method is invoked. Note that method invoke can't be nested. Ends the editing of the TextParagraph. Improves performance of TextParagraph population. Any layout calculation is suspended until EndEdit method is invoked. Note that method invoke can't be nested. Appends text line The new line's text. Appends text line. The new line's text. Additional spacing (0.0 is default and corresponds to default text line height). The spacing value is added to default line spacing for the particular line, so you may specify 12.0 to get empty row AFTER a text line drawn with 12pt font. Appends text line with text state parameters. The new line's text. Text state of the new line. Appends text line with text state parameters The new line's text. Text state of the new line. Additional spacing (0.0 is default and corresponds to default text line height). The spacing value is added to default line spacing for the particular line, so you may specify 12.0 to get empty row AFTER a text line drawn with 12pt font. Appends text line with text state parameters. The new line's text. Appends text line with text state parameters. The new line's text. Text state of the new line. Appends text line with text state parameters The new line's text. Text state of the new line. Additional spacing (0.0 is default and corresponds to default text line height). The spacing value is added to default line spacing for the particular line, so you may specify 12.0 to get empty row AFTER a text line drawn with 12pt font. Represents font object. The example demonstrates how to search text on first page and change font of a first search occurrence. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Create font and mark it to be embedded Font font = FontRepository.FindFont("Arial"); font.IsEmbedded = true; // Change font of the first text occurrence absorber.TextFragments[1].TextState.Font = font; // Save document doc.Save(@"D:\Tests\output.pdf"); Gets font name of the object. The example demonstrates how to search text on first page and view font name of a first text occurrence. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // View font name of first text occurrence Console.Out.WriteLine(absorber.TextFragments[1].TextState.Font.FontName); Sometimes PDF fonts(usually Chinese/Japanese/Korean fonts) could have specificical font name. This name is value of PDF font property "BaseFont" and sometimes this property could be represented in hexademical form. If read this name directly it could be represented in non-readable form. To get readable form it's necessary to decode font's name by rules specifical for this font. This property returns decoded font name, so use it for cases when you meet with a non-readable . If property has readable form this property will be the same as , so you can use this property for any cases when you need to get font name in a readable form. Gets BaseFont value of PDF font object. Also known as PostScript name of the font. An objective of this method - to return description of error if an attempt to embed font was failed. If there are no error cases it returns empty string. Error description Gets or sets a value that indicates whether the font is embedded. The following example demonstrates how to find a font, mark it as embedded, search text on the document's page and replace the text font. // Create font and mark it to be embedded Font font = FontRepository.FindFont("Arial"); font.IsEmbedded = true; // open document Document doc = new Document(@"D:\Tests\input.pdf"); // create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // accept the absorber for first page doc.Pages[1].Accept(absorber); // change font for the first text occurrence absorber.TextFragments[1].TextState.Font = font; // save document doc.Save(@"D:\Tests\output.pdf"); Gets or sets a value that indicates whether the font is a subset. The example demonstrates how to search text on first page and get the value that indicates whether the font is a subset. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // View font's IsSubset value of first text occurrence if(absorber.TextFragments[1].TextState.Font.IsSubset) Console.Out.WriteLine("the font is a subset"); Gets indicating whether the font is present (installed) in the system. Some operations are not available with fonts that could not be found in the system. The example demonstrates how to search text on first page and get the value that indicates whether the font is installed in the system. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // View font's IsSubset value of first text occurrence if(absorber.TextFragments[1].TextState.Font.IsAccessible) Console.Out.WriteLine("the font is installed in the system"); Useful properties to tune Font behaviour Saves the font into the stream. Note that the font is saved to intermediate TTF format intended to be used in a converted copy of the original document only. The font file is not intended to be used outside the original document context. Stream to save the font. Measures the string. The string. Font size. Width of the string represented with this font and the specified size. Represents font collection. Font collections represented by class are used in several scenarios. For example, in resources with property. The example demonstrates how to make all font declared on page as embedded. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // ensure all fonts declared on page resources are embedded // note that if fonts are declared on form resources they are not accessible from page resources foreach(Aspose.Pdf.Txt.Font font in doc.Pages[1].Resources.Fonts) { if(!font.IsEmbedded) font.IsEmbedded = true; } doc.Save(@"D:\Tests\input.pdf"); Gets the number of object elements actually contained in the collection. Gets an object that can be used to synchronize access to the collection. Gets a value indicating whether access to the collection is synchronized (thread safe). Gets a value indicating whether collection is read-only Returns an enumerator for the entire collection. Enumerator object. Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array Array of objects which will be copied. Starting index from which copying will be started. Adds new font to font resources and returns automatically assigned name of font resource. Font object. The automatically assigned resource item name. Gets the font element at the specified index. Index within the collection. Font object. Gets font from the collection by font name. Exception is thrown if font was not found. Name of the font. Found font. Checks if font exists in font collection. Font name. True in case collection contains the font with specified name. Determines whether the collection contains a specific value. The object to locate in the collection true if item is found in the collection; otherwise, false. Deletes specified item from collection. The object to delete true if item was deleted from collection; otherwise, false. Performs font search. Searches in system installed fonts and standard Pdf fonts. Also provides functionality to open custom fonts. The example demonstrates how to find font and replace the font of text of first page. // Find font Font font = FontRepository.FindFont("Arial"); // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change font of the first text occurrence absorber.TextFragments[1].TextState.Font = font; // Save document doc.Save(@"D:\Tests\output.pdf"); Gets font substitution strategies collection. Gets font sources collection. Searches and returns font with specified font name. The example demonstrates how to find font and replace the font of text of first page. // Find font Font font = FontRepository.FindFont("Arial"); // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change font of the first text occurrence absorber.TextFragments[1].TextState.Font = font; // Save document doc.Save(@"D:\Tests\output.pdf"); Font name. Font object. Searches and returns font with specified font name ignoring or honoring case sensitivity. The example demonstrates how to find font and replace the font of text of first page. // Find font Font font = FontRepository.FindFont("Arial"); // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change font of the first text occurrence absorber.TextFragments[1].TextState.Font = font; // Save document doc.Save(@"D:\Tests\output.pdf"); Font name. case sensitivity Font object. Searches and returns font with specified font name and font style. The example demonstrates how to find font and replace the font of text of first page. // Find font Font font = FontRepository.FindFont("Arial", FontStyle.Italic); // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change font of the first text occurence absorber.TextFragments[1].TextState.Font = font; // Save document doc.Save(@"D:\Tests\output.pdf"); Font family name. Font style value. Font object corresponding to search request parameters. Searches and returns font with specified font name and font style ignoring or honoring case sensitivity. The example demonstrates how to find font and replace the font of text of first page. // Find font Font font = FontRepository.FindFont("Arial", FontStyle.Italic); // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change font of the first text occurence absorber.TextFragments[1].TextState.Font = font; // Save document doc.Save(@"D:\Tests\output.pdf"); Font family name. Font style value. case sensitivity Font object corresponding to search request parameters. Opens font with specified font stream. The example demonstrates how to open font and replace the font of text of first page. // Open font using (FileStream fontStream = File.OpenRead(@"C:\WINDOWS\Fonts\arial.ttf")) { Font font = FontRepository.OpenFont(fontStream, , FontTypes.TTF); // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change font of the first text occurrence absorber.TextFragments[1].TextState.Font = font; // Save document doc.Save(@"D:\Tests\output.pdf"); } Font stream. Font type value. Font object. Opens font with specified font file path. The example demonstrates how to open font and replace the font of text of first page. // Open font Font font = FontRepository.OpenFont(@"C:\WINDOWS\Fonts\arial.ttf"); // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change font of the first text occurrence absorber.TextFragments[1].TextState.Font = font; // Save document doc.Save(@"D:\Tests\output.pdf"); Font file path. Font object. Opens font with specified font file path and metrics file path. The example demonstrates how to open Type1 font with metrics and replace the font of text of first page. // Open font Font font = FontRepository.OpenFont("courier.pfb", "courier.afm"); // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change font of the first text occurrence absorber.TextFragments[1].TextState.Font = font; // Save document doc.Save(@"D:\Tests\output.pdf"); Font file path. Font metrics file patrh. Font object. Loads system installed fonts and standard Pdf fonts. This method was designed to speed up font loading process. By default fonts are loaded on first request for any font. Use of this method loads system and standard Pdf fonts immediately before any Pdf document was open. Reloads all fonts specified by property Specifies style information applied to text. This enumeration has a attribute that allows a combination of its member values. Regular text. Bold text. Italic text. Represents a character info object. Provides character positioning information. Gets position of the character. Gets rectangle of the character. Represents an absorber object of a text. Performs text extraction and provides access to the result via object. The object is used to extract text from a Pdf document or the document's page. The example demonstrates how to extract text on the first PDF document page. // open document Document doc = new Document(inFile); // create TextAbsorber object to extract text TextAbsorber absorber = new TextAbsorber(); // accept the absorber for first page doc.Pages[1].Accept(absorber); // get the extracted text string extractedText = absorber.Text; Gets extracted text that the extracts on the PDF document or page. The example demonstrates how to extract text from all pages of the PDF document. // open document Document doc = new Document(inFile); // create TextAbsorber object to extract text TextAbsorber absorber = new TextAbsorber(); // accept the absorber for all document's pages doc.Pages.Accept(absorber); // get the extracted text string extractedText = absorber.Text; Value indicates whether errors were found during text extraction. Searching for errors will performed only if TextSearchOptions.LogTextExtractionErrors = true; And it may decrease performance. List of objects. It contain information about errors were found during text extraction. Searching for errors will performed only if TextSearchOptions.LogTextExtractionErrors = true; And it may decrease performance. Extracts text on the specified page The example demonstrates how to extract text on the first PDF document page. // open document Document doc = new Document(inFile); // create TextAbsorber object to extract text TextAbsorber absorber = new TextAbsorber(); // accept the absorber for all document's pages absorber.Visit(doc.Pages[1]); // get the extracted text string extractedText = absorber.Text; Pdf pocument page object. Extracts text on the specified XForm. The example demonstrates how to extract text on the first PDF document page. // open document Document doc = new Document(inFile); // create TextAbsorber object to extract text TextAbsorber absorber = new TextAbsorber(); // accept the absorber for all document's pages absorber.Visit(doc.Pages[1].Resources.Forms["Xform1"]); // get the extracted text string extractedText = absorber.Text; Pdf form object. Extracts text on the specified document The example demonstrates how to extract text on PDF document. // open document Document doc = new Document(inFile); // create TextAbsorber object to extract text TextAbsorber absorber = new TextAbsorber(); // accept the absorber for all document's pages absorber.Visit(doc); // get the extracted text string extractedText = absorber.Text; Pdf pocument object. Initializes a new instance of the . Performs text extraction and provides access to the extracted text via object. The example demonstrates how to extract text from all pages of the PDF document. // open document Document doc = new Document(inFile); // create TextAbsorber object to extract text TextAbsorber absorber = new TextAbsorber(); // accept the absorber for all document's pages doc.Pages.Accept(absorber); // get the extracted text string extractedText = absorber.Text; Gets or sets text extraction options. Allows to define text formatting mode during extraction. The default mode is The example demonstrates how to set Pure text formatting mode and perform text extraction. // open document Document doc = new Document(inFile); // create TextAbsorber object to extract text with formatting TextAbsorber absorber = new TextAbsorber(); // set pure text formatting mode absorber.ExtractionOptions = new TextExtractionOptions(TextExtractionOptions.TextFormattingMode.Pure); // accept the absorber for all document's pages doc.Pages.Accept(absorber); // get the extracted text string extractedText = absorber.Text; Gets or sets text search options. Allows to define rectangle which delimits the extracted text. By default the rectangle is empty. That means page boundaries only defines the text extraction region. Initializes a new instance of the with extraction options. Performs text extraction and provides access to the extracted text via object. The example demonstrates how to extract text from all pages of the PDF document. // open document Document doc = new Document(inFile); // create TextAbsorber object to extract text with formatting TextAbsorber absorber = new TextAbsorber(new TextExtractionOptions(TextExtractionOptions.TextFormattingMode.Pure)); // accept the absorber for all document's pages doc.Pages.Accept(absorber); // get the extracted text string extractedText = absorber.Text; Text extraction options Initializes a new instance of the with extraction and text search options. Performs text extraction and provides access to the extracted text via object. Text extraction options Text search options Initializes a new instance of the with text search options. Performs text extraction and provides access to the extracted text via object. Text search options Appends text object to Pdf page. Initializes a new instance of class for the Pdf page. The TextBuilder allows to append text objects to Pdf pages. Page object. Initializes a new instance of class for the Pdf page. The TextBuilder allows to append text objects to Pdf pages. Page object. Operator collection. Appends text paragraph to Pdf page. The example demonstrates how to create text paragraph object and append it to the Pdf page. Document doc = new Document(inFile); Page page = (Page)doc.Pages[1]; // create text paragraph TextParagraph paragraph = new TextParagraph(); // set the paragraph rectangle paragraph.Rectangle = new Rectangle(100, 600, 200, 700); // set word wrapping options paragraph.FormattingOptions.WrapMode = TextFormattingOptions.WordWrapMode.ByWords; // append string lines paragraph.AppendLine("the quick brown fox jumps over the lazy dog"); paragraph.AppendLine("line2"); paragraph.AppendLine("line3"); // append the paragraph to the Pdf page with the TextBuilder TextBuilder textBuilder = new TextBuilder(page); textBuilder.AppendParagraph(paragraph); // save Pdf document doc.Save(outFile); Text paragraph object. Appends text fragment to Pdf page The example demonstrates how to create text fragment object, customize it's text segments and append it to the Pdf page. Document doc = new Document(inFile); Page page = (Page)doc.Pages[1]; // create text fragment TextFragment tf = new TextFragment("main text"); tf.Position = new Position(100, 600); // set it's text properties tf.TextState.FontSize = 5; tf.TextState.Font = FontRepository.FindFont("TimesNewRoman"); tf.TextState.BackgroundColor = Color.LightGray; tf.TextState.ForegroundColor = Color.Red; // add one more segment to text fragment's Segments collection TextSegment segment2 = new TextSegment(); segment2.Text = "another segment"; tf.Segments.Add(segment2); // create TextBuilder object TextBuilder builder = new TextBuilder(page); // append the text fragment to the Pdf page builder.AppendText(tf); //save document doc.Save(outFile); Text fragment object. Represents fragment of Pdf text. In a few words, object contains list of objects. In details: Text of pdf document in is represented by two basic objects: and The differences between them is mostly context-dependent. Let's consider following scenario. User searches text "hello world" to operate with it, change it's properties, look etc. Document doc = new Document(docFile); TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); doc.Pages[1].Accept(absorber); Phisycally pdf text's representation is very complex. The text "hello world" may consist of several phisycally independent text segments. The Aspose.Pdf text model basically establishes that object provides single logic operation set over physical objects set that represent user's query. In text search scenario, is logical "hello world" text representation, and object collection represents all physical segments that construct "hello world" text object. So, is close to logical text representation. And is close to physical text representation. Obviously each object may have it's own font, coloring, positioning properties. provides simple way to change text with it's properties: set font, set font size, set font color etc. Meanwhile objects are accessible and users are able to operate with objects independently. Note that changing TextFragment properties may change inner collection because TextFragment is an aggregate object and it may rearrange internal segments or merge them into single segment. If your requirement is to leave the collection unchanged, please change inner segments individually. The example demonstrates how to find text on the first PDF document page and replace the text and it's font. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Find font that will be used to change document text font Aspose.Pdf.Txt.Font font = FontRepository.FindFont("Arial"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change text and font of the first text occurrence absorber.TextFragments[1].Text = "hi world"; absorber.TextFragments[1].TextState.Font = font; // Save document doc.Save(@"D:\Tests\output.pdf"); Gets text replace options. The options define behavior when fragment text is replaced to more short/long. Gets or sets text object that the object represents. The example demonstrates how to search a text and replace first occurrence represented with object . // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change font of the first text occurrence absorber.TextFragments[1].Text = "hi world"; // Save document doc.Save(@"D:\Tests\output.pdf"); Gets or sets a vertical alignment of text fragment. Gets or sets a horizontal alignment of text fragment. Sets the fragment hyperlink Gets or sets text state for the text that object represents. Provides a way to change following properties of the text: Font FontSize FontStyle ForegroundColor BackgroundColor The example demonstrates how to change text color and font size of the text with object. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change foreground color of the first text occurrence absorber.TextFragments[1].TextState.ForegroundColor = Color.FromRgb(System.Drawing.Color.Red); // Change font size of the first text occurrence absorber.TextFragments[1].TextState.FontSize = 15; // Save document doc.Save(@"D:\Tests\output.pdf"); Gets text segments for current . In a few words, objects are children of object. Advanced users may access segments directly to perform more complex text edit scenarios. For details, please look at object description. The example demonstrates how to navigate all objects inside . // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Navigate all text segments and out their text and placement info foreach (TextSegment segment in absorber.TextFragments[1].Segments) { Console.Out.WriteLine(string.Format("segment text: {0}", segment.Text)); Console.Out.WriteLine(string.Format("segment X indent: {0}", segment.Position.XIndent)); Console.Out.WriteLine(string.Format("segment Y indent: {0}", segment.Position.YIndent)); } Gets or sets text position for text, represented with object. The example demonstrates how to view placement of a text, represented by object. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // View text and placement info of first text occurrence TextFragment firstOccurrence = absorber.TextFragments[1]; Console.Out.WriteLine(string.Format("fragment text: {0}", firstOccurrence.Text)); Console.Out.WriteLine(string.Format("fragment X indent: {0}", firstOccurrence.Position.XIndent)); Console.Out.WriteLine(string.Format("fragment Y indent: {0}", firstOccurrence.Position.YIndent)); Gets text position for text, represented with object. The YIndent of the Position structure represents baseline coordinate of the text fragment. Gets rectangle of the TextFragment Gets page that contains the TextFragment The value can be null in case the TextFragment object doesn't belong to any page. Gets form object that contains the TextFragment The value can be null in case the TextFragment object doesn't belong to a form. Gets or sets wrap lines count for this paragraph(for pdf generation only) Gets or sets the paragraph end note.(for pdf generation only) Gets or sets the paragraph foot note.(for pdf generation only) Initializes new instance of the object. Initializes new instance of the object with predefined positions. Tabulation positions Creates object with single object inside. Specifies text string inside the segment. Text fragment's text. Creates object with single object inside and predefined positions. Text fragment's text. Tabulation positions Gets (s) representing specified part of the text. Position in text from which new (s) will start. Length of the text that will isolated into (s). containing text segments represeting text substring starting at a specifing position and having a specified length. Clone the fragment. The cloned object Clone the fragment with all segments. The cloned object Represents an absorber object of text fragments. Performs text search and provides access to search results via collection. The object is basically used in text search scenario. When the search is completed the occurrences are represented with objects that the collection contains. The object provides access to the search occurrence text, text properties, and allows to edit text and change the text state (font, font size, color etc). The example demonstrates how to find text on the first PDF document page and replace the text and it's font. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Find font that will be used to change document text font Aspose.Pdf.Txt.Font font = FontRepository.FindFont("Arial"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change text and font of the first text occurrence absorber.TextFragments[1].Text = "hi world"; absorber.TextFragments[1].TextState.Font = font; // Save document doc.Save(@"D:\Tests\output.pdf"); Gets collection of search occurrences that are presented with objects. The example demonstrates how to find text on the first PDF document page and replace all search occurrences with new text. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Find font that will be used to change document text font Aspose.Pdf.Txt.Font font = FontRepository.FindFont("Arial"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change text of all search occurrences foreach (TextFragment textFragment in absorber.TextFragments) { textFragment.Text = "hi world"; } // Save document doc.Save(@"D:\Tests\output.pdf"); Gets or sets phrase that the searches on the PDF document or page. The example demonstrates how to perform search text several times and perform text replacements. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello"); doc.Pages[1].Accept(absorber); absorber.TextFragments[1].Text = "Hi"; // search another word and replace it absorber.Phrase = "world"; doc.Pages[1].Accept(absorber); absorber.TextFragments[1].Text = "John"; // Save document doc.Save(@"D:\Tests\output.pdf"); Gets or sets search options. The options enable search using regular expressions. The example demonstrates how to perform search text using regular expression. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object TextFragmentAbsorber absorber = new TextFragmentAbsorber(); // make the absorber to search all words starting 'h' and ending 'o' using regular expression. absorber.Phrase = @"h\w*?o"; absorber.TextSearchOptions = new TextSearchOptions(true); // we should find "hello" word and replace it with "Hi" doc.Pages[1].Accept(absorber); absorber.TextFragments[1].Text = "Hi"; // Save document doc.Save(@"D:\Tests\output.pdf"); Gets or sets text edit options. The options define special behavior when requested symbol cannot be written with font. Gets or sets text replace options. The options define behavior when fragment text is replaced to more short/long. Value indicates whether errors were found during text extraction. Searching for errors will performed only if TextSearchOptions.LogTextExtractionErrors = true; And it may decrease performance. List of objects. It contain information about errors were found during text extraction. Searching for errors will performed only if TextSearchOptions.LogTextExtractionErrors = true; And it may decrease performance. Gets extracted text that the extracts on the PDF document or page. Initializes a new instance of the that performs search of all text segments of the document or page. Performs text search and provides access to search results via collection. The example demonstrates how to find text on the first PDF document page and replace the text. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Find font that will be used to change document text font Aspose.Pdf.Txt.Font font = FontRepository.FindFont("Arial"); // Create TextFragmentAbsorber object TextFragmentAbsorber absorber = new TextFragmentAbsorber(); // Make the absorber to search all "hello world" text occurrences absorber.Phrase = "hello world"; // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change text of the first text occurrence absorber.TextFragments[1].Text = "hi world"; // Save document doc.Save(@"D:\Tests\output.pdf"); Initializes a new instance of the with text edit options, that performs search of all text segments of the document or page. Performs text search and provides access to search results via collection. The example demonstrates how to find all text fragments on the first PDF document page and replace font for them. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object TextFragmentAbsorber absorber = new TextFragmentAbsorber(new TextEditOptions(TextEditOptions.FontReplace.RemoveUnusedFonts)); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Find Courier font Pdf.Text.Font font = FontRepository.FindFont("Courier"); // Set the font for all the text fragments foreach (TextFragment textFragment in absorber.TextFragments) { textFragment.TextState.Font = font; } // Save document doc.Save(@"D:\Tests\output.pdf"); Text edit options (Allows to turn on some edit features). Initializes a new instance of the class for the specified text phrase. Performs text search of the specified phrase and provides access to search results via collection. The example demonstrates how to find text on the first PDF document page and replace the text and it's font. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Find font that will be used to change document text font Aspose.Pdf.Txt.Font font = FontRepository.FindFont("Arial"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change text and font of the first text occurrence absorber.TextFragments[1].Text = "hi world"; absorber.TextFragments[1].TextState.Font = font; // Save document doc.Save(@"D:\Tests\output.pdf"); Phrase that the searches Initializes a new instance of the class for the specified System.Text.RegularExpressions.Regex class object. Performs text search of the specified phrase and provides access to search results via collection. The example demonstrates how to find text on the first PDF document page and replace the text and it's font. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Find font that will be used to change document text font Aspose.Pdf.Txt.Font font = FontRepository.FindFont("Arial"); // Create TextAbsorber object to find all instances of the input regex TextFragmentAbsorber absorber = new TextFragmentAbsorber(new System.Text.RegularExpressions.Regex(@"h\w*?o")); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // we should find "hello" word and replace it with "Hi" doc.Pages[1].Accept(absorber); absorber.TextFragments[1].Text = "Hi"; // Save document doc.Save(@"D:\Tests\output.pdf"); System.Text.RegularExpressions.Regex class object that the searches Initializes a new instance of the class for the specified text phrase and text search options. Performs text search of the specified phrase and provides access to search results via collection. The example demonstrates how to find text with regular expression on the first PDF document page and replace the text. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object that searches all words starting 'h' and ending 'o' using regular expression. TextFragmentAbsorber absorber = new TextFragmentAbsorber(@"h\w*?o", new TextSearchOptions(true)); // we should find "hello" word and replace it with "Hi" doc.Pages[1].Accept(absorber); absorber.TextFragments[1].Text = "Hi"; // Save document doc.Save(@"D:\Tests\output.pdf"); Phrase that the searches Text search options (Allows to turn on some search features. For example, search with regular expression) Initializes a new instance of the class for the specified text phrase and text search options. Performs text search of the specified phrase and provides access to search results via collection. The example demonstrates how to find text with regular expression on the first PDF document page and replace the text. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object that searches all words starting 'h' and ending 'o' using regular expression. TextFragmentAbsorber absorber = new TextFragmentAbsorber(new System.Text.RegularExpressions.Regex(@"h\w*?o"), new TextSearchOptions(true)); // we should find "hello" word and replace it with "Hi" doc.Pages[1].Accept(absorber); absorber.TextFragments[1].Text = "Hi"; // Save document doc.Save(@"D:\Tests\output.pdf"); System.Text.RegularExpressions.Regex class object that the searches Text search options (Allows to turn on some search features.) Initializes a new instance of the class for the specified text phrase, text search options and text edit options. Performs text search of the specified phrase and provides access to search results via collection. The example demonstrates how to find text with regular expression on the first PDF document page and replace the text. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object that searches all words starting 'h' and ending 'o' using regular expression. TextFragmentAbsorber absorber = new TextFragmentAbsorber(@"h\w*?o", new TextSearchOptions(true)); // we should find "hello" word and replace it with "Hi" doc.Pages[1].Accept(absorber); absorber.TextFragments[1].Text = "Hi"; // Save document doc.Save(@"D:\Tests\output.pdf"); Phrase that the searches Text search options (Allows to turn on some search features. For example, search with regular expression) Text edit options (Allows to turn on some edit features). Initializes a new instance of the class for the specified text phrase and text edit options. Performs text search of the specified phrase and provides access to search results via collection. Phrase that the searches Text edit options (Allows to turn on some edit features). Initializes a new instance of the class for the specified text phrase and text edit options. Performs text search of the specified phrase and provides access to search results via collection. System.Text.RegularExpressions.Regex class object that the searches Text edit options (Allows to turn on some edit features). Performs search on the specified page. The example demonstrates how to find text on the first PDF document page and replace the text. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Find font that will be used to change document text font Aspose.Pdf.Txt.Font font = FontRepository.FindFont("Arial"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page absorber.Visit(doc.Pages[1]); // Change text of all search occurrences foreach (TextFragment textFragment in absorber.TextFragments) { textFragment.Text = "hi world"; } // Save document doc.Save(@"D:\Tests\output.pdf"); PDF document page object. Performs search on the specified document. The example demonstrates how to find text on PDF document and replace text of all search occurrences. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Find font that will be used to change document text font Aspose.Pdf.Txt.Font font = FontRepository.FindFont("Arial"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page absorber.Visit(doc); // Change text of the first text occurrence absorber.TextFragments[1].Text = "hi world"; // Save document doc.Save(@"D:\Tests\output.pdf"); PDF document object. Applies font for all text fragments that were absorbed. It works faster than looping through the fragments if all fragments on the page(s) were absorbed. Otherwise it works similar with looping. of the text. Applies font size for all text fragments that were absorbed. It works faster than looping through the fragments if all fragments on the page(s) were absorbed. Otherwise it works similar with looping. Font size of the text. Applies font and size for all text fragments that were absorbed. It works faster than looping through the fragments if all fragments on the page(s) were absorbed. Otherwise it works similar with looping. of the text. Font size of the text. Clears TextFragments collection of this object. Removes all text from the specified page. PDF document page object. Removes text inside the specified rectangle from the specified page. PDF document page object. to remove text inside. Removes all text from the document. PDF document object. Performs search on the specified form object. Pdf form object. Gets or sets text extraction options. Represents a text fragments collection Gets the number of object elements actually contained in the collection. Gets an object that can be used to synchronize access to the collection. Gets a value indicating whether access to the collection is synchronized (thread safe). Gets a value indicating whether collection is read-only Adds the text fragment element at the specified index. Returns an enumerator for the entire collection. Enumerator object. Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array Array of objects which will be copied. Starting index from which copying will be started. Clears all items from the collection. Determines whether the collection contains a specific value. The object to locate in the collection true if item is found in the collection; otherwise, false. Deletes specified item from collection. The object to delete true if item was deleted from collection; otherwise, false. Gets the text fragment element at the specified index. Index within the collection. TextFragment object. Represents a text state of a text fragment. Provides a way to change following properties of the text: font ( property) font size ( property) font style ( property) foreground color ( property) background color ( property) Note that changing properties may change inner collection because TextFragment is an aggregate object and it may rearrange internal segments or merge them into single segment. If your requirement is to leave the collection unchanged, please change inner segments individually. The example demonstrates how to change text color and font size of the text with object. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change foreground color of the first text occurrence absorber.TextFragments[1].TextState.ForegroundColor = Color.FromRgb(System.Drawing.Color.Red); // Change font size of the first text occurrence absorber.TextFragments[1].TextState.FontSize = 15; // Save document doc.Save(@"D:\Tests\output.pdf"); Gets or sets character spacing of the text, represented by the object. Gets or sets horizontal scaling of the text, represented by the object. Gets or sets word spacing of the text. Gets or sets invisibility of the text. Gets or sets rendering mode of the text. Gets or sets subscript of the text, represented by the object. Gets or sets superscript of the text, represented by the object. Gets tabstops for the text. Note that Tabstops property works in new document generation scenarios only. Tabstops may be added during initialization. Tabstops must be constructed before the text. Gets or sets line spacing of the text. Note that the value is not preserved as a text characteristic within the document. The LineSpacing property getter works for an object in case it was explicitly set previously with LineSpacing setter for those object. The property is used by runtime in context of current generation/modification process. Gets or sets foreground color of the text, represented by the object Gets or sets color stroking operations of rendering (stroke text, rectangle border) Sets background color of the text, represented by the object Gets or sets underline for the text, represented by the object Sets strikeout for the text, represented by the object Sets font style of the text, represented by the object Gets or sets font of the text, represented by the object Gets or sets font size of the text, represented by the object Gets or sets horizontal alignment for the text. HorizontalAlignment.None is equal to HorizontalAlignment.Left. Note that TextFragmentState.VerticalAlignment property works in new document generation scenarios only. Gets or sets formatting options. Setting of the options will be effective in generator scenarios only. Gets or sets rotation angle in degrees. Measures the string. The string. Initializes new instance of the object with specified object. This initialization is not supported. TextFragmentState is only available with property. Text fragment object. Applies settings from another textState. Only those properties will be copied that were changed explicitly. Text state object. Descubes options of text edit operations. Initializes new instance of the object for the specified no-character behavior mode. No-character behavior mode object. Initializes new instance of the object for the specified font replacement behavior mode. Font replace behavior object. Initializes new instance of the object for the specified language transformation permission. Allows language transformation if set to true. Initializes new instance of the object for the specified language transformation behavior mode. language transformation behavior object. Action to perform if font does not contain required character Throw exception Repalce font to standard font which contains required character Replace text anyway without font substitution Repalce font to defined replacement font Gets or sets font used for replacing if user font does not contain required character Gets or sets mode that defines behavior in case fonts don't contain requested characters. Gets mode that defines behavior for fonts replacement scenarios. Font replacement behavior. No additional changes performed during font replacement. Fonts that become unused during font replacement will be removed from resulting document. Gets or sets value that permits usage of language transformation during adding or editing of text. true - language transformation will be applied if necessary (default value). false - language transformation will NOT be applied. Gets mode that defines behavior for language transformation scenarios. Language transformation modes Default language transformation is performed. Language transformation is performed the same way as in a text editor. It usually means text will looks in the document exactly as You see it in code. But no warranties. Language transformation is not performed. Gets mode for processing clipping path of the edited text. Clipping path processing modes Keeps clipping paths of the original page layout. (Default) Original clipping path will be expanded in the case edited text requires more space. Original clipping path will be removed in the case edited text requires more space. Caution: Because of clipping paths may interact with each other removing of it may lead to unexpected result on the page layout. Gets or sets value that permits searching for text underlining on the page of source document. (Obsolete) Please use TextSearchOptions.SearchForTextRelatedGraphics instead this. Represents text extraction options Initializes new instance of the object for the specified text formatting mode. Text formatting mode value. Defines different modes which can be used while converting pdf document into text. See class. Represent pdf content with a bit of formatting routines. Represent pdf content as is, i.e. without formatting. Extraction with memory saving. It is almost same to 'Raw' mode but works slightly faster and uses less memory. Gets formatting mode. Gets or sets factor that will be applied to scale font size during extraction in pure mode. Setting of less value leads to more spaces in the extracted text. Default value is 1 - no scaling; Setting value to zero allows algorithm choose scaling automatically. Represents text processing options Represents text replace options Scope where replace text operation is applied REPLACE_FIRST by default This obsolete option was kept for compatibility. It affects to PdfContentEditor and has no effect to TextFragmentAbsorber. Replace only first occurrence of the text on each of affected pages Replace all text occurrences on all affected pages Gets or sets a scope where replace text operation is applied Determines action that will be done after replace of text fragment to more short. None - no action, replaced text may overlaps rest of the line; AdjustSpaceWidth - tries adjust spaces between words to keep line length; WholeWordsHyphenation - tries distribute words between paragraph lines to keep paragraph's right field; ShiftRestOfLine - shifts rest of the line according to changing length of text, length of the line may be changed; Default value is ShiftRestOfLine. No action, replaced text may overlaps rest of the line Tries adjust spaces between words to keep line length Tries distribute words between paragraph lines to keep paragraph's right field (Default) Shifts rest of the line according to changing length of text, length of the line may be changed Gets or sets an action that will be done after replace of text fragment to more short. Gets or sets value of line spacing that used if replace adjustment is forced to create new line of text. The value expected is multiplier of font size of the replaced text. Default is 1.2. Initializes new instance of the object for the specified scope. Scope object. Initializes new instance of the object for the specified after replace action. ReplaceAdjustment object. Represents text search options Gets or sets indication that regular expression is used. Gets or sets indication that text is searched within the page bounds. Gets or sets rectangle that bounds the searched text. The property may be used in case it is required to delimit text extraction or text replace region. Gets or sets indication that text will be searched using font engine encoding. true - means that font engine encoding will be used (try this if text search fails because of imperfect encoding in the document) false - means that document font encoding will be used (default value) Gets or sets indication that text fragments representing shadow of normal text will be ignored during search. true - means that shadow text will not be found (try this if text search returns duplicated fragments on the close positions) false - means that shadow text will be found as well as normal text (default value) Gets or sets indication that text extraction (decoding) errors will be logged in the text (fragment) absorber. true - means that text extraction (decoding) errors will be loged. It may decrease performance. false (default) - no error loging. Gets or sets indication that errors related to absence of font will be ignored by text (fragment) absorber. true - means that errors of absence of font will be ignored. Text segments that refer to incorrect resources will be skipped during processing. false (default) - absence of font error will terminate processing by throwing exception. Gets or sets value that permits searching for text related graphics (underlining, background etc.) during text search. false - graphic elements that may present in source document will be ignored (default value). true - searching for text related graphics will be performed. It may decrease performance of text search and edit. It also may change graphical elements that look like text related. Initializes new instance of the object. Specifies regular expression usage mode. Value that indicates that regularexpression is used. Initializes new instance of the object. Specifies rectangle that delimits the searched text. Rectangle that includes the extracted text. Initializes new instance of the object. Specifies rectangle that delimits the searched text and regular expression usage mode. Rectangle that includes the extracted text. Value that indicates that regularexpression is used. Represents segment of Pdf text. In a few words, objects are children of object. In details: Text of pdf document in is represented by two basic objects: and The differences between them is mostly context-dependent. Let's consider following scenario. User searches text "hello world" to operate with it, change it's properties, look etc. Document doc = new Document(docFile); TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); doc.Pages[1].Accept(absorber); Phisycally pdf text's representation is very complex. The text "hello world" may consist of several phisycally independent text segments. The Aspose.Pdf text model basically establishes that object provides single logic operation set over physical objects set that represent user's query. In text search scenario, is logical "hello world" text representation, and object collection represents all physical segments that construct "hello world" text object. So, is close to logical text representation. And is close to physical text representation. Obviously each object may have it's own font, coloring, positioning properties. provides simple way to change text with it's properties: set font, set font size, set font color etc. Meanwhile objects are accessible and users are able to operate with objects independently. The example demonstrates how to change text color and font size of the text with object of object. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create TextFragmentAbsorber object to find all "hello world" text occurrences TextFragmentAbsorber absorber = new TextFragmentAbsorber("hello world"); // Accept the absorber for first page doc.Pages[1].Accept(absorber); // Change foreground color of the first text segment of the first text occurrence absorber.TextFragments[1].Segments[1].TextState.ForegroundColor = Color.FromRgb(System.Drawing.Color.Red); // Change font size of the first text segment of the first text occurrence absorber.TextFragments[1].Segments[1].TextState.FontSize = 15; // Save document doc.Save(@"D:\Tests\output.pdf"); Gets starting character index of current segment in the show text operator (Tj, TJ) segment. Gets ending character index of current segment in the show text operator (Tj, TJ) segment. Gets or sets text object that the object represents. Gets or sets text state for the text that object represents. Provides a way to change following properties of the text: Font FontSize FontStyle ForegroundColor BackgroundColor Gets text position for text, represented with object. Gets rectangle of the TextSegment Gets text position for text, represented with object. The YIndent of the Position structure represents baseline coordinate of the text segment. Gets or sets text edit options. The options define special behavior when requested symbol cannot be written with font. Gets collection of CharInfo objects that represent information on characters in the text segment. Gets or sets the segment hyperlink(for pdf generator). Creates TextSegment object. The example demonstrates how to create text fragment object, add a text segment to the text fragment collection and append it to the Pdf page. Document doc = new Document(inFile); Page page = (Page)doc.Pages[1]; // create text fragment TextFragment tf = new TextFragment("main text"); tf.Position = new Position(100, 600); // set it's text properties tf.TextState.FontSize = 5; tf.TextState.Font = FontRepository.FindFont("TimesNewRoman"); tf.TextState.BackgroundColor = Color.LightGray; tf.TextState.ForegroundColor = Color.Red; // add one more segment to text fragment's Segments collection TextSegment segment2 = new TextSegment(); segment2.Text = "another segment"; tf.Segments.Add(segment2); // create TextBuilder object TextBuilder builder = new TextBuilder(page); // append the text fragment to the Pdf page builder.AppendText(tf); //save document doc.Save(outFile); Creates TextSegment object. The example demonstrates how to create text fragment object, add a text segment to the text fragment collection and append it to the Pdf page. Document doc = new Document(inFile); Page page = (Page)doc.Pages[1]; // create text fragment TextFragment tf = new TextFragment("main text"); tf.Position = new Position(100, 600); // set it's text properties tf.TextState.FontSize = 5; tf.TextState.Font = FontRepository.FindFont("TimesNewRoman"); tf.TextState.BackgroundColor = Color.LightGray; tf.TextState.ForegroundColor = Color.Red; // add one more segment to text fragment's Segments collection TextSegment segment2 = new TextSegment("another segment"); tf.Segments.Add(segment2); // create TextBuilder object TextBuilder builder = new TextBuilder(page); // append the text fragment to the Pdf page builder.AppendText(tf); //save document doc.Save(outFile); Text segment's text. Represents a text segments collection Gets the number of object elements actually contained in the collection. Gets an object that can be used to synchronize access to the collection. Gets a value indicating whether access to the collection is synchronized (thread safe). Gets a value indicating whether collection is read-only Adds the text segment element at the specified index. Text segment object Returns an enumerator for the entire collection. Enumerator object. Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array Array of objects which will be copied. Starting index from which copying will be started. Gets the text segment element at the specified index. Index within the collection. TextSegment object. Clears all items from the collection. Determines whether the collection contains a specific value. The object to locate in the collection true if item is found in the collection; otherwise, false. Deletes specified item from collection. The object to delete true if item was deleted from collection; otherwise, false. Represents a text state of a text You can place this tag in text to declare tabulation. It has effect only in couple with . Default value of tabulation in widths of space character of default font. Applies settings from another textState. Only those properties will be copied that were changed explicitly. Text state object. Gets or sets character spacing of the text. Gets or sets line spacing of the text. Note that the value is not preserved as a text characteristic within the document. The LineSpacing property getter works for an object in case it was explicitly set previously with LineSpacing setter for those object. The property is used by runtime in context of current generation/modification process. Gets or sets horizontal scaling of the text. Gets or sets subscript of the text. Gets or sets superscript of the text. Gets or sets word spacing of the text. Gets or sets invisibility of the text. Obsolete. Please use RenderingMode instead. Gets or sets rendering mode of text. Gets or sets font size of the text. Gets or sets font of the text. Gets or sets foreground color of the text. Gets or sets foreground color of the text. Gets or sets underline for the text, represented by the object Sets strikeout for the text, represented by the object Sets background color of the text. Note that the value is not preserved as a text characteristic within the document. The BackgroundColor property getter works for an object in case it was explicitly set previously with BackgroundColor setter for those object. The property is used by runtime in context of current generation/modification process. Sets font style of the text. Gets or sets horizontal alignment for the text. HorizontalAlignment.None is equal to HorizontalAlignment.Left. Note that TextState.HorizontalAlignment property works in new document generation scenarios only. Creates text state object. Measures the string. The string. Width of the string represented with this text state. Creates text state object with font size specification. Font size. Creates text state object with foreground color specification. Foreground color. Creates text state object with foreground color and font size specification. Foreground color. Font size. Creates text state object with font family specification. Font family. Creates text state object with font family and font style specification. Font family. Bold font style. Italic font style. Creates text state object with font family and font size specification. Font family. Font size. enumerates strategies for font subsetting Declares to subset only fonts which are embedded in document already Declares to subsets all the fonts, non-embedded and embedded both Represents XMP value Constructor for string value. String value. Consructor for integer value. Integer value. Constructor for floating point Value. Double value. Constructor for date time value. Date time value. Constructor for array value. Array value. Returns true if value is string. Returns true if value is integer. Returns true if value is floating point value. Returns true if value is DateTime. Returns true if XmpValue is field. Returns true if XmpValue is named value. Returns true is XmpValue represents named values. Returns true is XmpValue represents structure. Returns true is XmpValue is array. Converts to string. Converts to integer. Converts to double. Converts to date time. Returns array. Returns XMP value as structure (set of fields). Returns XMP value as XMP field. Returns XMP value as named value. Returns XMP value as named value collection. Returs string representation of XmpValue. Returns string representation. Convers string to XmpValue. Converts integer into XmpValue. Converts double into XmpValue. Converts DateTime into XmpValue. Converts array to XmpValue. Converts XmpValue to array. Converts XmpValue into array. Converts XmpValue into string. Converts XmpValue to named value. Class which allows to create/load documents of different types. Create document. Input stream. Document load options. Created document. Create empty document. Created document. Load document from a stream. Input stream. Created document. Load password protected document from a stream. Source stream. Passowrd for access to document. Created document. Load document from a file. Name of PDF file. Created document. Represents encrypted payload in file specification. Gets type. Gets subtype. Gets version number. Initialize Encrypted payload instance. The file specification used for initialization. Class represents transformation matrix. A member of the transformation matrix. B member of the transformation matrix. C member of the transformation matrix. D member of the transformation matrix. E member of the transformation matrix. F member of the transformation matrix. G member of the transformation matrix. H member of the transformation matrix. I member of the transformation matrix. Tx member of the transformation matrix. Ty member of the transformation matrix. Tz member of the transformation matrix. Constructor creates stanrard 1 to 1 matrix: [ A B C D E F G H I Tx Ty Tz] = [ 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0 , 0] Matrix3D m = new Matrix3D(); Constructor accepts a matrix with following array representation: [ A B C D E F G H I Tx Ty Tz] Matrix data array. double[] c = new double[] { 1, 0, 0, 1, 10, 20, 1, 0, 0, 17, 40, 13 }; Matrix3D m = new Matrix3D(c); Constructor accepts a matrix to create a copy Matrix3D object. Returns text reporesentation of the matrix. String representation for the matrix Compares matrix agains other object. Object to compare. Returns true is other object is Matrix3D and all matrix members are equal to corresponding members of the matrix Transaltes rotation into angle (degrees) Rotation value. double angle = Matrix.GetAngle(Rotation.on90); Matrix m = Matrix.Rotation(angle); Angle value. Adds matrix to other matrix. Matrix to be added. Result of matrix add. Initializes transformation matrix with specified coefficients. A matrix value. B matrix value. C matrix value. D matrix value. E matrix value. F matrix value. Matrix m = new Matrix(1, 0, 0, 1, 3, 3); Hash-code for object. Hash-code. Exception which thrown when requirested value does not exists. Initializes a new instance of the class. Constructor. Exception message. The exception that is thrown when an attempt to embed font became failed Initializes a new instance of the class. The message. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The error message that explains the reason for the exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. The exception that is thrown when font usage is incorrect. Initializes a new instance of the class. The message. Exception which thrown when requested value has incorrect format. Initializes a new instance of the class. Constructor. Exception message. Represents modes for merging images. Images merged vertically. Images merged horizontally. Images aligned by center. Represents an object that contains current printing page info. Gets currently printed page number; Represents the method that handles the QueryPageSettings event of a PrintDocument. The source of the event. A QueryPageSettingsEventArgs that contains the event data. Currently printed page info. Represents algorithms which can be used to encrypt pdf document. RC4 algorithm. AES algorithm. Class contains possibly alignment types. Constructor of AlignmentType. Alignment type name. Center alignment. Left alignment. Right alignment. Returns string representation. Name value. Represents a class to receive data from database or other datasource, fills them into the designed fields of the template pdf and at last generates new pdf file or stream. It has two template file input modes:input as a stream or a pdf file. It has four types of output modes:one merged stream, one merged file, many small streams, many small files. It can recieve literal data contained in a System.Data.DataTable. [C#] //Note: mail.pdf is a template pdf which has seven text fields. NorthWind.mdb is the microsoft access db. ////Common part: Get the data from the database NorthWind.mdb fill it into the DataTable. OleDbCommand mQueryCommand; OleDbDataAdapter mDbDataAdapter; OleDbConnection mDbConnection; //Construct the data table. DataTable mDataTable = new DataTable("MailMerge"); DataColumnCollection columns = mDataTable.Columns; columns.Add("CompanyName",typeof(string)); columns.Add("ContactName",typeof(string)); columns.Add("Address",typeof(string)); columns.Add("PostalCode",typeof(string)); columns.Add("City",typeof(string)); columns.Add("Country",typeof(string)); columns.Add("Heading",typeof(string)); //Connect to the database source and query the data. mDbConnection = new OleDbConnection(); mDbConnection.ConnectionString = "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + DbPath + "NorthWind.mdb"; mQueryCommand = new OleDbCommand(); mQueryCommand.Connection = mDbConnection; mDbConnection.Open(); mQueryCommand.CommandText = "select CompanyName, ContactName, Address, PostalCode, City, Country from Customers;"; mDbDataAdapter = new OleDbDataAdapter(mQueryCommand); mDbDataAdapter.Fill(mDataTable); for (int i = 0; i<mDataTable.Rows.Count;i++) { mDataTable.Rows[i][mDataTable.Columns.Count - 1] = "Dear " + mDataTable.Rows[i][0].ToString() + ","; System.Console.WriteLine("postalCode:" + mDataTable.Rows[i][3].ToString()); System.Console.WriteLine("Heading:" + mDataTable.Rows[i][mDataTable.Columns.Count - 1].ToString()); } mDbDataAdapter.Dispose(); mDbConnection.Close(); ////End of Common part. ////case one: ////Input template pdf is a pdf file and output is a big merged stream. AutoFiller autoFiller = new AutoFiller(); autoFiller.InputFileName = "mail.pdf"; autoFiller.OutputStream = Response.OutputStream; autoFiller.ImportDataTable(mDataTable); autoFiller.Save(); ////case two: ////Input template pdf is a pdf file and output is a lot of small files. AutoFiller autoFiller = new AutoFiller(); autoFiller.InputFileName = "mail.pdf"; autoFiller.GeneratingPath = ".\\"; autoFiller.BasicFileName = "outputFile"; autoFiller.ImportDataTable(mDataTable); autoFiller.Save(); [Visual Basic] 'Note: mail.pdf is a template pdf which has seven text fields. NorthWind.mdb is the microsoft access db. 'Common part: Get the data from the database NorthWind.mdb fill it into the DataTable. mQueryCommand As OleDbCommand = Nothing mDbDataAdapter As OleDbDataAdapter = Nothing mDbConnection As OleDbConnection = Nothing mDataTable As DataTable = Nothing mPath As String = Nothing mTemplatePdf As String = Nothing 'Construct the data table. mDataTable = New DataTable("MailMerge") Dim columns As DataColumnCollection = mDataTable.Columns 'Create columns for the datatable. 'Every column's name should be the same as one field's name of the templatePdf. columns.Add("CompanyName", Type.GetType("System.String")) columns.Add("ContactName", Type.GetType("System.String")) columns.Add("Address", Type.GetType("System.String")) columns.Add("PostalCode", Type.GetType("System.String")) columns.Add("City", Type.GetType("System.String")) columns.Add("Country", Type.GetType("System.String")) columns.Add("Heading", Type.GetType("System.String")) 'Connect to the database source and query the data. mDbConnection = New OleDbConnection mDbConnection.ConnectionString = "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + DbPath + "NorthWind.mdb" mQueryCommand = New OleDbCommand mQueryCommand.Connection = mDbConnection mDbConnection.Open() 'Query the data and insert into the datatable. mQueryCommand.CommandText = "select CompanyName, ContactName, Address, PostalCode, City, Country from Customers;" mDbDataAdapter = New OleDbDataAdapter(mQueryCommand) mDbDataAdapter.Fill(mDataTable) 'Construct the last column of the Datatable. Dim i As Integer For i = 0 To mDataTable.Rows.Count - 1 Step i + 1 mDataTable.Rows(i)(mDataTable.Columns.Count - 1) = "Dear " + mDataTable.Rows(i)(0).ToString() + "," System.Console.WriteLine("postalCode:" + mDataTable.Rows(i)(3).ToString()) System.Console.WriteLine("Heading:" + mDataTable.Rows(i)(mDataTable.Columns.Count - 1).ToString()) Next mDbDataAdapter.Dispose() mDbConnection.Close() 'End of Common part. 'case one: 'Input template pdf is a pdf file and output is a big merged stream. Dim autoFiller As AutoFiller = New AutoFiller autoFiller.InputFileName = "mail.pdf" autoFiller.OutputStream = Response.OutputStream autoFiller.ImportDataTable(mDataTable) autoFiller.Save() 'case two: 'Input template pdf is a pdf file and output is a lot of small files. Dim autoFiller As AutoFiller = New AutoFiller autoFiller.InputFileName = "mail.pdf" autoFiller.GeneratingPath = ".\"; autoFiller.BasicFileName = "outputFile" autoFiller.ImportDataTable(mDataTable) autoFiller.Save() Sets the fields which will not be flattened. If this property is not set, all the fields will be flattened. Gets or sets the OutputStream. One of four output modes. Its classical use case is Response.OutputStream. Please refer to the online demo. Gets or sets the many Output Streams. One of four output modes. Gets or sets the input template stream. One of two input modes. Gets or sets the input template file. One of two input modes. Gets or sets the one big merged output file. One of the four output modes. Gets or sets the Generating Path of the small pdf files if many small pdf files to be generated. It works with another property BasicFileName. One of the four output modes. Gets or sets the basic file name if many small files will be generated. The generated file will be like "BasicFileName0","BasicFileName1",... It works with another property GeneratingPath. Saves all the pdfs. Imports data of DataTable type. Every column's name of the dataTable must be the same as one field name of the template pdf in case sensitive. The dataTable which contains all the data from database or other data source. Saves all the pdfs. Output file name. Saves all the pdfs. Output stream. Binds a Pdf file. Pdf file name. Binds a Pdf file. Pdf file stream. Binds a Pdf document. Pdf document. Closes the object and output streams. Closes the object and output streams. Class represents blending color space. The blending color space is not changed. The blending color space is determined automatically. Blending color space is set to DeviceRGB. Blending color space is set to DeviceCMYK. Represents a bookmark. Gets or sets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: "GoTo", "GoToR", "Launch", "Named". Gets or sets the bold flag of bookmark's title. Gets or sets bookmark's children. Gets or sets bookmark's children. The action name corresponding to execute a menu item in Acrobat viewer. Gets or sets bookmark's destination page. Required if action is set as string.Empty. Gets or sets the italic flag of bookmark's title. Gets or sets bookmark's hierarchy level. Gets or sets the type of display bookmark's destination page. Gets or sets the bottom coordinate of page display. Gets or sets the left coordinate of page display. Gets or sets the right coordinate of page display. Gets or sets the top coordinate of page display. Gets or sets the zoom factor of page display. Gets or sets the number of bookmark's destination page. Gets or sets the file (path) which is required for "GoToR" action of bookmark. Gets or sets bookmark's title. Gets or sets the color of bookmark's title. Gets or sets bookmark state (open, close). Represents a collection of objects. Enumerates field types definitions. FDF stream. XML stream. XFDF stream. PDF stream. OLEDB database, such as MS Access. ODBC database, such as MS SQL Server. Enumeration of standard XMP properties. xmp:Advisory property. An unordered array specifying properties that were edited outside the authoring application. Each item should contain a single /// namespace and XPath separated by one ASCII space xmp:BaseURL property. The base URL for relative URLs in the document content. If this document contains Internet links, and those links are relative, /// they are relative to this base URL. This property provides a standard way for embedded relative URLs to be interpreted by tools. /// Web authoring tools should set the value based on their notion of where URLs will be interpreted xmp:CreateDate property. The date and time the resource was originally created. xmp:CreatorTool property. The name of the first known tool used to create the resource. xmp:Identifier property. An unordered array of text strings that unambiguously identify the resource within a given context xmp:MetadataDate property. The date and time that any metadata for this resource was last changed xmp:ModifyDate property. The date and time the resource was last modified. xmp:Nickname property. A short informal name for the resource. xmp:Thumbnails property. An alternative array of thumbnail images for a file, which can differ in characteristics such as size or image encoding. Represents the privileges for accessing Pdf file. Refer to. There are 4 ways using this class: 1.Using predefined privilege directly. 2.Based on a predefined privilege and change some specifical permissions. 3.Based on a predefined privilege and change some specifical Adobe Professional permissions combination. 4.Mixes the way2 and way3. [C#] //Way1: Using predefined privilege directly. DocumentPrivilege privilege = DocumentPrivilege.Print; //Way2: Based on a predefined privilege and change some specifical permissions. DocumentPrivilege privilege = DocumentPrivilege.AllowAll; privilege.AllowPrint = false; privilege.AllowModifyContents = false; //Way3: Based on a predefined privilege and change some specifical Adobe Professional permissions combination. DocumentPrivilege privilege = DocumentPrivilege.ForbidAll; privilege.ChangeAllowLevel = 1; privilege.PrintAllowLevel = 2; //Way4: Mixes the way2 and way3 DocumentPrivilege privilege = DocumentPrivilege.ForbidAll; privilege.ChangeAllowLevel = 1; privilege.AllowPrint = true; [Visual Basic] 'Way1: Using predefined privilege directly. Dim privilege As DocumentPrivilege = DocumentPrivilege.Print 'Way2: Based on a predefined privilege and change some specifical permissions. Dim privilege As DocumentPrivilege = DocumentPrivilege.AllowAll privilege.AllowPrint = False privilege.AllowModifyContents = False 'Way3: Based on a predefined privilege and change some specifical Adobe Professional permissions combination. Dim privilege As DocumentPrivilege = DocumentPrivilege.ForbidAll privilege.ChangeAllowLevel = 1 privilege.PrintAllowLevel = 2 'Way4: Mixes the way2 and way3 Dim privilege As DocumentPrivilege = DocumentPrivilege.ForbidAll privilege.ChangeAllowLevel = 1 privilege.AllowPrint = True Sets the permission which allow print or not. true is allow and false is forbidden. Sets the permission which allow degraded printing or not. true is allow and false is forbidden. Sets the permission which allow modify contents or not. true is allow and false is forbidden. Sets the permission which allow copy or not. true is allow and false is forbidden. Sets the permission which allow modify annotations or not. true is allow and false is forbidden. Sets the permission which allow fill in forms or not. true is allow and false is forbidden. Sets the permission which allow screen readers or not. true is allow and false is forbidden. Sets the permission which allow assembly or not. true is allow and false is forbidden. Sets the print level of document's privilege. Just as the Adobe Professional's Printing Allowed settings. 0: None. 1: Low Resolution (150 dpi). 2: High Resolution. Sets the change level of document's privilege. Just as the Adobe Professional's Changes Allowed settings. 0: None. 1: Inserting, Deleting and Rotating pages. 2: Filling in form fields and signing existing signature fields. 3: Commenting, filling in form fields, and signing existing signature fields. 4: Any except extracting pages. Sets the copy level of document's privilege. Just as the Adobe Professional's permission settings. 0: None. 1: Enable text access for screen reader devices for the visually impaired. 2: Enable copying of text, images and other content. Compares two objects. The object to compare with. A signed integer that indicates the relative values of this instance and value. Less than zero this instance is less than value. Zero this instance is equal to value. Greater than zero this instance is greater than value. Allows degraded printing. Allows printing file. Allows modifying file. Allows copying file. Allows modifying annotations of file. Allows filling forms in file. Allows to reader on screen only. Allows assemblying file. All allowed. All Forbidded. Enumerates encoding types of the text using. The Unicode encoding with horizontal writing. The Unicode encoding with vertical writing. A windows text encoding name. A windows text encoding name. A windows text encoding name. Windows ansi encoding. Mac os standard encoding for Latin text. Enumeration of possible field types. Text field. Combo box field. List box field. Radio button field. Check box field. Push button field. Multiline text field. Barcode field. Invalid field type. Signature field. Image field. Numeric field Date/time field Class representing color of the text. Green component of color. Red component of color. Blue component of color. Initializes color with specified color components. Red component. Green component. Blue component. Initializes color. Enumerates 14 types of font. Courier font. Bold Courier font. Oblique Curier font. Bold oblique Courier font. Helvetica font. Bold Helvetica font. Oblique Helvetica font. Bold oblique Helvetica font. Symbol font. Times-Roman font. Bold Times font. Italic Times font. Bold italic Times font. ZapfDingbats font. Unknown font. Standard font will be used. True Type Font for CJK supporting ,default is MS PGothic font. Class representing Acro form object. Status of imported field Field was successfully imported Field with this name was not found in the document form. Class which describes result if field import. Status of field import. Full name of the field. Result of last import operation. Array of objects which descibre result of import for each field. Gets or sets source file name. Form form = new Aspose.Pdf.Facades.Form(); form.SrcFileName = "file.pdf"; Sets PDF file format. Result file will be saved in specified file format. If this property is not specified then file will be save in default PDF format without conversion. Gets or sets destiination file name. Form form = new Aspose.Pdf.Facades.Form(); form.DestFileName = "file.pdf"; Gets or sets source stream. Form form = new Aspose.Pdf.Facades.Form(); form.SrcStream = new FileStream("source.pdf", FileMode.Open, FileAccess.Read); Gets or sets destination stream. Form form = new Aspose.Pdf.Facades.Form(); form.DestStream = new FileStream("file.pdf", FileMode.Open, FileAccess.Read); Gets list of field names on the form. Form form = new Form("PdfForm.pdf"); string[] fields = form.FieldNames; foreach(string field in fields) { Console.WriteLine(field); } Gets all form submit button names. Form form = new Form("PdfForm.pdf"); string[] submits = form.FormSubmitButtonNames; foreach(string btn in submits) { Console.WriteLine(btn); } Returns FrofmFieldFacade object containing all appearance attributes. Aspose.Pdf.Facades.Form form = new Aspose.Pdf.Facades.Form("form.pdf"); FormFieldFacade field = form.GetFieldFacade("field1"); Console.WriteLine("Color of field border: " + field.BorderColor); Name of field to read. FormFieldFacade object Constructor of Form with two stream parameters. Specify same source and destination stream for incremental update. Source stream. Destination stream. Form form = new Form( new FileStream( "InFile.pdf", FileMode.Open, FileAccess.Read), new FileStream("OutFile.pdf", FileMode.Create, FileAccess.Write)); Construtcor of Form without parameters. Form form = new Aspose.Pdf.Facades.Form(); form.SrcFileName = "file.pdf"; Fills the field with a valid value according to a fully qualified field name. Before filling the fields, every field's names and its corresponding valid values must be known. Both the fields' name and values are case sensitive. Please note that Aspose.Pdf.Facades supports only full field names and does not work with partial field names in contrast with Aspose.Pdf.Kit; For example if field has full name "Form.Subform.TextField" you should specify full name and not "TextField". You can use FieldNames property to explore existing field names and search required field by its partial name. The field's name to be filled. The field's value which must be a valid value for some fields. true if field is found and filled successfully. Form form = new Form(TestSettings.GetInputFile("PdfForm.pdf")); form.FillField("FirstName", "John"); form.FillField("LastName", "Smith"); //how to search field by its partial name: Form form = new Form("input.pdf", "output.pdf"); foreach(string fieldName in form.FieldNames) { if (fieldName.EndsWith("TextField")) { Console.WriteLine("Full name is: " + fieldName); } } Fills the radio box field with a valid index value according to a fully qualified field name. Before filling the fields, only field's name must be known. While the value can be specified by its index. Notice: Only be applied to Radio Box, Combo Box and List Box fields. Please note that Aspose.Pdf.Facades supports only full field names and does not work with partial field names in contrast with Aspose.Pdf.Kit; For example if field has full name "Form.Subform.ListBoxField" you should specify full name and not "ListBoxField". You can use FieldNames property to explore existing field names and search required field by its partial name. Name of field to be filled. Index of chosen item. true if field was found and successfully filled. Form form = new Form("PdfForm.pdf"); form.FillField("listboxField", 2); form.FillField("comboboxField", 2); form.FillField("radiobuttonField", 2); //how to search field by its partial name: Form form = new Form("input.pdf", "output.pdf"); foreach(string fieldName in form.FieldNames) { if (fieldName.EndsWith("ListBoxField")) { Console.WriteLine("Full name is: " + fieldName); } } Fills the check box field with a boolean value. Notice: Only be applied to Check Box. Please note that Aspose.Pdf.Facades supports only full field names and does not work with partial field names in contrast with Aspose.Pdf.Kit; For example if field has full name "Form.Subform.CheckBoxField" you should specify full name and not "CheckBoxField". You can use FieldNames property to explore existing field names and search required field by its partial name. Form form = new Form("PdfForm.pdf"); form.FillField("checkboxField", true); //how to search field by its partial name: Form form = new Form("input.pdf", "output.pdf"); foreach(string fieldName in form.FieldNames) { if (fieldName.EndsWith("CheckBoxField")) { Console.WriteLine("Full name is: " + fieldName); } } The field's name to be filled. A boolean flag: true means to check the box, while false to uncheck it. true if field was found and successfully filled. Returns the current value for radio button option fields. Field Name String value for the current radio group optino. See also Form form = new Form("PdfForm.pdf"); Console.WriteLine(form.GetButtonOptionCurrentValue("btnField")); Gets the radio button option fields and related values based on the field name. This method has meaning for radio button groups. Field Name Hash table of option values keyed by form item name Form form = new Form("PdfForm.pdf"); Hashtable values = form.GetButtonOptionValues("Color"); Console.WriteLine(values["White"].ToString()); Console.WriteLine(values["Black"].ToString()); Gets the field's value according to its field name. The fully qualified field name. The field's value. Form form = new Form("PdfForm.pdf"); Console.WriteLine("Field value = " + form.GetField("Field1")); Gets the full field name according to its short field name. The fully qualified field name. The full field name. Form form = new Form("PdfForm.pdf"); Console.WriteLine("Full field name is : " + form.GetFullFieldName("textField")); Get the limitation of text field. The qualified field name. Return the limitation number of characters a text field can be filled. It not set, return 0. Form form = new Form("PdfForm.pdf"); Console.WriteLine(form.GetFieldLimit("textfieldBox")); Saves the value of the filled fields and close the opened Pdf document. Form form = new Form("PdfForm.pdf", "PdfForm_Changed.pdf"); form.FillField("textField", "new value"); form.Save(); Saves document into specified file. File where document will be saved. Saves document into specified stream. Stream where document will be saved. Closes opened files without any changes. Flattens all the fields. Form form = new Form("PdfForm.pdf"); form.FlattenAllFields(); Flattens a specified field with the fully qualified field name. Any other field will remain unchangable. If the fieldName is invalid, all the fields will remain unchangable. Form form = new Form("PdfForm.pdf"); form.FlattenField("textField"); The name of the field to be flattened. Fill a barcode field according to its fully qualified field name. The fully qualified field name. The new barcode value. If filling succeed, return true; otherwise, false. Form form = new Form("PdfForm.pdf"); form.FillBarcodeField("textField", "42207252"); Imports the content of the fields from the fdf file and put them into the new pdf. The input fdf stream. Form form = new Form("PdfForm.pdf", "PdfForm_imported.pdf"); form.ImportFdf(new FileStream("data.fdf", FileMode.Open, FileAccess.Read)); form.Save(); Exports the content of the fields of the pdf into the fdf stream. The output fdf stream. Form form = new Form("PdfForm.pdf"); Stream stream = new FileStream("export.fdf", FileMode.Create, FileAccess.Write); form.ExportFdf(stream); stream.Close(); Imports the content of the fields from the xml file and put them into the new pdf. Stream from which XML for import is read. Form form = new Form("PdfForm.pdf", "Form_Imported.pdf"); FileStream fs = new FileStream(TestSettings.GetInputFile("import.xml"), FileMode.Open, FileAccess.Read); form.ImportXml(fs); form.Save(); Exports the content of the fields of the pdf into the xml stream. The button field's value will not be exported. Form form = new Form("PdfForm.pdf")); FileStream fs = new FileStream("export.xml", FileMode.Create, FileAccess.Write); form.ExportXml(fs); fs.Close(); Output Xml stream. Extracts XFA data packet Stream where XML data will be stored. Replaces XFA data with specified data packet. Data packet may be extracted using ExtractXfaData. Stream where XML is stored. Imports the content of the fields from the xfdf(xml) file and put them into the new pdf. The input xfdf(xml) stream. Form form = new Form("PdfForm.pdf", "Form_ImportXfdf.pdf"); Stream fs = new FileStream("export_old.xfdf", FileMode.Open, FileAccess.Read); form.ImportXfdf(fs); fs.Close(); form.Save(); Exports the content of the fields of the pdf into the xml stream. The button field's value will not be exported. The output xml stream. Form form = new Form("PdfForm.pdf"); FileStream fs = new FileStream("export.xfdf", FileMode.Create, FileAccess.Write); form.ExportXfdf(fs); fs.Close(); Fill a field with multiple selections.Note: only for AcroForm List Box Field. The fully qualified field name. A string array which contains several items to be selected. Form form = new Aspose.Pdf.Facades.Form("PdfForm.pdf", "Form_Updated.pdf"); form.FillField("ListBox1", new String[] { "Three", "One" }); form.Save(); Renames a field. Either AcroForm field or XFA field is OK. the old field name the new field name Form form = new Form("PdfForm.pdf", "PdfFormUpdated.pdf"); form.RenameField("field", "field1"); form.Save(); Get a Rich Text field's value, including the formattinf information of every character. The fully qualified field name of the Rich Text field. Return a string containing formatting information of the Rich Text field. Form form = new Form("PdfForm.pdf"); Console.WriteLine(form.GetRichText("txtDescriptionRTF")); Returns the submit button's submission flags The qualified field name. Submission flags of the button. Aspose.Pdf.Facades.Form form = new Aspose.Pdf.Facades.Form("PdfForm.pdf"); System.Console.WriteLine((form.GetSubmitFlags("btnSubmit") | Aspose.Pdf.Facades.SubmitFormFlag.Xfdf )!= 0 ? " XFDF" : " "); System.Console.WriteLine((form.GetSubmitFlags("btnSubmit") | Aspose.Pdf.Facades.SubmitFormFlag.Fdf )!= 0 ? " FDF" : " "); System.Console.WriteLine((form.GetSubmitFlags("btnSubmit") | Aspose.Pdf.Facades.SubmitFormFlag.Pdf )!= 0 ? " PDF" : " "); Constructor of Form. Source file path. Form form = new Form("PdfForm.pdf"); Constructor for form. source stream. Form form = new Form(new FileStream("PdfForm.pdf", FileMode.Open, FileAccess.Read)); Constructor of Form class. Specify same source file name and destination file name to perform incremental update. Path of the source file. Path of the destination file. Form form = new Form("PdfForm.pdf", "PdfForm_Updated.pdf"); Constructor of Form. Source file path. Destination file path. Form form = new Form("PdfForm.pdf", "PdfForm_Updated.pdf"); Constructor of Form Source stream. Destination file path. Form form = new Form(new FileStream("PdfForm.pdf", FileMode.Open, FileAccess.Read), "PdfForm_Updated.pdf"); Returns type of field. Field name. Element of FileType enumeration corresponding to field type. Form form = new Form("PdfForm.pdf"); if (form.GetFieldType("textField") == FieldType.Text) { Console.WriteLine("Type of field is text"); } Determines whether field is required or not. The name of field. True - the field is required; otherwise, false. Returns flags of the field. Field name Property flag (ReadOnly/ Required/NoExport Form form = new Form("PdfForm.pdf"); if (form.GetFieldFlag("textField") == PropertyFlag.ReadOnly) { Console.WriteLine("Field is read-only"); } Pastes an image onto the existing button field as its appearance according to its fully qualified field name. The fully qualified field name of the image button field. The path of the image file, relative and absolute are both ok. Form form = new Form("PdfForm.pdf", "PdfForm_filled.pdf"); form.FillImageField("fieldName", "file.jpg"); form.Save(); Overloads function of FillImageField. The input is a image stream. The fully qualified field name. The image's stream. Form form = new Form("PdfForm.pdf", "PdfForm_filled.pdf"); form.FillImageField("fieldName", new FileStream("file.jpg", FileMode.Open, FileAccess.Read)); Initializes new object on base of the . Pdf document. Initializes new object on base of the . Pdf document. Path of the destination file. Initializes new object on base of the . Pdf document. Destination stream. Imports the content of the fields from the xml file and put them into the new pdf. The input xml stream. If this parameter is true then all changes of the XFA form template will not be saved Fills field with specified value. Name of field New value of the field If true, the font size in the edit boxes will be fitted. true if field was found and successfully filled. Class which represents formatted text. Contains information about text and its color, size, style. Gets height of text. Gets width of text. Initializes FormattedText. Initializes FormattedText. Text which contained in FormattedText. Initializes FormattedText. Text content of the string. Color of the text. Style of the text. Encoding type (value of EncodingType enumeration). True if the font will be embedded. Size of the text. Initialize FormattedText. Text content of the string. Color of the text. Font of the text. Encoding of the text. True if text will be embedded. Size of the text. Additional spacing. Initializes FormattedText. Text content of the string. Color of the text. Font of the text. Encoding of the text. True if text will be embedded. Size of the text. Initializes FormattedText. Text contents of the string. Color of the text. Font of the text. Encoding of the text. If true font will be embedded. Size of the text. Additional spacing. Initializes FormattedText. Text content of the string. Color of the text. Color of background. Font of the text. Encoding of the text. If true font will be embedded. Size of the text. Initializes FormattedText. Text content. Color of the text. Color of background. Font of the text. Encoding of the text. If true font will be embedded. Size of the text. Additional spacing. Initializes FormattedText. Text content of the string. Color of the text. Color of background. Font of the text. Encoding of the text. True if font will be embedded. Size of the text. Initializes FormattedText. Text contents of the string. Color of the text. Color of the background. Font of the text. Encoding of the text. If true font is embedded. Size of the text. Additional spacing. Initializes FormattedText. Text content. Color of the text. Color of background. Font of the text. Encoding of the text. If true font will be embedded. Size of the text. Initializes FormattedText. Text content. Color of the text. Color of background. Adds a new line to the FormattedText object and sets the newLineText to the next line's text. Text of new added line. Adds a new line to the FormattedText object and sets the newLineText to the next line's text. Text of new added line. Spacing of the line. Initializes FormattedText. Text content. Color of the text. Font of the text. Encoding of the text. If true font will be embedded. Size of the text. Represents a class to convert data from one format to another format. It can convert the data in fdf/xml/pdf/xfdf to the OLEDB/OdbcDB. It also can convert the data in the OLEDB/OdbcDB to the data in fdf/xml/xfdf. It can convert the fdf to the xml with "hard-named" tag. Gets or sets the middle data container, one DataTable. It must be defined before converting data from one format to another format. The Columns and TableName of the DataTable should be defined. The TableName is the name of the Table in the database. Every column's ColumnName is the qualified field name of the pdf. Every column's Caption is the column name of table in the database. If the field name is the same as the table column name, the Caption need not specified. ConvertToDataTable will create required field if it does not exists in Table. ImportIntoDatabase will drop existing table and create new table if this property set to true. ExportFromData will clear table before data export. ImportIntoDatabase will create table if it does not exists. Convert XML import/export form data file into FDF format. Source stream which contains XML file. Destination source where resultant FDF file will be stored. Convert FDF file into XML. Stream which contains FDF to convert. Source where reuslt XML will be placed. src = new FileStream("test.fdf", FileMode.Open); dest = new FileStream("converted_fdf.xml", FileMode.Create); FormDataConverter.ConvertFdfToXml(src, dest); src.Close(); dest.Close(); Convert files of strems into table. Array of source streams in specified format. Format of data in streams. Valid values are: PDF, FDF, XFDF, XML. DataTable table = new DataTable(); table.Columns.Add("radiobuttonField"); table.Columns.Add("textField"); table.Columns.Add("checkboxField"); table.Columns.Add("listboxField"); table.Columns.Add("comboboxField"); FormDataConverter fc = new FormDataConverter(); Stream stream = new FileStream("PdfWithAcroForm.pdf", FileMode.Open); fc.Table = table; fc.ConvertToDataTable(new Stream[] { stream }, DataType.PDF); stream.Close(); Imports data from table into database. Connection string of database. Type of database connection: OLEDB or ODBC. FormDataConverter fc = new FormDataConverter(); DataTable table = new DataTable(); table.TableName = "test"; table.Columns.Add("TEXT_VALUE"); table.Columns.Add("INT_VALUE"); fc.Table = table; DataRow row = table.NewRow(); row["TEXT_VALUE"] = "AAA"; row["INT_VALUE"] = "123"; table.Rows.Add(row); string connection = "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=ConverterDatabase.mdb"; fc.ImportIntoDataBase(connection, DataType.OLEDB); Exports data from database into table. Connection string for database. Connection type: OLEDB or ODBC. FormDataConverter fc = new FormDataConverter(); string connection = "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=ConverterDatabase.mdb"; DataTable table = new DataTable(); table.TableName = "TestSource"; table.Columns.Add("TEXT_VALUE"); table.Columns.Add("INT_VALUE"); fc.Table = table; fc.ExportFromDataBase(connection, DataType.OLEDB); Convert data in table into streams. Streams where data will be stored. Type of stored data. Valid values are: XML, FDF, XFDF. DataTable table = new DataTable(); table.Columns.Add("radiobuttonField"); table.Columns.Add("textField"); table.Columns.Add("checkboxField"); table.Columns.Add("listboxField"); table.Columns.Add("comboboxField"); DataRow newrow = table.NewRow(); newrow["textField"] = "NEW DATA"; newrow["listboxField"] = "Item1"; newrow["comboboxField"] = "Item1"; newrow["checkboxField"] = "true"; newrow["radiobuttonField"] = "true"; table.Rows.Add(newrow); fc.Table = table; fc.ConvertToStreams(new Stream[] { stream }, DataType.XML); This method is obsolete. Please use ConvertToStreams() instead. Destination stream object. Destination type value. Class for editing forms (ading/deleting field etc) Gets or sets name of source file. FormEditor editor = new FormEditor(); editor.SrcFileName = "InputFile.pdf"; Gets or sets destination file name. FormEditor editor = new FormEditor(); editor.DestFileName = "OutFile.pdf"; Gets or sets source stream. FormEditor editor = new FormEditor(); editor.SrcStream = new FileStream("InFile.pdf", FileMode.Open, FileAccess.Read); Sets PDF file format. Result file will be saved in specified file format. If this property is not specified then file will be save in default PDF format without conversion. Gets or sets destination stream. FormEditor editor = new FormEditor(); editor.DestStream = new FileStream("OutFile.pdf", FileMode.Create, FileAccess.Write); Sets items which will be added t onewly created list box or combo box. formEditor = new Aspose.Pdf.Facades.FormEditor("input.pdf", "output.pdf"); formEditor.Items = new string[] { "AAA", "BBB", "CCC" }; formEditor.AddField(FieldType.ListBox, "AddedListBoxField", "BBB", 1, 10, 30, 110, 130); formEditor.Save(); Sets options for combo box with export values. FormEditor formEditor = new FormEditor("PdfForm.pdf", "PdfForm_Updated.pdf")); formEditor.ExportItems = new string[][] { new string[] { "1", "Firs" }, new string[] { "2", "Second" }, new string[] { "3", "Third" } }; formEditor.AddField(FieldType.ListBox, "AddedListBoxField", "Second", 1, 10, 30, 110, 130); formEditor.Save(); Sets visual attributes of the field. FormEditor fe = new FormEditor("PdfForm.pdf", "PdfForm_DecorateField_text.pdf"); fe.Facade = new FormFieldFacade(); fe.Facade.BackgroundColor = System.Drawing.Color.Red; fe.Facade.TextColor = System.Drawing.Color.Blue; fe.Facade.BorderColor = System.Drawing.Color.Green; fe.Facade.Alignment = FormFieldFacade.AlignCenter; fe.DecorateField("textField"); fe.Save(); The member to record the gap between two neighboring radio buttons in pixels,default is 50. formEditor = new Aspose.Pdf.Facades.FormEditor("PdfForm.pdf", "FormEditor_AddField_RadioButton.pdf"); formEditor.RadioGap = 4; formEditor.RadioHoriz = false; formEditor.Items = new string[] { "First", "Second", "Third" }; formEditor.AddField(FieldType.Radio, "AddedRadioButtonField", "Second", 1, 10, 30, 110, 130); formEditor.Save(); The flag to indicate whether the radios are arranged horizontally or vertically, default value is true. formEditor = new Aspose.Pdf.Facades.FormEditor("PdfForm.pdf", "FormEditor_AddField_RadioButton.pdf"); formEditor.RadioGap = 4; formEditor.RadioHoriz = false; formEditor.Items = new string[] { "First", "Second", "Third" }; formEditor.AddField(FieldType.Radio, "AddedRadioButtonField", "Second", 1, 10, 30, 110, 130); formEditor.Save(); Gets or sets size of radio button item size (when new radio button field is added). formEditor = new Aspose.Pdf.Facades.FormEditor("PdfForm.pdf", "FormEditor_AddField_RadioButton.pdf"); formEditor.RadioGap = 4; formEditor.RadioHoriz = false; formEditor.RadioButtonItemSize = 20; formEditor.Items = new string[] { "First", "Second", "Third" }; formEditor.AddField(FieldType.Radio, "AddedRadioButtonField", "Second", 1, 10, 30, 110, 130); formEditor.Save(); Set the submit button's submission flags Constructor for FormEditor. Source stream. Destination stream. FormEditor formEditor = new FormEditor( new FileStream(new FileStream("InFile.pdf", FileMode.Open, FileAccess.Read), new FileStream("OutFile.pdf", FileMode.Create, FileAccess.Write)); Constructor for FormEditor Name of source file. Name of destination file. FormEditor formEditor = new FormEditor("InFile.pdf", "OutFile.pdf"); Constructor for FormEditor. FormEditor formEditor = new FormEditor(); Saves changes into destination file. FormEditor formEditor = new FormEditor("InFile.pdf", "OutFile.pdf"); //make some changes... formEditor.Save(); Set attributes of field. Name of field which attributes should be set. Flag (NoExport/ReadOnly/Required) true if attribute was set successfully. FormEditor formEditor = new FormEditor("PdfForm.pdf", "PdfForm_SetFieldAttribute.pdf"); formEditor.SetFieldAttribute("listboxField", PropertyFlag.ReadOnly); formEditor.SetFieldAttribute("textField", PropertyFlag.NoExport); Set field flags Name of field whose flags should be updated. Flag of the field. true if flags were updated successfully. FormEditor formEditor = new FormEditor("PdfForm1.pdf", "FormEditor_SetFieldAppearance.pdf"); formEditor.SetFieldAppearance("Name", AnnotationFlags.Hidden); formEditor.SetFieldAppearance("Phone", AnnotationFlags.NoView | AnnotationFlags.Print); Get field flags. Name of the field. Set of field flags Set submit flag of submit button. Name of submit button. Submit flag. true if field was found and submit flag was successfully set. FormEditor formEditor = new FormEditor("PdfForm.pdf", "FormEditor_SetSubmitFlag.pdf"); formEditor.SetSubmitFlag("btnSubmit", SubmitFormFlag.Fdf); Sets URL of the button. Submit button name. Fully qualified URL. true if URL for button was successfully set. FormEditor formEditor = new FormEditor("PdfForm.pdf", "FormEditor_SetSubmitUrl.pdf"); formEditor.SetSubmitUrl("btnSubmit", "www.mysite.com"); Sets maximum character count of the text field. Name of the text field. New value of limit for the field. true if field limit was successfully set. FormEditor formEditor = new FormEditor("PdfForm.pdf", "FormEditor_SetFieldLimit.pdf"); formEditor.SetFieldLimit("textField", 15); Sets number of combs for a regular single-line text field (the field is automatically divided into as many equally spaced positions, or combs, as the value of combNumber parameter). The qualified field name. The number of combs to divide the field into. If success, return true;else false. FormEditor formEditor = new FormEditor("PdfWithAcroForm.pdf", "FormEditor_SetFieldComb.pdf")); formEditor.SetFieldCombNumber("textCombField", 5); Set new position of field. Name of field which must be moved. Abscissa of the lower-left corner of the field. Ordinate of the lower-left coerner of the field. Abscissa of the upper-right corner of the field. Ordinate of the upper-right corner of the field. true if field position was changed successfully. FormEditor formEditor = new FormEditor("PdfForm.pdf", "FormEditor_MoveField.pdf"); formEditor.MoveField("textField", 20.5f, 20.3f, 120.6f, 40.8f); Add field of specified type to the form. Type of the field which must be added. Name of the field whic must be added. Page number where new field must be placed. Abscissa of the lower-left corner of the field. Ordinate of the lower-left corner of the field. Abscissa of the upper-right corner of the field. Ordinate of the upper-right corner of the field. true if field was successfully added. FormEditor formEditor = new Aspose.Pdf.Facades.FormEditor("PdfForm.pdf", "FormEditor_AddField_Text.pdf"); formEditor.AddField(FieldType.Text, "AddedTextField", 1, 10, 30, 110, 46); formEditor.Save(); Add field of specified type to the form. Type of the field which must be added. Name of the field whic must be added. Initial value of the field. Page number where new field must be placed. Abscissa of the lower-left corner of the field. Ordinate of the lower-left corner of the field. Abscissa of the upper-right corner of the field. Ordinate of the upper-right corner of the field. true if field was successfully added. /// FormEditor formEditor = new Aspose.Pdf.Facades.FormEditor("PdfForm.pdf", "FormEditor_AddField_Text.pdf"); formEditor.AddField(FieldType.Text, "AddedTextField", "Text Value", 1, 10, 30, 110, 46); formEditor.Items = new string[] { "Item1", "Item2", Item3" }; formEditor.AddField(FieldType.Radio, "RadioButtonField", 1, 265, 695, 365, 720); formEditor.Save(); Remove field from the form. Name of the field which must be removed. FormEditr formEditor = new FormEditor("PdfForm.pdf", "FormEditor_RemoveField.pdf"); formEditor.RemoveField("listboxField"); formEditor.RemoveField("textField"); Reset all visual attribtues to empty value. Reset all visual attribtues of inner facade to empty value. Copies an existing field to the same position in specified page number. A new document will be produced, which contains everything the source document has except for the newly copied field. The old fully qualified field name. The new fully qualified field name. If null, it will be set as fieldName + "~". The number of page to hold the new field. If -1, new field will be copid to the same page as old one hosted. FormEditor formEditor = new FormEditor("PdfForm.pdf", "PdfForm_out.pdf"); //Creates copy of text field on psecond page. formEditor.CopyInnerField("textField", "textFieldCopy", 2); Copies an existing field to a new position specified by both page number and ordinates. A new document will be produced, which contains everything the source document has except for the newly copied field. The old fully qualified field name. The new fully qualified field name. If null, it will be set as fieldName + "~". The number of page to hold the new field. If -1, new field will be copid to the same page as old one hosted. The abscissa of the new field. If -1, the abscissa will be equaled to the original one. The ordinate of the new field. If -1, the ordinate will be equaled to the original one. FormEditor formEditor = new FormEditor("PdfForm.pdf", "PdfForm_out.pdf"); //Creates copy of text field on psecond page. formEditor.CopyInnerField("textField", "textFieldCopy", 2, 100, 200); Copies an existing field from one PDF document to another document with original page number and ordinates. Notice: Only for AcroForm fields (excluding radio box). The name of PDF document which containes the field to be copied. The original fully qualified field name. FormEditor formEditor = new FormEditor("PdfForm.pdf", "PdfForm_updated.pdf"); //copies text field from source.pdf to PdfForm.pdf formEditor.CopyOuterField("source.pdf", "textField"); formEditor.Save(); Copies an existing field from one PDF document to another document with specified page number and original ordinates. Notice: Only for AcroForm fields (excluding radio box). The name of PDF document which containes the field to be copied. The original fully qualified field name. The number of page to hold the new field. If -1, new field will be copid to the same page as old one hosted. FormEditor formEditor = new FormEditor("PdfForm.pdf", "PdfForm_updated.pdf"); formEditor.CopyOuterField("source.pdf", "textField", 2); formEditor.Save(); Copies an existing field from one PDF document to another document with specified page number and ordinates. Notice: Only for AcroForm fields (excluding radio box). The name of PDF document which containes the field to be copied. The original fully qualified field name. The number of page to hold the new field. If -1, new field will be copid to the same page as old one hosted. The abscissa of the new field. If -1, the abscissa will be equaled to the original one. The ordinate of the new field. If -1, the ordinate will be equaled to the original one. FormEditor formEditor = new FormEditor("PdfForm.pdf", "PdfForm_updated.pdf"); formEditor.CopyOuterField("source.pdf", "textField" , 2, 100, 200); Changes visual attributes of the specified field. The fully qualified field name. FormEditor fe = new FormEditor("PdfWithAcroForm.pdf", "FormEditor_DecorateField_text.pdf"); fe.Facade = new FormFieldFacade(); fe.Facade.BackgroundColor = System.Drawing.Color.Red; fe.Facade.TextColor = System.Drawing.Color.Blue; fe.Facade.BorderColor = System.Drawing.Color.Green; fe.Facade.Alignment = FormFieldFacade.AlignCenter; fe.DecorateField("textField"); Changes visual attributes of all fields with the specified field type. Type of fields which will be decorated. FormEditor fe = new FormEditor("PdfForm.pdf", "FormEditor_DecorateField.pdf"); fe.Facade = new FormFieldFacade(); fe.Facade.BackgroundColor = System.Drawing.Color.Red; fe.Facade.TextColor = System.Drawing.Color.Blue; fe.Facade.BorderColor = System.Drawing.Color.Green; fe.Facade.Alignment = FormFieldFacade.AlignRight; //decorate all text fields. fe.DecorateField(FieldType.Text); Changes visual attributes of all fields in the PDF document. FormEditor fe = new FormEditor("PdfForm.pdf", "FormEditor_DecorateField.pdf"); fe.Facade = new FormFieldFacade(); fe.Facade.BackgroundColor = System.Drawing.Color.Red; fe.Facade.TextColor = System.Drawing.Color.Blue; fe.Facade.BorderColor = System.Drawing.Color.Green; fe.Facade.Alignment = FormFieldFacade.AlignRight; //decorate all fields. fe.DecorateField(); Change name of the field. Old name of the field. New name of the field. FormEditor formEditor = new FormEditor("PdfForm.pdf", "PdfForm_updated.pdf"); formEditor.RenameField("textField", "textField_Renamed"); Remove submit action of the field. Name of the field. FormEditor formEditor = new FormEditor("PdfForm.pdf", "FormEditor_RemoveFieldAction.pdf"); formEditor.RemoveFieldAction("btnSubmit"); Add submit button on the form. Name of new button. Page where button will be placed. Button caption. URL of the submit button. Abscissa of the lower-left corner. Ordinate of the lower-left corner. Abscissa of the upper-right corner. Ordinate of the upper-right corner. FormEditor formEditor = new FormEditor("PdfForm.pdf", "FormEditor_AddSubmitBtn.pdf"); formEditor.AddSubmitBtn("submit", 1, "Submit", "www.check.com", 10, 200, 70, 270); Adds new item to the list box. Name of the field ot which new item will be added. Name if new item. FormEditor formEditor = new FormEditor("PdfForm.pdf", PdfForm_out.pdf"); formEditor.AddListItem("listBoxField", "Item 4 (New Item)"); Add a new item with Export value to the existing list box field, only for AcroForm combo box field. Name of field to which items will be added. A string array denoting a new list item with Export Value, i.e. (Item Label, Export Value). FormEditor fe = new FormEditor("PdfForm.pdf", "FormEditor_AddListItem2.pdf"); fe.AddListItem("listboxField", new string[] { "4", "Item4(Added)" }); Delete item from the list field. Name of the field. Name of the item which must be deleted. formEditor = new Aspose.Pdf.Facades.FormEditor("PdfForm.pdf", "FormEditor_DelListItem.pdf"); formEditor.DelListItem("listboxField", "item2"); Set JavaScript for a PushButton field. If old JavaScript existed, it will be replaced by the new one. The fully qualified field name. The Java script to be added/placed into a push button field. true if field scrip was successfully set. Add JavaScript for a PushButton field. If old event exists, new event is added after it. The fully qualified field name. The Java script to be added/placed into a push button field. True in case script was added successfully. Change a single-lined text field to a multiple-lined one. The qualified field name. If success, return true;else false. FormEditor formEditor = new FormEditor("PdfForm.pdf", "PdfForm_updated.pdf"); formEditor.Single2Multiple("textField"); Set the alignment style of a text field. The qualified field name. The alignment style definition, including FormFieldFacade.AlignLeft, FormFieldFacade.AlignCenter and FormFieldFacade.AlignRight. true if true if field was found and alignment was set. FormEditor fe = new FormEditor("PdfStaticForm.pdf", "VerticalAlign.pdf"); fe.SetFieldAlignment("form1[0].TextField[0]", FormFieldFacade.AlignLeft); Set the vertical alignment style of a text field. The qualified field name. The alignment style definition, including FormFieldFacade.AlignTop, FormFieldFacade.AlignMiddle and FormFieldFacade.AlignRight. true if field was found and alignment was successfully filled. FormEditor fe = new FormEditor("PdfStaticForm.pdf", "VerticalAlign.pdf"); fe.SetFieldAlignmentV("form1[0].TextField[0]", FormFieldFacade.AlignBottom); Initializes new object on base of the . Pdf document. Initializes new object on base of the . Pdf document. Path of the destination file. Initializes new object on base of the . Pdf document. Destination stream. Closes the facade. Class for representing field properties. The color of a field border. The style of a field border. The width of a field border. The font type of a field text. Gets or sets name of the font when this is non-standart (other then 14 standard fonts). The size of a field text. The color of the field text. The text encoding type of the field text. The alignment of a field text, default is left alignment. The rotation of a field text. The normal caption of form field. The style of check box or radio box field, defined by FormFieldFacade.CheckBoxStyle*. A rectangle object holding field's location. A rectangle object holding field's location. An integer value holding the number of page on which field locates. An array of string, each representing an option of a combo box/list/radio box field. The options for adding a list/combo/radio box The color of a field background, default is white. Reset all visual attribtues to empty value. Undefined border width. Undefined border width. Defines a thin border width. Defines a medium border width. Defines a thick border width. Defines a solid border style. Defines a dashed border style. Defines a beveled border style. Defines an inseted border style. Defines an underlined border style. Undefined border style. Defines aglignment to left style. Defines aglignment to center style. Defines aglignment to right style. Undefined aglignment style. Defines text justification alignment style. Defines vertical aglignment as top style. Defines vertical aglignment as middle style. Defines vertical aglignment as bottom style. Defines a circle check box style. Defines the shape of a check box field when it checked. Defines a cross check box style. Defines a diamond check box style. Defines a star check box style. Defines a square check box style. Defines an undefined check box style. Obsolete property. Use BackgroundColor. Defines different key sizes which can be used to encrypt pdf documents. 40 bit key. Such key size is used with RC4 algorithm and provides low level of security. Nevertheless old versions of pdf documents can be encrypted only with such keys (v. 1.3 and lower); 128 bit key. Both RC4 and AES algorithms can use such key size. 256 bit key. Such key size can be used only with AES and is recognized with the last Adobe Reader versions (starting from v.9). Represents the information of line. Gets or sets an array of numbers representing the alternating horizontal and vertical,coordinates, respectively, of each vertex. Gets or sets the color of a line. Gets or sets the width of a line. Gets or sets the visibility of a line. Gets or sets the dash pattern of a line. Gets or sets the border style of a line, 0 represents solid, 1 represents dashed, 2 represents beleved, 3 represents insert, 4 represents underline. Represents a class for work with PDF document annotations (comments). Imports all annotations from XFDF file. The input XFDF file. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); editor.ImportAnnotationsFromXfdf("annots.xfdf"); editor.Save("example_out.pdf"); Imports all annotations from XFDF file. The input XFDF file. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); editor.ImportAnnotationsFromXfdf("annots.xfdf"); editor.Save("example_out.pdf"); Imports the specified annotations from XFDF file. The input XFDF file. The annotations array to be imported. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); AnnotationType[] annotTypes = {AnnotationType.Highlight, AnnotationType.Text}; editor.ImportAnnotationFromXfdf("annots.xfdf", annotTypes); editor.Save("example_out.pdf"); Imports the specified annotations from XFDF data stream. The input XFDF data stream. The array of annotation types to be imported. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); AnnotationType[] annotTypes ={ AnnotationType.Highlight, AnnotationType.Line }; editor.ImportAnnotationFromXfdf(File.OpenRead("annots.xfdf"), annotTypes); editor.Save("example_out.pdf"); Imports all annotations from XFDF data stream. The input XFDF data stream. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); editor.ImportAnnotationsFromXfdf(File.OpenRead("annots.xfdf")); editor.Save("example_out.pdf"); Imports all annotations from XFDF data stream. The input XFDF data stream. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); editor.ImportAnnotationFromXfdf(File.OpenRead("annots.xfdf")); editor.Save("example_out.pdf"); Imports the specified annotations into document from array of another PDF documents. The array of paths of PDF documents that contain source annotations. The array of annotation types to be imported. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); string[] paths = new string[2] {"with_annots1.pdf", "with_annots2.pdf"}; AnnotationType[] annotTypes = {AnnotationType.Highlight, AnnotationType.Text}; editor.ImportAnnotations(paths, annotTypes); editor.Save("example_out.pdf"); Imports annotations into document from array of another PDF documents. The array of paths of PDF documents that contain source annotations. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); string[] paths = new string[2] {"with_annots1.pdf", "with_annots2.pdf"}; editor.ImportAnnotations(paths); editor.Save("example_out.pdf"); Imports the specified annotations into document from array of another PDF document streams. The array of streams of PDF documents that contain source annotations. The annotation types to be imported. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); Stream[] streams = new FileStream[2]; stream[0]= File.OpenRead("with_annots1.pdf"); stream[1]= File.OpenRead("with_annots2.pdf"); AnnotationType[] annotTypes = {AnnotationType.Highlight, AnnotationType.Text}; editor.ImportAnnotations(streams, annotTypes); editor.Save("example_out.pdf"); stream[0].Close(); stream[1].Close(); Imports annotations into document from array of another PDF document streams. The array of streams of PDF documents that contain source annotations. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); Stream[] streams = new FileStream[2]; streams[0]= File.OpenRead("with_annots1.pdf"); streams[1]= File.OpenRead("with_annots2.pdf"); editor.ImportAnnotations(streams); editor.Save("example_out.pdf"); streams[0].Close(); streams[1].Close(); Modifies the annotations of the specifed type on the specified page range. It supports to modify next annotation properties: Modified, Title, Contents, Color, Subject and Open. The start page number. The end page number. The annotation type. The annotation object contains new properties. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); TextAnnotation annot = new TextAnnotation(); annot.Modified = DateTime.Now; annot.Title = "NEW AUTHOR"; annot.Contents = "NEW CONTENTS"; annot.Color = Color.Red; annot.Subject = "NEW SUBJECT"; annot.Open = true; editor.ModifyAnnotations(1, 2, AnnotationType.Text, annot); editor.Save("example_out.pdf"); Modifies the author of annotations on the specified page range. The start page number. The end page number. The author that must be modified. The new author. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); editor.ModifyAnnotationsAuthor(1, 2, "PREV AUTHOR", "NEW AUTHOR"); editor.Save("example_out.pdf"); Flattens all annotations in the document. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); editor.FlatteningAnnotations(); editor.Save(example_out.pdf"); Flattens all annotations in the document. Specifies modes of flattening. Flattens the annotations of the specified types. The start page. Then end page. The annotation types should be flattened. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); AnnotationType[] annotTypes ={AnnotationType.Line, AnnotationType.FreeText}; editor.FlatteningAnnotations(1, 2, annotTypes); editor.Save("example_out.pdf"); Deletes all annotations in the document. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); editor.DeleteAnnotations(); editor.Save("example_out.pdf"); Deletes all annotations of the specified type in the document. The type of annotation will be deleted. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); editor.DeleteAnnotations("Text"); editor.Save("example_out.pdf"); Deletes the annotation with specified annotation name. The annotation name PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); editor.DeleteAnnotation("4cfa69cd-9bff-49e0-9005-e22a77cebf38"); editor.Save("example_out.pdf"); Exports the content of the specified annotation types into XFDF The output XFDF stream. Start page from which the annotations of the document will be exported. End page to which the annotations of the document will be exported. The array of annotation types need be exported. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); string[] annotTypes = new string[] {"Text", "Highlight"}; using (Stream stream = File.Create("example.xfdf")) { editor.ExportAnnotationsXfdf(stream, 1, 2, annotTypes); } Exports the content of the specified annotations types into XFDF The output XFDF stream. Start page from which the annotations of the document will be exported. End page to which the annotations of the document will be exported. The array of annotation types need be exported. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); AnnotationType[] annotTypes = new AnnotationType[] {AnnotationType.Text, AnnotationType.Highlight}; using (Stream stream = File.Create("example.xfdf")) { editor.ExportAnnotationsXfdf(stream, 1, 2, annotTypes); } Exports Gets the list of annotations of the specified types. Start page from which the annotations will be selected. End page to which the annotations will be selected. The array of needed annotation types. Annotations list. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); string[] annotTypes = new string[] {"Text", "Highlight"}; IList annotList = editor.ExtractAnnotations(1, 2 , annotTypes); Gets the list of annotations of the specified types. Start page from which the annotations will be selected. End page to which the annotations will be selected. The array of needed annotation types. Annotations list. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); AnnotationType[] annotTypes = new AnnotationType[] {AnnotationType.Text, AnnotationType.Highlight}; IList annotList = editor.ExtractAnnotations(1, 2 , annotTypes); Initializes new object. Initializes new object on base of the . Pdf document. Modifies the annotations of the specifed type on the specified page range. It supports to modify next annotation properties: Modified, Title, Contents, Color, Subject and Open. The start page number. The end page number. The annotation object contains new properties. PdfAnnotationEditor editor = new PdfAnnotationEditor(); editor.BindPdf("example.pdf"); TextAnnotation annot = new TextAnnotation(); annot.Modified = DateTime.Now; annot.Title = "NEW AUTHOR"; annot.Contents = "NEW CONTENTS"; annot.Color = Color.Red; annot.Subject = "NEW SUBJECT"; annot.Open = true; editor.ModifyAnnotations(1, 2, annot); editor.Save("example_out.pdf"); Redacts area on the specified page. All contents is removed. Index of the page. Area rectangle. Filling color. Represents a class to work with PDF file's bookmarks including create, modify, export, import and delete. Creates bookmarks for all pages. PdfBookmarkEditor editor = new PdfBookmarkEditor(); editor.BindPdf("example.pdf"); editor.CreateBookmarks(); editor.Save("example_out.pdf"); Creates bookmark for the specified page. The specified bookmark name. The specified desination page. PdfBookmarkEditor editor = new PdfBookmarkEditor(); editor.BindPdf("example.pdf"); editor.CreateBookmarkOfPage("bookmark for page 1", 1); editor.Save("example_out.pdf"); Creates the specified bookmark in the document. The method can be used for forming nested bookmarks hierarchy. The bookmark will be added to the document. PdfBookmarkEditor editor = new PdfBookmarkEditor(); editor.BindPdf("example.pdf"); Bookmark bm1=new Bookmark(); bm1.PageNumber=1; bm1.Title="First child"; Bookmark bm2=new Bookmark(); bm2.PageNumber=2; bm2.Title="Second child"; Bookmark bm=new Bookmark(); bm.Action="GoTo"; bm.PageNumber=1; bm.Title="Parent"; Bookmarks bms=new Bookmarks(); bms.Add(bm1); bms.Add(bm2); bm.ChildItem=bms; editor.CreateBookmarks(bm); editor.Save("example_out.pdf"); Create bookmarks for all pages with specified color and style (bold, italic). The color of title. The flag of bold attribution. The flag of italic attribution. PdfBookmarkEditor editor = new PdfBookmarkEditor(); editor.BindPdf("example.pdf"); editor.CreateBookmarks(System.Drawing.Color.Red, true, true); editor.Save("example_out.pdf"); Creates bookmarks for the specified pages. Bookmarks title array. Bookmarks desination page array. PdfBookmarkEditor editor = new PdfBookmarkEditor(); editor.BindPdf("example.pdf"); editor.CreateBookmarkOfPage("bookmark for page 1", 1); editor.Save("example_out.pdf"); Deletes all bookmarks of the PDF document. PdfBookmarkEditor editor = new PdfBookmarkEditor(); editor.BindPdf("example.pdf"); editor.DeleteBookmarks(); editor.Save("example_out.pdf"); Deletes the bookmark of the PDF document. The title of bookmark deleted. PdfBookmarkEditor editor = new PdfBookmarkEditor(); editor.BindPdf("example.pdf"); editor.DeleteBookmarks("existing bookmark title"); editor.Save("example_out.pdf"); Modifys bookmark title according to the specified bookmark title. Source bookmark title. Modified bookmark title. PdfBookmarkEditor editor = new PdfBookmarkEditor(); editor.BindPdf("example.pdf"); editor.ModifyBookmarks("existing bookmark title", "new bookmark title"); editor.Save("example_out.pdf"); Extracts bookmarks of all levels from the document. The bookmarks collection of all bookmarks that exist in the document. PdfBookmarkEditor editor = new PdfBookmarkEditor(); editor.BindPdf("example.pdf"); Bookmarks bms = editor.ExtractBookmarks(); foreach(Bookmark bm in bms) Console.WriteLine(bm.Title); Extracts bookmarks of all levels from the document. If true, extracts only upper level bookmarks. Else, extracts all bookmarks recursively. List of extracted bookmarks. Extracts the bookmarks with the specified title. Extracted item title. Bookmark collection has items with the same title. PdfBookmarkEditor editor = new PdfBookmarkEditor(); editor.BindPdf("example.pdf"); Bookmarks bms = editor.ExtractBookmarks("Title"); foreach(Bookmark bm in bms) Console.WriteLine(bm.Title); Extracts the children of a bookmark with a title like in specified bookamrk. The specified bookamrk. Bookmark collection with child bookmarks. PdfBookmarkEditor editor = new PdfBookmarkEditor(); editor.BindPdf("example.pdf"); Bookmark bookmark = new Bookmark(); bookmark.Title = "Title"; Bookmarks bms = editor.ExtractBookmarks(bookmark); foreach(Bookmark bm in bms) Console.WriteLine(bm.Title); Exports bookmarks to HTML file. The PDF file which bookmarks will be exported. The CSS file to display HTML file, can be null. PdfBookmarkEditor editor = new PdfBookmarkEditor(); editor.ExtractBookmarksToHTML("example.pdf", null); Exports bookmarks to XML file. The output XML file. PdfBookmarkEditor editor = new PdfBookmarkEditor(); editor.BindPdf("example.pdf"); editor.ExportBookmarksToXML("bookmarks.xml"); Exports bookmarks to XML stream. Output stream where data will be stored. Imports bookmarks to the document from XML file. The XML file containing bookmarks list. PdfBookmarkEditor editor = new PdfBookmarkEditor(); editor.BindPdf("example.pdf"); editor.ImportBookmarksWithXML("bookmarks.xml"); editor.Save("example_out.pdf"); Imports bookmarks to the document from XML file. Stream with bookmarks data. Initializes new object. Initializes new object on base of the . Pdf document. Exports bookmarks to HTML file. Input PDF file which bookmarks will be exported. Output HTML file PdfBookmarkEditor.ExtractBookmarksToHTML("example.pdf", "bookmarks.html"); Represents a class to edit PDF file's content. Gets or sets text search options. Gets or sets text edit options. Gets or sets text replace options. A set of parameters for replace text operation Binds a PDF file for editing. A PDF file to be edited. Binds a PDF stream for editing. A PDF stream to be edited. Extracts the collection of Link instances contained in PDF document. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); IList links = editor.ExtractLink(); foreach (object obj in links) { Link link = (Link)obj; // work with Link instance } The collection of Link objects Creates a web link in PDF document. The rectangle for active click. The web link destination. The number of original page on which rectangle bound with web link will be created. The colour of rectangle for active click. The array of actions (members of PredefinedAction enum) corresponding to executing menu items in Acrobat viewer. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateWebLink(new System.Drawing.Rectangle(0, 0, 100, 100), "http://www.aspose.com", 1, System.Drawing.Color.Red, new Enum[] { PredefinedAction.FirstPage, PredefinedAction.PrintDialog }); editor.Save("example_out.pdf"); Creates a web link in PDF document. The rectangle for active click. The web link destination. The number of original page where rectangle bound with web link will be created. The colour of rectangle for active click. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateWebLink(new System.Drawing.Rectangle(0, 0, 100, 100), "http://www.aspose.com", 1, System.Drawing.Color.Red }); editor.Save("example_out.pdf"); Creates a web link in PDF document. The rectangle for active click. The web link destination. The number of original page where rectangle bound with web link will be created. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateWebLink(new System.Drawing.Rectangle(0, 0, 100, 100), "http://www.aspose.com", 1 }); editor.Save("example_out.pdf"); Creates a local link in PDF document. The rectangle for active click. The destination page. The number of original page where rectangle bound with local link will be created. The colour of rectangle for active click. The array of actions (members of PredefinedAction enum) corresponding to executing menu items in Acrobat viewer. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateLocalLink(new System.Drawing.Rectangle(0, 0, 100, 100), 2, 1, System.Drawing.Color.Red, new Enum[] { PredefinedAction.FirstPage, PredefinedAction.PrintDialog }); editor.Save("example_out.pdf"); Creates a local link in PDF document. The rectangle for active click. The destination page. The number of original page where rectangle bound with local link will be created. The colour of rectangle for active click. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateLocalLink(new System.Drawing.Rectangle(0, 0, 100, 100), 2, 1, System.Drawing.Color.Red }); editor.Save("example_out.pdf"); Creates a link to another PDF document page. The rectangle for active click. The PDF document which page will be opened. The number of original page where rectangle bound with link will be created. The destination page. The colour of rectangle for active click. The array of actions (members of PredefinedAction enum) corresponding to executing menu items in Acrobat viewer. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreatePdfDocumentLink(new System.Drawing.Rectangle(0, 0, 100, 100), "another_example.pdf", 1, 1, System.Drawing.Color.Red, new Enum[] { PredefinedAction.FirstPage, PredefinedAction.PrintDialog }); editor.Save("example_out.pdf"); Creates a link to another PDF document page. The rectangle for active click. The PDF document which page will be opened. The number of original page where rectangle bound with link will be created. The destination page. The colour of rectangle for active click. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreatePdfDocumentLink(new System.Drawing.Rectangle(0, 0, 100, 100), "another_example.pdf", 1, 1, System.Drawing.Color.Red }); editor.Save("example_out.pdf"); Creates a link to another PDF document page. The rectangle for active click. The PDF document which page will be opened. The number of original page where rectangle bound with link will be created. The destination page. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreatePdfDocumentLink(new System.Drawing.Rectangle(0, 0, 100, 100), "another_example.pdf", 1, 1 }); editor.Save("example_out.pdf"); Creates a link to custom actions in PDF document. The rectangle for active click. The number of original page where rectangle bound with link will be created. The colour of rectangle for active click. The array of actions (members of PredefinedAction enum) corresponding to executing menu items in Acrobat viewer./// PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateCustomActionLink(new System.Drawing.Rectangle(0, 0, 100, 100), 1, System.Drawing.Color.Red, new Enum[] { PredefinedAction.FirstPage, PredefinedAction.PrintDialog }); editor.Save("example_out.pdf"); Creates a link to launch an application in PDF document. The rectangle for active click. The path of application to be launched. The number of original page where rectangle bound with link will be created. The colour of rectangle for active click. The array of actions (members of PredefinedAction enum) corresponding to executing menu items in Acrobat viewer./// PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateApplicationLink(new System.Drawing.Rectangle(0, 0, 100, 100), "explorer", 1, System.Drawing.Color.Red, new Enum[] { PredefinedAction.FirstPage, PredefinedAction.PrintDialog }); editor.Save("example_out.pdf"); Creates a link to launch an application in PDF document. The rectangle for active click. The path of application to be launched. The number of original page where rectangle bound with link will be created. The colour of rectangle for active click. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateApplicationLink(new System.Drawing.Rectangle(0, 0, 100, 100), "explorer", 1, System.Drawing.Color.Red }); editor.Save("example_out.pdf"); Creates a link to launch an application in PDF document. The rectangle for active click. The path of application to be launched. The number of original page where rectangle bound with link will be created. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateApplicationLink(new System.Drawing.Rectangle(0, 0, 100, 100), "explorer", 1 }); editor.Save("example_out.pdf"); Creates a link to JavaScript in PDF document. The JavaScript code. The rectangle for active click. The number of original page where rectangle bound with link will be created. The colour of rectangle for active click. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateJavaScriptLink("app.alert('welcome to aspose!');", new System.Drawing.Rectangle(0, 0, 100, 100), 1, System.Drawing.Color.Red }); editor.Save("example_out.pdf"); Creates text annotation in PDF document The annotation rectangle defining the location of the annotation on the page. The title of the annotation. The contents of the annotation. A flag specifying whether the annotation should initially be displayed open. The name of an icon will be used in displaying the annotation. This value can be: "Comment", "Key", "Note", "Help", "NewParagraph", "Paragraph", "Insert" The number of original page where the text annotation will be created. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateText(new System.Drawing.Rectangle(0, 0, 100, 100), "Welcome to Aspose", "You are welcome to Aspose!", true, "Key", 1); editor.Save("example_out.pdf"); Creates free text annotation in PDF document The annotation rectangle defining the location of the annotation on the page. The contents of the annotation. The number of original page where the text annotation will be created. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateFreeText(new System.Drawing.Rectangle(0, 0, 100, 100), "Welcome to Aspose", 1); editor.Save("example_out.pdf"); Creates markup annotation it PDF document. The rectangle defining the location of the annotation on the page. The contents of the annotation. The type of markup annotation. Can be 0 (Highlight), 1 (Underline), 2 (StrikeOut), 3 (Squiggly). The number of original page where the annotation will be created. The color of markup. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateMarkup(new System.Drawing.Rectangle(0, 0, 100, 100), "Welcome to Aspose", 0, 1, System.Drawing.Color.Red); editor.Save("example_out.pdf"); Creates popup annotation in PDF document. The annotation rectangle defining the location of the annotation on the page. The contents of the annotation. A flag specifying whether the pop-up annotation should initially be displayed open. The number of original page where the annotation will be created. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreatePopup(new System.Drawing.Rectangle(0, 0, 100, 100), "Welcome to Aspose", true, 1); editor.Save("example_out.pdf"); Creates file attachment annotation. The annotation rectangle defining the location of the annotation on the page. The contents of the annotation. The path of the file will be attached. The number of original page where the annotation will be created. The name of an icon will be used in displaying the annotation. This value can be: "Graph", "PushPin", "Paperclip", "Tag". PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateFileAttachment(new System.Drawing.Rectangle(0, 0, 100, 100), "Welcome to Aspose", "attachment_file.pdf", 1, "Graph"); editor.Save("example_out.pdf"); Creates file attachment annotation. The annotation rectangle defining the location of the annotation on the page. The contents of the annotation. The path of the file will be attached. The number of original page where the annotation will be created. The name of an icon will be used in displaying the annotation. This value can be: "Graph", "PushPin", "Paperclip", "Tag". Icon's opacity from 0 to 1: 0 - completely transparant, 1 - completely opaque. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateFileAttachment(new System.Drawing.Rectangle(0, 0, 100, 100), "Welcome to Aspose", "attachment_file.pdf", 1, "Graph", 0.5); editor.Save("example_out.pdf"); Creates file attachment annotation. The annotation rectangle defining the location of the annotation on the page. The contents of the annotation. The attachment file stream. The attachment name. The number of original page where the annotation will be created. The name of an icon will be used in displaying the annotation. This value can be: "Graph", "PushPin", "Paperclip", "Tag". PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); using(System.IO.FileStream attStream = System.IO.File.OpenRead("attachment_file.pdf")) { editor.CreateFileAttachment(new System.Drawing.Rectangle(0, 0, 100, 100), "Welcome to Aspose", attStream, "attachment_file.pdf", 1, "Graph"); editor.Save("example_out.pdf"); } Creates file attachment annotation. The annotation rectangle defining the location of the annotation on the page. The contents of the annotation. The attachment file stream. The attachment name. The number of original page where the annotation will be created. The name of an icon will be used in displaying the annotation. This value can be: "Graph", "PushPin", "Paperclip", "Tag". Icon's opacity from 0 to 1: 0 - completely transparant, 1 - completely opaque. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); using(System.IO.FileStream attStream = System.IO.File.OpenRead("attachment_file.pdf")) { editor.CreateFileAttachment(new System.Drawing.Rectangle(0, 0, 100, 100), "Welcome to Aspose", attStream, "attachment_file.pdf", 1, "Graph", 0.5); editor.Save("example_out.pdf"); } Adds document attachment with no annotation. The path of the file will be attached. The description information. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.AddDocumentAttachment("attachment_file.pdf", "description of attachment_file"); editor.Save("example_out.pdf"); Adds document attachment with no annotation. The stream of the file will be attached. The attachment name. The description information. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); using(System.IO.FileStream attStream = System.IO.File.OpenRead("attachment_file.pdf")) { editor.AddDocumentAttachment(attStream, "attachment_file.pdf", "description of attachment_file"); editor.Save("example_out.pdf"); } Deletes all attachments in PDF document. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.DeleteAttachments(); editor.Save("example_out.pdf"); Creates line annotation. The annotation rectangle defining the location of the annotation on the page. The contents of the annotation. The starting horizontal coordinate of the line. The starting vertical coordinate of the line. The ending horizontal coordinate of the line. The ending vertical coordinate of the line. The number of original page where the annotation will be created. The border width in points. If this value is 0 no border is drawn. Default value is 1. The color of line. The border style specifying the width and dash pattern to be used in drawing the line. This value can be: "S" (Solid), "D" (Dashed), "B" (Beveled), "I" (Inset), "U" (Underline). A dash array defining a pattern of dashes and gaps to be used in drawing a dashed border. If it is used, borderSyle must be accordingly set to "D". An array of two values respectively specifying the beginning and ending style of the drawing line. The values can be: "Square", "Circle", "Diamond", "OpenArrow", "ClosedArrow", "None", "Butt", "ROpenArrow", "RClosedArrow", "Slash". PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateLine(new System.Drawing.Rectangle(0, 0, 100, 100), "Welcome to Aspose", 0, 0, 100, 100, 1, 1, System.Drawing.Color.Red, "D", new int[] {2, 3}, new string[] {"OpenArrow", "ClosedArrow"}); editor.Save("example_out.pdf"); Creates square-circle annotation. The annotation rectangle defining the location of the annotation on the page. The contents of the annotation. The colour of square or circle. True (square), false (sircle). The number of original page where the annotation will be created. The border width of square or circle. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateSquareCircle(new System.Drawing.Rectangle(0, 0, 100, 100), "Welcome to Aspose", System.Drawing.Color.Red, false, 1, 5); editor.Save("example_out.pdf"); Creates curve annotation. The instance of LineInfo class. The number of original page where the annotation will be created. The annotation rectangle defining the location of the annotation on the page. The contents of the annotation. PdfContentEditor editor = new PdfContentEditor(); newApiEditor.BindPdf("example.pdf"); LineInfo lineInfo = new LineInfo(); lineInfo.VerticeCoordinate = new float[] { 0, 0, 100, 100 }; //x1, y1, x2, y2, .. xn, yn lineInfo.Visibility = true; editor.DrawCurve(lineInfo, 1, new System.Drawing.Rectangle(0, 0, 0, 0), "Welcome to Aspose"); editor.Save("example_out.pdf"); Creates polygon annotation. The instance of LineInfo class. The number of original page where the annotation will be created. The annotation rectangle defining the location of the annotation on the page. The contents of the annotation. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); LineInfo lineInfo = new LineInfo(); lineInfo.VerticeCoordinate = new float[] { 0, 0, 100, 100, 100, 50 }; lineInfo.Visibility = true; editor.CreatePolygon(lineInfo, 1 , new System.Drawing.Rectangle(0, 0, 0, 0), "Welcome to Aspose"); editor.Save("example_out.pdf"); Creates polyline annotation. The instance of LineInfo class. The number of original page where the annotation will be created. The annotation rectangle defining the location of the annotation on the page. The contents of the annotation. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); LineInfo lineInfo = new LineInfo(); lineInfo.VerticeCoordinate = new float[] { 0, 0, 100, 100, 100, 50 }; lineInfo.Visibility = true; editor.CreatePolyLine(lineInfo, 1 , new System.Drawing.Rectangle(0, 0, 0, 0), "Welcome to Aspose"); editor.Save("example_out.pdf"); Creates caret annotation. The number of original page where the annotation will be created. The annotation rectangle defining the location of the annotation on the page. The actual boundaries of the underlying caret. A symbol will be associated with the caret. Value can be: "P" (Paragraph), "None". The contents of the annotation. The colour of the annotation. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateCaret(1, new System.Drawing.Rectangle(50, 50, 100, 100), new System.Drawing.Rectangle(60, 60, 70, 70), "None", "Welcome to Aspose", System.Drawing.Color.Red); editor.Save("example_out.pdf"); Creates a rubber stamp annotation. The number of original page where the annotation will be created. The annotation rectangle defining the location of the annotation on the page. An icon is to be used in displaying the annotation. Default value: 'Draft'." The contents of the annotation. The colour of the annotation. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateRubberStamp(1, System.Drawing.Rectangle(0, 0, 100, 100), "Welcome to Aspose", System.Drawing.Color.Red); editor.Save("example_out.pdf"); Creates a rubber stamp annotation. The number of original page where the annotation will be created. The annotation rectangle defining the location of the annotation on the page. The contents of the annotation. The colour of the annotation. The path of appearance file. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateRubberStamp(1, System.Drawing.Rectangle(0, 0, 100, 100), "Welcome to Aspose", System.Drawing.Color.Red, "appearance_file.pdf"); editor.Save("example_out.pdf"); Creates a rubber stamp annotation. The number of original page where the annotation will be created. The annotation rectangle defining the location of the annotation on the page. The contents of the annotation. The colour of the annotation. The stream of appearance file. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); using (System.IO.FileStream appStream = File.OpenRead("appearance_file.pdf")) { editor.CreateRubberStamp(1, System.Drawing.Rectangle(0, 0, 100, 100), "Welcome to Aspose", System.Drawing.Color.Red, appStream); editor.Save("example_out.pdf"); } Creates a bookmark with the specified action. The title of the bookmark. The colour of the bookmark's title. The flag of bold attribution. The flag of italic attribution. Another file or application required when the action type is "GoToR" or "Launch". The action type. The value can be: "GoToR", "Launch", "GoTo", "URI". The local destination or remote destination or URL. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateBookmarksAction("bookmark title", System.Drawing.Color.Red, true, true, null, "GoTo", 1/*page number*/); editor.Save("example_out.pdf"); Adds additional action for document event. The document event types. The code of JavaScript. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.AddDocumentAdditionalAction(PdfContentEditor.DocumentClose, "app.alert('Good-bye!');"); editor.Save("example_out.pdf"); Removes open action from the document. This operation is useful when concatenating multiple documents that use explicit 'GoTo' action on startup. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.RemoveDocumentOpenAction(); editor.Save("example_out.pdf"); Changes the view preference. The view attribution defined in the ViewerPreference class. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.ChangeViewerPreference(ViewerPreference.HideMenubar); editor.ChangeViewerPreference(ViewerPreference.PageModeUseNone); editor.Save("example_out.pdf"); Returns the view preference. Returns set of ViewerPrefernece flags PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); int prefValue = editor.GetViewerPreference(); if ((prefValue & ViewerPreference.PageModeUseOutline) != 0) { // ... } Replaces the specified image on the specified page of PDF document with another image. The number of page on which the image is replaced. The index of the image object must be replaced. The image file will be used for replacing. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.ReplaceImage(1, 1, "image.jpg"); editor.Save("example_out.pdf"); Deletes the specified images on the specified page. The number of page on which images must be deleted. An array repsents images' indexes. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.DeleteImage(1, new int[] {1, 2}); editor.Save("example_out.pdf"); Deletes all images from PDF document. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.DeleteImage(); editor.Save("example_out.pdf"); Replaces text in the PDF file on the specified page. object (font family, color) can be specified to replaced text. The example demonstrates how to replace text on the first page of the PDF document and set text properties for the new text. // open document Document doc = new Document(inFile); // Create font and mark it to be embedded Aspose.Pdf.Text.Font font = FontRepository.FindFont("Courier New"); font.IsEmbedded = true; // create PdfContentEditor object to edit text PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf(doc); // create textState object TextState textState = new TextState(); textState.Font = font; textState.FontSize = 17; textState.FontStyle = FontStyle.Bold | FontStyle.Italic; textState.ForegroundColor = Color.Red; // change text with specified font editor.ReplaceText("hello world", 1, "hi world", textState); // save document doc.Save(outFile); The string to be replaced. Page number (0 means "all pages"). The replaced string. Text state (Text Color, Font etc). Returns true if replacement was made. Replaces text in the PDF file. The example demonstrates how to replace text in PDF document. // open document Document doc = new Document(inFile); // create PdfContentEditor object to edit text PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf(doc); // change text editor.ReplaceText("hello world", "hi world"); // save document doc.Save(outFile); The string to be replaced. Replacing string. Returns true if replacement was made. Replaces text in the PDF file on the specified page. The example demonstrates how to replace text in PDF document on the specified page. // open document Document doc = new Document(inFile); // create PdfContentEditor object to edit text PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf(doc); // change text editor.ReplaceText("hello world", 1, "hi world"); // save document doc.Save(outFile); The sting to be replaced. Page number (0 for all pages) Replacing string. Returns true if replacement was made. Replaces text in the PDF file using specified object. The example demonstrates how to replace text and set text properties for the new text. // open document Document doc = new Document(inFile); // Create font and mark it to be embedded Aspose.Pdf.Text.Font font = FontRepository.FindFont("Courier New"); font.IsEmbedded = true; // create PdfContentEditor object to edit text PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf(doc); // create textState object TextState textState = new TextState(); textState.Font = font; textState.FontStyle = FontStyle.Bold | FontStyle.Italic; // change text with specified font editor.ReplaceText("hello world", "hi world", textState); // save document doc.Save(outFile); String to be replaced Replacing string Text state (Text Color, Font etc) Returns true if replacement was made. Creates Movie Annotations. The annotation rectangle defining the location of the annotation on the page. The path of movie file to be played. The page in which the Line annotation is created. Creates Sound Annotations. The annotation rectangle defining the location of the annotation on the page. The file path of sound file. The name of an icon to be used in displaying the annotation,include:Speaker and Mic. The page in which the Sound annotation is created. The sampling rate, in samples per second. Deletes multiple stamps on the specified page by stamp indexes. Page number where stamp will be deleted. Stamp indexes. PdfContentEditor contentEditor = new PdfContentEditor(); contentEditor.BindPdf("file.pdf"); contentEditor.DeleteStamp(1, new int[] { 2, 3, 5} ); contentEditor.Save("outfile.pdf"); Deletes stamps with specified IDs from all pages of the document. Array of stamp IDs. PdfContentEditor contentEditor = new PdfContentEditor(); contentEditor.BindPdf("file.pdf"); contentEditor.DeleteStampByIds(new int[] { 102, 103 } ); contentEditor.Save("outfile.pdf"); Deletes stamps on the specified page by multiple stamp IDs. Page number where stamps will be deleted. Array of stamp IDs. PdfContentEditor contentEditor = new PdfContentEditor(); contentEditor.BindPdf("file.pdf"); contentEditor.DeleteStampByIds(1, new int[] { 100, 101 } ); contentEditor.Save("outfile.pdf"); Deletes stamp on the specified page by stamp ID. Page number where stamp will be deleted. Identifier of stanp which should be deleted. PdfContentEditor contentEditor = new PdfContentEditor(); contentEditor.BindPdf("file.pdf"); contentEditor.DeleteStampById(1, 100); contentEditor.Save("outfile.pdf"); Hides the stamp. After hiding, stamp visibility may be restored with ShowStampById method. Number of the page. Identifier of stamp which should be hidden. Shows stamp which was hidden by HiddenStampById. Number of the page. Identifier of stamp which should be shown. Changes position of the stamp on page. Numer of page. Identifier of stamp which should be moved. New stamp horizontal pozition on the page. New stamp vertical position on the page. Changes position of the stamp on page. Number of page. Index of stamp on the page. New stamp horizontal position. New stamp vertical position. Delete stamp by ID from all pages of the document. Identifier of stamp which should be deleted. PdfContentEditor contentEditor = new PdfContentEditor(); contentEditor.BindPdf("file.pdf"); contentEditor.DeleteStampById(100); contentEditor.Save("outfile.pdf"); A document event type. Opens a document. A document event type. Closes a document. A document event type. Excute a action before saving. A document event type. Excute a action after saving. A document event type. Excute a action before printing. A document event type. Excute a action after printing. The constructor of the PdfContentEditor object. Initializes new object on base of the . Pdf document. Creates a local link in PDF document. The rectangle for active click. The destination page. The number of original page where rectangle bound with local link will be created. PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf("example.pdf"); editor.CreateLocalLink(new System.Drawing.Rectangle(0, 0, 100, 100), 2, 1}); editor.Save("example_out.pdf"); Replaces text in the PDF file and sets font size. The example demonstrates how to replace text and set font size for the new text. // open document Document doc = new Document(inFile); // Create font and mark it to be embedded Aspose.Pdf.Text.Font font = FontRepository.FindFont("Courier New"); font.IsEmbedded = true; // create PdfContentEditor object to edit text PdfContentEditor editor = new PdfContentEditor(); editor.BindPdf(doc); // change text with specified font editor.ReplaceText("hello world", "hi world", 14); // save document doc.Save(outFile); String to be replaced. Replacing string. Font size. Returns true if replacement was made. Returns array of stamps on the page. Page number where stamps will be searched. Array of stamps. Closes opened document. Represents a class to convert a pdf file's each page to images, supporting BMP, JPEG, PNG and TIFF now. Supported content in pdfs: pictures, form, comment. Gets or sets the page coordinate type (Media/Crop boxes). CropBox value is used by default. Gets or sets flag that controls visibility of hidden areas on the page. Gets or sets rendering options. Gets or sets form presentation mode. Gets or sets resolution during convertting. The higher resolution, the slower convertting speed. The default value is 150. Gets or sets start position which you want to convert. The minimal value is 1. Gets or sets end position which you want to convert. Gets or sets document OwnerPassword. Gets or sets document UserPassword. Gets the page count. Do some initial works for converting a pdf document to images. [C#] PdfConverter converter = new PdfConverter(); converter.BindPdf(@"D:\Test\test.pdf"); converter.DoConvert(); String prefix = @"D:\Test\"; String suffix = ".jpg"; int imageCount = 1; while (converter.HasNextImage()) { converter.GetNextImage(prefix + imageCount + suffix); imageCount++; } [Visual Basic] Dim converter As PdfConverter = New PdfConverter() converter.BindPdf("D:\Test\test.pdf") converter.DoConvert() Dim prefix As String = "D:\Test\" Dim suffix As String = ".jpg" Dim imageCount As Integer = 1 While converter.HasNextImage() converter.GetNextImage(prefix + imageCount + suffix) imageCount = imageCount + 1 End While Converts each pages of a pdf document to images and saves images to a single TIFF file. The file to save the TIFF image. [C#] PdfConverter converter = new PdfConverter(); converter.BindPdf(@"D:\Test\test.pdf"); converter.DoConvert(); converter.SaveAsTIFF(@"D:\Test\test.tiff"); [Visual Basic] Dim converter As PdfConverter = New PdfConverter() converter.BindPdf("D:\Test\test.pdf") converter.DoConvert() converter.SaveAsTIFF(@"D:\Test\test.tiff") Converts each pages of a pdf document to images and saves images to a single TIFF file. The output file. Type of the compression. [C#] PdfConverter converter = new PdfConverter(); converter.BindPdf(@"D:\Test\test.pdf"); converter.DoConvert(); converter.SaveAsTIFF(@"D:\Test\test.tiff"); [Visual Basic] Dim converter As PdfConverter = New PdfConverter() converter.BindPdf("D:\Test\test.pdf") converter.DoConvert() converter.SaveAsTIFF(@"D:\Test\test.tiff") Converts each pages of a pdf document to images with dimensions, and saves images to a single TIFF file. The file name to save the TIFF image The image width, the unit is pixel. The image height, the unit is pixel. Converts each pages of a pdf document to images with page size and saves images to a single TIFF file. The file name to save the TIFF image The page size of the image. Converts each pages of a pdf document to images with page size and saves images to a single TIFF file. The file name to save the TIFF image The page size of the image. Settings object that defines TIFF parameters. Converts each pages of a pdf document to images with dimensions, and saves images to a single TIFF file. The file name to save the TIFF image The image width, the unit is pixel. The image height, the unit is pixel. Type of the compression. Converts each pages of a pdf document to images with dimensions, and saves images to a single TIFF file. The file name to save the TIFF image The image width, the unit is pixel. The image height, the unit is pixel. Settings object that defines TIFF parameters. Converts each pages of a pdf document to images with dimensions, and saves images to a single TIFF file. The file name to save the TIFF image The image width, the unit is pixel. The image height, the unit is pixel. Settings object that defines TIFF parameters. External converter Converts each pages of a pdf document to images and save images to a single TIFF ClassF file. The stream to save the TIFF image. The image width, the unit is pixel. The image height, the unit is pixel. [C#] PdfConverter converter = new PdfConverter(); converter.BindPdf(@"D:\Test\test.pdf"); converter.DoConvert(); converter.SaveAsTIFFClassF(@"D:\Test\test.tiff",204,196); [Visual Basic] Dim converter As PdfConverter = New PdfConverter() converter.BindPdf("D:\Test\test.pdf") converter.DoConvert() converter.SaveAsTIFFClassF(@"D:\Test\test.tiff",204,196) Converts each pages of a pdf document to images and save images to a single TIFF ClassF file. The stream to save the TIFF image. The page size of the image. Converts each pages of a pdf document to images and save images to a single TIFF ClassF stream. The stream to save the TIFF image. The image width, the unit is pixel. The image height, the unit is pixel. Converts each pages of a pdf document to images and save images to a single TIFF ClassF stream. The stream to save the TIFF image. The page size of the image. Converts each pages of a pdf document to images and saves images to a single TIFF stream. The stream to save the TIFF image. Converts each pages of a pdf document to images and saves images to a single TIFF file. The output stream. Type of the compression. Converts each pages of a pdf document to images with page size and saves images to a single TIFF stream. The stream to save the TIFF image. The page size of the image. Converts each pages of a pdf document to images with page size and saves images to a single TIFF stream. The stream to save the TIFF image. The page size of the image. Settings object that defines TIFF parameters. Converts each pages of a pdf document to images with dimensions, and saves images to a single TIFF stream. The stream to save the TIFF image. The image width, the unit is pixel. The image height, the unit is pixel. Converts each pages of a pdf document to images with dimensions, and saves images to a single TIFF stream. The stream to save the TIFF image. The image width, the unit is pixel. The image height, the unit is pixel. Type of the compression. Converts each pages of a pdf document to images with dimensions, and saves images to a single TIFF stream. The stream to save the TIFF image. The image width, the unit is pixel. The image height, the unit is pixel. Settings object that defines TIFF parameters. Converts each pages of a pdf document to images with dimensions, and saves images to a single TIFF stream. The stream to save the TIFF image. The image width, the unit is pixel. The image height, the unit is pixel. Settings object that defines TIFF parameters. External converter Indicates whether the pdf file has more images or not. Can get more images or not, true if can, or false. Saves image to file with default image format - jpeg. The file path and name to save the image. Saves image to file with ith given page size and default image format - jpeg. The file path and name to save the image. The page size of the image. Saves image to file with the givin image format. The file path and name to save the image. The format of the image. [C#] PdfConverter converter = new PdfConverter(); converter.BindPdf(@"D:\Test\test.pdf"); converter.DoConvert(); String prefix = @"D:\Test\"; String suffix = ".png"; int imageCount = 1; while (converter.HasNextImage()) { converter.GetNextImage(prefix + imageCount + suffix, ImageFormat.Png); imageCount++; } [Visual Basic] Dim converter As PdfConverter = New PdfConverter() converter.BindPdf("D:\Test\test.pdf") converter.DoConvert() Dim prefix As String = "D:\Test\" Dim suffix As String = ".png" Dim imageCount As Integer = 1 While converter.HasNextImage() converter.GetNextImage(prefix + imageCount + suffix, ImageFormat.Png) imageCount = imageCount + 1 End While Saves image to file with given page size and image format. The file path and name to save the image. The page size of the image. The format of the image. Saves image to stream with default image format - jpeg. The stream to save the image. Saves image to stream with given page size. The stream to save the image. The page size of the image. Saves image to stream with given image format. The stream to save the image. The format of the image. Saves image to stream with given page size. The stream to save the image. The page size of the image. The format of the image. Saves image to file with the given image format, dimensions and quality. The file path and name to save the image. The format of the image. The image width, the unit is pixel. The image height, the unit is pixel. The Jpeg file's quality (0~100), 0 is lowest and 100 is highest [C#] PdfConverter converter = new PdfConverter(); converter.BindPdf(@"D:\Test\test.pdf"); converter.DoConvert(); String prefix = @"D:\Test\"; String suffix = ".jpg"; int imageCount = 1; while (converter.HasNextImage()) { converter.GetNextImage(prefix + imageCount + suffix, ImageFormat.Jpeg, 800, 1000, 50); imageCount++; } [Visual Basic] Dim converter As PdfConverter = New PdfConverter() converter.BindPdf("D:\Test\test.pdf") converter.DoConvert() Dim prefix As String = "D:\Test\" Dim suffix As String = ".jpg" Dim imageCount As Integer = 1 While converter.HasNextImage() converter.GetNextImage(prefix + imageCount + suffix, ImageFormat.Jpeg, 800, 1000, 50) imageCount = imageCount + 1 End While Saves image to stream with the givin image format, dimensions and quality. The stream to save the image. The format of the image. The image width, the unit is pixel. The image height, the unit is pixel. The Jpeg file's quality (0~100), 0 is lowest and 100 is highest Saves image to file with the givin image format, image size, and quality. The file path and name to save the image. The format of the image. The image width, the unit is pixels. The image height, the unit is pixels.. The Jpeg file's quality (0~100), 0 is lowest and 100 is highest [C#] PdfConverter converter = new PdfConverter(); converter.BindPdf(@"D:\Test\test.pdf"); converter.DoConvert(); String prefix = @"D:\Test\"; String suffix = ".jpg"; int imageCount = 1; float pixelX=800f; float pixelY=600f; while (converter.HasNextImage()) { converter.GetNextImage(prefix + imageCount + suffix, ImageFormat.Jpeg, pixelX, pixelY, 50); imageCount++; } [Visual Basic] Dim converter As PdfConverter = New PdfConverter() converter.BindPdf("D:\Test\test.pdf") converter.DoConvert() Dim prefix As String = "D:\Test\" Dim suffix As String = ".jpg" Dim pixelX As float =800 Dim pixelY As float=600 Dim imageCount As Integer = 1 While converter.HasNextImage() converter.GetNextImage(prefix + imageCount + suffix, ImageFormat.Jpeg, pixelX, pixelY, 50) imageCount = imageCount + 1 End While Saves image to stream with the givin image format, size and quality. The stream to save the image. The format of the image. The image width, the unit is pixel. The image height, the unit is pixel. The Jpeg file's quality (0~100), 0 is lowest and 100 is highest Binds a Pdf file for converting. The pdf file. Binds a Pdf Stream for convert. The pdf Stream. Initializes new object. Initializes new object on base of the . Pdf document. Close the instance of PdfConverter and release the resources. Converts each pages of a pdf document to images and save images to a single TIFF ClassF file. The stream to save the TIFF image. [C#] PdfConverter converter = new PdfConverter(); converter.BindPdf(@"D:\Test\test.pdf"); converter.DoConvert(); converter.SaveAsTIFFClassF(@"D:\Test\test.tiff"); [Visual Basic] Dim converter As PdfConverter = New PdfConverter() converter.BindPdf("D:\Test\test.pdf") converter.DoConvert() converter.SaveAsTIFFClassF(@"D:\Test\test.tiff") Converts each pages of a pdf document to images and save images to a single TIFF ClassF stream. The stream to save the TIFF image. Converts each pages of a pdf document to images with and saves images to a single TIFF file. The file name to save the TIFF image Settings object that defines TIFF parameters. Converts each pages of a pdf document to images with and saves images to a single TIFF file. The file name to save the TIFF image Settings object that defines TIFF parameters. External converter Converts each pages of a pdf document to images and saves images to a single TIFF stream. The stream to save the TIFF image. Settings object that defines TIFF parameters. Converts each pages of a pdf document to images and saves images to a single TIFF stream. The stream to save the TIFF image. Settings object that defines TIFF parameters. External converter Saves image to file with the given image format and dimensions. The file path and name to save the image. The format of the image. The image width, the unit is pixel. The image height, the unit is pixel. [C#] PdfConverter converter = new PdfConverter(); converter.BindPdf(@"D:\Test\test.pdf"); converter.DoConvert(); String prefix = @"D:\Test\"; String suffix = ".jpg"; int imageCount = 1; while (converter.HasNextImage()) { converter.GetNextImage(prefix + imageCount + suffix, ImageFormat.Jpeg, 800, 1000); imageCount++; } [Visual Basic] Dim converter As PdfConverter = New PdfConverter() converter.BindPdf("D:\Test\test.pdf") converter.DoConvert() Dim prefix As String = "D:\Test\" Dim suffix As String = ".jpg" Dim imageCount As Integer = 1 While converter.HasNextImage() converter.GetNextImage(prefix + imageCount + suffix, ImageFormat.Jpeg, 800, 1000) imageCount = imageCount + 1 End While Saves image to stream with the givin image format, size and quality. The stream to save the image. The format of the image. The image width, the unit is pixel. The image height, the unit is pixel. Saves image to stream with given image format and quality. The stream to save the image. The format of the image. The Jpeg file's quality (0~100), 0 is lowest and 100 is highest Saves image to stream with given page size, image format and quality. The stream to save the image. The page size of the image. The format of the image. The Jpeg file's quality (0~100), 0 is lowest and 100 is highest Saves image to file with given image format and quality. The file path and name to save the image. The format of the image. The Jpeg file's quality (0~100), 0 is lowest and 100 is highest Saves image to file with given page size, image format and quality. The file path and name to save the image. The page size of the image. The format of the image. The Jpeg file's quality (0~100), 0 is lowest and 100 is highest Merges list of image streams as one image stream. Png/jpg/tiff outputs formats are supported, in case of using non supported format output stream encoded as Jpeg by default. The list of image streams to merge. Image output format for merged stream. Merge mode. Used for Png/Jpg formats. Horizontal ratio to set canvas width for output image stream. Used for Png/Jpg formats with ImageMergeMode.Center only. Vertical ratio to set canvas height for output image stream. Used for Png/Jpg formats with ImageMergeMode.Center only. Image stream encoded as output image format. Merges list of tiff streams as one multiple frames tiff stream. The list of tiff streams. Multiple frames tiff stream. Class for extracting images and text from PDF document. Gets or sets start page in the page range where extracting operation will be performed. PdfExtractor ext = new PdfExtractor(); ext.BindBdf("sample.pdf"); ext.StartPage = 2; ext.EndPage = 5; ext.ExtractText(); Gets or sets end page in the page range where extracting operation will be performed. PdfExtractor ext = new PdfExtractor(); ext.BindBdf("sample.pdf"); ext.StartPage = 2; ext.EndPage = 3; ext.ExtractText(); Sets the mode for extract text's result. 0 is pure text mode and 1 is raw ordering mode. Default is 0. The example demonstratres the property usage in text extraction scenario. PdfExtractor extractor = new PdfExtractor(); extractor.BindPdf(@"D:\Text\text.pdf"); extractor.ExtractTextMode = 1; extractor.ExtractText(); extractor.GetText(@"D:\Text\text.txt"); Gets or sets text search options. Sets the mode for extract images process. Default value is ExtractImageMode.DefinedInResources that extracts all images defined in resources. To extract actually shown images ExtractImageMode.ActuallyUsed mode should be used. Is true when text has hebriew or arabic symbols. This case must be specially considered because string functions change their behaviour and start process text from right to left (except numbers and other non text chars). Extracts text from a Pdf document using Unicode encoding. First example demonstratres how to extract all the text from PDF file. PdfExtractor extractor = new PdfExtractor(); extractor.BindPdf(@"D:\Text\text.pdf"); extractor.ExtractText(); extractor.GetText(@"D:\Text\text.txt"); Dim extractor As PdfExtractor = New PdfExtractor() extractor.BindPdf("D:\Text\text.pdf") extractor.ExtractText() extractor.GetText("D:\Text\text.txt") Second example demonstratres how to extract each page's text into one txt file. PdfExtractor extractor = new PdfExtractor(); extractor.BindPdf(TestPath + @"Aspose.Pdf.Kit.Pdf"); extractor.ExtractText(); String prefix = TestPath + @"Aspose.Pdf.Kit"; String suffix = ".txt"; int pageCount = 1; while (extractor.HasNextPageText()) { extractor.GetNextPageText(prefix + pageCount + suffix); pageCount++; } Dim extractor As PdfExtractor = New PdfExtractor() extractor.BindPdf(TestPath + "Aspose.Pdf.Kit.Pdf") extractor.ExtractText() Dim prefix As String = TestPath + "Aspose.Pdf.Kit" Dim suffix As String = ".txt" Dim pageCount As Integer = 1 While extractor.HasNextPageText() extractor.GetNextPageText(prefix + pageCount + suffix) pageCount = pageCount + 1 End While Extracts text from a Pdf document using specified encoding. First example demonstratres how to extract all the text from PDF file. PdfExtractor extractor = new PdfExtractor(); extractor.BindPdf(@"D:\Text\text.pdf"); extractor.ExtractText(Encoding.Unicode); extractor.GetText(@"D:\Text\text.txt"); Dim extractor As PdfExtractor = New PdfExtractor() extractor.BindPdf("D:\Text\text.pdf") extractor.ExtractText(Encoding.Unicode) extractor.GetText("D:\Text\text.txt") Second example demonstratres how to extract each page's text into one txt file. PdfExtractor extractor = new PdfExtractor(); extractor.BindPdf(TestPath + @"Aspose.Pdf.Kit.Pdf"); extractor.ExtractText(Encoding.Unicode); String prefix = TestPath + @"Aspose.Pdf.Kit"; String suffix = ".txt"; int pageCount = 1; while (extractor.HasNextPageText()) { extractor.GetNextPageText(prefix + pageCount + suffix); pageCount++; } Dim extractor As PdfExtractor = New PdfExtractor() extractor.BindPdf(TestPath + "Aspose.Pdf.Kit.Pdf") extractor.ExtractText(Encoding.Unicode) Dim prefix As String = TestPath + "Aspose.Pdf.Kit" Dim suffix As String = ".txt" Dim pageCount As Integer = 1 While extractor.HasNextPageText() extractor.GetNextPageText(prefix + pageCount + suffix) pageCount = pageCount + 1 End While The encoding of the extracted text. Saves text to file. see also: The file path and name to save the text. Saves text to stream. see also: The stream to save the text. Bind input PDF file. PDF fiel to bind PdfExtractor ext = new PdfExtractor(); ext.BindPdf("sample.pdf"); Binds PDF document from stream. Stream containing PDF document data PdfExtractor ext = new PdfExtractor(); Stream stream = new FileStream("sample.pdf", FileMode.Open, FileAccess.Read); ext.BindPdf(stream); Extract images from PDF file. PdfExtractor extractor = new PdfExtractor(); extractor.BindPdf("sample.pdf"); extractor.ExtractImage(); int i = 1; while (extractor.HasNextImage()) { extractor.GetNextImage("image-" + i +".pdf"); } Checks if more images are accessible in PDF document. Note: ExtractImage must be called before using of this method. Trues if more images are accessible PdfExtractor extractor = new PdfExtractor(); extractor.BindPdf("sample.pdf"); extractor.ExtractImage(); int i = 1; while (extractor.HasNextImage()) { extractor.GetNextImage("image-" + i +".pdf"); } Retreives next image from PDF document. Note: ExtractImage must be called before using of this method. File where image will be stored True is image is successfully extracted PdfExtractor extractor = new PdfExtractor(); extractor.BindPdf("sample.pdf"); extractor.ExtractImage(); int i = 1; while (extractor.HasNextImage()) { extractor.GetNextImage("image-" + i +".pdf"); } Retreives next image from PDF document with given image format. Note: ExtractImage must be called before using of this method. File where image will be stored The format of the image. True is image is successfully extracted Retreive next image from PDF file and stores it into stream with given image format. Stream where image data will be saved The format of the image. True in case the image is successfully extracted. Retreive next image from PDF file and stores it into stream. Stream where image data will be saved True in case the image is successfully extracted. Returns list of attachments in PDF file. Note: ExtractAttachments must be called befor using this method. List of attachments Example demonstrates how to extract attachment names form PDF file. PdfExtractor extractor = new PdfExtractor(); extractor.BindPdf(TestSettings.GetInputFile("sample.pdf")); extractor.ExtractAttachment(); IList attachments = extractor.GetAttachNames(); foreach (string name in attachments) Console.WriteLine(name); Extracts attachments from a Pdf document. Extracts attachment to PDF file by attachment name. Name of attachment to extract Stores attachment into file. Directory path where attachment(s) will be stored. Null or empty string means attachment(s) will be placed in the application directory. Indicates that whether can get more texts or not. The example demonstratres the property usage in text extraction scenario. PdfExtractor extractor = new PdfExtractor(); extractor.BindPdf(TestPath + @"Aspose.Pdf.Kit.Pdf"); extractor.ExtractText(Encoding.Unicode); String prefix = TestPath + @"Aspose.Pdf.Kit"; String suffix = ".txt"; int pageCount = 1; while (extractor.HasNextPageText()) { extractor.GetNextPageText(prefix + pageCount + suffix); pageCount++; } Dim extractor As PdfExtractor = New PdfExtractor() extractor.BindPdf(TestPath + "Aspose.Pdf.Kit.Pdf") extractor.ExtractText(Encoding.Unicode) Dim prefix As String = TestPath + "Aspose.Pdf.Kit" Dim suffix As String = ".txt" Dim pageCount As Integer = 1 While extractor.HasNextPageText() extractor.GetNextPageText(prefix + pageCount + suffix) pageCount = pageCount + 1 End While Can get more texts or not, true is can, or false. Saves one page's text to file. The example demonstratres the GetNextPageText method usage in text extraction scenario. PdfExtractor extractor = new PdfExtractor(); extractor.BindPdf(TestPath + @"Aspose.Pdf.Kit.Pdf"); extractor.ExtractText(Encoding.Unicode); String prefix = TestPath + @"Aspose.Pdf.Kit"; String suffix = ".txt"; int pageCount = 1; while (extractor.HasNextPageText()) { extractor.GetNextPageText(prefix + pageCount + suffix); pageCount++; } Dim extractor As PdfExtractor = New PdfExtractor() extractor.BindPdf(TestPath + "Aspose.Pdf.Kit.Pdf") extractor.ExtractText(Encoding.Unicode) Dim prefix As String = TestPath + "Aspose.Pdf.Kit" Dim suffix As String = ".txt" Dim pageCount As Integer = 1 While extractor.HasNextPageText() extractor.GetNextPageText(prefix + pageCount + suffix) pageCount = pageCount + 1 End While The file path and name to save the text. Saves one page's text to stream. The example demonstratres the method usage in text extraction scenario. PdfExtractor extractor = new PdfExtractor(); extractor.BindPdf(TestPath + @"Aspose.Pdf.Kit.Pdf"); extractor.ExtractText(Encoding.Unicode); String prefix = TestPath + @"Aspose.Pdf.Kit"; String suffix = ".txt"; int pageCount = 1; while (extractor.HasNextPageText()) { FileStream fs = new FileStream(prefix + pageCount + suffix, FileMode.Create); extractor.GetNextPageText(prefix + pageCount + suffix); fs.Close(); pageCount++; } The stream to save the text. Initializes new object. Initializes new object on base of the . Pdf document. Saves text to stream. see also: The stream to save the text. If this parameter is true all Not ASCII simbols will be removed Saves all the attachment file to streams. The stream array of the attachment file in the pdf document. [C#] PdfExtractor extractor = new PdfExtractor(); extractor.BindPdf(path + "Attach.pdf"); extractor.ExtractAttachment(); IList names = extractor.GetAttachNames(); MemoryStream[] tempStreams = extractor.GetAttachment(); for (int i=0; i<tempStreams.Length; i++) { string name = (string)names[i]; FileStream fs = new FileStream(path + name,System.IO.FileMode.Create); byte[] tempBytes = new byte[4096]; tempStreams[i].Position = 0; for (; ; ) { int numOfBytes = tempStreams[i].Read(tempBytes, 0, 4096); if (numOfBytes < 1) break; fs.Write(tempBytes, 0, numOfBytes); } fs.Close(); } [Visual Basic] Dim extractor As PdfExtractor = New PdfExtractor() extractor.BindPdf(path + "Attach.pdf") extractor.ExtractAttachment() extractor.GetAttachment(path) Dim names As IList = extractor.GetAttachNames() Dim tempStreams() As MemoryStream = extractor.GetAttachment() for(Integer i = 0 i<tempStreams.Length i++) { Dim name As String = CType(names(i), String) Dim fs As FileStream = New FileStream(path + name,System.IO.FileMode.Create) Dim tempBytes() As Byte = New Byte(4096) {} tempStreams(i).Position = 0 for() { Dim numOfBytes As Integer = tempStreams(i).Read(tempBytes,0,4096) If numOfBytes < 1 Then break End If fs.Write(tempBytes, 0, numOfBytes) } fs.Close() } Gets the list of attachments. Returns a List<FileSpecificatio>>. Set or gets resolution for extracted images. Default value is 150. Images which have greater resolution value are more clear. However increasing resolution value results in increasing time and memory needed to extract images. Usually to get clear image it's enough to set resolution to 150 or 300. Gets or sets input file's password. Implements operations with PDF file: concatenation, splitting, extracting pages, making booklet, etc. Action performed when corrupted file was met in concatenation process. If corrupted file was met, then stop concatentation process and return error. If corrupted file was met, then don't stop concatenation and don't process corrupted file. List of corrupted files is accessible in Failures property. When corrupted object is met in source document, process will not stopped and corrupted object only is ignored. Gets log of conversion process. Optional contents of concatentated documents with equal names will be merged into one layer in resulstant document if this property is true. Else, layers with equal names will be save as different layers in resultant document. If true then outlines will be copied. If true then logical structure of the file is copied when concatenation is performed. If true, duplicate outlines are merged. If true, user rights of first document are applied to concatenated document. User rights of all other documents are ignored. If true, incremental updates are made during concatenation. Class which provides information about corrupted files in time of concatenation. Index of corrupted file. Exception thrown for this file which indicates problem with the file. Gets or sets optimization flag. Equal resource streams in resultant file are merged into one PDF object if this flag set. This allows to decrease resultant file size but may cause slower execution and larger memory requirements. Default value: false. Array of encountered problems when concatenation was performed. For every corrupted document from passed to Concatenate() function new CorruptedItem entry is created. This property may be used only when CorruptedFileAction is ConcatenateIgnoringCorrupted. //concatenate documents and show information about corrupted documents PdfFileEditor pfe = new PdfFileEditor(); pfe.CorruptedFileAction = PdfFileEditor.ConcatenateCorruptedFileActions.ConcatenateIgnoringCorrupted; if (pfe.CorruptedItems.Length >0) { foreach(PdfFileEditor.CorruptedItem item in pfe.CorruptedItems) { Console.WriteLine(item.Index + " reason: " + item.Exception); } } This property defines behavior when concatenating process met corrupted file. Possible values are: StopWithError and ConcatenateIgnoringCorrupted. Value of margin or content size specified in percents of default space units. This class is used in ContentsResizeParameters. Sets value in percents of page size. Sets value in default space units. Gets specified value. Use Unit property to get value units. Gets true if value is expressed in percents; False if value is expressed in default units. Initializes value in percents. Value in percents. New value instance. Initializes value in default space units. Value in units. New value instance. Initializes automatically calculated value. New value instance. Class for specifing page resize parameters. Allow to set the following parameters: Size of result page (width, height) in default space units or in percents of initial pages size; Left, Top, Bottom and Right margins in default space units or in percents of initial page size; Some values may be left null for automatic calculation. These values will be calculated from rest of page size after calculation explicitly specified values. For example: if page width = 100 and new page width specified 60 units then left and right margins are automatically calculated: (100 - 60) / 2 = 15. This class is used in ResizeContents method. Gets or sets left margin on the resultant page. Gets or sets right margin on the resultant page. Gets or sets top margin on the resultant page. Gets or sets bottom margin on the resultant page. Gets or sets width of the content of the source page on the resultant page. Gets or sets height of the content of the source page on the resultant page. Creates resize parameters where al values are set to "auto". Later margins and contents size may be specified if required. Creates resize parameters with specified margin values and contents size. Left margin value. Contents width. Right margin. Top margin. Contents height. Bottom margin. Empty values means that corresponding value calculated automatically Creates resize parameters with specifed margins value. Contents size is automatically calculated. Left margin. Right margin. Top margin. Bottom margin. Created resize parameters. Creates resize parameters. Margins are specified in percents of initial page size. Left margin (in percents of page width). Right margin (in percents of page height). Top margin (in percents of page height). Bottom margin (in percents of page height). Returns new resize parameters. Creates resize parameters with specified contents size. New width of contents. New height of contetns. Returns new resize parameters. Creates resize parameters with specified contents size in percents of initial page size. Margins are caculated automatically. New content width in percents. New contents height in percents. New resize parameters. Creates resize paramters for page resize. New page width in units. New page height in units. New resize paramteres. Creates resize paramters for page resize. New sizes are specified in percent. New page width in percents. New page height in percents. New resize paramteres. Sets owner's password if the source input Pdf file is encrypted. This property is not implemented yet. If set to true, exceptions are thrown if error occured. Else excetion are not thrown and methods return false if failed. PdfFileEditor pfe = new PdfFileEditor(); pfe.AllowConcatenatedException = true; Sets PDF file format. Result file will be saved in specified file format. If this property is not specified then file will be save in default PDF format without conversion. If set to true, streams are closed after operation. PdfFileEditor pfe = new PdfFileEditor(); pfe.CloseConcatenatedStreams = true; Format of the suffix which is added to field name to make it unique when forms are concatenated. This string must contain %NUM% substring which will be replaced with numbers. For example if UniqueSuffix = "ABC%NUM%" then for field "fieldName" names will be: fieldNameABC1, fieldNameABC2, fieldNameABC3 etc. PdfFileEditor ed = new PdfFileEditor(); ed.UniqueSuffix = "_%NUM%"; If true actions will be copied from source documents. Defaulkt value : true. If true then field names will be made unique when forms are concatenated. Suffixes will be added to field names, suffix template may be specified in UniqueSuffix property. Concatentates two files. First file to concatenate. Second file to concatenate. Output file. PdfFileEditor fileEditor = new PdfFileEditor(); fileEditor.Concatenate("file1.pdf", "file2.pdf", "outfile.pdf"); True if operation was succeeded. Concatenates two files. Stream of first file. Stream of second file. Stream where result file will be stored. True if operation was succeeded. PdfFileEditor fileEditor = new PdfFileEditor(); Stream stream1 = new FileStream("file1.pdf", FileMode.Open, FileAccess.Read); Stream stream2 = new FileStream("file2.pdf", FileMode.Open, FileAccess.Read); Stream outstream = new FileStream("outfile.pdf", FileMode.Create, FileAccess.Write); fileEditor.Concatenate(stream1, stream2, outstream); True if operation was succeeded. Concatenates documents. Array of source documents. Destination document. True if concatenation is successful. If this option used then destination document will be saved on disk periodically and further concatenation will appllied to it as incremental updates. Number of documents concatenated before new incremental update was made during concatenation when UseDiskBuffer is set to true. Concatenates files into one file. Array of files to concatenate. Name of output file. True if operation was succeeded. PdfFileEditor pfe = new PdfFileEditor(); pfe.Concatenate(new string[] { "src1.pdf", "src2.pdf" }, "dest.pdf"); Concatenates files Array of streams to be concatenated. Stream where result file will be stored. True if operation was succeeded. PdfFileEditor fileEditor = new PdfFileEditor(); Stream stream1 = new FileStream("file1.pdf", FileMode.Open, FileAccess.Read); Stream stream2 = new FileStream("file2.pdf", FileMode.Open, FileAccess.Read); Stream outstream = new FileStream("outfile.pdf", FileMode.Create, FileAccess.Write); fileEditor.Concatenate(new Stream[] { stream1, stream2 } , outstream); Merges two Pdf documents into a new Pdf document with pages in alternate ways and fill the blank places with blank pages. e.g.: document1 has 5 pages: p1, p2, p3, p4, p5. document2 has 3 pages: p1', p2', p3'. Merging the two Pdf document will produce the result document with pages:p1, p1', p2, p2', p3, p3', p4, blankpage, p5, blankpage. First file. Second file. PDF file with blank page. Result file. True if operation was succeeded. PdfFileEditor pfe = new PdfFileEditor(); pfe.Concatenate("src1.pdf", "src2.pdf", "blank.pdf", "dest.pdf"); Merges two Pdf documents into a new Pdf document with pages in alternate ways and fill the blank places with blank pages. e.g.: document1 has 5 pages: p1, p2, p3, p4, p5. document2 has 3 pages: p1', p2', p3'. Merging the two Pdf document will produce the result document with pages:p1, p1', p2, p2', p3, p3', p4, blankpage, p5, blankpage. The first Pdf Stream. The second Pdf Stream. The Pdf Stream with blank page Output Pdf Stream. True if operation was succeeded. PdfFileEditor fileEditor = new PdfFileEditor(); Stream stream1 = new FileStream("file1.pdf", FileMode.Open, FileAccess.Read); Stream stream2 = new FileStream("file2.pdf", FileMode.Open, FileAccess.Read); Stream blank = new FileStream("blank.pdf", FileMode.Open, FileAccess.Read); Stream outstream = new FileStream("outfile.pdf", FileMode.Create, FileAccess.Write); fileEditor.Concatenate(new Stream[] { stream1, stream2, blank } , outstream); Appends pages, which are chosen from array of documents in portStreams. The result document includes firstInputFile and all portStreams documents pages in the range startPage to endPage. Input Pdf stream. Documents to copy pages from. Page starts in portStreams documents. Page ends in portStreams documents . Output Pdf stream. True for success, or false. PdfFileEditor fileEditor = new PdfFileEditor(); Stream instream = new FileStream("input.pdf", FileMode.Open, FileAccess.Read); Stream stream1 = new FileStream("file1.pdf", FileMode.Open, FileAccess.Read); Stream stream2 = new FileStream("file2.pdf", FileMode.Open, FileAccess.Read); Stream outstream = new FileStream("outfile.pdf", FileMode.Create, FileAccess.Write); fileEditor.Append(instream, new Stream[] { stream1, stream2}, 3, 5, outstream); Appends pages, which are chosen from portFiles documents. The result document includes firstInputFile and all portFiles documents pages in the range startPage to endPage. Input Pdf file. Documents to copy pages from. Page starts in portFiles documents. Page ends in portFiles documents . Output Pdf document. True if operation was succeeded. PdfFileEditor fileEditor = new PdfFileEditor(); fileEditor.Append("input.pdf", new string[] { "file1.pdf", "file2.pdf"}, 3, 5, "outfile.pdf"); Appends pages, which are chosen from portFile within the range from startPage to endPage, in portFile at the end of firstInputFile. Input Pdf file. Pages from Pdf file. Page starts in portFile. Page ends in portFile. Output Pdf document. True if operation was succeeded. PdfFileEditor fileEditor = new PdfFileEditor(); fileEditor.Append("input.pdf", "file1.pdf", 3, 5, "outfile.pdf"); Appends pages,which are chosen from portStream within the range from startPage to endPage, in portStream at the end of firstInputStream. Input file Stream. Pages from Pdf file Stream. Page starts in portFile Stream. Page ends in portFile Stream. Output Pdf file Stream. True for success, or false. PdfFileEditor fileEditor = new PdfFileEditor(); Stream instream = new FileStream("input.pdf", FileMode.Open, FileAccess.Read); Stream stream1 = new FileStream("file1.pdf", FileMode.Open, FileAccess.Read); Stream outstream = new FileStream("outfile.pdf", FileMode.Create, FileAccess.Write); fileEditor.Append(instream, stream1, 3, 5, "outfile.pdf"); Inserts pages from an other file into the Pdf file at a position. Input Pdf file. Position in input file. The porting Pdf file. Start position in portFile. End position in portFile. Output Pdf file. True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); pfe.Insert("file1.pdf", 1, "file2.pdf", 2, 6, "out.pdf"); Inserts pages from an other file into the input Pdf file. Input Stream of Pdf file. Insert position in input file. Stream of Pdf file for pages. From which page to start. To which page to end. Output Stream. True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); Stream sourceStream = new FileStream("file1.pdf", FileMode.Open, FileAccess.Read); Stream insertedStream = new FileStream("file2.pdf", FileMode.Open, FileAccess.Read); Stream outStream = new FileStream("out.pdf", FileMode.Create, FileAccess.Write); pfe.Insert(sourceStream, 1, insertedStream, 2, 6, outStream); Inserts pages from an other file into the input Pdf file. Input Pdf file. Insert position in input file. Pages from the Pdf file. The page number of the ported in portFile. Output Pdf file. True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); Stream sourceStream = new FileStream("file1.pdf", FileMode.Open, FileAccess.Read); Stream insertedStream = new FileStream("file2.pdf", FileMode.Open, FileAccess.Read); Stream outStream = new FileStream("out.pdf", FileMode.Create, FileAccess.Write); pfe.Insert(sourceStream, 1, insertedStream, 2, 6, outStream); Inserts pages from an other file into the input Pdf file. Input Stream of Pdf file. Insert position in input file. Stream of Pdf file for pages. The page number of the ported in portFile. Output Stream. True if operation was succeeded. PdfFileEditor pfe = new PdfFileEditor(); Stream sourceStream = new FileStream("file1.pdf", FileMode.Open, FileAccess.Read); Stream insertedStream = new FileStream("file2.pdf", FileMode.Open, FileAccess.Read); Stream outStream = new FileStream("out.pdf", FileMode.Create, FileAccess.Write); pfe.Insert(sourceStream, 1, insertedStream, new int[] { 3, 4, 5}, outStream); Deletes pages specified by number array from input file, saves as a new Pdf file. Input file path. Index of page out of the input file. Output file path. True if operation was succeeded. PdfFileEditor pfe = new PdfFileEditor(); pfe.Delete("input.pdf", new int[] { 2, 3 }, "out.pdf"); Deletes pages specified by number array from input file, saves as a new Pdf file. Input file Stream. Index of page out of the input file. Output file stream. True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); Stream intputStream = new FileStream("input.pdf", FileMode.Open, FileAccess.Read); Stream outputStream = new FileStream("output.pdf", FileMode.Create, FileAccess.Write); pfe.Delete(inputStream, new int[] { 2, 3 }, outputStream); Extracts pages from input file,saves as a new Pdf file. Input Pdf file path. Start page number. End page number. Output Pdf file path. True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); pfe.Extract("input.pdf", 3, 7, "output.pdf"); Extracts pages specified by number array, saves as a new PDF file. Input file path. Index of page out of the input file. Output file path. True if operation was succeeded. PdfFileEditor pfe = new PdfFileEditor(); pfe.Extract("input.pdf", new int[] { 3, 5, 7 }, "output.pdf"); Extracts pages from input file,saves as a new Pdf file. Input file Stream. Start page number. End page number. Output Pdf file Stream. True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); Stream sourceStream = new FileStream("file1.pdf", FileMode.Open, FileAccess.Read); Stream outStream = new FileStream("out.pdf", FileMode.Create, FileAccess.Write); pfe.Extract(sourceStream, 1, 3, 6, outStream); Extracts pages specified by number array, saves as a new Pdf file. Input file Stream. Index of page out of the input file. Output file stream. True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); Stream sourceStream = new FileStream("file1.pdf", FileMode.Open, FileAccess.Read); Stream outStream = new FileStream("out.pdf", FileMode.Create, FileAccess.Write); pfe.Extract(sourceStream, new int[] { 3, 5, 8 }, outStream); Splits Pdf file from first page to specified location,and saves the front part as a new file. Source Pdf file. The splitting point. Output Pdf file. True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); pfe.SplitFromFirst("input.pdf", 5, "out.pdf"); Splits from start to specified location,and saves the front part in output Stream. Source Pdf file Stream. The splitting point. Output file Stream. True for success, or false. The streams are NOT closed after this operation. PdfFileEditor pfe = new PdfFileEditor(); Stream sourceStream = new FileStream("file1.pdf", FileMode.Open, FileAccess.Read); Stream outStream = new FileStream("out.pdf", FileMode.Create, FileAccess.Write); pfe.SplitFromFirst(sourceStream, 5, outStream); Splits from location, and saves the rear part as a new file. Source Pdf file. The splitting position. Output Pdf file path. True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); pfe.SplitToEnd("input.pdf", 5, "out.pdf"); Splits from specified location, and saves the rear part as a new file Stream. Source Pdf file Stream. The splitting position. Output Pdf file Stream. True for success, or false. The streams are NOT closed after this operation unless CloseConcatedStreams is specified. PdfFileEditor pfe = new PdfFileEditor(); Stream sourceStream = new FileStream("file1.pdf", FileMode.Open, FileAccess.Read); Stream outStream = new FileStream("out.pdf", FileMode.Create, FileAccess.Write); pfe.SplitToEnd(sourceStream, 5, outStream); Makes booklet from the input file to output file. Input pdf file path and name. Output pdf file path and name. boolean - True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); pfe.MakeBooklet("input.pdf", "output.pdf"); Makes booklet from the InputStream to outputStream. Input pdf stream. output pdf stream. True if operation was succeeded. PdfFileEditor pfe = new PdfFileEditor(); Stream inputStream = new FileStream("input.pdf", FileMode.Open, FileAccess.Read); Stream outputStream = new FileStream("output.pdf", FileMode.Create, FileAccess.Write); pfe.MakeBooklet(inputStream, outputStream); Makes booklet from the inputFile to outputFile. Input pdf file path and name. Output pdf file path and name. The page size of the output pdf file. True if operation is succeeded. PdfFileEditor pfe = new PdfFileEditor(); pfe.MakeBooklet("input.pdf", "output.pdf", PageSize.A4); Makes booklet from the input stream and save result into output stream. Input PDF stream. output pdf stream. The page size of the output pdf file. PdfFileEditor pfe = new PdfFileEditor(); Stream inputStream = new FileStream("input.pdf", FileMode.Open, FileAccess.Read); Stream outputStream = new FileStream("output.pdf", FileMode.Create, FileAccess.Write); pfe.MakeBooklet(inputStream, outputStream, PageSize.A4); True if operation was succeeded. Makes customized booklet from the firstInputFile to outputFile. The input file. Output pdf file path and name. The left pages of the booklet. The right pages of the booklet. boolean - True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); pfe.MakeBooklet("input.pdf", "output.pdf", new int[] { 2, 4, 6 }, new int[] 1, 3, 5, 7 }); Makes customized booklet from the firstInputStream to outputStream. The input stream. output pdf stream. The left pages. The right pages. boolean - True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); Stream inputStream = new FileStream("input.pdf", FileMode.Open, FileAccess.Read); Stream outputStream = new FileStream("output.pdf", FileMode.Create, FileAccess.Write); pfe.MakeBooklet(inputStream, outputStream, new int[] { 2, 4, 6 }, new int[] 1, 3, 5, 7 }); Makes customized booklet from the firstInputFile to outputFile. The input file. Output pdf file path and name. The page size of the output pdf file. The left pages. The right pages. boolean - True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); pfe.MakeBooklet("input.pdf", "output.pdf", PageSize.A4, new int[] { 2, 4, 6 }, new int[] 1, 3, 5, 7 }); Makes booklet from the firstInputStream to outputStream. The input stream. output pdf stream. The page size of the output pdf file. The left pages. The right pages. boolean - True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); Stream inputStream = new FileStream("input.pdf", FileMode.Open, FileAccess.Read); Stream outputStream = new FileStream("output.pdf", FileMode.Create, FileAccess.Write); pfe.MakeBooklet(inputStream, outputStream, PageSize.A4, new int[] { 2, 4, 6 }, new int[] 1, 3, 5, 7 }); Makes N-Up document from the firstInputFile to outputFile. Input pdf file path and name. Output pdf file path and name. Number of columns. Number of rows. boolean - True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); pfe.MakeNUp("input.pdf", "output.pdf", 3, 3); Makes N-Up document from the input stream and saves result into output stream. Input pdf stream. Output pdf stream. Number of columns. Number of rows. boolean - True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); Stream inputStream = new FileStream("input.pdf", FileMode.Open, FileAccess.Read); Stream outputStream = new FileStream("output.pdf", FileMode.Create, FileAccess.Write); pfe.MakeNUp(inputStream, outputStream, 3, 3); Makes N-Up document from the first input stream to output stream. Input pdf stream. Output pdf stream. Number of columns. Number of rows. The page size of the output pdf file. True if operation was succeeded. PdfFileEditor pfe = new PdfFileEditor(); Stream inputStream = new FileStream("input.pdf", FileMode.Open, FileAccess.Read); Stream outputStream = new FileStream("output.pdf", FileMode.Create, FileAccess.Write); pfe.MakeNUp(inputStream, outputStream, 3, 3, PageSize.A4); Makes N-Up document from the two input PDF files to outputFile. Each page of outputFile will contain two pages, one page is from the first input file and another is from the second input file. The two pages are piled up horizontally. first input file. second input file. Output pdf file path and name. boolean - True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); pfe.MakeNUp("input1.pdf", "input2.pdf", "output.pdf"); Makes N-Up document from the two input PDF streams to outputStream. first input stream. second input stream. Output pdf stream. boolean - True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); Stream input1 = new FileStream("input1.pdf", FileMode.Open, FileAccess.Read); Stream input2 = new FileStream("input2.pdf", FileMode.Open, FileAccess.Read); Stream output = new FileStream("output.pdf"); pfe.MakeNUp(input1, input2, output); Makes N-Up document from the multi input PDF files to outputFile. Each page of outputFile will contain multi pages, which are combination with pages in the input files of the same page number. The multi pages piled up horizontally if isSidewise is true and piled up vertically if isSidewise is false. Input Pdf files. Output pdf file path and name. Piled up way, true for horizontally and flase for vertically. boolean - True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); pfe.MakeNUp(new string[] { "input1.pdf", "input2.pdf", "input3.pdf" }, "output.pdf", false); Makes N-Up document from the multi input PDF streams to outputStream. Each page of outputStream will contain multi pages, which are combination with pages in the input streams of the same page number. The multi-pages piled up horizontally if isSidewise is true and piled up vertically if isSidewise is false. Input Pdf streams. Output pdf stream. Piled up way, true for horizontally and flase for vertically boolean - True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); Stream stream1 = new FileStream("input1.pdf", FileMode.Open, FileAccess.Read); Stream stream2 = new FileStream("input2.pdf", FileMode.Open, FileAccess.Read); Stream stream3 = new FileStream("input3.pdf", FileMode.Open, FileAccess.Read); Stream output = new FileStream("output.pdf", FileMode.Create, FileAccess.Write); pfe.MakeNUp(new Stream[] { stream1, stream2, stream3 }, output, false); Makes N-Up document from the input file to outputFile. Input pdf file path and name. Output pdf file path and name. Number of columns. Number of rows. The page size of the output pdf file. boolean - True for success, or false. PdfFileEditor pfe = new PdfFileEditor(); pfe.MakeNUp("input.pdf", "output.pdf", 3, 3, PageSize.A4); Splits the PDF file into single-page documents. Input PDF file name. Output PDF streams, each stream buffers a single-page PDF document. Splits the Pdf file into single-page documents. Input Pdf stream. Array of memory streams which contain pages of the document. Split the Pdf file into single-page documents and saves it into specified path. Path is specifield by field name temaplate. Input file name. Template of resultant file name. Must contain %NUM% which is replaced with page number. For example, if c:/dir/page%NUM%.pdf is specified, resultant files will have the following names: c:/dir/page1.pdf, c:/dir/page2.pdf etc. Split the Pdf file into single-page documents and saves it into specified path. Path is specifield by field name temaplate. Stream of the soruce document. Template of resultant file name. Must contain %NUM% which is replaced with page number. For example, if c:/dir/page%NUM%.pdf is specified, resultant files will have the following names: c:/dir/page1.pdf, c:/dir/page2.pdf etc. Splits the Pdf file into several documents.The documents can be single-page or multi-pages. Input PDF file. Array which contains array of double elements, which is start and end pages of document. Output PDF streams, each stream buffers a PDF document. Splits the Pdf file into several documents.The documents can be single-page or multi-pages. Input PDF stream. The start page and the end page of each document. Output PDF streams, each stream buffers a PDF document. Gets last occured exception. May be used to check the reason of failure when AllowconcatenateExceptions = false. PdfFileEditor pfe = new PdfFileEditor(); pfe.AllowConcatenateExceptions = false; if (!pfe.Concatenate("file1.pdf", "file2.pdf", "file3.pdf")) { Console.WriteLine("Error occured:"); if (pfe.LastException != null) { Console.WriteLine(pfe.LastException.Message); if (pfe.LastException.InnerException != null) Console.WriteLine(pfe.LastException.InnerException.Message); } } Resizes contents of pages of the document. Stream with source document. Stream with the destination document. Array of page indexes. Resize parameters. Returns true if success. PdfFileEditor fileEditor = new PdfFileEditor(); Stream src = new Stream("input.pdf", FileMode.Open); Stream dest = new Stream("output.pdf", FileMode.Create); PdfFileEditor.ContentsResizeParameters parameters = new PdfFileEditor.ContentsResizeParameters( //left margin = 10% of page width PdfFileEditor.ContentsResizeValue.Percents(10), //new contents width calculated automatically as width - left margin - right margin (100% - 10% - 10% = 80%) null, //right margin is 10% of page PdfFileEditor.ContentsResizeValue.Percents(10), //top margin = 10% of height PdfFileEditor.ContentsResizeValue.Percents(10), //new contents height is calculated automatically (similar to width) null, //bottom margin is 10% PdfFileEditor.ContentsResizeValue.Percents(10) ); fileEditor.ResizeContents(src, dest, new int[] { 1, 2,.3}, parameters); dest.Close(); Resizes contents of document pages. Shrinks contents of page and adds margins. New size of contents is specified in default space units. Stream which contains source document. Stream where resultant document will be saved. Array of page indexes. If null then all document pages will be processed. New width of page contents in default space units. New height of page contents in default space units. True if resize was successful. PdfFileEditor fileEditor = new PdfFileEditor(); Stream src = new Stream("input.pdf", FileMode.Open); Stream dest = new Stream("output.pdf", FileMode.Create); fileEditor.ResizeContents(src, dest, //resize all pages of document null, //new contents width = 200 200, //new contents height = 300 300); // rest area of page will be empty Resizes contents of document pages. Shrinks contents of page and adds margins. New contents size is specified in percents. Stream which contains source document. Stream where resultant document will be saved. Array of page indexes. If null then all document pages will be processed. New width of page contents in percents. New height of page contents in percetns. true if resized sucessfully. PdfFileEditor fileEditor = new PdfFileEditor(); Stream src = new Stream("input.pdf", FileMode.Open); Stream dest = new Stream("output.pdf", FileMode.Create); fileEditor.ResizePct(src, dest, //resize all pages of document null, //new contents width = 60% of initial size 60, //new contents height = 60% of initial size 60); // Rest area of page will be empty (page margins). Size of left and right margins is (100% - 60%) / 2 = 20% // The same for top and bottom margins. Resizes page contents and add specifed margins. Margins are specified in default space units. Stream which contains source document. Stream where resultant document will be saved. Array of page indexes. If null then all document pages will be processed. Left margin. Right margin. Top margin. Bottom margin. true if operation was successful. PdfFileEditor fileEditor = new PdfFileEditor(); Stream src = new Stream("input.pdf", FileMode.Open); Stream dest = new Stream("output.pdf", FileMode.Create); fileEditor.AddMargins(src, dest, //process pages 1, 2, 3 new int[] { 1, 2, 3}, //left margin is 10 units 10, //right margin is 5 units 5, //top margin is 5 units 5, //bottom margin is 5 units 5); dest.Close(); Resizes page contents and add specified margins. Margins are specified in percents of intitial page size. Stream which contains source document. Stream where resultant document will be saved. Array of page indexes. If null then all document pages will be processed. Left margin in percents of initial page size. Right margin in percents of initial page size. Top margin in percents of initial page size. Bottom margin in percents of initial page size. true if action was performed successfully. PdfFileEditor fileEditor = new PdfFileEditor(); Stream src = new Stream("input.pdf", FileMode.Open); Stream dest = new Stream("output.pdf", FileMode.Create); fileEditor.AddMarginsPct(src, dest, //process pages 1, 2, 3 new int[] { 1, 2, 3}, //left margin is 15% of page width 15, //right margin is 10% of page width 10, //top margin is 20% of page width 20, //bottom margin is 5% of page width 5); dest.Close(); Resizes contents of document pages. Shrinks contents of page and adds margins. New size of contents is specified in default space units. Path to source document. Path where resultant document will be saved. Array of page indexes. If null then all document pages will be processed. New width of page contents in default space units. New height of page contents in default space units. true if resize was successful. PdfFileEditor fileEditor = new PdfFileEditor(); fileEditor.ResizeContents("input.pdf", "output.pdf", //resize all pages of document null, //new contents width = 200 200, //new contents height = 300 300); // rest area of page will be empty Resizes contents of document pages. Shrinks contents of page and adds margins. New contents size is specified in percents. Path to source document. Path where resultant document will be saved. Array of page indexes. If null then all document pages will be processed. New width of page contents in percents. New height of page contents in percetns. true if resize was successful. PdfFileEditor fileEditor = new PdfFileEditor(); fileEditor.ResizePct("input.pdf", "output.pdf", //resize all pages of document null, //new contents width = 60% of initial size 60, //new contents height = 60% of initial size 60); // Rest area of page will be empty (page margins). Size of left and right margins is (100% - 60%) / 2 = 20% // The same for top and bottom margins. Resizes page contents and add specifed margins. Margins are specified in default space units. Path to source document. Path where resultant document will be saved. Array of page indexes. If null then all document pages will be processed. Left margin. Right margin. Top margin. Bottom margin. true if resize was successful. PdfFileEditor fileEditor = new PdfFileEditor(); fileEditor.AddMargins("input.pdf", "output.pdf", //process pages 1, 2, 3 new int[] { 1, 2, 3}, //left margin is 10 units 10, //right margin is 5 units 5, //top margin is 5 units 5, //bottom margin is 5 units 5); Resizes page contents and add specified margins. Margins are specified in percents of intitial page size. Path to source document. Path where resultant document will be saved. Array of page indexes. If null then all document pages will be processed. Left margin in percents of initial page size. Right margin in percents of initial page size. Top margin in percents of initial page size. Bottom margin in percents of initial page size. true if resize was successful PdfFileEditor fileEditor = new PdfFileEditor(); fileEditor.AddMarginsPct("input.pdf", "output.pdf", //process pages 1, 2, 3 new int[] { 1, 2, 3}, //left margin is 15% of page width 15, //right margin is 10% of page width 10, //top margin is 20% of page width 20, //bottom margin is 5% of page width 5); Resizes contents of pages in document. If page is shrinked blank margins are added around the page. Source document path. Destination document path. Array of page indexes (page index starts from 1). Parameters of page resize. trure if resize was successful. PdfFileEditor fileEditor = new PdfFileEditor(); PdfFileEditor.ContentsResizeParameters parameters = new PdfFileEditor.ContentsResizeParameters( //left margin = 10% of page width PdfFileEditor.ContentsResizeValue.Percents(10), //new contents width calculated automatically as width - left margin - right margin (100% - 10% - 10% = 80%) null, //right margin is 10% of page PdfFileEditor.ContentsResizeValue.Percents(10), //top margin = 10% of height PdfFileEditor.ContentsResizeValue.Percents(10), //new contents height is calculated automatically (similar to width) null, //bottom margin is 10% PdfFileEditor.ContentsResizeValue.Percents(10) ); fileEditor.ResizeContents("input.pdf", "output.pdf", new int[] { 1, 2,.3}, parameters); Resizes pages of document. Blank margins are added around of shrinked page. Source document. List of page indexes. Resize parameters. PdfFileEditor fileEditor = new PdfFileEditor(); Document doc = new Document("input.pdf"); PdfFileEditor.ContentsResizeParameters parameters = new PdfFileEditor.ContentsResizeParameters( //left margin = 10% of page width PdfFileEditor.ContentsResizeValue.Percents(10), //new contents width calculated automatically as width - left margin - right margin (100% - 10% - 10% = 80%) null, //right margin is 10% of page PdfFileEditor.ContentsResizeValue.Percents(10), //top margin = 10% of height PdfFileEditor.ContentsResizeValue.Percents(10), //new contents height is calculated automatically (similar to width) null, //bottom margin is 10% PdfFileEditor.ContentsResizeValue.Percents(10) ); fileEditor.ResizeContents(doc, new int[] { 1, 2,.3}, parameters); doc.Save("output.pdf"); Resizes pages of document. Blank margins are added around of shrinked page. Source document. Resize parameters. PdfFileEditor fileEditor = new PdfFileEditor(); Document doc = new Document("input.pdf"); PdfFileEditor.ContentsResizeParameters parameters = new PdfFileEditor.ContentsResizeParameters( //left margin = 10% of page width PdfFileEditor.ContentsResizeValue.Percents(10), //new contents width calculated automatically as width - left margin - right margin (100% - 10% - 10% = 80%) null, //right margin is 10% of page PdfFileEditor.ContentsResizeValue.Percents(10), //top margin = 10% of height PdfFileEditor.ContentsResizeValue.Percents(10), //new contents height is calculated automatically (similar to width) null, //bottom margin is 10% PdfFileEditor.ContentsResizeValue.Percents(10) ); fileEditor.ResizeContents(doc, parameters); doc.Save("output.pdf"); Data of page break position. Number of page (starting from 1) where page break must be added. Vertical position of page break. Constructor to create PageBreak object. Number of page where page break is placed. Vertical position of page break. Adds page breaks into document pages. Source document. Destination document. Array of PageBreak objects which describe places of page breaks. Adds page breaks into document pages. Path to source document. Path to destination document. Array of PageBreak object describing pages and places where page break will be added. Adds page breaks into document pages. Source which contains source document. Source where destination document will be saved. Array of PageBreak object describing pages and places where page break will be added. Represents a class for accessing meta information of PDF document. Initializes the facade. The Aspose.Pdf.Document object. Gets or sets the Author information of PDF document. Checkes whether the PDF document is encrypted. Checkes whether the source input is a valid PDF file. Gets or sets the CreationDate information of PDF document. Gets or sets the Creator information of PDF document. Returns true if the current input file is a 'Portfolio' file containing collection of PDF files in it. Gets or sets the customized information of PDF document. Gets or sets the input file. Gets or sets the input stream. Gets or sets the Keywords information of PDF document. Gets or sets the ModDate date information of PDF document. Gets the number of document pages. Gets the Producer information of PDF document. Gets or sets the Subject information of PDF document. Gets or sets the Title information of PDF document. Initializes a new instance of the Aspose.Pdf.Facades.PdfFileInfo class with default values. Initializes a new instance of the Aspose.Pdf.Facades.PdfFileInfo class. Stream where input file is placed. Initializes a new instance of the Aspose.Pdf.Facades.PdfFileInfo class. Stream where input file is placed. Password for access to file. Initializes a new instance of the Aspose.Pdf.Facades.PdfFileInfo class. Name of file containing input file. Initializes a new instance of the Aspose.Pdf.Facades.PdfFileInfo class. Name of file containing input file. Password for access to file. Clears all meta information of PDF document. Gets the PDF document privilege settings. The PDF document privilege settings. Gets customized information of PDF document with property name. If there is no property match the name it will return a blank string. Custom meta property key. Custom meta property value. Gets the height of the specified page. Page number. The height of the page. Gets the rotation of the specified page. Page number. The rotation of the page. The value may be 0,90,180,270. Gets the width of the specified page. Page number. The width of the page. Gets the horizontal offset of the specified page display area. Page number. The horizontal offset from the left side of the page. Gets the vertical offset of the specified page display area. Page number. The vertical offset of the page display area. Gets the version info of PDF document. The version string. Save updated PDF document into specified stream. Output stream. True if success otherwise is false. Save updated PDF document into specified file. Output file. True if success otherwise is false. Saves the PDF document to the specified file. The destination stream. Saves the PDF document to the specified file. The destination file. Sets customized information of PDF document. Custom meta property key. Custom meta property value. Changes the properties specified explicitly by setting file information, other properties remain. Output file. True for success, or false. Initializes new object on base of the . Pdf document. Returns the type of password which was passed for creating PdfFileInfo instance. See possible values in . Pay attention that pdf document can be opened using both user (or open) password and owner (or permissions, edit) password. Returns true if password is needed to open password protected pdf document. Returns true if password is needed to modify permissions or document security property. Pay attention that this property can be read only if valid password was provided in constructor. In case PasswordType is Inaccessible (means that invalid password was provided) reading this property will fail with . Deinitializes the instance. Represents a class for adding texts and images on the pages of existing PDF document. Sets the input stream. Sets the output stream. Sets the input file. Sets the output file. Sets a bool value that indicates word wrap in AddText methods. If the value is true, the text in FormattedText will word wrap. By defalt, the value is false. Sets or gets word wrapping algorithm. See WordWrapMode and IsWordWrap. Sets or gets text positioning strategy. Default mode is Legacy. Adds image to the specified page of PDF document at specified coordinates. Input image stream. The number of page that will receive the image. The lower left x of image rectangle. The lower left y of image rectangle. The upper right x of image rectangle. The upper right y of image rectangle. True if success false otherwise. PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf"); using (Stream stream = File.OpenRead("picture.jpg")) { mendor.AddImage(stream, 1, 10, 10, 100, 100); } mendor.Close(); Adds image to the specified page of PDF document at specified coordinates. Input image stream. The number of page that will receive the image. The lower left x of image rectangle. The lower left y of image rectangle. The upper right x of image rectangle. The upper right y of image rectangle. The graphics compositing parameters for the image. True if success false otherwise. PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf"); using (Stream stream = File.OpenRead("picture.jpg")) { mendor.AddImage(stream, 1, 10, 10, 100, 100, new CompositingParameters(BlendMode.Multiply); } mendor.Close(); Adds image to the specified pages of PDF document at specified coordinates. Input image stream. The numbers of pages that will receive the image. The lower left x of image rectangle. The lower left y of image rectangle. The upper right x of image rectangle. The upper right y of image rectangle. True if success false otherwise. PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf"); using (Stream stream = File.OpenRead("picture.jpg")) { mendor.AddImage(stream, new int[]{1, 2}, 10, 10, 100, 100); } mendor.Close(); Adds image to the specified pages of PDF document at specified coordinates. Input image stream. The numbers of pages that will receive the image. The lower left x of image rectangle. The lower left y of image rectangle. The upper right x of image rectangle. The upper right y of image rectangle. The graphics compositing parameters for the images. True if success false otherwise. PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf"); using (Stream stream = File.OpenRead("picture.jpg")) { mendor.AddImage(stream, new int[]{1, 2}, 10, 10, 100, 100, new CompositingParameters(BlendMode.Multiply); } mendor.Close(); Adds image to the specified page of PDF document at specified coordinates. The path of input image file. The number of page that will receive the image. The lower left x of image rectangle. The lower left y of image rectangle. The upper right x of image rectangle. The upper right y of image rectangle. True if success false otherwise. PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf"); mendor.AddImage("picture.jpg", 1, 10, 10, 100, 100); mendor.Close(); Adds image to the specified page of PDF document at specified coordinates. The path of input image file. The number of page that will receive the image. The lower left x of image rectangle. The lower left y of image rectangle. The upper right x of image rectangle. The upper right y of image rectangle. The graphics compositing parameters for the images. True if success false otherwise. PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf"); mendor.AddImage("picture.jpg", 1, 10, 10, 100, 100, new CompositingParameters(BlendMode.Multiply)); mendor.Close(); Adds image to the specified pages of PDF document at specified coordinates. The path of input image file. The numbers of pages that will receive the image. The lower left x of image rectangle. The lower left y of image rectangle. The upper right x of image rectangle. The upper right y of image rectangle. True if success false otherwise. PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf"); mendor.AddImage("picture.jpg", 1, 10, 10, 100, 100); mendor.Close(); Adds image to the specified pages of PDF document at specified coordinates. The path of input image file. The numbers of pages that will receive the image. The lower left x of image rectangle. The lower left y of image rectangle. The upper right x of image rectangle. The upper right y of image rectangle. The graphics compositing parameters for the images. True if success false otherwise. PdfFileMend mendor = new PdfFileMend("example.pdf", "out_example.pdf"); mendor.AddImage("picture.jpg", 1, 10, 10, 100, 100, new CompositingParameters(BlendMode.Multiply)); mendor.Close(); Not implemented. FormattedText object. Page number. Lower left X coordinate. Lower left Y coordinate. True in case text was successfully added. Not implemented. FormattedText object. Page number. Lower left X coordinate. Lower left Y coordinate. Upper right X coordinate. Upper right Y coordinate. True in case text was successfully added. Not implemented. FormattedText object. Page numbers array. Lower left X coordinate. Lower left Y coordinate. Upper right X coordinate. Upper right Y coordinate. True in case text was successfully added. Closes PdfFileMend object. Constructor. Constructor. Input PDF file name. Output PDF file name. Constructor. Input PDF stream. Output PDF stream. Initializes new object on base of the . Pdf document. Initializes new object on base of the . Pdf document. Output PDF file name. Initializes new object on base of the . Pdf document. Output PDF stream. Saves the PDF document to the specified file. The destination file. Saves the PDF document to the specified stream. The destination stream. Represents encrypting or decrypting a Pdf file with owner or user password, changing the security setting and password. Sets the input file. Sets the input stream. Sets the output file. Sets the output stream. If this value set to true, exception will be thrown on opearation failure. Else, method returns false on failure and last exception can be checked with LastException variable. Returns exception which was thrown by last operation. Initialize the object of PdfFileSecurity with input and output stream. Input Pdf Stream. Output Pdf Stream. Initializes the object of PdfFileSecurity with input and output file. Source input Pdf file. Output Pdf file. Initialize the object of PdfFileSecurity. Encrypts Pdf file with userpassword and ownerpassword and sets the document's privileges to access. The user password and the owner password can be null or empty. The owner password will be replaced with a random string if the input owner password is null or empty. User password. Owner password. Set privilege. KeySize.x40 for 40 bits encryption, KeySize.x128 for 128 bits encryption and KeySize.x256 for 256 bits encryption. True for success, or false. [C#] string inFile = "..\\AsposePdfKitExample\\example1.pdf"; //The TestPath may be re-assigned. string outFile = "..\\AsposePdfKitExample\\Kit0401.pdf"; //The TestPath may be re-assigned. PdfFileSecurity fileSecurity = new PdfFileSecurity(inFile,outFile); fileSecurity.EncryptFile("userpass", "ownerpass", DocumentPrivilege.Print, KeySize.x256); [Visual Basic] Dim inFile As String = "..\\AsposePdfKitExample\\example1.pdf" 'The TestPath may be re-assigned.' Dim outFile As String = "..\\AsposePdfKitExample\\Kit0401.pdf" 'The TestPath may be re-assigned.' Dim fileSecurity As PdfFileSecurity = New PdfFileSecurity(inFile,outFile) fileSecurity.EncryptFile("userpass", "ownerpass", DocumentPrivilege.Print, KeySize.x256) Encrypts Pdf file with userpassword and ownerpassword and sets the document's privileges to access. The user password and the owner password can be null or empty. The owner password will be replaced with a random string if the input owner password is null or empty. There are 6 possible combinations of KeySize and Algorithm values. However (KeySize.x40, Algorithm.AES) and (KeySize.x256, Algorithm.RC4) are invalid and corresponding exception will be raised if kit encounters this combination. User password. Owner password. Set privilege. KeySize.x40 for 40 bits encryption, KeySize.x128 for 128 bits encryption and KeySize.x256 for 256 bits encryption. Algorithm.AES to encrypt using AES algorithm or Algorithm.RC4 for RC4 encryption. True for success, or false. [C#] string inFile = "..\\AsposePdfKitExample\\example1.pdf"; //The TestPath may be re-assigned. string outFile = "..\\AsposePdfKitExample\\Kit0401.pdf"; //The TestPath may be re-assigned. PdfFileSecurity fileSecurity = new PdfFileSecurity(inFile,outFile); fileSecurity.EncryptFile("userpass","ownerpass",DocumentPrivilege.Print,KeySize.x256,Algorithm.AES); [Visual Basic] Dim inFile As String = "..\\AsposePdfKitExample\\example1.pdf" 'The TestPath may be re-assigned.' Dim outFile As String = "..\\AsposePdfKitExample\\Kit0401.pdf" 'The TestPath may be re-assigned.' Dim fileSecurity As PdfFileSecurity = New PdfFileSecurity(inFile,outFile) fileSecurity.EncryptFile("userpass","ownerpass",DocumentPrivilege.Print,KeySize.x256,Algorithm.AES) Decrypts an encrypted Pdf document by owner password. If the document hasn't owner password, it is allow to use user password. Owner password. True for success,or false. [C#] string inFile = "..\\AsposePdfKitExample\\Kit0401.pdf"; //The TestPath may be re-assigned. string outFile = "..\\AsposePdfKitExample\\Kit0404.pdf"; //The TestPath may be re-assigned. PdfFileSecurity fileSecurity = new PdfFileSecurity(inFile,outFile); fileSecurity.DecryptFile("ownerpass"); [Visual Basic] Dim inFile As String = "..\\AsposePdfKitExample\\Kit0401.pdf" 'The TestPath may be re-assigned.' Dim outFile As String = "..\\AsposePdfKitExample\\Kit0404.pdf" 'The TestPath may be re-assigned.' Dim fileSecurity As PdfFileSecurity = New PdfFileSecurity(inFile,outFile) fileSecurity.DecryptFile("ownerpass") Sets Pdf file security with empty user/owner passwords. The owner password will be added by a random string. Set privilege. True for success, or false. [C#] string inFile = "..\\AsposePdfKitExample\\example1.pdf"; //The TestPath may be re-assigned. string outFile = "..\\AsposePdfKitExample\\Kit0405.pdf"; //The TestPath may be re-assigned. PdfFileSecurity fileSecurity = new PdfFileSecurity(inFile,outFile); fileSecurity.SetPrivilege(DocumentPrivilege.Print); [Visual Basic] Dim inFile As String = "..\\AsposePdfKitExample\\example1.pdf" 'The TestPath may be re-assigned.' Dim outFile As String = "..1\\AsposePdfKitExample\\Kit0405.pdf" 'The TestPath may be re-assigned.' Dim fileSecurity As PdfFileSecurity = New PdfFileSecurity(inFile,outFile) fileSecurity.SetPrivilege(DocumentPrivilege.Print) Sets Pdf file security with original password. Original user password. Original owner password. Set privilege. True for success, or false. [C#] string inFile = "..\\AsposePdfKitExample\\example1.pdf"; //The TestPath may be re-assigned. string outFile = "..\\AsposePdfKitExample\\Kit0405.pdf"; //The TestPath may be re-assigned. PdfFileSecurity fileSecurity = new PdfFileSecurity(inFile,outFile); fileSecurity.SetPrivilege(userPassword, ownerPassword, DocumentPrivilege.Print); [Visual Basic] Dim inFile As String = "..\\AsposePdfKitExample\\example1.pdf" 'The TestPath may be re-assigned.' Dim outFile As String = "..1\\AsposePdfKitExample\\Kit0405.pdf" 'The TestPath may be re-assigned.' Dim fileSecurity As PdfFileSecurity = New PdfFileSecurity(inFile,outFile) fileSecurity.SetPrivilege(userPassword, ownerPassword, DocumentPrivilege.Print) Changes the user password and owner password by owner password, keeps the original security settings. The new user password and the new owner password can be null or empty. The owner password will be replaced with a random string if the new owner password is null or empty. Original Owner password. New User password. New Owner password. True for success,or false. [C#] string inFile = "..\\AsposePdfKitExample\\Kit0406.pdf"; //The TestPath may be re-assigned. string outFile = "..\\AsposePdfKitExample\\Kit0407.pdf"; //The TestPath may be re-assigned. PdfFileSecurity fileSecurity = new PdfFileSecurity(inFile,outFile); fileSecurity.ChangePassword("owner","newuser","newowner"); [Visual Basic] Dim inFile As String = "..\\AsposePdfKitExample\\Kit0401.pdf" 'The TestPath may be re-assigned.' Dim outFile As String = "..\\AsposePdfKitExample\\Kit0406.pdf" 'The TestPath may be re-assigned.' Dim fileSecurity As PdfFileSecurity = New PdfFileSecurity(inFile,outFile) fileSecurity.ChangePassword("owner","newuser","newowner") Changes the user password and password by owner password, allows to reset Pdf documnent security. The new user password and the new owner password can be null or empty. The owner password will be replaced with a random string if the new owner password is null or empty. Original owner password. New User password. New Owner password. Reset security. KeySize.x40 for 40 bits encryption, KeySize.x128 for 128 bits encryption and KeySize.x256 for 256 bits encryption. True for success, or false. [C#] string inFile = "..\\AsposePdfKitExample\\Kit0401.pdf"; //The TestPath may be re-assigned. string outFile = "..\\AsposePdfKitExample\\Kit0407.pdf"; //The TestPath may be re-assigned. PdfFileSecurity fileSecurity = new PdfFileSecurity(inFile,outFile); fileSecurity.ChangePassword("owner","newuser","newowner", DocumentPrivilege.Print,KeySize.x256); [Visual Basic] Dim inFile As String = "..\\AsposePdfKitExample\\Kit0401.pdf" 'The TestPath may be re-assigned.' Dim outFile As String = "..\\AsposePdfKitExample\\Kit0407.pdf" 'The TestPath may be re-assigned.' Dim fileSecurity As PdfFileSecurity = New PdfFileSecurity(inFile,outFile) fileSecurity.ChangePassword("owner","newuser","newowner", DocumentPrivilege.Print,KeySize.x256) Changes the user password and password by owner password, allows to reset Pdf documnent security. The new user password and the new owner password can be null or empty. The owner password will be replaced with a random string if the new owner password is null or empty. There are 6 possible combinations of KeySize and Algorithm values. However (KeySize.x40, Algorithm.AES) and (KeySize.x256, Algorithm.RC4) are invalid and corresponding exception will be raised if kit encounters this combination. Original owner password. New User password. New Owner password. Reset security. KeySize.x40 for 40 bits encryption, KeySize.x128 for 128 bits encryption and KeySize.x256 for 256 bits encryption. Algorithm.AES to encrypt using AES algorithm or Algorithm.RC4 for RC4 encryption. True for success, or false. [C#] string inFile = "..\\AsposePdfKitExample\\Kit0401.pdf"; //The TestPath may be re-assigned. string outFile = "..\\AsposePdfKitExample\\Kit0407.pdf"; //The TestPath may be re-assigned. PdfFileSecurity fileSecurity = new PdfFileSecurity(inFile,outFile); fileSecurity.ChangePassword("owner","newuser","newowner", DocumentPrivilege.Print,KeySize.x256,Algorithm.AES); [Visual Basic] Dim inFile As String = "..\\AsposePdfKitExample\\Kit0401.pdf" 'The TestPath may be re-assigned.' Dim outFile As String = "..\\AsposePdfKitExample\\Kit0407.pdf" 'The TestPath may be re-assigned.' Dim fileSecurity As PdfFileSecurity = New PdfFileSecurity(inFile,outFile) fileSecurity.ChangePassword("owner","newuser","newowner", DocumentPrivilege.Print,KeySize.x256,Algorithm.AES) Initializes new object on base of the . Pdf document. Initializes new object on base of the . Pdf document. Output Pdf file. Initializes new object on base of the . Pdf document. Output Pdf Stream. Initializes the facade. The PDF file. Initializes the facade. The stream of PDF file. Closes the facade. Represents a class to sign a pdf file with a certificate. Sets or gets a graphic appearance for the signature. Property value represents image file name. Gets the LTV enabled flag. The constructor of PdfFileSignature class. The constructor of PdfFileSignature class. The input file for signature. The constructor of PdfFileSignature class. The input file for signature. The output file. Binds a Pdf file for editing. The pdf file to be edited. Binds a Pdf stream for editing. The pdf stream to be edited. Saves the result PDF to file. output pdf file Saves the result PDF to stream. output pdf stream Make a signature on the pdf document. The page number on which signature is made. The reason of signature. The contact of signature. The location of signature. The visiblity of signature. The rect of signature. [C#] string inFile = TestPath + "example1.pdf"; string outFile = TestPath + "signature.pdf"; PdfFileSignature pdfSign = new PdfFileSignature(); pdfSign.BindPdf(inFile); System.Drawing.Rectangle rect = new System.Drawing.Rectangle(100, 100, 200, 200); pdfSign.SignatureAppearance = TestPath + "butterfly.jpg"; pdfSign.SetCertificate("certificate.pfx", "password"); pdfSign.Sign(2, "Allen", "success", "ChangSha", true, rect); pdfSign.Save(outFile); [Visual Basic] Dim pdfSign = new PdfFileSignature() pdfSign.BindPdf(inFile) Dim rect as System.Drawing.Rectangle = new System.Drawing.Rectangle(100, 100, 200, 200) pdfSign.SetCertificate("certificate.pfx", "password") pdfSign.Sign(2, "Allen", "success", "ChangSha", true, rect) pdfSign.SignatureAppearance = TestPath + "butterfly.jpg" pdfSign.Save(outFile) Sign the document with the given type signature. The page number on which signature is made. The reason of signature. The contact of signature. The location of signature. The visiblity of signature. The rect of signature. The type of the signature, could be PKCS1, PKCS7 and PKCS7Detached. [C#] string inFile = TestPath + "example1.pdf"; string outFile = TestPath + "signature.pdf"; PdfFileSignature pdfSign = new PdfFileSignature(inFile, outFile); System.Drawing.Rectangle rect = new System.Drawing.Rectangle(100, 100, 200, 100); pdfSign.SignatureAppearance = TestPath + "butterfly.jpg"; pdfSign.Sign(2, "Allen", "success", "ChangSha", true, rect, new PKCS1("certificate.pfx", "password")); pdfSign.Save(); [Visual Basic] Dim inFile As String = TestPath & "example1.pdf" Dim outFile As String = TestPath & "signature.pdf" Dim sig As PKCS1 = new PKCS1("certificate.pfx", "password") Dim pdfSign = new PdfFileSignature(inFile, outFile) Dim rect as System.Drawing.Rectangle = new System.Drawing.Rectangle(100, 100, 200, 100) pdfSign.SignatureAppearance = TestPath & "butterfly.jpg" pdfSign.Sign(2, "Allen", "success", "ChangSha", true, rect, sig) pdfSign.Save() Sign the document with the given type signature. The page number on which signature is made. The visiblity of signature. The rect of signature. The type of the signature, could be PKCS1, PKCS7 and PKCS7Detached. Such data as signature reason, contact and location must be already present in this object (see corresponding properties). [C#] string inFile = TestPath + "example1.pdf"; string outFile = TestPath + "signature.pdf"; PKCS1 sig = new PKCS1("certificate.pfx", "password"); sig.Reason = "Some reason"; sig.Contact = "Smith"; sig.Location = "New York"; PdfFileSignature pdfSign = new PdfFileSignature(inFile, outFile); System.Drawing.Rectangle rect = new System.Drawing.Rectangle(100, 100, 200, 100); pdfSign.SignatureAppearance = TestPath + "butterfly.jpg"; pdfSign.Sign(2, true, rect, sig); pdfSign.Save(); [Visual Basic] Dim inFile As String = TestPath & "example1.pdf" Dim outFile As String = TestPath & "signature.pdf" Dim sig As PKCS1 = new PKCS1("certificate.pfx", "password") sig.Reason = "Some reason" sig.Contact = "Smith" sig.Location = "New York" Dim pdfSign = new PdfFileSignature(inFile, outFile) Dim rect as System.Drawing.Rectangle = new System.Drawing.Rectangle(100, 100, 200, 100) pdfSign.SignatureAppearance = TestPath & "butterfly.jpg" pdfSign.Sign(2, true, rect, sig) pdfSign.Save() Sign the document with the given type signature which is placed in already presented signature field. Before signing signature field must be empty, i.e. field must not contain signature dictionary. Thus pdf document already has signature field, you should not supply the place to stamp the signature, corresponding page and rectangle are taken from signature field which is found by signature name (see SigName parameter). The name of the signature field. The reason of signature. The contact of signature. The location of signature. The type of the signature, could be PKCS1, PKCS7 and PKCS7Detached. [C#] string inFile = TestPath + "example1.pdf"; string outFile = TestPath + "signature.pdf"; PKCS1 sig = new PKCS1("certificate.pfx", "password"); PdfFileSignature pdfSign = new PdfFileSignature(inFile, outFile); pdfSign.SignatureAppearance = TestPath + "butterfly.jpg"; pdfSign.Sign("Signature1", "Allen", "success", "ChangSha", sig); pdfSign.Save(); [Visual Basic] Dim inFile As String = TestPath & "example1.pdf" Dim outFile As String = TestPath & "signature.pdf" Dim sig As PKCS1 = new PKCS1("certificate.pfx", "password") Dim pdfSign = new PdfFileSignature(inFile, outFile) pdfSign.SignatureAppearance = TestPath & "butterfly.jpg" pdfSign.Sign("Signature1", "Allen", "success", "ChangSha", sig) pdfSign.Save() Sign the document with the given type signature which is placed in already presented signature field. Before signing pdf document should already has signature field, corresponding page and rectangle are taken from signature field which is found by signature name (see SigName parameter). The page number on which signature is made. The name of the signature field. The reason of signature. The contact of signature. The location of signature. The visiblity of signature. The rect of signature. The type of the signature, could be PKCS1, PKCS7 and PKCS7Detached. [C#] string inFile = TestPath + "blankWithSignature.pdf"; string outFile = TestPath + "signature.pdf"; PKCS7 sig = new PKCS7("certificate.pfx", "password"); PdfFileSignature pdfSign = new PdfFileSignature(inFile); System.Drawing.Rectangle rect = new System.Drawing.Rectangle(100, 100, 100, 100); pdfSign.SignatureAppearance = TestPath + "butterfly.jpg" pdfSign.Sign(1, "Signature1", "ReasonToTest", "ContactMe", "SomeLocation", true, rect, sig); pdfSign.Save(outFile); [Visual Basic] Dim inFile As String = TestPath & "blankWithSignature.pdf" Dim outFile As String = TestPath & "signature.pdf" Dim sig As PKCS7 = new PKCS7("certificate.pfx", "password") Dim pdfSign = new PdfFileSignature(inFile, outFile) pdfSign.SignatureAppearance = TestPath & "butterfly.jpg" pdfSign.Sign("Signature1", "ReasonToTest", "ContactMe", "SomeLocation", true, rect, sig) pdfSign.Save(outFile) Sign the document with the given type signature which is placed in already presented signature field. Before signing signature field must be empty, i.e. field must not contain signature dictionary. Thus pdf document already has signature field, you should not supply the place to stamp the signature, corresponding page and rectangle are taken from signature field which is found by signature name (see SigName parameter). Such data as signature reason, contact and location must be provided by corresponding properties of the Signature object sig. The name of the signature field. The type of the signature, could be PKCS1 (Pkcs1Signature object), PKCS7 and PKCS7 detached (Pkcs7Signature object) [C#] string inFile = TestPath + "example1.pdf"; string outFile = TestPath + "signature.pdf"; PKCS1 sig = new PKCS1("certificate.pfx", "password"); sig.Reason = "Some reason"; sig.Contact = "Smith"; sig.Location = "New York"; PdfFileSignature pdfSign = new PdfFileSignature(inFile, outFile); pdfSign.SignatureAppearance = TestPath + "butterfly.jpg"; pdfSign.Sign("Signature1", sig); pdfSign.Save(); [Visual Basic] Dim inFile As String = TestPath & "example1.pdf" Dim outFile As String = TestPath & "signature.pdf" Dim sig As PKCS1 = new PKCS1("certificate.pfx", "password") sig.Reason = "Some reason" sig.Contact = "Smith" sig.Location = "New York" Dim pdfSign = new PdfFileSignature(inFile, outFile) pdfSign.SignatureAppearance = TestPath & "butterfly.jpg" pdfSign.Sign("Signature1", sig) pdfSign.Save() Gets the flag determining whether a document is certified or not. Returns the access permissions value of certified document by the MDP signature type. If the document is being certified, than returns access permissions value; otherwise, is thrown. Certify the document with the MDP signature. Such data as signature reason, contact and location must be provided by corresponding properties of the Signature object sig. The page on which signature is made. The reason of signature. The contact of signature. The location of signature. The visiblity of signature. The rect of signature. The document MDP type of the signature. Gets the names of all not empty signatures. Return an IList. [C#] string inFile=TestPath + "example1.pdf"; PdfFileSignature pdfSign=new PdfFileSignature(); pdfSign.BindPdf(inFile); IList names=pdfSign.GetSignNames(); for(int i=0;i<names.Count;i++) { Console.WriteLine("signature name:"+(string)names[i]); Console.WriteLine("coverswholedocument:"+pdfSign.IsCoversWholeDocument((string)names[i])); Console.WriteLine("revision:"+pdfSign.GetRevision((string)names[i])); Console.WriteLine("verifysigned:"+pdfSign.VerifySigned((string)names[i])); Console.WriteLine("reason:"+pdfSign.GetReason((string)names[i])); Console.WriteLine("location:"+pdfSign.GetLocation((string)names[i])); Console.WriteLine("datatime:"+pdfSign.GetDateTime((string)names[i])); } Console.WriteLine("totalvision:"+pdfSign.GetTotalRevision()); [Visual Basic] Dim pdfSign as PdfFileSignature =new PdfFileSignature pdfSign.BindPdf(inFile) Dim names as IList names=pdfSign.GetSignNames() For i=0 To names.Count Console.WriteLine("signature name:" + (string)names[i]) Console.WriteLine("coverswholedocument:" + pdfSign.IsCoversWholeDocument((string)names[i])) Console.WriteLine("revision:" + pdfSign.GetRevision((string)names[i])) Console.WriteLine("verifysigned:" + pdfSign.VerifySigned((string)names[i])) Console.WriteLine("reason:" + pdfSign.GetReason((string)names[i])) Console.WriteLine("location:" + pdfSign.GetLocation((string)names[i])) Console.WriteLine("datatime:" + pdfSign.GetDateTime((string)names[i])) Next i Console.WriteLine("totalvision:"+pdfSign.GetTotalRevision()) Gets the names of all empty signature fields. Return an IList. Checks if the pdf has a digital signature or not. Return a result of bool type. Checks if the pdf has a digital signature or not. Return a result of bool type. Checks if the pdf has a usage rights or not. Returns a result of bool type. Checks if the signature covers the whole document. The name of signature. Return a result of bool type. Checks if the signature covers the whole document. The name of signature. Return a result of bool type. Gets the revision of a signature. The name of signature. Return the number of signature revision. Gets the toltal revision. Return the total number of signature revision. Removes the usage rights entry. Remove the signature according to the name of the signature. The name of signature. [C#] string inFile = TestPath + "example1.pdf"; PdfFileSignature pdfSign = new PdfFileSignature(); pdfSign.BindPdf(inFile); IList names = pdfSign.GetSignNames(); for(int i = 0; i < names.Count; i++) { pdfSign.RemoveSignature((string)names[i]); } pdfSign.Save(TestPath + "signed_removed.pdf"); [Visual Basic] Dim pdfSign as PdfFileSignature = new PdfFileSignature pdfSign.BindPdf(inFile) Dim names as IList names = pdfSign.GetSignNames() For i = 0 To names.Count pdfSign.RemoveSignature((string)names[i]) Next i pdfSign.Save(TestPath + "signed_removed.pdf") Removes the signature according to the name of the signature. The name of signature. If set to true, than removes both of signature and field from document; otherwise, signature only. [C#] string inFile = TestPath + "example1.pdf"; PdfFileSignature pdfSign = new PdfFileSignature(); pdfSign.BindPdf(inFile); IList names = pdfSign.GetSignNames(); for(int i = 0; i < names.Count; i++) { pdfSign.RemoveSignature((string)names[i], false); } pdfSign.Save(TestPath + "signed_removed.pdf"); [Visual Basic] Dim pdfSign as PdfFileSignature = new PdfFileSignature pdfSign.BindPdf(inFile) Dim names as IList names = pdfSign.GetSignNames() For i = 0 To names.Count pdfSign.RemoveSignature((string)names[i], false) Next i pdfSign.Save(TestPath + "signed_removed.pdf") Checks the validity of a signature. The name of signature. Return a result of bool type. Gets the name of person or organization who signing the pdf document. The name of signature. Returns the result of the signer's name. Gets the signature's datetime. The name of signature. Return the result of DateTime type. Gets the reason of a signature. The name of signature. Returns a result of string type. Gets the location of a signature. The name of signature. Returns a result of string type. Gets the contact information of a signature. The name of signature. Returns a result of string type. Checks the validity of a signature. The name of signature. Return a result of bool type. Extracts signature's image. The name of signature. If image was successfully found than returns stream object; otherwise, null. Extracts signature's single X.509 certificate as a stream. The name of signature. If certificate was found returns X.509 single certificate; otherwise, null. Save signed pdf file. Output filename must be provided before with the help of coresponding PdfFileSignature constructor. Initializes new object on base of the . Pdf document. Initializes new object on base of the . Pdf document. The output file. Set certificate file and password for signing routine. PKCS #12 certificate file. Password to get access for the certificate private key. Sets or gets a graphic appearance for the signature. Property value represents image stream. Closes the facade. Class for adding stamps (watermark or background) to PDF files. Bottom middle position. Bottom right position. Right upper position. Right position. Upper middle position. Bottom left position. Left position. Upper let position. Gets or sets optimization flag. Equal resource streams in resultant file are merged into one PDF object if this flag set. This allows to decrease resultant file size but may cause slower execution and larger memory requirements. Default value: false. Keeps security if true. (This feature will be implemented in next versions). Gets or sets name and path of input file. Gets or sets input stream. Gets or sets name and path of output file. Gets or sets output stream. Gets or sets rotation of page number. Rotation is in degrees. Default is 0. Sets PDF file format. Result file will be saved in specified file format. If this property is not specified then file will be save in default PDF format without conversion. Gets height of first page in souorce file. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); Console.WriteLine("Height = " + fileStamp.PageHeight); fileStamp.Close(); Gets width of first page in input file. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); Console.WriteLine("Width = " + fileStamp.PageWidth); fileStamp.Close(); Gets or sets starting number for first page in input file. Next pages will be numbered starting from this value. For example if StartingNumber is set to 100, document pages will have numbers 100, 101, 102... PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); fileStamp.StartingNumber = 100; fileStamp.AddPageNumber("Page #"); fileStamp.Close(); Constructor for PdfFileStamp. Input file name and path. Output file name and path. PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf"); Constructor for PdfFileStamp. Input stream. Output stream. Stream input = new FileStream("input.pdf", FileMode.Open, FileAccess.Read); Stream output = new FileStream("output.pdf", FileMode.Creat, FileAccess.Write); PdfFileStamp stamp = new PdfFileStamp(input, output); Constructor for PdfFileStamp. Input file name and path. Output file name and path. Keep security if true. Constructor of PdfFileStamp. Input stream. Output stream. Keep security if true. Closes opened files and saves changes. Warning. If input or output streams are specified they are not closed by Close() method. PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf"); //do some work... stamp.Close(); Saves result into specified file. Path to file where document will be saved. Saves document into specified stream. Stream where document will be saved. Adds stamp to the file. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); Stamp stamp = new Aspose.Pdf.Facades.Stamp(); stamp.SetOrigin(140, 400); stamp.SetImageSize(50, 50); stamp.Opacity = 0.8f; stamp.IsBackground = true; stamp.BindImage("image.jpg"); fileStamp.AddStamp(stamp); fileStamp.Close(); Stamp object which. Gets or sets pabge numbering style. Possible values: NumeralsArabic, NumeralsRomanUppercase, NumeralsRomanLowercase, LettersAppercase, LettersLowercase Add page number to file. Page number text may contain # sign which will be replaced with number of the page. Page number is placed in the bottom of the page centered horizontally. Text of page number PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); fileStamp.AddPageNumber("Page #"); fileStamp.Close(); Adds page number to the page. Page number may contain # sign which will be replaced with page number. Page number is placed in the bottom of the page centered horizontally. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); fileStamp.AddPageNumber(new FormattedText("Page #")); fileStamp.Close(); Format string for page number representes as FormattedText. Adds page number to the pages of document. Format string for page number. Position where page number will be placed on the page. 0-bottom middle, 1-bottom right, 2-upper right, 3 - sides right, 4 - upper middle,5 - bottom left,6 - sides left,7 - upper left. You can use the following constants: PosBottomMiddle = 0, PosBottomRight = 1, PosUpperRight = 2, PosSidesRight = 3, PosUpperMiddle, PosBottomLeft = 5, PosSidesLeft, PosUpperLeft Margin on the left edge of the page. Margin on the right edge of the page. Margin on the top edge of the page. Margin on the bottom edge of the page. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); fileStamp.AddPageNumber("Page #", PdfFileStamp.PosBottomLeft, 100, 100, 200, 200); fileStamp.Close(); Adds page number at the specified position on the page. Format string. Format string can contain # sign which will be replaced with page number. X coordinate of page number. Y coordinate of page number. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); fileStamp.AddPageNumber(new FormattedText("Page #"), 123, 357); fileStamp.Close(); Adds page number to the pages of document. FormattedText object which represents page number format and properties iof the text. Position where page number will be placed on the page. 0-bottom middle, 1-bottom right, 2-upper right, 3 - sides right, 4 - upper middle,5 - bottom left,6 - sides left,7 - upper left. You can use the following constants: PosBottomMiddle = 0, PosBottomRight = 1, PosUpperRight = 2, PosSidesRight = 3, PosUpperMiddle, PosBottomLeft = 5, PosSidesLeft, PosUpperLeft Margin on the left edge of the page. Margin on the right edge of the page. Margin on the top edge of the page. Margin on the bottom edge of the page. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); fileStamp.AddPageNumber(new FormattedText("Page #"), PdfFileStamp.PosBottomLeft, 100, 100, 200, 200); fileStamp.Close(); Adds page number at the specified position on the page. Formatted text which represents page number format and properties of the text. Format string can contain # sign which will be replaced with page number. X coordinate of page number. Y coordinate of page number. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); fileStamp.AddPageNumber(new FormattedText("Page #"), 123, 357); fileStamp.Close(); Adds header to the page. Text for header and properties of the text. Margin on the top of page. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); fileStamp.AddHeader(new FormattedText("Head of the page"), 50); fileStamp.Close(); Adds header to the pages of file. Formatted text object which contains page text and its properties. Margin on the top of the page. Margin on the left of the page. Margin on the right of the page. PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf"); stamp.AddHeader(new FormattedText("Head of the page"), 10, 50, 50); Adds image as header to the pages of the file. Path to the image file. Margin at top of the page. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf"); Stream input = new FileStream(TestSettings.GetInputFile("test.jpg"), FileMode.Open, FileAccess.Read); fileStamp.AddHeader("image.jpg", 50); fileStamp.Close(); Adds image as header on the pages. Path to the image file. Margin at top of the page. Margin at left side of the page. Margin at right side of the page. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf"); Stream input = new FileStream(TestSettings.GetInputFile("test.jpg"), FileMode.Open, FileAccess.Read); fileStamp.AddHeader("image.jpg", 50, 100, 100); fileStamp.Close(); Adds image as header on the pages. Stream of the image. Margin at top of the page. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf"); Stream input = new FileStream(TestSettings.GetInputFile("test.jpg"), FileMode.Open, FileAccess.Read); fileStamp.AddHeader(new FileStream("image.jpg", FileMode.Open, FileAccess.Read), 50); fileStamp.Close(); Adds image at the top of the page. Stream which contains image data. Margin at top of the page. Margin at left side of the page. Margin at right side of the page. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf"); Stream input = new FileStream(TestSettings.GetInputFile("test.jpg"), FileMode.Open, FileAccess.Read); fileStamp.AddHeader(new FileStream("image.jpg", FileMode.Open, FileAccess.Read), 50, 100, 100); fileStamp.Close(); Adds footer to the pages of the document. FormattedText object which contains text of the footer and text properties. Margin at the top of page. PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf"); stamp.AddFooter(new FormattedText("Foot of the page"), 10); Adds footer to the pages of the document. FormattedText object which contains footer text and text properties. Margin at the bottom of the page. Margin at the left side of the page. Margin at the right side of the page. PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf"); stamp.AddFooter(new FormattedText("Foot of the page"), 10, 50, 50); Adds image as footer to the pages of the document. Image file name and path. Margin at the bottom of the page. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf"); Stream input = new FileStream(TestSettings.GetInputFile("test.jpg"), FileMode.Open, FileAccess.Read); fileStamp.AddFooter("image.jpg", 50); fileStamp.Close(); Adds image as footer of the pages. Iamge file name and path. Margin at the bottom of the page. Margin at the left side of the page. Margin at the right side of the page. /// PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf"); Stream input = new FileStream(TestSettings.GetInputFile("test.jpg"), FileMode.Open, FileAccess.Read); fileStamp.AddFooter("image.jpg", 50, 100, 100); fileStamp.Close(); Adds image as footer of the page. Stream contains image data. Margin at the bottom of the page. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf"); Stream input = new FileStream(TestSettings.GetInputFile("test.jpg"), FileMode.Open, FileAccess.Read); fileStamp.AddFooter(new FileStream("image.jpg", FileMode.Open, FileAccess.Read), 50); fileStamp.Close(); Adds image as footer of the page. Stream contains image data. Margin at the bottom of the page. Margin at the left side of the page. Margin at the right side of the page. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf"); Stream input = new FileStream(TestSettings.GetInputFile("test.jpg"), FileMode.Open, FileAccess.Read); fileStamp.AddFooter(new FileStream("image.jpg", FileMode.Open, FileAccess.Read), 50, 50, 50); fileStamp.Close(); Adds page number to the pages. Format of the page number. This text may contain # which will be replaced with page number. Position where page number will be placed on the page. 0-bottom middle, 1-bottom right, 2-upper right, 3 - sides right, 4 - upper middle,5 - bottom left,6 - sides left,7 - upper left. You can use the following constants: PosBottomMiddle = 0, PosBottomRight = 1, PosUpperRight = 2, PosSidesRight = 3, PosUpperMiddle, PosBottomLeft = 5, PosSidesLeft, PosUpperLeft PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); fileStamp.AddPageNumber("Page #", PdfFileStamp.PosUpperRight); fileStamp.Close(); Adds page number to the pages. FormattedText object which contains format of the page number and text properties. This text may contain # which will be replaced with page number. Position where page number will be placed on the page. 0-bottom middle, 1-bottom right, 2-upper right, 3 - sides right, 4 - upper middle,5 - bottom left,6 - sides left,7 - upper left. You can use the following constants: PosBottomMiddle = 0, PosBottomRight = 1, PosUpperRight = 2, PosSidesRight = 3, PosUpperMiddle, PosBottomLeft = 5, PosSidesLeft, PosUpperLeft PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); fileStamp.AddPageNumber("Page #", PdfFileStamp.PosUpperRight); fileStamp.Close(); Constructor of the PdfFileStamp. Input file and output file may be specified via corresponding properties. PdfFileStamp fileStamp = new PdfFileStamp(); fileStamp.InputFile = "input.pdf"; fileStamp.OutputFile = "output.pdf"; Initializes new object on base of the . Pdf document. Initializes new object on base of the . Pdf document. Output file name and path. Initializes new object on base of the . Pdf document. Output stream. Stamp ID of next added stamp (incluiding page headers/hooters/page numbers). Class for removing all Java Script code. Remove Java Script from document. File containig the document. File where document will be stored. true if JavaScript was stripped successfully. Remove Java Script from the document. Stream containing document. Stream where the document will be stored. true if JavaScript was stripped successfully. Represents a class to edit the PDF file's page, including rotating page, zooming page, moving position and changing page size. Constructor for PdfPageEditor class. Constructor for PdfPageEditor class. Document object which should be processed. Out Vertical Split Out Horizontal Split In Vertical Split IN Horizontal Split Vertical Blinds Vertical Blinds Inward Box Outward Box Left-Right Wipe Right-Left Wipe Bottom-Top Wipe Top-Bottom Wipe The old page dissolves Left-Right Glitter Top-Bottom Glitter Diagonal Glitter Gets or sets duration of the transition effect. Gets or sets transition style to use when moving to this page from another during a presentation. Gets or sets display duration for pages. Gets or sets the page numbers to be edited. By default, each page would be edited. Gets or sets the rotation of the pages, the rotation must be 0, 90, 180 or 270. Default value is 0. A hashtable contains the page number and rotation degree, the key represents the page number, the value of key represents the rotation in degrees. Get or sets zoom coefficient. Value 1.0 corresponds to 100%. Default value is 1.0. The following example demonstrates how to change zoom of the document pages. PdfPageEditor editor = new PdfPageEditor(); editor.BindPdf("sample.pdf"); editor.Zoom = 0.5f; Gets or sets the output file's page size. Gets or sets the horizontal alignment of the original PDF content on the result page, default is AlignmentType.Left. Gets or sets the horizontal alignment of the original PDF content on the result page, default is AlignmentType.Left. Gets or Sets the vertical alignment of the original PDF content on the result page, default is VerticalAlignmentType.Bottom. Gets or Sets the vertical alignment of the original PDF content on the result page, default is VerticalAlignmentType.Bottom. Moves the origin from (0, 0) to the point that appointted. The origin is left-bottom and the unit is point(1 inch = 72 points). X-coordinate. Y-coordinate. PdfPageEditor editor = new PdfPageEditor(); editor.BindPdf("input.pdf"); editor.MovePosition(-100, 60); editor.Save("moved.pdf"); Returns total number of pages. Number of pages. The following example demonstrates using of GetPages() method: PdfPageEditor editor = new PdfPageEditor(); editor.BindPdf("sample.pdf"); Console.WriteLine("Document has: " + editor.GetPages()); Returns the page size of the specified page. Page index. Document pages are numbered from 1. Result is instance of PageSize. Use Width and Height properties of the returned object to get page width and height. The following example demonstrates using of GetPageSize method: PdfPageEditor editor = new PdfPageEditor(); editor.BindPdf("sample.pdf"); PageSize size = editor.GetPageSize(1); Console.WriteLine("Size of 1st page : " + size.Width + " x " + size.Height); Returns the rotation of specified page. Page index. Document pages are numbered from 1. Page rotation in degrees. The following example demonstrates how to get page rotation: PdfPageEditor editor = new PdfPageEditor(); editor.BindPdf("sample.pdf"); int rotation = editor.GetPageSize(1); Console.WriteLine("Rotation of 1st page : " + rotation + " degrees"); Returns size of specified box in document. Page index. Document pages are numbered from 1. Box type name. Valid values are: "art", "bleed", "crop", "media", "trim". Rectangle which contains requested box. The following example demonstrates how to get media box of the 1st page: PdfPageEditor editor = new PdfPageEditor(); editor.BindPdf("sample.pdf"); System.Drawing.Rectangle rect = editor.GetBoxSize(1, "media"); Saves changed document into file. Path to file where document will be saved. The following sample demonstrates how to save changed PDF document PdfPageEditor editor = new PdfPageEditor(); editor.BindPdf("sample.pdf"); editor.Zoom = 0.5f; editor.Save("newdocument.pdf"); Saves changed document into stream. Stream where changed PDF document will be saved. The following sample demonstrates how to save changed PDF document into stream. PdfPageEditor editor = new PdfPageEditor(); editor.BindPdf("sample.pdf"); editor.Zoom = 0.5f; editor.Save("newdocument.pdf"); Apply changes made to the document pages. Represents a class to produce PDF from other formats. This sample shows how to produce Pdf file from CGM file. string inputFile = "myImage.cgm"; string outputFile = "myPdf.pdf"; try { PdfProducer.Produce(inputFile, ImportFormat.Cgm, outputFile); // Success produced pdf file. } catch (InvalidCgmFileFormatException e) { // Do something... } ImportOptions holds level of abstraction on individual import options. Constructor. Import option. Produce the PDF stream using specified import format. This sample shows how to produce Pdf stream from CGM stream. string inputFile = "myImage.cgm"; string outputFile = "myPdf.pdf"; using (FileStream inputStream = File.OpenRead(inputFile)) using (FileStream outputStream = File.Create(outputFile)) { PdfProducer.Produce(inputStream, ImportFormat.Cgm, outputStream); } Input stream. Import format. Output PDF stream. The exception is thrown when a file is invalid. Input or output stream is null Produce the PDF stream using specified import format. This sample shows how to produce Pdf stream from CGM file. string inputFile = "myImage.cgm"; string outputFile = "myPdf.pdf"; using (FileStream outputStream = File.Create(outputFile)) { PdfProducer.Produce(inputFile, ImportFormat.Cgm, outputStream); } Input file name. Import format. Output PDF stream. The exception is thrown when a file is invalid. Output stream is null Input file name is an empty string Produce the PDF file using specified import format. This sample shows how to produce Pdf file from CGM stream. string inputFile = "myImage.cgm"; string outputFile = "myPdf.pdf"; using (FileStream inputStream = File.OpenRead(inputFile)) using (FileStream outputStream = File.Create(outputFile)) { PdfProducer.Produce(inputStream, ImportFormat.Cgm, outputStream); } Input stream. Import format. Output PDF file The exception is thrown when a file is invalid. Input stream is null Output file name is an empty string Produce the PDF file using specified import format. This sample shows how to produce Pdf file from CGM file. string inputFile = "myImage.cgm"; string outputFile = "myPdf.pdf"; PdfProducer.Produce(inputFile, ImportFormat.Cgm, outputFile); Input file name. Import format. Output PDF file The exception is thrown when a file is invalid. Input or output file name is an empty string Produce the PDF stream using specified import option. This sample shows how to produce Pdf stream from CGM file. string inputFile = "myImage.cgm"; string outputFile = "myPdf.pdf"; ImportOptions importOptions = new CgmImportOptions(); using (FileStream outputStream = File.Create(outputFile)) { PdfProducer.Produce(inputFile, importOptions, outputStream); } Input file name. Import option. Output PDF stream. The exception is thrown when a file is invalid. Output stream is null Input file name is an empty string Produce the PDF file using specified import option. This sample shows how to produce Pdf file from CGM stream. string inputFile = "myImage.cgm"; string outputFile = "myPdf.pdf"; ImportOptions importOptions = new CgmImportOptions(); using (FileStream inputStream = File.OpenRead(inputFile)) { PdfProducer.Produce(inputStream, importOptions, outputFile); } Input stream. Import option. Output PDF file. The exception is thrown when a file is invalid. Input stream is null Output file name is an empty string Produce the PDF file using specified import option. This sample shows how to produce Pdf file from CGM file. string inputFile = "myImage.cgm"; string outputFile = "myPdf.pdf"; ImportOptions importOptions = new CgmImportOptions(); PdfProducer.Produce(inputStream, importOptions, outputStream); Input file name. Import option. Output PDF stream. The exception is thrown when a file is invalid. Input or output file name is an empty string Produce the PDF file using specified import option. This sample shows how to produce Pdf stream from CGM stream. string inputFile = "myImage.cgm"; string outputFile = "myPdf.pdf"; ImportOptions importOptions = new CgmImportOptions(); using (FileStream inputStream = File.OpenRead(inputFile)) using (FileStream outputStream = File.Create(outputFile)) { PdfProducer.Produce(inputStream, importOptions, outputStream); } Input stream. Import option. Output PDF stream. The exception is thrown when a file is invalid. Input or output stream is null. Represents a class to view or print a pdf. Adds/removes subscription on the last page printing event. Gets or sets flag that controls visibility of hidden areas on the page. Gets the result of printing job. If success than null; otherwise, exception object. Adds/removes subscription on the last page printing event. Gets/sets the using of conversion of pdf page into intermidiate png file during printing in file mode. Use it when the size of output file is important. Initializes new object. Initializes new object. Document object. Gets or sets the page coordinate type (Media/Crop boxes). CropBox value is used by default. Sets or gets a mode for PdfViewer to print as image. If true prints always as image (generates image that is printed) If false prints directly to device if all features are supported. In case document contains non-supported features the system may automatically decide to print as image. Default falue is false. Gets page count of the current Pdf file. return page count. Gets or sets input document password. Gets or sets a bool value that indicates whether produce the page number dialog when printing. Gets or sets a bool value that indicates whether the page is being printed as grayscale. By default is false. Default falue is false. Gets or sets name of document in printer queue when document is printed. Default value is file name. Gets or sets form presentation mode. Gets or sets rendering options. Gets or sets a value that indicates vertical alignment Gets or sets a value that indicates horizontal alignment Gets or sets a bool value that indicates whether the file be printed with optimized size. If false print page without page scaling. If true print page with scaling to fit to printable area. Gets or sets a bool value that indicates whether the file be printed with auto rotation Gets or sets a AutoRotateMode value that indicates direction of rotation Gets or sets resolution during viewing and printing. The higher resolution, the slower speed. The default value is 150. Opens and prints a large Pdf file. If your Pdf file has hundreds of pages or more or its size is more than 3 MB, this method is recommended to get better performance. This method has integrated the opening and the printing of the file and you need not calling the OpenPdfFile() explicitly. The path of Pdf file. [C#] PdfViewer viewer = new PdfViewer(); viewer.AutoResize = true; //print the file with adjusted size viewer.AutoRotate = true; //print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing viewer.PrintLargePdf(@"d:\test.pdf"); [VisualBasic] Dim viewer As PdfViewer = new PdfViewer(); viewer.AutoResize = true 'print the file with adjusted size viewer.AutoRotate = true 'print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing viewer.PrintLargePdf(@"d:\test.pdf") viewer.ClosePdfFile(); Opens and prints a large Pdf stream. If your Pdf file has hundreds of pages or more or its size is more than 3 MB, this method is recommended to get better performance. This method has integrated the opening and the printing of the file and you need not calling the OpenPdfFile() explicitly. The pdf stream to be opened and printed.. [C#] PdfViewer viewer = new PdfViewer(); viewer.AutoResize = true; //print the file with adjusted size viewer.AutoRotate = true; //print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing viewer.PrintLargePdf(new MemoryStream(File.ReadAllBytes(@"d:\test.pdf"))); viewer.ClosePdfFile(); [VisualBasic] Dim viewer As PdfViewer = new PdfViewer(); viewer.AutoResize = true 'print the file with adjusted size viewer.AutoRotate = true 'print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing viewer.PrintLargePdf(new MemoryStream(File.ReadAllBytes(@"d:\test.pdf"))) viewer.ClosePdfFile() Opens and prints a large Pdf file with specified printer settings. If your Pdf file has hundreds of pages or more or its size is more than 3 MB, this method is recommended to get better performance. This method has integrated the opening and the printing of the file and you need not calling the OpenPdfFile() explicitly. The path of Pdf file. The printer settings. [C#] PdfViewer viewer = new PdfViewer(); viewer.AutoResize = true; //print the file with adjusted size viewer.AutoRotate = true; //print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing System.Drawing.Printing.PrinterSettings ps = new System.Drawing.Printing.PrinterSettings(); PrintDocument prtdoc = new PrintDocument(); ps.PrinterName = prtdoc.PrinterSettings.PrinterName; viewer.PrintLargePdf(@"d:\test.pdf",ps); viewer.ClosePdfFile(); [VisualBasic] Dim viewer As PdfViewer = new PdfViewer(); viewer.AutoResize = true 'print the file with adjusted size viewer.AutoRotate = true 'print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing Dim ps As System.Drawing.Printing.PrinterSettings = new System.Drawing.Printing.PrinterSettings() Dim prtdoc As PrintDocument = new PrintDocument() ps.PrinterName = prtdoc.PrinterSettings.PrinterName viewer.PrintLargePdf(@"d:\test.pdf",ps) viewer.ClosePdfFile() Opens and prints a large Pdf stream with specified printer settings. If your Pdf file has hundreds of pages or more or its size is more than 3 MB, this method is recommended to get better performance. This method has integrated the opening and the printing of the file and you need not calling the OpenPdfFile() explicitly. The pdf stream to be opened and printed.. The printer settings. [C#] PdfViewer viewer = new PdfViewer(); viewer.AutoResize = true; //print the file with adjusted size viewer.AutoRotate = true; //print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing System.Drawing.Printing.PrinterSettings ps = new System.Drawing.Printing.PrinterSettings(); PrintDocument prtdoc = new PrintDocument(); ps.PrinterName = prtdoc.PrinterSettings.PrinterName; viewer.PrintLargePdf(new MemoryStream(File.ReadAllBytes(@"d:\middleware.pdf")),ps); viewer.ClosePdfFile(); [VisualBasic] Dim viewer As PdfViewer = new PdfViewer(); viewer.AutoResize = true 'print the file with adjusted size viewer.AutoRotate = true 'print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing Dim ps As System.Drawing.Printing.PrinterSettings = new System.Drawing.Printing.PrinterSettings() Dim prtdoc As PrintDocument = new PrintDocument() ps.PrinterName = prtdoc.PrinterSettings.PrinterName viewer.PrintLargePdf(new MemoryStream(File.ReadAllBytes(@"d:\middleware.pdf")),ps) viewer.ClosePdfFile() Opens and prints a large Pdf file with specified page settings and printer settings. If your Pdf file has hundreds of pages or more or its size is more than 3 MB, this method is recommended to get better performance. This method has integrated the opening and the printing of the file and you need not calling the OpenPdfFile() explicitly. The path of Pdf file. The page settings. The printer settings. [C#] PdfViewer viewer = new PdfViewer(); viewer.AutoResize = true; //print the file with adjusted size viewer.AutoRotate = true; //print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing System.Drawing.Printing.PrinterSettings ps = new System.Drawing.Printing.PrinterSettings(); PrintDocument prtdoc = new PrintDocument(); ps.PrinterName = prtdoc.PrinterSettings.PrinterName; PageSettings pgs = new PageSettings(); pgs.PaperSize = new System.Drawing.Printing.PaperSize("A4", 827, 1169); pgs.Margins = new Margins(0, 0, 0, 0); viewer.PrintLargePdf(@"d:\test.pdf",pgs,ps); viewer.ClosePdfFile(); [VisualBasic] Dim viewer As PdfViewer = new PdfViewer(); viewer.AutoResize = true 'print the file with adjusted size viewer.AutoRotate = true 'print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing Dim ps As System.Drawing.Printing.PrinterSettings = new System.Drawing.Printing.PrinterSettings() Dim prtdoc As PrintDocument = new PrintDocument() ps.PrinterName = prtdoc.PrinterSettings.PrinterName Dim pgs As PageSettings=new PageSettings() pgs.PaperSize = new System.Drawing.Printing.PaperSize("A4", 827, 1169) pgs.Margins = new Margins(0, 0, 0, 0) viewer.PrintLargePdf(@"d:\test.pdf",pgs,ps) viewer.ClosePdfFile() Opens and prints a large Pdf stream with specified page settings and printer settings. If your Pdf file has hundreds of pages or more or its size is more than 3 MB, this method is recommended to get better performance. This method has integrated the opening and the printing of the file and you need not calling the OpenPdfFile() explicitly. The pdf stream to be opened and printed. The page settings. The printer settings. [C#] PdfViewer viewer = new PdfViewer(); viewer.AutoResize = true; //print the file with adjusted size viewer.AutoRotate = true; //print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing System.Drawing.Printing.PrinterSettings ps = new System.Drawing.Printing.PrinterSettings(); PrintDocument prtdoc = new PrintDocument(); ps.PrinterName = prtdoc.PrinterSettings.PrinterName; PageSettings pgs = new PageSettings(); pgs.PaperSize = new System.Drawing.Printing.PaperSize("A4", 827, 1169); pgs.Margins = new Margins(0, 0, 0, 0); viewer.PrintLargePdf(new MemoryStream(File.ReadAllBytes(@"d:\middleware.pdf")),pgs,ps); viewer.ClosePdfFile(); [VisualBasic] Dim viewer As PdfViewer = new PdfViewer(); viewer.AutoResize = true 'print the file with adjusted size viewer.AutoRotate = true 'print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing Dim ps As System.Drawing.Printing.PrinterSettings = new System.Drawing.Printing.PrinterSettings() Dim prtdoc As PrintDocument = new PrintDocument() ps.PrinterName = prtdoc.PrinterSettings.PrinterName Dim pgs As PageSettings=new PageSettings() pgs.PaperSize = new System.Drawing.Printing.PaperSize("A4", 827, 1169) pgs.Margins = new Margins(0, 0, 0, 0) viewer.PrintLargePdf(new MemoryStream(File.ReadAllBytes(@"d:\middleware.pdf")),pgs,ps) viewer.ClosePdfFile() Get pages of current pdf file. return the array of Pdf page images. Decodes a page of one Pdf file. The page number of one Pdf file which must be between 1 and PageCount. return the Pdf page image. Prints the Pdf document with a setup dialog. Choose a printer using the dialog. [C#] PdfViewer viewer = new PdfViewer(); viewer.OpenPdfFile(@"d:\test.pdf"); viewer.AutoResize = true; //print the file with adjusted size viewer.AutoRotate = true; //print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing viewer.PrintDocumentWithSetup(); viewer.ClosePdfFile(); [VisualBasic] Dim viewer As PdfViewer = new PdfViewer() viewer.OpenPdfFile(@"d:\test.pdf") viewer.AutoResize = true 'print the file with adjusted size viewer.AutoRotate = true 'print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing viewer.PrintDocumentWithSetup() viewer.ClosePdfFile() Prints the Pdf document with settings. If the document size is not complatible to page size, pdf.kit will extend it to fit page size. The page setting of the printing document. The printer setting of the printing document. [C#] PdfViewer viewer = new PdfViewer(); viewer.OpenPdfFile(@"d:\test.pdf"); viewer.AutoResize = true; //print the file with adjusted size viewer.AutoRotate = true; //print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing System.Drawing.Printing.PrinterSettings ps = new System.Drawing.Printing.PrinterSettings(); PrintDocument prtdoc = new PrintDocument(); ps.PrinterName = prtdoc.PrinterSettings.PrinterName; PageSettings pgs = new PageSettings(); pgs.PaperSize = new System.Drawing.Printing.PaperSize("A4", 827, 1169); pgs.Margins = new Margins(0, 0, 0, 0); viewer.PrintDocumentWithSettings(pgs, ps); viewer.ClosePdfFile(); [VisualBasic] Dim viewer As PdfViewer = new PdfViewer() viewer.OpenPdfFile(@"d:\test.pdf") viewer.AutoResize = true; 'print the file with adjusted size viewer.AutoRotate = true; 'print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing Dim ps As System.Drawing.Printing.PrinterSettings = new System.Drawing.Printing.PrinterSettings() Dim prtdoc As PrintDocument = new PrintDocument() ps.PrinterName = prtdoc.PrinterSettings.PrinterName Dim pgs As PageSettings=new PageSettings() pgs.PaperSize = new System.Drawing.Printing.PaperSize("A4", 827, 1169) pgs.Margins = new Margins(0, 0, 0, 0) viewer.PrintDocumentWithSettings(pgs, ps) viewer.ClosePdfFile() printerSettings object is used to print the document. pageSettings.PrinterSettings object is ignored. Prints the Pdf document with printer settings. The output page size will fit the the document first page size. The printer setting of the printing document. [C#] PdfViewer viewer = new PdfViewer(); viewer.OpenPdfFile(@"d:\test.pdf"); viewer.AutoResize = true; //print the file with adjusted size viewer.AutoRotate = true; //print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing System.Drawing.Printing.PrinterSettings ps = new System.Drawing.Printing.PrinterSettings(); PrintDocument prtdoc = new PrintDocument(); ps.PrinterName = prtdoc.PrinterSettings.PrinterName; viewer.PrintDocumentWithSettings(ps); viewer.ClosePdfFile(); [VisualBasic] Dim viewer As PdfViewer = new PdfViewer() viewer.OpenPdfFile(@"d:\test.pdf") viewer.AutoResize = true; 'print the file with adjusted size viewer.AutoRotate = true; 'print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing Dim ps As System.Drawing.Printing.PrinterSettings = new System.Drawing.Printing.PrinterSettings() Dim prtdoc As PrintDocument = new PrintDocument() ps.PrinterName = prtdoc.PrinterSettings.PrinterName viewer.PrintDocumentWithSettings(ps); viewer.ClosePdfFile() Prints the Pdf document using default printer. [C#] PdfViewer viewer = new PdfViewer(); viewer.OpenPdfFile(@"d:\test.pdf"); viewer.AutoResize = true; //print the file with adjusted size viewer.AutoRotate = true; //print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing viewer.PrintDocument(ps); viewer.ClosePdfFile(); [VisualBasic] Dim viewer As PdfViewer = new PdfViewer() viewer.OpenPdfFile(@"d:\test.pdf") viewer.AutoResize = true; 'print the file with adjusted size viewer.AutoRotate = true; 'print the file with adjusted rotation viewer.PrintPageDialog=false;//do not produce the page number dialog when printing viewer.PrintDocument(ps); viewer.ClosePdfFile() Gets the default page settings. Page settings object. Gets the default printer settings. Printer settings object. Opens a Pdf file, but does not actually decode the pages of the Pdf file. The path of Pdf file. [C#] PdfViewer viewer = new PdfViewer(); viewer.OpenPdfFile(@"d:\test.pdf"); viewer.ClosePdfFile(); [VisualBasic] Dim viewer As PdfViewer = new PdfViewer() viewer.OpenPdfFile(@"d:\test.pdf") viewer.ClosePdfFile() Opens a Pdf file stream. But does not actually decode the pages of the Pdf file. The pdf stream to be opened. [C#] PdfViewer viewer = new PdfViewer(); viewer.OpenPdfFile(new MemoryStream(File.ReadAllBytes(@"d:\test.pdf"))); viewer.ClosePdfFile(); [VisualBasic] Dim viewer As PdfViewer = new PdfViewer() viewer.OpenPdfFile(new MemoryStream(File.ReadAllBytes(@"d:\test.pdf"))) viewer.ClosePdfFile() Closes the current Pdf file. Gets or sets a floating point value that indicates scale factor. The default value is 1.0. Initializes the facade. The PDF file. Initializes the facade. The stream of PDF file. Initializes the facade. The Aspose.Pdf.Document object. Saves the result PDF document to file. The path of output PDF document. Saves the result PDF document to stream. The stream of output PDF document. Closes the facade. Disposes the facade resources. Class for manipulation with XMP metadata. Constructor for PdfXmpMetadata. PdfXmlMetadata xmp = new PdfXmpMetadata(); xmp.BindPdf("input.pdf"); Initializes new object on base of the . Pdf document. Registers the namespace URI. The prefix. The namespace URI. PdfXmpMetadata xmp = new PdfXmpMetadata("input.pdf"); xmp.RegisterNamespaceURI("xmp", "http://ns.adobe.com/xap/1.0/"); Gets namespace URI by prefix. The prefix. Namespace URI. PdfXmpMetadata xmp = new PdfXmpMetadata("input.pdf"); Console.WriteLine(xmp.GetNamespaceURIByPrefix("xmp")); Gets the prefix by namespace URI. Namespace URI. The prefix value. PdfXmpMetadata xmp = new PdfXmpMetadata("input.pdf"); Console.WriteLine(xmp.GetPrefixByNamespaceURI("http://ns.adobe.com/xap/1.0/")); Adds value to XMP metadata. The key name. Value which will be added. PdfXmpMetadata xmp = new PdfXmpMetadata(); xmp.BindPdf("input.pdf"); xmp.Add(DefaultMetadataProperties.Nickname, "name1"); xmp.Save(TestSettings.GetOutputFile("XMP_AddedValue.pdf")); Adds extension field into metadata. The pdf extension object to add. The prefix of schema. The namespace uri of schema. The optional description of schema. Removes all elements from the object. PdfXmpMetadata xmp = new PdfXmpMetadata(); xmp.BindPdf("input.pdf"); xmp.Clear(); Removes element with specified key. Key of the element which will be deleted. PdfXmpMetadata xmp = new PdfXmpMetadata(); xmp.BindPdf("input.pdf"); xmp.Remove(DefaultMetadataProperties.Nickname); Adds new element to the dictionary object. Key of new element. Value of the element. PdfXmpMetadata xmp = new PdfXmpMetadata(); xmp.BindPdf("input.pdf"); xmp.Add("xmp:Nickname", "Nickname1"); Adds new element to the dictionary object. Key of new element. Value of the element. Checks if dictionary contains the specified key. Key which will be checked. True - if the dictionary contains the specified key; otherwise, false. PdfXmpMetadata xmp = new PdfXmpMetadata(); xmp.BindPdf("input.pdf"); xmp.Add("xmp:Nickname", "Nickname1"); if (!xmp.Contains("xmp:Nickname")) Console.WriteLine("Key does not exists"); Checks if dictionary contains the specified property. Property which will be checked. True - if the dictionary contains the specified property; otherwise, false. Gets enumerator object of the dictionary. The enumerator object. Gets keys from the dictionary. Removes key from the dictionary. Key which will be removed. PdfXmpMetadata xmp = new PdfXmpMetadata(); xmp.BindPdf("input.pdf"); xmp.Remove("xmp:Nickname"); Gets the dictionary of extension fields. Gets the collection of values in dictionary. Gets or sets value by key. The key name to get/set. Object by key PdfXmpMetadata pxm = new PdfXmpMetadata(); pxm.BindPdf("PdfFile.pdf"); Console.WriteLine(pxm["xmp:Nickname"]); Returns true is collection has fixed size. Returns true if collection is read-only. Gets count if items in the collection. PdfXmpMetadata pxm = new PdfXmpMetadata(); pxm.BindPdf("PdfFile.pdf"); Console.WriteLine("Count = " + pxm.Count); Returns true if collection is synchronized. Gets synchroniztion object of the collection. Gets value of XMP metadata by key. Key of the value. Value from XMP metadata. PdfXmpMetadata pxm = new PdfXmpMetadata(); pxm.BindPdf("PdfFile.pdf"); Console.WriteLine(pxm[DefaultMetadataProperties.CreatorTool]); Get the XmpMetadata of the input pdf in a xml format. The bytes of the XmpMetadata. PdfXmpMetadata pxm = new PdfXmpMetadata(); pxm.BindPdf("PdfFile.pdf"); byte[] data = pxm.GetXmpMetadata(); Get a part of the XmpMetadata of the input pdf according to a meta name. Metadata name. Bytes of metadata. PdfXmpMetadata pxm = new PdfXmpMetadata(); pxm.BindPdf("PdfFile.pdf"); byte[] data = pxm.GetXmpMetadata("dc:creator"); Determines does this dictionary contasins specified key. Key to search in the dictionary. true if key is found. Tries to find key in the dictionary and retreives value if found. Key to search in the dictionary. Retreived value. true if key was found. Adds pair with key and value into the dictionary. Item to be added. Checks does specified key-value pair is contained in the dictionary. Key-value pair. true if this pauir was found. Removes key/value pair from the colleciton. Key/value pair to be removed. true if pair was found and removed. Defines positioning mode. Possible values include Legacy (backward compatibility) and Current (updated text position calculation method) Legacy text positioning Updated line spacing, vertical position calculation is done by the old rules (i.e. text is positioned relative to bottom-left corner of the specified rectangle) Updated line spacing and vertical position calculation is done based on left-top corner rather than left-bottom. Enumeration of possible field flags. Field is read-only. Field is required. Field is not exportable. Invalid field flag. Class represeting stamp. Gets or sets identifier of stamp. Gets or sets quality of image stamp in percent. Valiued values 0..100%. Gets or sets opacity of the stamp. Gets or sets page number. Gets or sets array with numbers of pages which will be affected by stamp. If Pages = null all pages of the document are affected. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); Stamp stamp = new Aspose.Pdf.Facades.Stamp(); stamp.BindLogo(new FormattedText(text)); //put stamp only on 1st, 4th and 6th page. stamp.Pages = new int[] { 1, 4, 6 }; fileStamp.AddStamp(stamp); fileStamp.Close(); Gets or sets rotation of the stamp in degrees. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); Stamp stamp = new Stamp(); stamp.BindLogo(new FormattedText("STAMP")); stamp.Rotation = 90; fileStamp.AddStamp(stamp); fileStamp.Close(); Gets or sets background status. If true stamp will be placed as background of the spamped page. By default is set to false. /// PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); Stamp stamp = new Stamp(); stamp.BindLogo(new FormattedText("STAMP")); stamp.IsBackground = true; fileStamp.AddStamp(stamp); fileStamp.Close(); Gets or sets a BlendingColorSpace value that defines a color space that is used to perform transparency and blending operations on the page. Sets PDF file and number of page which will be used as stamp. Path to PDF file. Number of page in PDF file PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); Stamp stamp = new Stamp(); //First page will be used as stamp. stamp.BindPdf("stamp.pdf", 1); stamp.IsBackground = true; fileStamp.AddStamp(stamp); fileStamp.Close(); Sets PDF file and number of page which will be used as stamp. Stream which contains PDF document. Page index of the document whihc will be used as stamp. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); Stamp stamp = new Stamp(); //First page will be used as stamp. Stream stream = new FileStream("stamp.pdf", FileMode.Open, FileAccess.Read); stamp.BindPdf(stream, 1); fileStamp.AddStamp(stamp); fileStamp.Close(); Sets image as a stamp. Image file name and path. PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf"); Stamp stamp = new Stamp(); stamp.BindImage("image.jpg"); fileStamp.AddStamp(stamp); fileStamp.Close(); Sets text as stamp. FormattedText object which specifies text and text properties. Sets text state of stamp text. TextState object which specifies text properties. Sets position on page where stamp will be placed. X coordinate of the stamp. Y coordinate of the stamp. Sets size of image stamp. Image will be scaled according to the specified values. Image width. Image height. Sets image which will be used as stamp. Stream which contains image data. Class representing stamp information. Gets identifier of the stamp. Gets stamp index on the page. Gets stamp type (image / form). Gets rectangle where stamp is placed. Gets image of stamp. May be null if stamp does not contain images (for example for text stamp). Gets XForm of the stamp. Gets text in the stamp. Gets visibility of stamp. If false then stamp is hidden (with HideStampById). Hidden stamp may be restored by ShowStampById. Describes stamp types. Stamp if Form. Stamp is image. Enumeration of possible submit form flags. Data will be returned in FDF format. Data will be returned in HTML format. Data will be returned in XFDF format. Data will be returned in FDF format with comments. Data will be returned in XFDF format with comments. Whole PDF file will be submitted. Represents text properties such as: text size, color, style etc. Gets or sets text color. Gets or sets a value that indicates whether the property is specified. Gets or sets text size. Gets or sets a value that indicates whether the property is specified. Creates object for the specified text size Text size value. Class representing possible vertical alignment values. Initializes vertical alignment by its name. Vertical alignment type name. Top alignment. Center alignment type. Bottom alignment type. Returns string representation. Name value. Describes viewer prefereces (page mode, non full screen page mode, page layout). Optional content group panel visible. A flag specifying whether the window�s title bar should display the document title Optional content group panel visible. Display one page at a time. Display the pages in one column. Display the pages in two columns, with odd-numbered pages on the right Display the pages in two columns, with odd-numbered pages on the right. Neither document outline nor thumbnail images visible Document outline visible. Thumbnail images visible. Full-screen mode, with no menu bar, window controls, or any other window visible. Page mode with attacments. A flag specifying whether to hide the conforming reader�s tool bars when the document is active. A flag specifying whether to hide the conforming reader�s menu bar when the document is active. A flag specifying whether to hide user interface elements in the document�s window (such as scroll bars and navigation controls), leaving only the document�s contents displayed. A flag specifying whether to resize the document�s window to fit the size of the first displayed page. A flag specifying whether to position the document�s window in the center of the screen. Neither document outline nor thumbnail images visible. Document outline visible. Thumbnail images visible Text reading order left to right. Text reading order right to left. Print single-sided. Duplex and flip on the short edge of the sheet. Duplex and flip on the short edge of the sheet. Defines word wrapping strategies Default algorithm (allows breaking words in the middle) Word wrapping only wraps complete words. If the complete word cannot be wrapped, attempts to wrap word in the middle This class contains parameters which define PdfContentEditor behavior when ReplaceText operation is performed. Scope where replace text operation is applied REPLACE_FIRST by default Replace only first occurence of the text on each of affected pages Replace all text occurences on all affected pages Action to perform if font does not contain required character Throw exception Repalce font to standard font which contains required character Replace text anyway without font substitution If false, string to find is a simple text. If true, string to find is regular expression. Action which is performed when no approppriate font found for changed text (Throw exception / Substitute other font / Replace anyway). Scope of the replacement operation (replace first occurence or replace all occurences). Direction of the rotation when document is printed. No rotation. Rotation direction is clockwise. Rotation directon is counterclockwise. The Aspose.Pdf.Facades namespace provides classes originaly came from Aspose.Pdf.Kit. These classes are used for manipulating documents perfoming operations like concatenating, stamping, signing, annotating etc. but on the high level without access to a document's inner structure. Base facade class. Gets the document facade is working on. The constructor. The constructor. The Aspose.Pdf.Document object. Initializes the facade. The PDF file. Initializes the facade. The stream of PDF file. Initializes the facade. The Aspose.Pdf.Document object. Initializes the facade. The PDF file. The password of the PDF document. Initializes the facade. The stream of PDF file. The password of the PDF document. Disposes Aspose.Pdf.Document bound with a facade. Disposes the facade. Asserts if the facade is initialized. Base class for all saveable facades. The constructor. The constructor. The Aspose.Pdf.Document object. Saves the PDF document to the specified file. The destination file. Saves the PDF document to the specified stream. The destination stream. General facade interface that defines common facades methods. Binds PDF document for editing. The path of input PDF document. Binds PDF document for editing. The stream of input PDF document. Binds PDF document for editing. Input PDF document. Releases any resources associates with the current facade. Facade interface that defines methods common for all saveable facades. Saves the result PDF document to file. The path of output PDF document. Saves the result PDF document to stream. The stream of output PDF document. Encoding of the attached file. Possible values: Zip - file is compressed with ZIP, None - file is non compressed. File is not compressed. File is compressed with ZIP algorithhm. This class represents a columns info. Gets or sets a string that contains the width of columns. The value of each column should be separated by blank.The default unit is point, but cm, inch and percentage of available width are also supported. For example,"120 2.5cm 1.5inch" Gets or sets a string that contains the spacing between columns. The value of each spacing should be separated by blank. The default unit is point, but cm and inch are also supported.For example,"120 2.5cm 1.5inch". If this property is not set, default value 0 will be used for each spacing. Gets or sets a int value that indicates the number of columns. Represents gradient axial shading class. Initializes a new instance of the class. Initializes a new instance of the class. The start point. The end point. Gets or sets start point. Gets or sets end point. Gets or sets start color. Gets or sets end color. Represents gradient radial shading type. Initializes a new instance of the class. Initializes a new instance of the class. The starting circle color. The ending circle color. Gets or sets starting circle center point. Gets or sets ending circle center point. Gets or sets starting circle radius. Gets or sets ending circle radius. Gets or sets start color. Gets or sets end color. Represents base pattern class. This enum represents image formats. Represents ellipse. Initializes a new instance of the class. The left position of the ellipse. The bottom position of the ellipse. The width of the ellipse. The height of the ellipse. Gets or sets a float value that indicates the left position of the ellipse. Gets or sets a float value that indicates the bottom position of the ellipse. Gets or sets a float value that indicates the width of the ellipse. Gets or sets a float value that indicates the height of the ellipse. Represents arc. Initializes a new instance of the class. The shape array contains path segments set. Initializes a new instance of the class. Gets or sets shapes collection. The Aspose.Pdf.Drawing namespace provides classes describing graphic primitives like arc, line, circle etc. Corresponding objects can be used for creating new documents. Represents arc. Initializes a new instance of the class. The x-coordinate of the center point of the arc. The y-coordinate of the center point of the arc. The radius value of the arc. The beginning angle value of the arc. The end angle value of the arc. Gets or sets a float value that indicates the x-coordinate of the center of the arc. Gets or sets a float value that indicates the y-coordinate of the center of the arc. Gets or sets a float value that indicates the radius of the arc. Gets or sets a float value that indicates the beginning angle degree of the arc. Gets or sets a float value that indicates the ending angle degree of the arc. Represents circle. Initializes a new instance of the class. The x-coordinate of the center of the circle. The y-coordinate of the center of the circle. The radius of the circle. Gets or sets a float value that indicates the x-coordinate of the center of the circle. Gets or sets a float value that indicates the y-coordinate of the center of the circle. Gets or sets a float value that indicates the radius of the circle. Represents bezier curve. Initializes a new instance of the class. The position array of the control points of the curve.There should be four control points,so the length of the array should be eight. Gets or sets a float position array. Represents graph - graphics generator paragraph. Initializes a new instance of the class. The width of the graph. The height of the graph. Gets or sets a object that indicates the graph info,such as color, line width,etc. Gets or sets the border. Gets or sets change curret position after process paragraph.(default true) Gets or sets the table left coordinate. Gets or sets the table top coordinate. Gets or sets a collection that indicates all shapes in the graph. Gets or sets a string value that indicates the title of the graph. Gets or sets a float value that indicates the graph width. The unit is point. Gets or sets a float value that indicates the graph height. The unit is point. Clone the graph. The cloned object Represents line. Initializes a new instance of the class. The line position array. Gets or sets a object that indicates the position array.The array is composed by coordinates of each control point of the line. directly. Represents rectangle. Initializes a new instance of the class. The left position of the rectangle. The bottom position of the rectangle. The width of the rectangle. The height of the rectangle. Gets or sets a float value that indicates the radius of rectangle corners. Gets or sets a float value that indicates the left position of the rectangle. Gets or sets a float value that indicates the bottom position of the rectangle. Gets or sets a float value that indicates the width of the rectangle. Gets or sets a float value that indicates the height of the rectangle. Represents shape - the base graphics object. Gets or sets a object that indicates the graph info,such as color, line width,etc. Gets or sets a text for shape Represents file hyperlink object. Initializes a new instance of the class. Initializes a new instance of the class. Path to file. Gets or sets the path to file. Represents abstract formatted fragment. Represents TeX fragment. Gets or sets TeXLoadOptions that will be used for loading (and rendering) of LaTeX into this instance of class. Please use it when it's necessary use specific setting for import of LaTeX for this or that instance (f.e when this or that instance should use specific BasePath for imported LaTeX or should use specific loader of external resources) If parameter is default (null), then standard LaTeX loading options will be used. Gets or sets TeXLoadOptions that will be used for loading (and rendering) of LaTeX into this instance of class. Please use it when it's necessary use specific setting for import of LaTeX for this or that instance (f.e when this or that instance should use specific BasePath for imported LaTeX or should use specific loader of external resources) If parameter is default (null), then standard LaTeX loading options will be used. Initializes a new instance of the HtmlFragment class. The fragment text Initializes a new instance of the HtmlFragment class. The fragment text Determines whether not to make indents while typesetting LaTeX fragment Represents TeX fragment. Initializes a new instance of the HtmlFragment class. The fragment text Initializes a new instance of the HtmlFragment class. The fragment text Determines whether not to make indents while typesetting LaTeX fragment Represents local hyperlink object. Initializes a new instance of the class. Initializes a new instance of the class. Target paragraph. Gets or sets the target paragraph. Gets or sets the target page number. This class represents generator paragraph note. Gets or sets a collection that indicates all paragraphs in the FootNote. Gets or sets a note text. Gets or sets a note text state. Initializes a new instance of the class. Initializes a new instance of the class. The note content. Enumerates the image file types. Unknown type. svg image file type. Dicom image file type. Base64 image file type. Represents print controller. Specifies possible media types used during rendering. Class describes media clip data. Return file specification which contains actual media data . This class descibes Media clip section. Class describes media rendition. Gets or sets media clip obkects associated with rendition. Class which describes rendition object of RendtionAnnotation. Text string specifying the name of the rendition for use in a user interface and for name tree lookup by JavaScript actions. Gets rendition type. The operation to perform when the action is triggered. If no rendition is associated with the annotation, play the specified rendition, associating it with the annotation. If a rendition is already associated with the annotation, it shall be stopped, and the new rendition shall be associated with the annotation. Stop any rendition being played in association with the annotation. Pause any rendition being played in association with the annotation. Resume any rendition being played in association with the annotation. Play the specified rendition, associating it with the annotation. If a rendition is already associated with the annotation, resume the rendition if it is paused. Operation not defined. Enumeration describes possible types of Rendition. Media rendition object. Selector rendition object. Rendition type is undefined. Class describes selector rendition. Gets array of renditions. Represents custom explicit destination. Upon invocation of an import-data action, Forms Data Format (FDF) data shall be imported into the document’s interactive form from a specified file. The FDF file from which to import the data. Represents a hide action that hides or shows one or more annotations on the screen by setting or clearing their Hidden flags. Gets or sets status of the annotation(s) to hide/display. Initializes a new instance of the class for the specified annotation. An annotation to be hidden. Initializes a new instance of the class for the specified annotation and invisibility flag. An annotation to be hidden or shown. A flag indicating whether to hide the annotation (true) or show it (false). Initializes a new instance of the class for the specified field name. A text string giving the fully qualified field name of an interactive form field. Initializes a new instance of the class for the specified field name and invisibility flag. A text string giving the fully qualified field name of an interactive form field. A flag indicating whether to hide the field (true) or show it (false). Initializes a new instance of the class for the specified annotations. An array of annotations to be hidden. Initializes a new instance of the class for the specified annotations and for invisibility flag. An array of annotations to be hidden or shown. A flag indicating whether to hide the annotations (true) or show it (false). Initializes a new instance of the class for the specified field names. An array of strings giving the fully qualified field names of an interactive form fields. Initializes a new instance of the class for the specified field names and for invisibility flag. An array of strings giving the fully qualified field names of an interactive form fields. A flag indicating whether to hide the fields (true) or show it (false). Class describes list of actions. Gets count of actions. Gets action by its index. Remove action by index. Index of action to remove. Add action to action list. Action to be added. Gets enumerator. PDfAction enumerator. Represent Fixed print data of Watermark Annotation. Class PDF3DAnnotation. This class cannot be inherited. Gets the 3D Artwork. The PDF3 d artwork. Gets the lighting scheme. The lighting scheme. Gets or sets the content. The content. Gets the render mode. The render mode. Sets the index of the default view. The default view index. Gets the view array. The view array. Initializes a new instance of the class. The page. The rectangle. The 3D Artwork. Initializes a new instance of the class. The page. The rectangle. The 3D Artwork. The activation mode. 3D Stream is already added to current 3D Artwork Gets type of annotation. The type of the annotation. Accepts visitor for annotation processing. AnnotationSelector object. Sets the image preview. The image preview filename. Sets the image preview. The image stream. Clears the image preview. Gets the image preview. Image preview as stream. Enum PDF3DActivation: set of 3D annotation activation mode. The active when open The active when visible The activated by user or script action Class PDF3DArtwork. Gets or sets the lighting scheme. The lighting scheme. Gets or sets the render mode. The render mode. Gets the view array. The view array. Initializes a new instance of the class. The document. The content. The lighting scheme. The render mode. Initializes a new instance of the class. The document. The content. Get the views as list. ReadOnlyCollection<PDF3DView>. Gets the views array. Array of views. Class PDF3DContent. Gets the extension . The extension. Initializes a new instance of the class. Initializes a new instance of the class. The filename. Unknown 3D Artwork type Loads 3D content with the specified filename. The filename. Unknown 3D content type Loads 3D content with the specified filename as PRC format. The filename. Loads 3D content with the specified filename as U3D format. The filename. Loads 3D content from stream as PRC format. The 3D content stream. Loads 3D content from stream as U3D format. The 3D content stream. Loads 3D content from byte array as PRC format. The stream. Loads 3D content from byte array as U3D format. The stream. Saves 3D content to file. The file name. 3DArtwork content format is PRC or U3D. Gets 3D content as stream. Stream. Gets 3D content as byte array. System.Byte[]. Class PDF3DCrossSectionArray. Gets the cross section count. The cross section count. Initializes a new instance of the class. The document. Adds the specified cross section to views array . The cross section. Removes cross section from array at specified index. The index of removed cross section in array. Invalid index: index should be in the range [1..n] where n equals to the cross sections count. Removes all cross section from array. Gets or sets the at the specified index. The index. Cross section. Invalid index: index should be in the range [1..n] where n equals to the cross sections count. Class PDF3DCuttingPlaneOrientation. Gets or sets the angle to X axis. The angle to X axis. Gets or sets the angle to Y axis. The angle Y axis. Gets or sets the angle to Z axis. The angle to Z axis. Initializes a new instance of the class. Initializes a new instance of the class. The angle x. The angle y. The angle z. Returns a that represents this instance. A that represents this instance. Class PDF3DLightingScheme. The "Artwork" lighting scheme. The "None" lighting scheme. The "White" lighting scheme. The "Day" lighting scheme. The "Night" lighting scheme. The "Hard" lighting scheme. The "Primary" lighting scheme. The "Blue" lighting scheme. The "Red" lighting scheme. The "Cube" lighting scheme. The "Cad" lighting scheme. The "Headlamp" lighting scheme. Gets the lighting scheme type. The lighting scheme type. Initializes a new instance of the class. The lighting scheme type. Initializes a new instance of the class. Name of the lighting scheme type. Unknown lighting scheme type argument Enum LightingSchemeType: set of lighting scheme types. The "Artwork" lighting scheme. The "None" lighting scheme. The "White" lighting scheme. The "Day" lighting scheme. The "Night" lighting scheme. The "Hard" lighting scheme. The "Primary" lighting scheme. The "Blue" lighting scheme. The "Red" lighting scheme. The "Cube" lighting scheme. The "Cad" lighting scheme. The "Headlamp" lighting scheme. Class PDF3DRenderMode. The "Solid" render mode. The "SolidWireFrame" render mode. The "Transparent" render mode. The "TransparentWareFrame" render mode. The "BoundingBox" render mode. The "TransparentBoundingBox" render mode. The "TransparentBoundingBoxOutline" render mode. The "WireFrame" render mode. The "ShadedWireFrame" render mode. The "Vertices" render mode. The "ShadedVertices" render mode. The "Illustration" render mode. The "SolidOutline" render mode. The "ShadedIllustration" render mode. Initializes a new instance of the class. The render mode type. Initializes a new instance of the class. Name of the type. Unknown a render mode type argument Gets the auxiliary colour. Color. Sets the auxiliary colour. The color. PDF3DRenderMode. Gets the color of the face. Object. Sets the color of the face. The color. PDF3DRenderMode. Gets the opacity. System.Double. Sets the opacity. The opacity. PDF3DRenderMode. Sets the crease value. The crease value. PDF3DRenderMode. Gets the crease value. System.Double. Gets the type. The type. Enum RenderModeType: set of render mode types The "Solid" render mode. The "SolidWireFrame" render mode. The "Transparent" render mode. The "TransparentWareFrame" render mode. The "BoundingBox" render mode. The "TransparentBoundingBox" render mode. The "TransparentBoundingBoxOutline" render mode. The "WireFrame" render mode. The "ShadedWireFrame" render mode. The "Vertices" render mode. The "ShadedVertices" render mode. The "Illustration" render mode. The "SolidOutline" render mode. The "ShadedIllustration" render mode. Class PDF3DStream. Initializes a new instance of the class. The document. The 3D Artwork. Gets or sets the content. The content. Class PDF3DView. Gets or sets the lighting scheme of view. The lighting scheme of view. Gets or sets the render mode of view. The render mode of view. Gets the cross sections array of view. The cross sections array of view. Gets or sets the name of the view. The name of the view. Gets or sets the camera position of view. The camera position of view. Gets or sets the camera orbit of view. The camera orbit of view. Gets or sets the color of the back ground of view. The color of the back ground of view. Initializes a new instance of the class. The document. The camera position. The camera orbit. Name of the view. Initializes a new instance of the class. The document. The view. Name of the view. Class PDF3DViewArray. Gets the views count. The views count. Adds the specified view. The view. Only one entry of 3D view is allowed Removes view from views array at specified index. The view index. Invalid index: index should be in the range [1..n] where n equals to the views count. Removes all views. Gets or sets the to view array at the specified index. The index. PDF3DView. Invalid index: index should be in the range [1..n] where n equals to the views count. Class PDF3DCrossSection. Gets or sets the cross section rotation center. The center. Gets or sets the cutting plane opacity. The cutting plane opacity. The number must be in the range [0 , 1] Gets or sets the cutting plane orientation. The cutting plane orientation. Only one of the values shall be Null Gets or sets the color of the cutting plane. The color of the cutting plane. Gets or sets the color of the cutting planes intersection. The color of the cutting planes intersection. Gets or sets a value indicating visibility of the cutting planes intersection. true if visible; otherwise, false. Initializes a new instance of the class. The document. Represents Redact annotation. Accepts visitor object to process the annotation. Visitor object. Constructor for RedactionAnnotation. For using in Generator. Document where new annotation will be created. An array of 8xN numbers specifying the coordinates of content region that is intended to be removed. Constructor for RedactAnnotation. Page where annotation will be placed. Annotation position on the page. Gets or sets the default appearance string to be used in formatting the text. Gets or sets color to fill annotation. Gets or sets color of border which is drawn when redaction is not active. Text to print on redact annotation. If true overlay text will be repated on the annotation. Gets or sets. Alignment of Overlay Text. Flattens annotation i.e. removes annotation and adds its Flattens annotation and redacts page contents (i.e. removes text and image under redacted annotation) Gets type of annotation. Class describes RichMediaAnnotation which allows embed video/audio data into PDF document. Type of the multimedia. Audio data. Video data. Unknown/unsupported type of data. Event which activates annotation. Activated by click on the annotation. Activated on page open. Activated when page becames visible. Gets type of annotation. Accepts visitor for this annotation. Visitor instance. Sets or gets custom flash player to play video/audio data. Sets or gets flash variables which passed to player. Add custom named data (for example required for flash script). Name of the data. Data. Set content stream. Name of the stream. Data stream. Data of the Rich Media content. Gets or sets type of content. Possible values: Audio, Video. Event which activates application. Set poster of the annotation. Stream containing poster image. Updates data with specified parameters. Constuctore for Watermark annotation class. Page where annotation should be placed. Position of the annotation. Set text of the annotation. Set text of the annotation. Fuxed print object of Watermark annotation. Gets or sets opacity of the annotation. Style of line ending of Ink annotation line. End is rectangular. End is rounded. Class which describes Measure coordinate system. Number format for measure. Constructor for NumberFormat class. Measure object which contains this number format. A text string specifying a label for displaying the units. The conversion factor used to multiply a value in partial units of the previous number format array element to obtain a value in the units of this number format. Value which indicates in which manner fraction values are displayed. Show fractional values as decimal fraction. Show fractional value as fraction. Round fractional values to the nearest whole integer. Truncate to achieve whole units. In what manner fractional values are displayed. If FractionDisplayment is ShowAsDecimal, this value is precision of fractional value; It shall me multiple of 10. Default is 100. If FractionDisplayment is ShowAsFraction, this value is denominator of the fraction. Default value is 16. If FractionDisplayment is ShowAsFraction, this value determines meay or not the fraction be reduced. If value is true fraction may not be reduced. Text that shall be used between orders of thousands in display of numerical values. An empty string indicates that no text shall be added. Default is comma. Text that shall be used as the decimal position in displaying numerical values. An empty string indicates that the default shall be used. Default is period character. Text that shall be concatenated to the left of the label. Text that shall be concatenated after the label Represents list of number formats. Constructor for NumberFormatList. Parent measure object. Adds number format to list. Value to be added into list. Inserts number format into list. Index where new element will be added. Value to be inserted. Removes number format from list. Index of item to be removed. Gets or sets number format in list by its index. Index of the item to be retreived. Retreived measure item. Count if items in the list. Creates Measure object for measure annotations. Annotation for which measure will be bound. A text string expressing the scale ratio of the drawing. A number format array for measurement of change along the xaxis and, if Y is not present, along the y axis as well A number format array for measurement of change along the y axis. A number format array for measurement of distance in any direction. A number format array for measurement of area. A number format array for measurement of angles. A number format array for measurement of the slope of a line. Point that shall specify the origin of the measurement coordinate system in default user space coordinates. A factor that shall be used to convert the largest units along the y axis to the largest units along the x axis. Represents additional entries specific to a sound object (Section 9.2 PDF1-7) Default value for SamplingRate. Default value for Channels parameter. Default value for BitsPerchannel parameter. Default value for encoding format. Gets or sets the sampling rate. Gets or sets the number of sound channels. Gets or sets the number of bits per sample value per channel. Gets or sets the encoding format. Initializes new sound sample data. The sampling rate. Initializes new sound sample data. The sampling rate. The number of sound channels. Initializes new sound sample data. The sampling rate. The number of sound channels. The number of bits per sample value per channel. Initializes new sound sample data. The sampling rate. The number of sound channels. The number of bits per sample value per channel. The encoding format for the sample data. The encoding format for the sound sample data. Unspecified or unsigned values in the range 0 to 2B − 1. Twos-complement values. μ-law–encoded samples. A-law–encoded samples. Collection of actions Count of actions on the collection. Returns true if object is synchronized. Gets synchronization object. Returns true if collection is readonly. Adds new action into colleciton. Action which should be added. Removes action from collection by index. Index of action to remove. Delete all actions. Copies actions array into collection. Array of actions which must be copied into collection. Index starting from which array will be copied. Returns enumerator for collection. Collection enumerator. Clear collection. Returns true if give item presents in the collection. Removes item from collection. Item to delete. Gets action by its index. Index of action. Retreived action. Represents the collection of annotation actions. Gets or sets an action to be performed when the cursor enters the annotation�s active area. Gets or sets an action to be performed when the cursor exits the annotation�s active area. Gets or sets an action to be performed when the mouse button is pressed inside the annotation�s active area. Gets or sets an action to be performed when the mouse button is released inside the annotation�s active area. Gets or sets an action to be performed when the annotation receives the input focus. Gets or sets an action to be performed when the page containing the annotation is opened. Gets or sets an action to be performed when the page containing the annotation is closed. Gets or sets an action to be performed when the page containing the annotation becomes visible in the viewer application�s user interface. Gets or sets an action to be performed when the page containing the annotation is no longer visible in the viewer application�s user interface. Gets or sets an action to be performed when the annotation loses the input focus. Gets or sets an action to be performed when user modifies character of the field. Gets or sets an action to be performed when user changes contents of the field. Gets or sets an action to be performed to format field value. Gets or sets an action to calculate field value. Class representing annotation collection. Gets a value indicating whether access to the Aspose.Pdf.Annotations.AnnotationCollection is synchronized (thread safe). Gets an object that can be used to synchronize access to Aspose.Pdf.Annotations.AnnotationCollection. Gets count of annotations in collection. Gets a value indicating if collection is readonly. Adds annotation to the collection. If page is rotated then annotation rectangle will be recalculated accordingly. Annotation which shall be added. If true and if page is rotated then annotation position will be recaculated accroding to page rotation. Adds annotation to the collection. Annotation which shall be added. Deletes annotation from the collection by index. Index of annotation which shall be deleted. Deletes all annotations from the collection. Copies array of annotations into collection. Array to copy into collection. Starting index where colleciton wil lbe copied. Returns collection enumerator. Enumerator object Accepts visitor to process annotation. Annotation selector object. Deletes specified annotation from the collection. Annotation which shall be deleted. Deletes all annotations from the collection. Checks if specified annotation belong to collection. Annotation to be searched. Deletes specified annotation from the collection. Annotation which shall be deleted. The index of the element to get. The index value started from one. Annotation object Returns annotation by its name. Name of the annotation A set of flags specifying various characteristics of the annotation. Default value. If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such an unknown annotation using an appearance stream specified by its appearance dictionary, if any. If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available. In cases where screen space is limited, the ability to hide and show annotations selectively can be used in combination with appearance streams to display auxiliary pop-up information similar in function to online help systems. If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. This can be useful, for example, for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page. If set, do not scale the annotation�s appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper-left corner of its annotation rectangle) remains fixed, regardless of the page magnification. If set, do not rotate the annotation�s appearance to match the rotation of the page. The upper-left corner of the annotation rectangle remains in a fixed location on the page, regardless of the page rotation. If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction. If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse clicks or change its appearance in response to mouse motions. This flag is ignored for widget annotations; its function is subsumed by the ReadOnly flag of the associated form field. If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation�s contents, such as the value of a form field. If set, invert the interpretation of the NoView flag for certain events. A typical use is to have an annotation that appears only when a mouse cursor is held over it. If set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size. The state model corresponding to state of annotation. Not defined state model. The annotation has been marked (or unmarked) by the user. The annotation has been reviewed (accepted, rejected, cancelled, completed, none) by the user. Enumeration of annotation types. Text annotation type. Circle annotation type. Polygon annotation type. Plyline annotation type. Line annotation type. Square annotatotion type. Free text annotation type. Highlight annotation type. Underline annotation type. Squiggle annotation type. Strikeout annotation type. Caret annotation type. Ink annotation type. Link annotation type. Popup annotation type. File attachment annotation type. Sound annotation type. Movie annotation type. Screen annotation type. Widget annotation type. Watermark annotation type. Trap network annotation type. Printer mark annotation type. Redaction annotation type. Rubber stamp annotation type. Rich media annotation type Unknown annotation. Annotation appearance dictionary specifying how the annotation shall be presented visually on the page. Gets a value indicating whether dictionary is read-only. Gets a value indicating whether dictionary has a fixed size. Gets keys of the dictionary. If appearance dictionary has subditionaries, then contains (N|R|D).state values, where N - normal appearance, R - rollover appearance, D - down appearance and state - the name of the state (e.g. On, Off for checkboxes). Gets the list of the dictionary values. Result collection contains the list of XForm objects. Gets a value indicating whether access to the dictionary is synchronized (thread safe). Gets an object that can be used to synchronize access to the dictionary. Gets the number of elements contained in the dictionary. Removes all elements from the dictionary. Adds an element with the provided key and value. Element key. Element value. Returns an IDictionaryEnumerator object for the dictionary. Enumerator of the dictionary. Copies the elements of the dictionary to an Array, starting at a particular Array index. Array where items must be copied. Index where items must be copied. Represents convenient form for getting appearance streams. Represents path to appearance stream. If appearance dictionary has subdictionaries, then path must contain 2 parts (), else path has only one part. XForm object (appearance stream) which corresponds to the given key. Add X form for specifed key. Element key. XForm object value. Determines does this dictionary contasins specified key. Key to search in the dictionary. true if key is found. Removes key from the dictionary. Key to be removed from the dictionary. true if key was successfully removed. Tries to find key in the dictionary and retreives value if found. Key to search in the dictionary. Retreived value. true if key was found. Adds pair with key and value into the dictionary. Item to be added. Checks does specified key-value pair is contained in the dictionary. Key-value pair. true if this pauir was found. Removes key/value pair from the colleciton. Key/value pair to be removed. true if pair was found and removed. Class representing Caret annotation. Gets type of annotation. Gets or sets caret rectangle. Gets or sets symbol associated with caret. Accepts visitor object to process the annotation. Visitor object. Constructor for usign in Generator. Document where annotation will be created. Creates new Caret annotation on the specified page. Document's page where annotation should be created. Required rectangle that sets annotation's border. Represents annotation characteristics Gets or sets color of the background Gets or sets color of the border. Gets or sets rotation of the annotation. Class representing Circle annotation. Constructor for Circle annotation. Document where annotation will be created. Accepts visitor object to process the annotation. Visitor object. Creates new Circle annotation on the specified page. Document's page where annotation should be created. Required rectangle that sets annotation's border. Gets type of annotation. Abstract class representing common figure annotation. Constructor. The page with which the annotation will be associated. The annotation rectangle, defining the location of the annotation on the page. Constructor for using in Generator. Document where annotation will be placed. When overridden in a derived class, exports annotation attributes into XFDF. Writer of destination file. When overridden in a derived class, import annotation attributes from XFDF. Reader of XFDF file. Interior color with which to fill the annotation�s rectangle or ellipse. The rectangle describing the numerical differences between two rectangles: the Rect entry of the annotation and the actual boundaries of the underlying square or circle. Class describes file attachment annotation. Gets type of annotation. The specification of the file associated with this annotation. Gets or sets icon that shall be used in displaying annotation. Gets or sets icon's opacity from 0 to 1: 0 - completely transparant, 1 - completely opaque. Accepts visitor object to process annotation. Visitor object. Creates new FileAttachment annotation on the specified page. Document's page where annotation should be created. Required rectangle that sets annotation's border. Describes the file that shoud be bound with the annotation. Represents a free text annotation that displays text directly on the page. Unlike an ordinary text annotation, a free text annotation has no open or closed state; instead of being displayed in a pop-up window, the text is always visible. Constructor to use with Generator. Document where annotation will be created. Default Appearance Gets or sets line ending style for line ending point. OThis property is obsolete, please use EndingStyle. Gets or sets line ending style for line ending point. Gets or set a code specifying the form of quadding (justification) to be used in displaying the annotation�s text. Accepts visitor object to process the annotation. Visitor object. Creates new FreeText annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. The default appearance to be used in formatting the text. Gets or sets the default appearance string to be used in formatting the text. Object which represents default appearance of FreeText annotation. Gets or sets the intent of the free text annotation. Gets or sets a default style string. Gets or sets style of the text in appearance. when text style is changed, text appearance is updated. Angle of annotation rotation. Gets type of annotation. Array of point specifying callout line. Rectangle describing the numerical differences between two rectangles: the Rect entry of the annotation and a rectangle contained within that rectangle. The inner rectangle is where the annotation�s text should be displayed. Enumerates the intents of the free text annotation. Not defined state. Means that the annotation is intended to function as a callout. Means that the annotation is intended to function as a click-to-type or typewriter object. Represents a highlight annotation that highlights a range of text in the document. Accepts visitor object to process the annotation. Visitor object. Creates new Highlight annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. Gets type of annotation. Represents a freehand "scribble" composed of one or more disjoint paths. Style of ink annotation line endings. Accepts visitor object to process the annotation. Visitor object. Constructor for Ink annotation for Generator. Document where ink annotation will be created. An array of Point[] arrays, each representing a stroked path. Creates new Ink annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. An array of Point[] arrays, each representing a stroked path. Creates new Ink annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. An array of Point[] arrays, each representing a stroked path. Gets or sets list of gestures that are independent lines which are represented by Point[] arrays. Gets type of annotation. Class representing line annotation. Gets or sets starting point of line. Gets or sets line ending style for line starting point. Gets or sets line ending point. Gets or sets ending style for end point of line. Gets or sets interior color of the annotation. Gets or sets leader line length. Gets or sets length of leader line extension. Gets or sets boolean flag which determinies is contents must be shown as caption. Gets or sets leader line offset. Gets or sets caption text offset from its normal position. Gets or sets annotation caption position. Measure units specifed for this annotation. Accepts visitor to annotation processing. Visitor object Constructor for using with Generator. Document where annotation will be created. Starting point. Ending point. Creates new Line annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. A point, specifying the starting coordinate of the line. A point, specifying the ending coordinate of the line. Gets or sets the intent of the line annotation. Gets type of annotation. Enumerates the intents of the line annotation. Undefined state. Means that the annotation is intended to function as an arrow. Means that the annotation is intended to function as a dimension line. Represents either a hypertext link to a destination elsewhere in the document or an action to be performed. An action to be performed when the link annotation is activated. A destination to be displayed when the annotation is activated. Accepts visitor object to process the annotation. Visitor object. Creates new Link annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. The visual effect to be used when the mouse button is pressed or held down inside its active area. Gets type of annotation. Abstract class representing markup annotation. Constructor for markup annotation. Document where annotation will be created. Constructor. The page with which the annotation will be associated. The annotation rectangle, defining the location of the annotation on the page. When overridden in a derived class, exports annotation attributes into XFDF. Writer of destination file. When overridden in a derived class, exports annotation elements into XFDF. Writer of destination file. When overridden in a derived class, import annotation attributes from XFDF. Reader of XFDF file. When overridden in a derived class, import annotation elements from XFDF. Hashtable with information parsed from the XFDF file. Gets or sets a text that shall be displayed in title bar of annotation. Gets or sets a rich text string to be displayed in the pop-up window when the annotation is opened. Gets date and time when annotation was created. Gets text representing desciption of the object. Pop-up annotation for entering or editing the text associated with this annotation. Gets or sets the constant opacity value to be used in painting the annotation. A reference to the annotation that this annotation is "in reply to". Both annotations must be on the same page of the document. A string specifying the relationship (the "reply type") between this annotation and one specified by InReplyTo. Represents a movie annotation that contains animated graphics and sound to be presented on the computer screen and through the speakers. When the annotation is activated, the movie is played. Gets or sets the title of the movie annotation. Gets or sets a file specification identifying a self-describing movie file. Gets or sets a flag or stream specifying whether and how a poster image representing the movie shall be displayed. If true, the poster image shall be retrieved from the movie file; if it is false, no poster shall be displayed. Gets or sets the width and height of the movie�s bounding box, in pixels. Gets or sets the number of degrees by which the movie shall be rotated clockwise relative to the page. The value shall be a multiple of 90. Gets type of annotation. Constructor for using with Generator. Document where movie annotation will be created. Name of movie file. Creates new Sound annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. A movie file to be played when the annotation is activated. Accepts visitor object to process the annotation. Visitor object. Abstract base class for poly- annotations. Constructor. Document where annotation will be created. An array of points representing the horizontal and vertical coordinates of each vertex. Constructor. The page with which the annotation will be associated. The annotation rectangle, defining the location of the annotation on the page. An array of points representing the horizontal and vertical coordinates of each vertex. Measure units specifed for this annotation. When overridden in a derived class, exports annotation attributes into XFDF. Writer of destination file. When overridden in a derived class, exports annotation elements into XFDF. Writer of destination file. When overridden in a derived class, import annotation attributes from XFDF. Reader of XFDF file. When overridden in a derived class, import annotation elements from XFDF. Hashtable with information parsed from the XFDF file. Gets or sets an array of points representing the horizontal and vertical coordinates of each vertex. Gets or sets the interior color with which to fill the annotation�s line endings. Gets or sets the style of first line ending. Gets or sets the style of second line ending. Gets or sets the intent of the polygon or polyline annotation. Class representing polygon annotation. Accepts visitor object for annotation processing. Visitor object. Constructor for using with Generator. Document where annotation will be added. Array of points. Creates new Polygon annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. An array of polygon vertices points. Gets type of annotation. Enumerates the intents of the polygon or polyline annotation. Undefined state. Means that the annotation is intended to function as a cloud object. Indicates that the polyline annotation is intended to function as a dimension. Indicates that the polygon annotation is intended to function as a dimension. Represents polyline annotation that is similar to polygon, except that the first and last vertex are not implicitly connected. Accepts visitor object to process the annotation. Visitor object. Creates new Polyline annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. An array of polygon vertices points. Gets type of annotation. Represents the pop-up annotation that displays text in a pop-up window for entry and editing. Gets or sets a flag specifying whether the pop-up annotation should initially be displayed open. Gets or sets the parent annotation with which this pop-up annotation shall be associated. If this entry is present, the parent annotation�s Contents, M, C, and T entries shall override those of the pop-up annotation itself. Gets type of annotation. Accepts visitor object to process the annotation. Visitor object. Constructor. for using in Generator. Document where new popup annotation will be created. Creates new Popup annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. Enumerates the kinds of the relationships (the “reply type”) between the annotation and one specified by InReplyTo. Undefined relationship. The annotation is considered a reply to the annotation specified by InReplyTo. Viewer applications should not display replies to an annotation individually but together in the form of threaded comments. The annotation is grouped with the annotation specified by InReplyTo. Represents a sound annotation that contains sound recorded from the computer�s microphone or imported from a file. Gets or sets an icon to be used in displaying the annotation. Gets a sound object defining the sound to be played when the annotation is activated. Gets type of annotation. Accepts visitor object to process the annotation. Visitor object. Creates new Sound annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. A sound file defining the sound to be played when the annotation is activated. Creates new Sound annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. A sound file defining the sound to be played when the annotation is activated. A sound sample data contains extra of sound parameters such as sampling rate, bits per sample and so on. Represents a sound data defining the sound to be played when the annotation is activated. Gets or sets the sampling rate, in samples per second. Gets or sets the number of sound channels. Gets or sets the number of bits per sample value per channel. Gets stream of the sound to be played when the annotation is activated. Gets or sets the encoding format for the sample data. The encoding format for the sample data. Unspecified or unsigned values in the range 0 to 2^bits − 1. Twos-complement values. μ-law–encoded samples. A-law–encoded samples. Enumerates the icons to be used in displaying the annotation. Speaker icon. Microphone icon. Class representing square annotation. Constructor for using with Generator. Documennt where annotation will be created. Accepts visitor to process annotation. Visitor object. Creates new Square annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. Gets type of annotation. Represents the squiggly annotation that appears as a jagged underline in the text of a document. Gets type of annotation. Accepts visitor object to process the annotation. Visitor object. Creates new Squiggly annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. Represents rubber stamp annotation. This type of annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp. Next code snippet demonstrates how to add 2 stamps into the first pdf document page. Input document comes from inFile and changes are saved into the outFile. The first stamp has icon NotForPublicRelease and the second comes with image from rubber.jpg. Document document = new Document(inFile); StampAnnotation stamp1 = new StampAnnotation(StampIcon.NotForPublicRelease); stamp1.Rect = new Rectangle(100, 100, 120, 120) document.Pages[1].Annotations.Add(stamp1); StampAnnotation stamp2 = new StampAnnotation(new FileStream("rubber.jpg", FileMode.Open)); stamp2.Rect = new Rectangle(200, 200, 220, 220) document.Pages[1].Annotations.Add(stamp2); document.Save(outFile); Gets or sets icon for rubber stamp. Gets type of annotation. Acepts visitor when browsing annotation collection. Visitor object. Constructor Document where annotation will be created. Creates new Stamp annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. Gets or sets image of the annotation. Represents a strikeout annotation that appears as a strikeout in the text of the document. Accepts visitor object to process the annotation. Visitor object. Creates new StrikeOut annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. Gets type of annotation. Alignment of text in annotation. Text is aligned to left. Text is centered. Text is aligned to right. Abstract base class for text markup annotations. Constructor. The page with which the annotation will be associated. The annotation rectangle, defining the location of the annotation on the page. When overridden in a derived class, exports annotation attributes into XFDF. Writer of destination file. When overridden in a derived class, import annotation attributes from XFDF. Reader of XFDF file. Gets or sets an array of points specifying the coordinates of n quadrilaterals. Each quadrilateral encompasses a word or group of contiguous words in the text underlying the annotation. Gets text under markup annotation as string. String containing text that is under markup annotation. Gets text under markup annotation as . containing s that is under markup annotation. Represents an underline annotation that appears as an underline in the text of the document. Accepts visitor object to process the annotation. Visitor object. Creates new Underline annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. Gets type of annotation. Class representing widget annotation. An action which shall be performed when the annotation is activated. Gets the annotation actions. Annotation highlighting mode. Gets annotation parent. Gets or sets default appearance of the field. Gets or sets read only status of the field. Gets or sets required status of the field. Gets or sets exportable flag of the field. Accepts visitor. Visitor to be accepted. Create annotation (used for Generator) Document where annotation will be created. Gets type of annotation. Describes default appearance of field (font, text size and color). Gets font size in default apperance. Gets or sets the color of text in the default appearance. Gets font name in the default appearance. Gets font specified as default for text. Constructor of DefaultAppearance. Gets the list of pdf operators which represent appearence. Constructor of DefaultAppearance. Font name. Font size. Color of text. Constructor of Default Appearance. Previously created font may be specified as default font. Font which will be used as default. Font size. Color of text. Class describes actions performed on some actions with document Gets or sets action performed before document saving. Gets or sets action that will be performed before documetn closing. Gets or sets action that will be performed after document saving. Action that will be performed before document printing. Action that will be performed after document printing. Constructor for DocumentActionCollection. Constructs DocumentActionCollection objects from Pdf.Kit.Engine Document object. Document for which action colleciton is created. Represents explicit destination that displays the page with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the window in the other dimension. Creates local explicit destination. The destination page object. Creates remote explicit destination. The parent document that contains this object. The destination page number of remote document. Creates remote explicit destination. The destination page number of remote document. Converts the object state into string value. Example: "1 FitB". String value representing object state. Represents explicit destination that displays the page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window. A null value for top specifies that the current value of that parameter is to be retained unchanged. Gets the vertical coordinate top positioned at the top edge of the window. Creates local explicit destination. The destination page object. The vertical coordinate top positioned at the top edge of the window. Creates remote explicit destination. The parent document that contains this object. The destination page number of remote document. The vertical coordinate top positioned at the top edge of the window. Creates remote explicit destination. The destination page number of remote document. The vertical coordinate top positioned at the top edge of the window. Converts the object state into string value. Example: "1 FitBH 100". String value representing object state. Represents explicit destination that displays the page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window. A null value for left specifies that the current value of that parameter is to be retained unchanged. Gets the horizontal coordinate left positioned at the left edge of the window. Creates local explicit destination. The destination page object. The horizontal coordinate left positioned at the left edge of the window. Creates remote explicit destination. The parent document that contains this object. The destination page number of remote document. The horizontal coordinate left positioned at the left edge of the window. Creates remote explicit destination. The destination page number of remote document. The horizontal coordinate left positioned at the left edge of the window. Converts the object state into string value. Example: "1 FitBV 100". String value representing object state. Represents explicit destination that displays the page with its contents magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension. Creates local explicit destination. The destination page object. Creates remote explicit destination. The Aspose.Pdf.Document object. The destination page number. Creates remote explicit destination. The destination page number of remote document. Converts the object state into string value. Example: "1 Fit". String value representing object state. Represents explicit destination that displays the page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window. A null value for top specifies that the current value of that parameter is to be retained unchanged. Gets the vertical coordinate top positioned at the top edge of the window. Creates local explicit destination. The destination page object. The vertical coordinate top positioned at the top edge of the window. Creates remote explicit destination. The parent document that contains this object. The destination page number of remote document. The vertical coordinate top positioned at the top edge of the window. Creates remote explicit destination. The destination page number of remote document. The vertical coordinate top positioned at the top edge of the window. Converts the object state into string value. Example: "1 FitH 100". String value representing object state. Represents explicit destination that displays the page with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and topentirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension. A null value for any of the parameters may result in unpredictable behavior. Gets left horizontal coordinate of visible rectangle. Gets bottom vertical coordinate of visible rectangle. Gets right horizontal coordinate of visible rectangle. Gets top vertical coordinate of visible rectangle. Creates local explicit destination. The destination page object. Left horizontal coordinate of visible rectangle. Bottom vertical coordinate of visible rectangle. Right horizontal coordinate of visible rectangle. Top vertical coordinate of visible rectangle. Creates remote explicit destination. The parent document that contains this object. The destination page number of remote document. Left horizontal coordinate of visible rectangle. Bottom vertical coordinate of visible rectangle. Right horizontal coordinate of visible rectangle. Top vertical coordinate of visible rectangle. Creates remote explicit destination. The destination page number of remote document. Left horizontal coordinate of visible rectangle. Bottom vertical coordinate of visible rectangle. Right horizontal coordinate of visible rectangle. Top vertical coordinate of visible rectangle. Converts the object state into string value. Example: "1 FitR 100 200 300 400". String value representing object state. Represents explicit destination that displays the page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window. A null value for left specifies that the current value of that parameter is to be retained unchanged. Gets the horizontal coordinate left positioned at the left edge of the window. Creates local explicit destination. The destination page object. The horizontal coordinate left positioned at the left edge of the window. Creates remote explicit destination. The parent document that contains this object. The destination page number of remote document. The horizontal coordinate left positioned at the left edge of the window. Creates remote explicit destination. The destination page number of remote document. The horizontal coordinate left positioned at the left edge of the window. Converts the object state into string value. Example: "1 FitV 100". String value representing object state. Represents explicit destination that displays the page with the coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom. A null value for any of the parameters left, top, or zoom specifies that the current value of that parameter is to be retained unchanged. A zoom value of 0 has the same meaning as a null value. Document doc = new Document("example.pdf"); XYZExplicitDestination dest = (XYZExplicitDestination)doc.Outlines[1].Destination; string left = dest.Left; string top = dest.Top; string zoom = dest.Zoom; Gets left horizontal coordinate of the upper-left corner of the window. Gets top vertical coordinate of the upper-left corner of the window. Gets zoom factor. Creates local explicit destination. The destination page object. Left horizontal coordinate of the upper-left corner of the window. Top vertical coordinate of the upper-left corner of the window. Zoom factor. Create destintion to specified location of the page considering page rotation if required. Destination page. Left position on the page. Top position on the page. Zoom factor (0 for default). If true position will be recalculated according to page rotation. Destination object. Create destionation to upper left corner of the specifed page. Destination page. Zoom factor. Destination object. Create destination to specified page. Destination page. Destination object. Creates remote explicit destination. The parent document that contains this object. The destination page number of remote document. Left horizontal coordinate of the upper-left corner of the window. Top vertical coordinate of the upper-left corner of the window. Zoom factor. Creates remote explicit destination. The destination page number of remote document. Left horizontal coordinate of the upper-left corner of the window. Top vertical coordinate of the upper-left corner of the window. Zoom factor. Converts the object state into string value. Example: "1 XYZ 100 200 3". String value representing object state. Represents a go-to action that changes the view to a specified destination (page, location, and magnification factor). Gets or sets the destination to jump to. Constructor for GoToAction class. The destination page number to jump to. Constructor for GoToAction class. Aspose.Pdf.Page destination object to jump to. Constructor for GoToAction class. Destination page. Destination type. Action parameters. Constructor. Explicit destination. Constructor. Action which linked with Named Destination. Document where action will be created. Name of the destination. Represents a remote go-to action that is similar to an ordinary go-to action but jumps to a destination in another PDF file instead of the current file. Gets or sets the specification of the file in which the destination is located. Gets or sets a flag specifying whether to open the destination document in a new window. Initializes GoToRemoteAction object. Destination PDF document. Destination page number. Initializes GoToRemoteAction object. Destination PDF document. Destination in the PDF document. Gets or sets the destination to jump to. Represents a URI action causes a URI to be resolved. Gets or sets the uniform resource identifier to resolve. Constructor. The uniform resource identifier to resolve. Enumerates the annotation�s highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area. No highlighting. Invert the contents of the annotation rectangle. Invert the annotation�s border. Display the annotation�s down appearance, if any. If no down appearance is defined, offset the contents of the annotation rectangle to appear as if it were being pushed below the surface of the page. Same as Push (which is preferred). Class representing javascript action. Gets or sets javascript code. Constructor. JavaScript code. Represents a launch action that launches an application or opens or prints a document. Gets or sets the application to be launched or the document to be opened or printed. Gets or sets a flag specifying whether to open the destination document in a new window (affect PDF documents only). Creates a launch action. The file to be launched. Creates a launch action. Document where action will be created. The file to be launched. The Aspose.Pdf.Annotations namespace provides classes for working with various types of actions, destinations and other features of document which traditionally called as interactive providing means user can intercommunicate with it. Represents Action in PDF document Next actions in sequence. Class which describes submit-form action. If clear, the Fields array specifies which fields to include in the submission. If set, all fields designated by the Fields array and the Include/Exclude flag shall be submitted. If set, field names and values shall be submitted in HTML Form format. If set, field names and values shall be submitted using an HTTP GET request. If set, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data. If set, field names and values shall be submitted as XFDF. If set, the submitted FDF file shall include the contents of all incremental updates. If set, the submitted FDF file shall include includes all markup annotations in the underlying PDF document. If set, the document shall be submitted as PDF, using the MIME content type application/pdf. If set, any submitted field values representing dates shall be converted to the standard format. If set, it shall include only those markup annotations whose T entry matches the name of the current user. If set, the submitted FDF shall exclude the F entry. If set, the F entry of the submitted FDF shall be a file specification containing an embedded file stream representing the PDF file from which the FDF is being submitted. Gets or sets flagas of submit action Destination URL. Initializes SubmitFormAction object. Class representing annotation object. The message. If true, annotation appearance will be updated before converting PF document into image. This allows convert fields correctly but probably demand more time. If this property set to true, fonts will be added to document as subsets. Default value is true. Gets normal appearance. When overridden in a derived class, exports annotation attributes into XFDF. Writer of destination file. When overridden in a derived class, exports annotation elements into XFDF. Writer of destination file. When overridden in a derived class, import annotation attributes from XFDF. Reader of XFDF file. When overridden in a derived class, import annotation elements from XFDF. Hashtable with information parsed from the XFDF file. Flags of the annotation. Gets rotated rectangle. Returns internal rectnagle of annotation, i.e. rectangle recalculated according to RD entry of annotation Initialize the annotation. The Aspose.Pdf.Page object. The rectangle of the annotation. Create annotation data structure. Document where annotation is created. Annotation rectangle. Constructor. The page with which the annotation will be associated. The annotation rectangle, defining the location of the annotation on the page. Constructor for Annotation. Document where annotation is added. Annotation rectangle. Gets type of annotation. Gets or sets width of the annotation. Gets list of annotatation actions. Gets or sets height of the annotation. Gets or sets annotation rectangle. Returns rectangle of annotation taking into consideration page rotation. If true, page rotation is takein into consideration. Gets or sets annotation text. Gets or sets annotation name on the page. Gets or sets date and time when annotation was recently modified. Gets or sets annotation color. Gets or sets annotation border characteristics. Gets or sets current annotation appearance state. Gets annotation characteristics. Gets appearance dictionary of annotation. Annotation alignment. This property is obsolete. Use HorizontalAligment instead. Gets or sets text alignment for annotation. Gets or sets text alignment for annotation. Accepts visitor for annotation processing. AnnotationSelector object. Places annotation contents directly on the page, annotation object will be removed. Gets full qualified name of the annotation. Gets appearance dictionary of the annotation. Gets index of page which contains annotation. Class represents style of text in annotation Name of the font. Fonst size. Gets or sets horizontal alignment of the text. Text alignment. Valid values are: Left, Center, Rigth. Color of the text. String representation of TextStyle. String representation. This class is used for selecting annotations using Visitor template idea. The list of selected objects. Initializes new instance of the AnnotationSelector class. Select link annotation if AnnotationSelector was initialized with LinkAnnotation object. LinkAnnotation object for selecting. Initializes new object. Annotation to be selected. This object only describes some characteristics we want found annotations to have, e.g. the type of annotation. Select attachment annotation if AnnotationSelector was initialized with FileAttachmentAnnotation object. FileAttachmentAnnotation object for selecting. Select text annotation if AnnotationSelector was initialized with TextAnnotation object. TextAnnotation object for selecting. Select redact annotation if AnnotationSelector was initialized with RedactAnnotation object. RedactAnnotation object for selecting. Select freetext annotation if AnnotationSelector was initialized with FreeTextAnnotation object. FreeTextAnnotation object for selecting. Select attachment annotation if AnnotationSelector was initialized with FreeTextAnnotation object. HighlightAnnotation object for selecting. Select underline annotation if AnnotationSelector was initialized with UnderlineAnnotation object. UnderlineAnnotation object for selecting. Select strikeOut annotation if AnnotationSelector was initialized with StrikeOutAnnotation object. StrikeOutAnnotation object for selecting. Select squiggly annotation if AnnotationSelector was initialized with SquigglyAnnotation object. SquigglyAnnotation object for selecting. Select popup annotation if AnnotationSelector was initialized with PopupAnnotation object. PopupAnnotation object for selecting. Select line annotation if AnnotationSelector was initialized with LineAnnotation object. LineAnnotation object for selecting. Select circle annotation if AnnotationSelector was initialized with CircleAnnotation object. CircleAnnotation object for selecting. Select square annotation if AnnotationSelector was initialized with SquareAnnotation object. SquareAnnotation object for selecting. Select ink annotation if AnnotationSelector was initialized with InkAnnotation object. InkAnnotation object for selecting. Select polyline annotation if AnnotationSelector was initialized with PolylineAnnotation object. PolylineAnnotation object for selecting. Select polygon annotation if AnnotationSelector was initialized with PolygonAnnotation object. PolygonAnnotation object for selecting. Select caret annotation if AnnotationSelector was initialized with CaretAnnotation object. CaretAnnotation object for selecting. Select stamp annotation if AnnotationSelector was initialized with StampAnnotation object. StampAnnotation object for selecting. Select widget annotation if AnnotationSelector was initialized with WidgetAnnotation object. WidgetAnnotation object for selecting. Select watermark annotation if AnnotationSelector was initialized with WatermarkAnnotation object. WatermarkAnnotation for selecting. Select movie annotation if AnnotationSelector was initialized with MovieAnnotation object. MovieAnnotation object for selecting. Select movie annotation if AnnotationSelector was initialized with RichMedia annotation object. RichMedia annotation. Select screen annotation if AnnotationSelector was initialized with ScreenAnnotation object. ScreenAnnotation object for selecting. Select PDF3D annotation if AnnotationSelector was initialized with PDF3DAnnotation object. PDF3DAnnotation object for selecting. The enumeration of states to which the original annotation can be set. Not defined state. The annotation has been marked by the user. The annotation has not been marked by the user. The user agrees with the change. The user disagrees with the change. The change has been cancelled. The change has been completed. The user has indicated nothing about the change. Class representing characteristics of annotation border. Gets or sets horizontal corner radius. Gets or sets vertical corner radius. Gets or sets border width. Gets or sets effect intencity. Valid range of value is [0..2]. Gets or sets border style. Gets or sets border effect. Gets or sets dash pattern. Constructor for border object. Parent annotation. Describes effect which should be applied to the border of the annotations. No effect. The border will appear "cloudly". Describes style of the annotation border. Solid border. Dashed border. Bevelled border. Inset border. Underlined border. Enumeration of the annotation�s caption positioning. The caption will be centered inside the line (default value). The caption will be on top of the line. A symbol to be associated with the caret. No symbol should be associated with the caret. A new paragraph symbol (�) should be associated with the caret. Class representing line dash pattern. Gets or sets length of dash. Gets or sets length of gap between dashes. Constructor for Dash. Length of the dash. Length of the gap. An icon to be used in displaying the annotation. PushPin icon (default value). Graph icon. Paperclip icon. This is tag icon. Defines Visitor for visiting different document annotations. Visit/select link annotation. LinkAnnotation object example/template. Visit/select attachment annotation. FileAttachmentAnnotation object example/template. Visit/select text annotation. TextAnnotation object example/template. Visit/select freetext annotation. FreeTextAnnotation object example/template. Visit/select highlight annotation. HighlightAnnotation object example/template. Visit/select underline annotation. UnderlineAnnotation object example/template. Visit/select strikeOut annotation. StrikeOutAnnotation object example/template. Visit/select squiggly annotation. SquigglyAnnotation object example/template. Visit/select popup annotation. PopupAnnotation object example/template. Visit/select line annotation. LineAnnotation object example/template. Visit/select circle annotation. CircleAnnotation object example/template. Visit/select square annotation. SquareAnnotation object example/template. Visit/select ink annotation. InkAnnotation object example/template. Visit/select polyline annotation. PolylineAnnotation object example/template. Visit/select polygon annotation. PolygonAnnotation object example/template. Visit/select caret annotation. CaretAnnotation object example/template. Visit/select stamp annotation. StampAnnotation object example/template. Visit/select widget annotation. WidgetAnnotation object example/template. Visit/select movie annotation. MovieAnnotation object example/template. Visit/select screen annotation. ScreenAnnotation object example/template. Enumerates the line ending styles to be used in drawing the line. No line ending. A square filled with the annotation�s interior color, if any. A circle filled with the annotation�s interior color, if any. A diamond shape filled with the annotation�s interior color, if any. Two short lines meeting in an acute angle to form an open arrowhead. Two short lines meeting in an acute angle as in the OpenArrow style and connected by a third line to form a triangular closed arrowhead filled with the annotation�s interior color, if any. A short line at the endpoint perpendicular to the line itself. Two short lines in the reverse direction from OpenArrow. A triangular closed arrowhead in the reverse direction from ClosedArrow. A short line at the endpoint approximately 30 degrees clockwise from perpendicular to the line itself. Enumerates the icons to be used in displaying the annotation. Draft stamp icon. Approved stamp icon. Experimental stamp icon. Stamp icon is not approved. Stamp icon "as is". Stamp icon is expired. Not for public release. Confidential. Final stamp. Sold stamp. Departamental. For comment. For public release. Top secret. Represents a text annotation that is a �sticky note� attached to a point in the PDF document. Gets or sets a flag specifying whether the annotation should initially be displayed open. Gets or sets an icon to be used in displaying the annotation. Gets or sets the state to which the original annotation should be set. Gets type of annotation. Accepts visitor object to process the annotation. Visitor object. Constructor for annotation when used in Generator. Document where text annotation will be created. Creates new Text annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. Enumerates the icons to be used in displaying the annotation. Note icon. Comment icon. Key icon. Help icon. NewParagraph icon. Paragraph icon. Insert icon. Check icon. Cross icon. Circle icon. Star icon. Represents the base class for explicit destinations in PDF document. Gets the destination page object Gets the destination page number Creates the explicit destination. The destination Aspose.Pdf.Page object. The type of explicit destination. The additional values of explicit destination type. Creates the explicit destination. The destination page number. The type of explicit destination. The additional values of explicit destination type. Creates instances of ExplicitDestination descendant classes. The object of destination page. The type of explicit destination. Array of double values. The explicit destination object. Creates instances of ExplicitDestination descendant classes. Document where destination will be created. Number of the page. Destionatyion type. Array of destination specific values. The explicit destination object. Creates instances of ExplicitDestination descendant classes. The destination page number. The type of explicit destination. Array of double values. The explicit destination object. Returns string representation of ExplicitDestination object. Represents general interface for actions and destinations. Returns string representation Enumerates the forms of quadding (justification) to be used in displaying the annotation�s text. Left justification. Center justification. Right justification. Represents named actions that PDF viewer applications are expected to support. Gets or sets the action to be performed. Constructor for Named Action class. Action for which this object is created. Defines different actions which can be triggered from a PDF file. A named action to go to the first page. A named action to go to the last page. A named action to go to the next page. A named action to go to the previous page. A named action to open a print dialog (JavaScript). A named action to open a print dialog. A named action to find current bookmark. A named action to highlight current bookmark. A named action to add file attachment. A named action to crop document pages. A named action to delete document pages. A named action to exctract document pages. A named action to insert pages from a document. A named action to replace document pages. A named action to rotate document pages. A named action to check spelling in comments. A named action to find. A named action to edit preferences. A named action for searching. A named action for attaching current pdf document into email message. A named action to close the document. A named action to create pdf document from scanner. A named action to create pdf document from web page. A named action to exit pdf reader. A named action to open organizer. A named action to print the document. A named action to open the document properties. A named action to save the document with another name. A named action to zoom in the document. A named action to zoom out the document. A named action to print the document pages. A named action to go to the next view. A named action to go to the certain page. A named action to go to the previous document. A named action to go to the previous view. A named action to show/hide articles panel. A named action to show/hide attachment panel. A named action to show/hide bookmark panel. A named action to show/hide comments panel. A named action to show/hide fields panel. A named action to show/hide layers panel. A named action to show/hide model tree panel. A named action to show/hide pages panel. A named action to show/hide signatures panel. A named action to display single page. A named action to display single continious page. A named action to display pages as Two-Up. A named action to display pages as Two-Up continious. A named action to show/hide advanced editing toolbar. A named action to show/hide commenting toolbar. A named action to show/hide edit toolbar. A named action to show/hide file toolbar. A named action to show/hide find toolbar. A named action to show/hide forms toolbar. A named action to show/hide measuring toolbar. A named action to show/hide object data toolbar. A named action to show/hide page display toolbar. A named action to show/hide navigation toolbar. A named action to show/hide print production toolbar. A named action to show/hide property toolbar. A named action to show/hide redaction toolbar. A named action to show/hide select & zoom toolbar. A named action to show/hide tasks toolbar. A named action to show/hide typewriter toolbar. A named action to view pages in actual size. A named action to fit page on height. A named action to fit page. A named action to fit page visibility. A named action to fit page on width. A named action to make zoom. A named action to view the document in the full screen mode. Class which peroformes reading of XFDF format. Document doc = new Document("example.pdf"); Stream xfdfStream = File.OpenRead("file.xfdf"); XfdfReader.ReadAnnotations(xfdfStream, doc); xfdfStream.Close(); doc.Save("example_out.pdf"); Import annotations from XFDF file and put them into document. Source stream containing XFDF file. Document where annotations will be added. Import field values from XFDF file. Stream containing XFDF data. Document where fields data will be imported. Parses XFDF file and returns information as hashtable. XmlReader for the source file. Hashtable with information parsed from XFDF file. Enumerates the types of explicit destinations. Display the page with the coordinates (left,�top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom. A null value for any of the parameters left, top, or zoom specifies that the current value of that parameter is to be retained unchanged. A zoom value of 0 has the same meaning as a null value. Display the page with its contents magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension. Display the page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window. A null value for top specifies that the current value of that parameter is to be retained unchanged. Display the page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window. A null value for left specifies that the current value of that parameter is to be retained unchanged. Display the page with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and topentirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension. A null value for any of the parameters may result in unpredictable behavior. Display the page with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the window in the other dimension. Display the page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window. A null value for top specifies that the current value of that parameter is to be retained unchanged. Display the page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window. A null value for left specifies that the current value of that parameter is to be retained unchanged. Instead of being defined directly with the explicit syntax, a destination may be referred to indirectly by means of a name object or a byte string. Gets the name of named destination. Create named destination. Document where named destination should be created. Name to which destination refers. Converts destination to string value. String value. A screen annotation that specifies a region of a page upon which media clips may be played. Creates new Screen annotation on the specified page. The document's page where annotation should be created. The annotation rectangle, defining the location of the annotation on the page. The path to multimedia file. Accepts visitor object to process the annotation. Visitor object. Gets or sets the title of the screen annotation. Gets or sets an action to be performed when the annotation is activated. Gets type of annotation. A rendition action that controls the playing of multimedia content. Gets or sets rendition associated with the action. The operation to perform when the action is triggered. Gets or sets JavaScript code associated with the action. Enumerates the operations to perform with document during launch action executing. Undefined state. Open a document. Print a document. Creates a detached PKCS#7Detached signature using a X509Certificate2. It supports usb smartcards, tokens without exportable private keys. The certificate with the private key. Creates a detached PKCS#7Detached signature using a X509Certificate2. It supports usb smartcards, tokens without exportable private keys. The certificate with the private key An abstract class which represents signature custon appearance object. Gets/sets font family name. It should be existed in the document. Default value: Arial. Gets/sets font size. Default value: 10. Gets/sets contact info visibility. Default value: true. Gets/sets reason visibility. Default value: true. Gets/sets location visibility. Default value: true. Gets/sets contact info label. Default value: "Contact". Gets/sets reason label. Default value: "Reason". Gets/sets location label. Default value: "Location". Gets/sets digital signed label. Default value: "Digitally signed by". Gets/sets date signed label. Default value: "Date". Gets/sets datetime local format. Default value: "yyyy.MM.dd HH:mm:ss zzz". Gets/sets datetime format. Default value: "yyyy.MM.dd HH:mm:ss". Gets/sets culture info value. Default value: InvariantCulture. Gets or sets signature rotation. The access permissions granted for this document. Valid values are: 1 - No changes to the document are permitted; any change to the document invalidates the signature. 2 - Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature. 3 - Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification; other changes invalidate the signature. 1 - No changes to the document are permitted; any change to the document invalidates the signature. 2 - Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature. 3 - Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification; other changes invalidate the signature. Represents the class of document MDP (modification detection and prevention) signature type. Returns the access permissions granted for this document. Initializes a new instance of the class. The signature object that used during signing. The access permissions granted for this document. Enumeration of posible types of Acro Form. Standard AcroForm. Static XFA form. Dynamic XFA form. Represents XML form regarding XML Forms Architecture (XFA). XFA Template component of an XFA form. XFA Form Component of an XFA form. XFA Datasets component of an XFA form. XFA Config component of an XFA form. XML Data Package (all XFA form components within a surrounding XML container). Gets of sets data node value according . Data node path, e.g. form1[0].Subform1[0].Subform2[0].Subform3[0].TextField[0]. Be sure to include indices even if data contains only single occurences of each nodes, i.e. write node1[0].node2[0]... instead of node1.node2... Data node value. List of field names in the form template. Returns XML node of XFA field tempalte. Path of the field which template must be found. XL node with field template. Returns list of all field templates on XFA form. List of field templates. Gets the namespace for the XFA form. The following namepsaces are defined: "data" for form data and "tpl" for form template. Sets image for XFA field. Name of the field. Stream which contains image. Class represents barcode field. Gets the resolution, in dots-per-inch (dpi), at which the barcode object is rendered. Gets the caption of the barcode object. Specifies which barcode or glyph technology is to be used on this annotation, see for details. Gets The horizontal distance, in pixels, between two barcode modules. Gets the the vertical distance between two barcode modules, measured in pixels. The ratio XSymHeight/XSymWidth shall be an integer value. For PDF417, the acceptable ratio range is from 1 to 4. For QRCode and DataMatrix, this ratio shall always be 1 Gets an integer value representing the error correction coefficient. For PDF417, shall be from 0 to 8. For QRCode, shall be from 0 to 3 (0 for �L�, 1 for �M�, 2 for �Q�, and 3 for �H�). Initializes new instance of the class. The page where to place new barcode. Barcode sizes given in rectangle. Initializes new instance of the class. Document where field will be created. Rectangle where field will be placed on the page. Circle style. Check style. Cross style. Diamond style. Square style. Star style. Class represnets push button field. Gets or sets normal caption. Gets or sets rollover caption of button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button. Gets or sets alternate caption of the button which shall be displayed when the mouse button is pressed within its active area. Gets or sets normal icon of the button which shall be displayed when it is not interacting with the user. Gets or sets rollover icon of the button which shall be displayed when the user rolls the cursor into its active area without pressing the mouse button. Gets or sets alternate icon which shall be displayed when the mouse button is pressed within its active area. Gets icon fit object specifying how the widget annotation's icon shall be displayed within its annotation rectangle. Gets or sets icon caption position. Button field constructor for Generator. Adds image into the field resources an draws it. Image ot add into text field. ButtonField constructor. Page where button will be placed. Rectangle where button is placed on the page. ButtonField constructore. Docuemtn where new field will be created. Rectangle hwere button is placed on the page. Class representing checkbox field Returns list of allowed states. Gets or sets style of check box. Gets or sets current annotation appearance state. Gets or sets state of check box. Constructor for CheckboxField class. Page where check box will be placed. Position and size of the check box. Constructor for CheckboxField class. Document where will be new field created. Rectangle where new field will be created. Create instance of CheckboxField. Constructor to use with Generator. Document where field will be created. Gets or sets value of check box field. Clone the checkbox. The cloned object Gets or sets export value of CheckBox field. Represents base class for choice fields. Gets or sets commit on selection change flag. Gets or sets multiselection flag. Gets or sets index of selected option. This property allows to change selection. Gets or sets array of selected items. For multiselect list array contains more then one item. For single selection list it contains single item. Gets collection of choice options. Constructor for ChoiceField. Page where field is situated. Rectangle of the field. Creates choice field (for Generator) Document where choice field will be created. Constructor for ChoiceField. Document where field will be created. Rectangle of the field. Adds new option with specified name. Name of the new option. Adds new option with specified export value and name. Export value. Name of the new option. Deletes option by its name. Name of the option which must be deleted. Gets or sets value of the field. Class representing Combobox field of the form. Gets or sets editable status of the field. Gets or sets spellchaeck activiity status. Constructor for ComboBoxField to be used in Generator. Creates CombBox field to work with Generator. Document where field will be created. Constructor for Combobox Field. Page where field will be placed. Rectangle which defines size and position of the field on the page. Constructor for Combobox field. Document where field should be created. Rectangle which defines size and position of the field. The Aspose.Pdf.Forms namespace has classes which describes forms (standard, static, dynamic) and various types of fields like text box, list box, radio button etc. Base class for acro form fields. Operator for comparision field value with given value. Value to check the field value on. True if field value and passed value are equals. Returns value correctly encoded for placing into XFA dataset. Value for placing into XFA form. Encoded value. Gets or sets partial name of the field. Gets or sets alternate name of the field (An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface). Alternate name is used as field tooltip in Adobe Acrobat. Gets or sets mapping name of the field that shall be used when exporting interactive form field data from the document. Recaculates all calculated fields on the form. true if field value was changed during recalculation. Gets or sets value of the field. Returns true if dictionary is synchronized. Gets or sets number of subfields in this field. (For example number of items in radio button field). Synchronization object. Gets or sets boolean value which indicates is this field non-terminal field i.e. group of fields. Copies subfields of this field into array starting from specified index. Array where field must be copied. Starting index where fields will be copied. Returns enumerator of contained fields. Enumerator. Creates field for use in Generator. Document where field will be created. Removes this field and place its value directly on the page. Gets subfield contained in this field by name of the subfield. Contained subfield name. Field instance. Gets subfield contained in this field by index. Index of the reuqested subfield. Field instance. Set position of the field. Point where field should be positioned. Gets or sets index of this anotation on the page. Gets index of page which contains this field. Gets or sets the field rectangle. Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page. If true then font size will reduced to fit text to specified rectangle. Maximail font size which can be used for field contents. -1 to don't check size. Minimal font size which can be used for field contents. -1 to don't check size. Gets or sets tab order of the field. Field for file select box element. Class representing form object. Class which describes settings for Form flattening procedure. If set, all field appearances will be regenerated before flattening. This option may help if field is incorrectly flattened. This option may decrease performance. By default set to false. If set, formatting and other JavaScript events will be called. True by default. If set, buttons will be removed from flattened document. False by default. If true, redaction specified Redaction annotation will be applied Returns true if object is thread-safe. Returns synchronization object. If set, all form fields will be recalculated when any field is changed. Default value is true. Set to false in order to increase performance when filling form with large amount of calculated fields. Gets number of the fields on this form. Gets default resources placed on this form. Gets or sets default appearance of the form (object which describes default font, text size and color for fields on the form). Gets XFA data of the form (if presents). Forms can contain signing information and can be signed or unsigned. Sometimes view of forms in viewer must depend on whether form is signed or not. This enum enumerates possible rendering modes during convertion of form type in regard to sign. Forms can contain signing information, i.e. can be signed or unsigned. And form's view sometimes must depend on whether form is signed or not. This property tells to form's converter (f.e. during conversion XFA form to Standard form) whether result form must be rendered as signed or as unsigned. If this property is true the value of NeedsRendering key will be ignored during conversion XFA form to Standard form. It is false by default. If this property is true the "Perms" dictionary will be removed from the pdf document after conversion dynamic documents to standard. The "Perms" dictionary can contain a rules that disturb displaying selection of mandatory fields in Adobe Acrobat reader. It is false by default. If this property is true then additional red boundary rectangles will be drawn for required Xfa exclGroup elements containers This property was introduced because absences of analogues for the exclGroup during conversion Xfa representation of forms to standard. It is false by default. Gets type of the form. Possible values are: Standard, Static, Dynamic. Copies fields placed on the form into array. Array where fields must be placed. Starting index. Gets enumeration of form fields. Field enumerator. Adds field on the form. Field which must be added. Page index where added field will be placed. Adds field on the form. Field which must be added. Delete field from the form. Field which must be deleted. Deletes field from the form by its name. Name of the filed which must be deleted. Removes all form fields and place their values directly on the page. Gets field of the form by field name. Throws excpetion if the field was not found. Name of the field. Retreived field. Gets field of the form by field index. Index of the field. Retreived field. Adds new field to the form; If this field is already placed on other or this form, the copy of field is created. Field name. Name of field on the form. Page number where field will be added. Added field returned. If copy of the field was created it will be returned. Adds additional appearance of the field to specified page of the document in the specified location. Field which appearance should be added on form. Number of the page where field must be placed. Rectangle where field will be placed. Sets XFA of the form to specified value. Xml document which concains new XFA data. Gets list of all fields in lowest level of hierarhical form. Returns fields inside of specified rectangle. Rectangle where fields should be found. Array with found fields. Allows to set order of field calculation. If set, the document contains at least one signature field. If set, the document contains signatures that may be invalidated if the file is saved (written) in a way that alters its previous contents, as opposed to an incremental update. Describes position of icon. Icon is not displayed. Caption is not displayed. Caption is below icon. Caption is above icon. Caption to the right. Caption to the left. Caption over laid. Describes how the widget annotation's icon shall be displayed within its annotation rectangle. Gets or sets scaling reason. The type of scaling that shall be used. /// Gets or sets space to allocate at the left of the icon. Gets or sets space to allocate at the bottom of the icon. If true, indicates that the button appearance shall be scaled to fit fully within the bounds of the annotation without taking into consideration the line width of the border. Converts name of scaling reason into ScalingReason object. Name of scaling reason. Scaling reason object. Converts scaling reason obejct to name. Scaling reason object to be converted. Name of scaling reasong. Converts scaling mode name into ScalingMode object. Scaling mode name. Scaling mode object. Converts scaling mode object into name. Scaling mode object. Scaling mode name. Class represents ListBox field. Gets or sets index of the top visible element of the list. Gets or sets index of the selected item. Items are numbered from 1. Constructor for ListBoxField to be used in Generator. Gets or sets array of the selected items in the multiselect list. For single-select list returns array with single item. Creates new ListBox field. Page where list box will be placed. Rectangle where list box will be placed on the page. Constructor for ListBox field. Document to which this field will belong. Rectangle where list box will be placed. Class represents option of choice field. Gets or sets option export value. Gets or sets name of option. Gets or sets selected status of option. Returns true if option is selected. Gets index of the option. Class representing collection of options of the choice field. Returns true of object is synchronized. Gets a value indicating if collection is readonly. Synchronization object of the collection. Gets number of options. Copies options into array. Array where options wil lbe copied. Startign index in array. Returns enumerator for options in collection. Options enumerator. Gets option by index. Option index. Index should be in range [1..n] where n is options count. Retreived option. Gets option from colleciton by option name. Option name. Retreived option. Gets option by index. Index of the option. Option on the specified index. Gets option by its name. Name of the option. Found option. Class descibes text field for entering password. Represents signature object regarding PKCS#1 standard. RSA encryption algorithm and SHA-1 digest method are used for signing. Initializes new instance of the class. This image will define signature appearance on the page. Inititalizes new instance of the class. Inititalizes new instance of the class. Pfx file which contains certificate for signing. Password for certificate. Password to get access to the private key in the certificate. Inititalizes new instance of the class. Stream with certificate data organized as pfx. Password to get access to the private key in the certificate. Represents the PKCS#7 object that conform to the PKCS#7 specification in Internet RFC 2315, PKCS #7: Cryptographic Message Syntax, Version 1.5. The SHA1 digest of the document's byte range is encapsulated in the PKCS#7 SignedData field. Inititalizes new instance of the class. Inititalizes new instance of the class. Pfx file which contains certificate for signing. Password for certificate. Password to get access to the private key in the certificate. Inititalizes new instance of the class. Stream with certificate data organized as pfx. Password to get access to the private key in the certificate. Represents the PKCS#7 object that conform to the PKCS#7 specification in Internet RFC 2315, PKCS #7: Cryptographic Message Syntax, Version 1.5. The original signed message digest over the document's byte range is incorporated as the normal PKCS#7 SignedData field. No data shall is encapsulated in the PKCS#7 SignedData field. Initializes new instance of the class. This image will define signature appearance on the page. Inititalizes new instance of the class. Inititalizes new instance of the class. Pfx file which contains certificate for signing. Password to get access to the private key in the certificate. Inititalizes new instance of the class. Stream with certificate data organized as pfx. Password to get access to the private key in the certificate. Class representing radio button field. Style of field box. Gets or sets index of selected item. Numbering of items is started from 1. Gets collection of options of the radio button. Constructor for RadiouttonField Page where radio button will be placed. Constructor for RadioButtonField. Document where radio button will be created. Adds new option field to RadioButton field Item which should be added. Add to radio button option with specifed rectangle. Name of new option. New item rectangle. Add option to radion button. Name of the option which will be added. Move all subitems of radio button to specified positins on the page. Sets position of RadioButton field annotations. Gets index of page which contains this RadioButton field. Gets or sets value of field. Class represents item of RadioButton field. Create new RadioButtonOptionField instance. Creates radiobutton in the specified recangle on specified page. Page where RadioButton will be placed; Recangle of RadioButton. Gets or sets name of the option. Gets or sets caption. Gets or sets style of check box. Class describes rich text editor component. Gets or sets default style string of the rich text field. Gets or sets rich text value. Gets or sets formatted rich text value with markup. Value of RichTextField. Gets or sets justification of the rich text box. Constructor for Rich Text Box field. Page where field will be placed. Position of the field on the page. The type of scaling that shall be used. Scale the icon to fit the width or height of the annotation rectangle while maintaining the icon�s original aspect ratio. Scale the icon to fill the annotation rectangle exactly. The circumstances under which the icon shall be scaled inside the annotation rectangle. Always scale. BScale only when the icon is bigger than the annotation rectangle. Scale only when the icon is smaller than the annotation rectangle. Never scale. An abstract class which represents signature object in the pdf document. Signatures are fields with values of signature objects, the last contain data which is used to verify the document validity. Gets/sets the custom appearance. The name of the person or authority signing the document. The time of signing. The CPU host name or physical location of the signing. The reason for the signing, such as (I agree…). Information provided by the signer to enable a recipient to contact the signer to verify the signature, e.g. a phone number. An array of pairs of integers (starting byte offset, length in bytes) that shall describe the exact byte range for the digest calculation. Gets/sets timestamp settings. Gets/sets ocsp settings. Gets/sets ltv validation flag. Verify the document regarding this signature and return true if document is valid or otherwise false. true if document is valid. Inititalizes new instance of the class. Force to show/hide signature properties. In case ShowProperties is true signature field has predefined format of appearance (strings to represent): ------------------------------------------- Digitally signed by {certificate subject} Date: {signature.Date} Reason: {signature.Reason} Location: {signature.Location} ------------------------------------------- where {X} is placeholder for X value. Also signature can have image, in this case listed strings are placed over image. ShowProperties is true by default. Inititalizes new instance of the class. Pfx file which contains certificate for signing. Password to get access to the private key in the certificate. Inititalizes new instance of the class. Stream with certificate data organized as pfx. Password to get access to the private key in the certificate. Represents signature form field. Gets signature object. This object contains signature data regarding public-key cryptographic standards. Classes , and represent all supported types of signature objects. Signs the document using this signature field. Signature object, see , , . Stream with certificate. Password to access private in the . Initializes new instance of the class. Page where signature field should be placed. Position and size of signature field. Initializes new instance of the class. Page where signature field should be placed. Position and size of signature field. Sign the document using this signature field. Signature object, see , and . Extracts signature's image as jpeg encoded stream. If image was successfully found than returns jpeg encoded stream object; otherwise, null. Extracts signature's image as encoded stream. Image format for encoding. If image was successfully found than returns encodedstream object; otherwise, null. Extracts the single X.509 certificate in DER format as a stream. If certificate was found returns X.509 single certificate; otherwise, null. A (Barcode) Symbology defines the technical details of a particular type of barcode: the width of the bars, character set, method of encoding, checksum specifications, etc. A multi-row, variable-length 2D symbology with high data capacity and error-correction capability. QR code (short for Quick Response) is a specific matrix barcode (2D code), readable by dedicated QR barcode readers and camera phones. A 2D matrix symbology consisting of black and white square modules arranged in either a square or rectangular pattern. Class representing text box field. Gets or sets multiline flag of the field. If Multiline is true field can contain multiple lines of text. Gets or sets spellcheck flag for field. If true field shall be spell checked. Gets or sets scrollable flag of field. If true field can be scrolled. Gets or sets flag which indicates is field divided into spaced positions. Gets or sets maximum length of text in the field. Constructor which should be used with Generator. Document where field will be created. Create instance of TextBoxField. Constructor of TextBox field. Page where text field is placed. Rectangle where the text field will be placed on the page. Constructor of TextBox field. Document where field will be created. Rectangle of the field. Gets or sets text vertical alignment for annotation. Gets or sets value of the field. Adds image into the field resources an draws it. Image to add into text field. Adds barcode 128 into the field. Field value will be changed onto the code and field become read only. The text to generate barcode 128. This action represents actions for conversion of images with soft mask. Use default strategy. Soft mask will be converted into stencil mask. Load options for Markdown format conversion. Collection of Named Destinations. Gets or sets destination by its name. Returns count of the destinations. Removes destination by its name. Adds new named destination. Gets array of names of the destiantions. Class represents the collection of all destinations (a name tree mapping name strings to destinations (see 12.3.2.3, "Named Destinations") and (see 7.7.4, "Name Dictionary")) in the pdf document. Gets or sets appointment by its name. Name of the appointment. Appoitnemt Count of named destinations. Delete named destination. Name of the destination to delete. Add new named destination. Destination name. Appointment to add. List of names of the destinations. Class contains set options for image compression. If this flag is set to true images will be compressed in the document. compression level is specfied with ImageQuality property. If this flag set to true and CompressImages is true images will be resized if image resoultion is greater then specified MaxResolution parameter. Specifies level of image compression when CompressIamges flag is used. Specifies maximum resolution of images. If image has higher resolition it will be scaled Version of compression algorithm. Possible values are: 1. standard compression, 2. fast (improved compression which is faster then standard but may be applicable not for all images), 3. mixed (standard compression is applied to images which can not be compressed by faster algorithm, this may give best compression but more slow then "fast" algorithm. Version "Fast" is not applicable for resizing images (standard method will be used). Default is "Standard". Gets or sets encoding used to store images. Describes versions of image compression algorithm. Standard algorithm. Default value. Improved algorithm faster then standard but applicable not for all cases. Use fast algorithm when possible and standard for other cases. May be slower then "Fast" but may produce better compression. Don't change encoding. JPEG (DCT) encoding. Flate encoding. JPEG2000 (JPX) encoding. The Aspose.Pdf.Optimization is a namespace for classes for managing of document optimization process. Class which describes document optimization algorithm. Instance of this class may be used as parameter of OptimizeResources() method. If this flag is set to true, Resource streams will be analyzed. If duplicate streams are found (i.e. if stream contents is equal), then thes streams will be stored as one object. This allows to decrease document size in some cases (for example, when same document was concatenedted multiple times). If true page contents will be reused when document is optimized for equal pages. If this flag set to true, every resource is checked on it's usage. If resource is never used, then resources is removed. This may decrease document size for example when pages were extracted from document. If this flag is set to true, all document objects will be checked and unused objects (i.e. objects which does not have any reference) are removed from document. Set of options which describe will images in the document be compressed and parameters of the compression. If this flag is set to true images will be compressed in the document. compression level is specfied with ImageQuality property. If this flag set to true and CompressImages is true images will be resized if image resoultion is greater then specified MaxResolution parameter. Specifies level of image compression when CompressIamges flag is used. Specifies maximum resolution of images. If image has higher resolition it will be scaled [Obsolete("Please use ImageCompressionOptions.MaxResolution instead.")] Make fonts not embedded if set to true. Fonts will be converted into subsets if set to true. Remove private information (page piece info). Image encodre which will be used. Creates optimization strategy will all options activated. Please note that activated only options which does not change any functionality of the document. I.e. image compressing and fonts unembedding will not enabled (and can be embedded manually). OptimizationOptions object. Class describes collection of outlines. Gets a value indicating whether the collection is read-only. Gets the total number of outline items at all levels in the document outline hierarchy. Adds outline item to collection. The outline item to be added. Clears all items from the collection. Always throws NotImplementedException The object to locate in the collection Copies the outline entries to an System.Array, starting at a particular System.Array index. The one-dimensional System.Array that is the destination. Must have zero-based indexing. The zero-based index in array at which copying begins. Returns an enumerator that iterates through the collection. An System.Collections.IEnumerator object that can be used to iterate through the collection. Remove outline collection item. Item to delete. Represents rgb to device gray color spaces conversion strategy. Converts the page of document. The page of document. Interface for color space conversion strategies. Converts the page of document. The page of document. Represents options for loading/importing of .mht-file into pdf document. Represents The Open Prepress Interface (OPI) is a mechanism for creating low-resolution placeholders, or proxies, for such high-resolution images. The constructor. Xform object. Gets the version of OPI to which this dictionary refers. Gets the external file containing the low- resolution proxy image. Gets an array of eight numbers of the form specifying the location on the page of the cropped image. This class represents action for conversion of transparency. Use default strategy, no adding masks. Add transparent mask image. This class represnets collection of JavaScript List of keys in JavaScript collection. Gets or sets JavaScrip from collection by its key. Removes JavaScript by its name. Provides methods to set metered key. In this example, an attempt will be made to set metered public and private key [C#] Metered matered = new Metered(); matered.SetMeteredKey("PublicKey", "PrivateKey"); [Visual Basic] Dim matered As Metered = New Metered matered.SetMeteredKey("PublicKey", "PrivateKey") Sets metered public and private key public key private key Gets consumption file size consumption quantity Gets consumption credit consumption quantity The paper handling option to use when printing the file from the print dialog.. Print single-sided. Duplex and flip on the short edge of the sheet. Duplex and flip on the long edge of the sheet. The Aspose.PdfAOptionClasses is a namespace for PDF/A convertsion optins. This class describes rules which can be used to solve Adobe Preflight error "Text cannot be mapped to Unicode". Constructor Constructor sets flag Constructor sets flag sets flag Some fonts have ToUnicode character code maps with spaces in names. These spaces could call errors with unicode text mapping. This flag commands to remove spaces from names of ToUnicode character code maps. By default false. Some fonts doesn't provide information about unicodes for some text symbols. This lack of information calls an error "Text cannot be mapped to Unicode". Use this flag to map non-linked symbols on unicode "space"(code 32). PDF/A standard requires, that all fonts must be embedded into document. This class includes flags for cases when it's not possible to embed some font cause this font is absent on destination PC. Declares to substitute non-embedded font using default font substitution strategy. By default false; represents set of options for convert PDF document Constructor Path to file where comments will be stored. The pdf format. Action for objects that can not be converted Constructor Path to file where comments will be stored. The pdf format. Constructor The pdf format. Constructor The pdf format. Action for objects that can not be converted Constructor Path to file where comments will be stored. The pdf format. Action for objects that can not be converted Action for image masked objects Constructor Stream where comments will be stored The pdf format Action for objects that can not be converted Gets/sets run of image streams in async mode. Is low memory conversion mode enabled PDF format. Path to file where comments will be stored. Stream where comments will be stored. Action for objects that can not be converted Action for image masked objects Action for images with soft mask. Gets PdfFormatConversionOptions object with default parameters Holds flags to control PDF/A conversion process for cases when source document doesn't correspond to PDF/A specification. Strategy to copy encoding data for symbolic fonts if symbolic TrueType font has more than one encoding subtable. This flag controls text alignment in converted document. By default document conversion doesn't affect text alignment and leave text as is. But in some cases font substitution causes text overlapping or extra spaces in converted document. When this flag is set special alignment operations will be performed. This flag should be set only for documents which have problems with overlapped text or extra text spaces cause using of this flag decrease performance and in some cases could corrupt text content. Strategy to align text. This parameter has sense only when flag is set to true. Strategy to process symbols from unicode Private Use Area (PUA). Gets or sets a flag which enables/disables special conversion mode to get PDF/A document with reduced file size. Now this flag impacts on optimization of fonts used in PDF document, possibly, in future, this flag also will be used to switch on optimization for another data structures, such as graphic. Set of this flag and mode could significantly reduce file size but at the same time it could significantly decrease performance of conversion. Strategy(ies) to exclude superfluous fonts and reduce document file size. This parameter has sense only when flag is set to true. By default combination of strategies and is used. Options for cases when it's not possible to embed some fonts into PDF document. Rules to solve problems with unicode mapping. Can be null. Gets or sets the filename of icc profile name. In case of null the default icc profile used. This property is out-property. It holds all the fonts(font names) which were not found on computer at last PDF/A conversion. Describes strategies used to align document text segments. Now only strategy to restore segments to original bounds is supported. In future another strategies could be added. Some PDF documents have special unicode symbols, which are belonged to Private Use Area (PUA), see description at https://en.wikipedia.org/wiki/Private_Use_Areas. This symbols cause an PDF/A compliant errors like "Text is mapped to Unicode Private Use Area but no ActualText entry is present". This enumeration declares a strategies which can be used to handle PUA symbols. Disable PUA symbol processing. This strategy used by default for PDF/A documents with Level B conformance. Inserts marked content block with ActualText entry which contains empty text. This strategy gives good results for documents without marked content blocks. Used by default for PDF/A documents with Level A conformance. This strategy works slower than 'SurroundPuaTextWithEmptyActualText' but it can remove PUA compliant errors for documents which can't be handled properly by SurroundPuaTextWithEmptyActualText. PUA symbols are substituted on symbol 'space' or special unicode (some PUA symbols have unicode analogs). Substitution applied not to document's text but to font's internal data ToUnicode so it doesn't affects symbol's vision but it affects symbol's presentation in copy/paste operation system buffer. Some documens have large size after converison into PDF/A format. To reduce file size for these documents it's necessary to define a strategy of fonts removing. This enumeration declares a strategies which can be used to optimize fonts usage. Every strategy from this enumeration has sense only when flag is set. This strategy removes all the fonts which have duplicates in document. If document contains group of duplicated fonts only one font from this group is embedded in document. All other fonts from this group are removed from document, every removed font substituted with the already embedded analog. This strategy looks like but it removes not fully duplicated fonts but fonts which are similar one to another and differs only by parameter "Widths". This parameter contains set of some widths for specified symbols of font. Every value of width from this "Widths" set is not the real width of symbol(glyph), real width for this symbol already defined in font's binary data. Value of width from "Widths" set means visual width for this symbol - the width which PDF viewer software must set on displaying symbol instead of real width defined in the font. More accurately specification tells: Acrobat 5.0 and later viewers use the glyph widths stored in the font dictionary to override the widths of glyphs in the font program itself, which improves the consistency of the display and printing of the document. This strategy is more effective than but using of this strategy in some cases theoretically could damage visual presentation of converted document. This defect is possible due to that declared widths of fonts could be different for the same symbol and in this case width of this symbol will be changed to new one after font substitution - when removed font will be replaced in document with already embedded one. And if symbol's visual width will be changed - it will be shown incorrectly and this distinction could cause visual defects such as text overlapping or another problems. But visual defect described is a very rare case and this strategy reduces size of document more effectively. This is most effective strategy to reduce document's size. It takes fully embedded font sets and trim them down to only the subsets used. It's recommended to use this strategy in combination with or to get multiple compression effect for file size. Using of all three strategies simultaneously has no sense and strategy will not be used in this case. This class holds flags to control PDF/A conversion for cases when source PDF document doesn't correspond to PDF specification. If flags of this clas are used it decreases performance but it's necessary when source PDF document can't be convert into PDF/A format by usual way. By default all flags are set to false. Some PDF documents contain fonts which have different names in internal data. Use of this flag enforces special processing logic for cases when fields BaseFont and FontDescriptor.FontName are different. This class describes rules which can be used to tune process of copy encoding data for cases when TrueType symbolic font has more than one encoding. Some PDF documents after conversion into PDF/A format could have error "More than one encoding in symbolic TrueType font's cmap". What is a reason of this error? All TrueType symbolic fonts have special table "cmap" in it's internal data. This table maps character codes to glyph indices. And this table could contain different encoding subtables which describe encodings used. See advanced info about cmap tables at https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6cmap.html. Usually cmap table contains several encoding subtables, but PDF/A standard requires that only one encoding subtable (3,0) must be leaved for this font in PDF/A document. And key question here - what data must be taken from another subtables to copy into destination encoding table (3,0)? Majority of fonts have 'well-formed' cmap tables where every encoding subtable is fully consistent with another subtable. But some fonts have cmap tables with collisions - where for example one subtable has glyph index 100 for unicode 100, but another subtable has glyph index 200 for the same unicode 100. To solve this problems special strategy needed. By default following strategy used: mac subtable(1,0) is looked for. If this table is found, only this data used to fill destination table (3,0). If mac subtable is not found then all subtables except (3,0) are iterated and used to copy data into destination (3,0) subtable. Also mapping for every unicode(unicode, glyph index) is copied into destination table only if destination table has no this unicode at current moment. So, for example if first subtabe has glyph index 100 for unicode 100, and next subtable has glyph index 200 for the same unicode 100, only data from first subtable (unicode=100, glyph index = 100) will be copied. So each previous subtable takes precedence over the next. Properties of this class help tune default behaviour. If property of type is set, then relevant subtable will be used in precedence to mac subtable(1,0). Value 'MacTable' from enumeration has no sense in this case, cause it points on the same mac subtable (1,0) which will be used by default. Property discards all priorities for any subtable. If this property is set, then only subtables from declared queue will be used in specified order. If subtables specified are not found then default iteration of all subtables and copy strategy described above will be used. Object specifies encoding subtable used. This subtable can be set via combination of members(PlatformID, PlatformSpecificId) or via enumeration. Constructor. Sets default subtable (mac 1,0) Constructor queue of encoding subtables to iterate Constructor encoding subtable which will be used in precedence to mac subtable(1,0) Specifies subtable which will be used in precedence to mac subtable(1,0). Value 'MacTable' from enumeration has no sense in this case. Specifies queue of encoding subtables to process. Specifies encoding subtable. Each encoding subtable has unique combination of parameters (PlatformID, PlatformSpecificId). Enumeration and property were implemented to make easier set of encoding subtable needed. Constructor, specifies mac subtable(1,0) by default Constructor Platform identifier for encoding subtable Platform-specific encoding identifier for encoding subtable Constructor encoding subtable Specifies encoding subtable via enumeration Platform identifier for encoding subtable Platform-specific encoding identifier for encoding subtable Declares set of some known encoding subtables Specifies windows unicode table(3,1) - Unicode BMP-only (UCS-2) Specifies windows symbolic table - (3,0) Specifies mac table(1,0) Specifies unicode table(0,3) Represent point with fractional coordinates. X coordinate value. Y coordinate value. Z coordinate value. Initializes new instance of the . x coordinate value. y coordinate value. z coordinate value. Gets point with zero coordinates. Enumerates column adjustment types. Customized. Auto fit to content. Auto fit to window. Represents the ocsp settings using during signing process. Gets/sets the ocsp server url. Initializes a new instance of the class. The ocsp server url. The Aspose.Pdf.Sanitization is a namespace for sanitization operations. The exception that is thrown when an sanitization operation failed. Initializes a new instance of the class. Initializes a new instance of the class. The message. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The error message that explains the reason for the exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Represents the ocsp settings using during signing process. Gets/sets the timestamp server url. Gets/sets the basic authentication credentials, Username and password are combined into a string "username:password". Initializes a new instance of the class. The timestamp server url.The basic authentication credentials, username and password are combined into a string "username:password". Save options for export to Excel format Defines conversion engine that will be used for conversion Set true if you need to minimize the number of worksheets in resultant workbook. Default value is false; it means save of each PDF page as separated worksheet. Set true if you need inserting of blank column as the first column of worksheet. Default value is false; it means that blank column will not be inserted. Set true for using uniform columns division through the document. Default value is false; it means that columns division will independent for each page. Gets or sets factor that will be applied to (virtual) scaling font size during conversion to Excel table in legacy engine. Setting of less value facilitates the search for columns and prevents merging of them for some documents. Default value is 0.9; Setting value to zero allows algorithm choose scaling automatically. Output format Allows to specify .xlsx, .xls/xml or csv file format. Default value is XLSX; Excel 2003 XML Format Office Open XML (.xlsx) File Format A comma-separated values (CSV) File Format A macro-enabled Office Open XML (.xlsm) File Format OpenDocument Spreadsheet Enumerates conversion engines that can be used for conversion Default value is NewEngine Legacy conversion engine is deprecated. The new conversion engine. Used by default. Represents graphics info. Gets or sets a float value that indicates the line width of the graph. Gets or sets a object that indicates the color of the graph. Gets or sets a dash array. Gets or sets a dash phase. Gets or sets a object that indicates the fill color of the graph. Gets or sets is border doubled. Gets or sets a float value that indicates the skew angle of the x-coordinate when transforming a coordinate system. Gets or sets a float value that indicates the skew angle of the y-coordinate when transforming a coordinate system. Gets or sets a float value that indicates the scaling rate of the x-coordinate when transforming a coordinate system. Gets or sets a float value that indicates the scaling rate of the y-coordinate when transforming a coordinate system. Gets or sets a float value that indicates the rotation angle of the coordinate system when transforming a coordinate system. Clone the graphics info. The cloned object Represents html fragment. Gets rectangle of the HtmlFragment Gets or sets words break Gets or sets font Gets or sets HtmlLoadOptions that will be used for loading (and rendering) of HTML into this instance of class. Please use it when it's necessary use specific setting for import of HTML for this or that instance (f.e when this or that instance should use specific BasePath for imported HTML or should use specific loader of external resources) If parameter is default (null), then standard HTML loading options will be used. Initializes a new instance of the HtmlFragment class. The fragment text The exception that is thrown when a font type is not supported. Initializes a new instance of the class. The message. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The error message that explains the reason for the exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Represents boolean type that supports Undefined value. Undefined value value of ExtendnedBoolean. False value of ExtendnedBoolean. True value of ExtendnedBoolean. Represents XMP field. Gets an Empty xmp field. Gets xml:lang qualifier. Gets the prefix. The prefix. Gets the namespace URI. The namespace URI. Gets or sets the name of the local. The name of the local. Gets the name. The name. Gets the value. The value. Gets the type of the field. The type of the field. Gets a value indicating whether this instance is empty. true if this instance is empty; otherwise, false. Indicates whether this instance and a specified object are equal. true if obj and this instance are the same type and represent the same value; otherwise, false. Another object to compare to. 2 Returns a hash code for this instance. A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. Implements the operator ==. The field1. The field2. The result of the operator. Implements the operator !=. The field1. The field2. The result of the operator. Gets value as a structure Gets value as an array. This enum represents types of a XMP field. This type represents a structure. This type represents a array. This type represents a property. This type represents a packet. This field represents an unknown type. The exception that is thrown when font usage is incorrect. Initializes a new instance of the class. The message. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The error message that explains the reason for the exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. The exception that is thrown when a file is invalid. Initializes a new instance of the class. Initializes a new instance of the class. The message. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The error message that explains the reason for the exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. The exception that is thrown when invalid password is provided by user. Initializes a new instance of the class. The message. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The error message that explains the reason for the exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. The exception that is thrown when a pdf file is invalid. Initializes a new instance of the class. The message. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The error message that explains the reason for the exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Represents errors that occur during PDF application execution. Initializes a new instance of the class. Initializes a new instance of the class. The message. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The error message that explains the reason for the exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. This class represents action for conversion errors. Delete convert errors Do nothing with convert errors This class represents an pdf format. Pdf/A-1a format Pdf/A-1b format Pdf/A-2a format Pdf/A-3a format Pdf/A-2b format Pdf/A-2u format Pdf/A-3b format Pdf/A-3u format Adobe version 1.3 Adobe version 1.4 Adobe version 1.5 Adobe version 1.6 Adobe version 1.7 PDF/UA-1 format PDF/X-1a-2001 format PDF/X-1a format PDF/X-3 format ZUGFeRD format This interface declared for customization algorithms of quantization. Users can implement their own realization of this algorithms (for example algorithms based on unmanaged code). Returns 1Bpp bitmap representation Source bitmap. Bitmap in 1 bpp image format. Returns 4Bpp bitmap representation Source bitmap. Bitmap in 4 bpp image format. Returns 8Bpp bitmap representation Source bitmap. Bitmap in 8 bpp image format. Represent type of cryptographic algorithm that used in encryption/decryption routines. RC4 with key length 40. RC4 with key length 128. AES with key length 128. AES with key length 256. The Aspose.Pdf.Tagged is a namespace for classes for support of Tagged PDF documents. Represents interface for work with TaggedPdf content of document. Get settings for whole document. settings for whole document. Gets of PDF document. of PDF document. Gets root of logical structure of PDF document. Root of logical structure of PDF document. Sets natural language for pdf document. A language identifier that shall specify the natural language for all text in the document except where overridden by language specifications for structure elements or marked content. A language identifier shall either be the empty text string, to indicate that the language is unknown, or a Language-Tag as defined in RFC 3066, Tags for the Identification of Languages. Sets title for PDF document. The title of PDF document. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates with level. The level of Header. Must be 1, 2, 3, 4, 5 or 6. Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Creates . Created structure element. Represents exception for TaggedPDF content of document. Initializes a new instance of the class. Represents Standard Attribute Keys. Get Attribute Key. Attribute Key. Get Attribute Owner. Attribute Owner. Placement attribute (Layout attribute owner). WritingMode attribute (Layout attribute owner). BackgroundColor attribute (Layout attribute owner). BorderColor attribute (Layout attribute owner). BorderStyle attribute (Layout attribute owner). BorderThickness attribute (Layout attribute owner). Padding attribute (Layout attribute owner). Color attribute (Layout attribute owner). SpaceBefore attribute (Layout attribute owner). SpaceAfter attribute (Layout attribute owner). StartIndent attribute (Layout attribute owner). EndIndent attribute (Layout attribute owner). TextIndent attribute (Layout attribute owner). TextAlign attribute (Layout attribute owner). BBox attribute (Layout attribute owner). Width attribute (Layout attribute owner). Height attribute (Layout attribute owner). BlockAlign attribute (Layout attribute owner). InlineAlign attribute (Layout attribute owner). TBorderStyle attribute (Layout attribute owner). TPadding attribute (Layout attribute owner). BaselineShift attribute (Layout attribute owner). LineHeight attribute (Layout attribute owner). TextDecorationColor attribute (Layout attribute owner). TextDecorationThickness attribute (Layout attribute owner). TextDecorationType attribute (Layout attribute owner). RubyAlign attribute (Layout attribute owner). RubyPosition attribute (Layout attribute owner). GlyphOrientationVertical attribute (Layout attribute owner). ColumnCount attribute (Layout attribute owner). ColumnGap attribute (Layout attribute owner). ColumnWidths attribute (Layout attribute owner). ListNumbering attribute (List attribute owner). Role attribute (PrintField attribute owner). Checked attribute (PrintField attribute owner). Desc attribute (PrintField attribute owner). RowSpan attribute (Table attribute owner). ColSpan attribute (Table attribute owner). Headers attribute (Table attribute owner). Scope attribute (Table attribute owner). Summary attribute (Table attribute owner). Performs an explicit conversion from to . The attribute key. The result of the conversion. Returns a string that represents the current object. String that represents the current object. Represents class for Attribute Name Values. Gets name value of attribute. Gets attribute key. Attribute Placement: Block - Stacked in the block-progression direction within an enclosing reference area or parent BLSE. Attribute Placement: Inline - Packed in the inline-progression direction within an enclosing BLSE. Attribute Placement: Before - Placed so that the before edge of the element's allocation rectangle coincides with that of the nearest enclosing reference area. Attribute Placement: Start - Placed so that the start edge of the element's allocation rectangle coincides with that of the nearest enclosing reference area. Attribute Placement: End - Placed so that the end edge of the element's allocation rectangle coincides with that of the nearest enclosing reference area. Attribute WritingMode: LrTb - Inline progression from left to right; block progression from top to bottom. This is the typical writing mode for Western writing systems. Attribute WritingMode: RlTb - Inline progression from right to left; block progression from top to bottom. This is the typical writing mode for Arabic and Hebrew writing systems. Attribute WritingMode: TbRl - Inline progression from top to bottom; block progression from right to left. This is the typical writing mode for Chinese and Japanese writing systems. Attribute BorderStyle: None - No border. Forces the computed value of BorderThicknessto be 0. Attribute BorderStyle: Hidden - Same as None, except in terms of border conflict resolution for table elements. Attribute BorderStyle: Dotted - The border is a series of dots. Attribute BorderStyle: Dashed - The border is a series of short line segments. Attribute BorderStyle: Solid - The border is a single line segment. Attribute BorderStyle: Double - The border is two solid lines. The sum of the two lines and the space between them equals the value of BorderThickness. Attribute BorderStyle: Groove - The border looks as though it were carved into the canvas. Attribute BorderStyle: Ridge - The border looks as though it were coming out of the canvas (the opposite of Groove). Attribute BorderStyle: Inset - The border makes the entire box look as though it were embedded in the canvas. Attribute BorderStyle: Outset - The border makes the entire box look as though it were coming out of the canvas (the opposite of Inset). Attribute TextAlign: Start - Aligned with the start edge. Attribute TextAlign: Center - Centered between the start and end edges. Attribute TextAlign: End - Aligned with the end edge. Attribute TextAlign: Justify - Aligned with both the start and end edges, with internal spacing within each line expanded, if necessary, to achieve such alignment. The last (or only) line shall be aligned with the start edge only. Attribute Width: Auto - the element's width shall be determined by the intrinsic width of its content. Attribute Height: Auto - The element's height shall be determined by the intrinsic height of its content. Attribute BlockAlign: Before - Before edge of the first child's allocation rectangle aligned with that of the table cell's content rectangle. Attribute BlockAlign: Middle- Children centered within the table cell. The distance between the before edge of the first child's allocation rectangle and that of the table cell's content rectangle shall be the same as the distance between the after edge of the last child's allocation rectangle and that of the table cell's content rectangle. Attribute BlockAlign: After - After edge of the last child's allocation rectangle aligned with that of the table cell's content rectangle. Attribute BlockAlign: Justify - Children aligned with both the before and after edges of the table cell's content rectangle. The first child shall be placed as described for Before and the last child as described for After, with equal spacing between the children. If there is only one child, it shall be aligned with the before edge only, as for Before. Attribute InlineAlign: Start - Start edge of each child's allocation rectangle aligned with that of the table cell's content rectangle. Attribute InlineAlign: Center - Each child centered within the table cell. The distance between the start edges of the child's allocation rectangle and the table cell's content rectangle shall be the same as the distance between their end edges. Attribute InlineAlign: End - End edge of each child's allocation rectangle aligned with that of the table cell's content rectangle. Attribute LineHeight: Normal - Adjust the line height to include any nonzero value specified for BaselineShift. Attribute LineHeight: Auto - Adjustment for the value of BaselineShift shall not be made. Attribute TextDecorationType: None - No text decoration. Attribute TextDecorationType: Underline - A line below the text. Attribute TextDecorationType: Overline - A line above the text. Attribute TextDecorationType: LineThrough - A line through the middle of the text. Attribute RubyAlign: Start - The content shall be aligned on the start edge in the inline-progression direction. Attribute RubyAlign: Center - The content shall be centered in the inline-progression direction. Attribute RubyAlign: End - The content shall be aligned on the end edge in the inline-progression direction. Attribute RubyAlign: Justify - The content shall be expanded to fill the available width in the inline-progression direction. Attribute RubyAlign: Distribute - The content shall be expanded to fill the available width in the inline-progression direction. However, space shall also be inserted at the start edge and end edge of the text. The spacing shall be distributed using a 1:2:1 (start:infix:end) ratio. It shall be changed to a 0:1:1 ratio if the ruby appears at the start of a text line or to a 1:1:0 ratio if the ruby appears at the end of the text line. Attribute RubyPosition: Before - The RT content shall be aligned along the before edge of the element. Attribute RubyPosition: After - The RT content shall be aligned along the after edge of the element. Attribute RubyPosition: Warichu - The RT and associated RP elements shall be formatted as a warichu, following the RB element. Attribute RubyPosition: Inline - The RT and associated RP elements shall be formatted as a parenthesis comment, following the RB element. Attribute GlyphOrientationVertical: Auto - Specifies a default orientation for text, depending on whether it is fullwidth (as wide as it is high). Attribute ListNumbering: None - No autonumbering; Lbl elements (if present) contain arbitrary text not subject to any numbering scheme. Attribute ListNumbering: Disc - Solid circular bullet. Attribute ListNumbering: Circle - Open circular bullet. Attribute ListNumbering: Square - Solid square bullet. Attribute ListNumbering: Decimal - Decimal arabic numerals (1-9, 10-99, ...). Attribute ListNumbering: UpperRoman - Uppercase roman numerals (I, II, III, IV, ...). Attribute ListNumbering: LowerRoman - Lowercase roman numerals (i, ii, iii, iv, ...). Attribute ListNumbering: UpperAlpha - Uppercase letters (A, B, C, ...). Attribute ListNumbering: LowerAlpha - Lowercase letters (a, b, c, ...). Attribute Role: rb - Radio button. Attribute Role: cb - Check box. Attribute Role: pb - Push button. Attribute Role: tv - Text-value field. Attribute checked: On - The state of a radio button or check box field. Attribute checked: Off - The state of a radio button or check box field. Attribute checked: Neutral - The state of a radio button or check box field. Attribute Scope: Row. Attribute Scope: Column. Attribute Scope: Both. Gets attribute name for attribute key. Attribute name Attribute key Attribute name Returns a string that represents the current object. String that represents the current object. Represents Standard Attribute Owners. Get Attribute Owner. Attribute Owner. Layout attribute owner. List attribute owner. PrintField attribute owner. Table attribute owner. XML-1.0.0 attribute owner. HTML-3.20 attribute owner. HTML-4.01 attribute owner. OEB-1.00 attribute owner. RTF-1.05 attribute owner. CSS-1.00 attribute owner. CSS-2.00 attribute owner. Performs an explicit conversion from to . The owner. The result of the conversion. Returns a string that represents the current object. String that represents the current object. Represents a base class for block-level structure elements in logical structure. Represents a base class for block-level text structure elements in logical structure. Gets object for current element. object for current element. Appends text content to current text element. Text content Represents Paragraph structure element in logical structure. Represents Header structure element in logical structure. Represents List structure element in logical structure. Represents a base class for children elements of the List in logical structure. Represents LI structure element in logical structure of the list. Represents Lbl structure element in logical structure of the list. Represents LBody structure element in logical structure of the list. Represents Table structure element in logical structure. Gets or sets the table background color. Gets or sets the table border. Gets or sets the table alignment. Gets or sets the styles of the border corners Gets or sets table vertial broken; Gets or sets the table column adjustment. Gets the column widths of the table. Gets default cell border. Gets or sets the default cell padding. Gets or sets the default cell text state. Gets or sets default column width. Gets or sets the table is broken - will be truncated for next page. Gets or sets border included in column widhts. Gets or sets the table left coordinate. Gets or sets the table top coordinate. Gets or sets the maximum columns count for table. Gets the first rows count repeated for several pages. Gets the style for repeating rows. Creates and added it to current table. Created structure element. Creates and added it to current table. Created structure element. Creates and added it to current table. Created structure element. Represents a base class for children elements of the Table in logical structure. Represents a base class for children elements of the Table Head, Body and Foot in logical structure. Creates and added it to current table. Created structure element. Represents THead structure element in logical structure of the table. Represents TBody structure element in logical structure of the table. Represents TFoot structure element in logical structure of the table. Represents TR structure element in logical structure of the table. Gets or sets the row background color. Gets or sets the row border. Gets default cell border. Gets height for row. Gets fixed row height - row may have fixed height. Gets fixed row is in new page - page with this property should be printed to next page Default false. Gets is row can be broken between two pages. Gets or sets default text state for row cells Gets or sets default margin for row cells. Gets or sets the vertical alignment. Creates and added it to current table. Created structure element. Creates and added it to current table. Created structure element. Represents a base class for table cell elements (TH and TD) in logical structure. Gets or sets the cell background color. Gets or sets the cell border. Gets or sets the cell have border. Gets or sets the padding. Gets or sets the cell alignment. Gets or sets the default cell text state. Gets or sets the cell's text word wrapped. Gets or sets the vertical alignment. Gets or sets the column span. Gets or sets the row span. Gets object for current element. object for current element. Appends text content to current text element. Text content Represents TH structure element in logical structure of the table. Represents TD structure element in logical structure of the table. The Aspose.Pdf.Tagged.LogicalStructure is a namespace for PDF Logical Structure classes. Represents a base class for element in logical structure. Get parent element. Parent element. Gets children collection of objects. Children collection of objects. Find Elements of a given type Type of Structure Element for search (Optional) Recursive Search (default false, search only from direct children) List of found Elements Append to collection of children. object to add. which has been added. Returns a string that represents the current object. String that represents the current object. Represents an ordered collection of elements. Gets the number of elements in the ElementList. Retrieves a element at the given index. The index into the list of elements. The with the specified index in the collection. If is greater than or equal to the number of elements in the list, this returns null. Gets an element at the given index. The index into the list of elements. The with the specified index in the collection. If index is greater than or equal to the number of elements in the list, this returns null. Gets an enumerator that iterates through the collection of elements. An enumerator used to iterate through the collection of elements. Represents a base class for grouping structure elements in logical structure. Represents Document structure element in logical structure. Represents Part structure element in logical structure. Represents Art structure element in logical structure. Represents Sect structure element in logical structure. Represents Div structure element in logical structure. Represents BlockQuote structure element in logical structure. Represents Caption structure element in logical structure. Represents TOC structure element in logical structure. Represents TOCI structure element in logical structure. Represents Index structure element in logical structure. Represents NonStruct structure element in logical structure. Represents Private structure element in logical structure. Represents a base class for illustration structure elements in logical structure. Appends image to current illustration element. Image source. (Optional) Image Resolution. Default: 300 DPI. Appends image to current illustration element. Image source. Image width. Image height. Represents Figure structure element in logical structure. Represents Formula structure element in logical structure. Represents Form structure element in logical structure. Represents a base class for inline-level structure elements in logical structure. Represents a base class for inline-level text structure elements in logical structure. Gets object for current element. object for current element. Appends text content to current text element. Text content. Represents a base class for annotation structure elements in logical structure. Gets or Sets the Alternate Descriptions for annotation. Text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form. Represents Span structure element in logical structure. Represents Quote structure element in logical structure. Represents Note structure element in logical structure. Represents Reference structure element in logical structure. Represents BibEntry structure element in logical structure. Represents Code structure element in logical structure. Represents Link structure element in logical structure. Gets or Sets Hyperlink for Link Element. Gets object for current element. object for current element. Appends text content to current text element. Text content. Represents Annot structure element in logical structure. Represents Ruby structure element in logical structure. Represents Warichu structure element in logical structure. Represents a base class for children elements of the Ruby in logical structure. Represents a base class for children elements of the Warichu in logical structure. Represents RB structure element in logical structure of the Ruby. Represents RT structure element in logical structure of the Ruby. Represents RP structure element in logical structure of the Ruby. Represents WT structure element in logical structure of the Warichu. Represents WP structure element in logical structure of the Warichu. Interface for presenting text structure elements. Gets object for text structure element. object for text structure element. Appends text content to current text element. Text content Represents marked-content reference object in logical structure. Gets image source for marked-content reference element. For just created . Is null in other cases. Image source for marked-content reference element. Gets text content for marked-content reference element. For just created object wich implement . Is null in other cases. Text content for marked-content reference element. Gets MCID of marked-content reference object. MCID of marked-content reference object. Returns a string that represents the current object. String that represents the current object. Represents object reference entity in logical structure. Returns a string that represents the current object. String that represents the current object. Represents StructTreeRoot object in logical structure. Represents attribute of structure element. Gets attribute key. Attribute Key. Gets Value Name. Value Name. Gets Value String. Value String. Gets Value Number. Value Number. Gets Value Name Array. Value Name Array. Gets Value Number Array. Value Number Array. Sets Value Name. Allowable Value Name. Sets Value String. Value String. Sets Value Number. Value Number. Sets Value Name Array. Array of allowable Value Names. Sets Value Color. Color. Sets Value Rectangle. Rectangle. Gets status of structure attribute value. True if value is set. Initializes a new instance of the StructureAttribute. Attribute Key Represents collection of attributes of structure elements. Return of structure element by standard attribute owner. Standard attribute owner. of structure element. Return null if not found. Create and return of structure element by standard attribute owner. Standard attribute owner. of structure element. Structure Attributes will be created if it needed. Represents attributes of structure element for standard attribute owners. Gets standard attribute owner. Standard attribute owner. Gets StructureAttribute by AttributeKey. AttributeKey. StructureAttribute Sets StructureAttribute into StructureAttributes. StructureAttribute. Represents a base class for structure elements in logical structure. Gets object. object. Gets object. object. Gets type of structure element. object of structure element. Gets the ID for structure element. ID of the structure element. Gets or sets the title for structure element. Title of the structure element. Gets or sets the language for structure element. Language of the structure element. Gets or sets the alternative text for structure element. Alternative text of the structure element. Gets or sets the expansion text for structure element. Expansion text of the structure element. Gets or sets the actual text for structure element. Actual text of the structure element. Change parent element for current structure element New parent structure element Generate ID for structure element. Sets ID for structure element. ID value for structure element Clear ID for structure element. Sets custom tag for structure element. Tag name Returns a string that represents the current object. String that represents the current object. Represents text state settings for Text Structure Elements and TaggedContent (ITextElement, ITaggedContent) Gets or sets the font of text. Can be null. Use null to inherit Font property from parent structure element. Gets or sets font size of the text. Can be null. Use null to inherit FontSize property from parent structure element. Gets or sets font style of the text. Can be null. Use null to inherit FontStyle property from parent structure element. Gets or sets foreground color of the text. Can be null. Use null to inherit ForegroundColor property from parent structure element. Gets or sets background color of the text. Can be null. Use null to inherit BackgroundColor property from parent structure element. Gets or sets underline for the text. Can be null. Use null to inherit Underline property from parent structure element. Gets or sets strikeout for the text. Can be null. Use null to inherit StrikeOut property from parent structure element. Gets or sets superscript of the text. Can be null. Use null to inherit Superscript property from parent structure element. Gets or sets subscript of the text. Can be null. Use null to inherit Subscript property from parent structure element. Gets or sets horizontal scaling of the text. Can be null. Use null to inherit HorizontalScaling property from parent structure element. Gets or sets line spacing of the text. Can be null. Use null to inherit LineSpacing property from parent structure element. Gets or sets character spacing of the text. Can be null. Use null to inherit CharacterSpacing property from parent structure element. Gets or sets word spacing of the text. Can be null. Use null to inherit WordSpacing property from parent structure element. Gets or sets margin for block structure element. Represents Categories of Standard Structure Types. Grouping elements group other elements into sequences or hierarchies but hold no content directly and have no direct effect on layout. Block-level structure elements (BLSEs) describe the overall layout of content on the page, proceeding in the block-progression direction. Inline-level structure elements (ILSEs) describe the layout of content within a BLSE, proceeding in the inline-progression direction. Illustration elements are compact sequences of content, in page content order, that are considered to be unitary objects with respect to page layout. An illustration can be treated as either a BLSE or an ILSE. Performs an explicit conversion from to . The name. The result of the conversion. Returns a string that represents the current object. String that represents the current object. Represents Standard Structure Types. (Document) A complete document. This is the root element of any structure tree containing multiple parts or multiple articles. (Part) A large-scale division of a document. This type of element is appropriate for grouping articles or sections. (Article) A relatively self-contained body of text constituting a single narrative or exposition. Articles should be disjoint; that is, they should not contain other articles as constituent elements. (Section) A container for grouping related content elements. (Division) A generic block-level element or group of elements. (Block quotation) A portion of text consisting of one or more paragraphs attributed to someone other than the author of the surrounding text. (Caption) A brief portion of text describing a table or figure. (Table of contents) A list made up of table of contents item entries (structure type TOCI) and/or other nested table of contents entries (TOC). A TOC entry that includes only TOCI entries represents a flat hierarchy. A TOC entry that includes other nested TOC entries (and possibly TOCI entries) represents a more complex hierarchy.Ideally, the hierarchy of a top level TOC entry reflects the structure of the main body of the document. (Table of contents item) An individual member of a table of contents. This entry’s children may be any of the following structure types: Lbl A label Reference A reference to the title and the page number NonStruct Non-structure elements for wrapping a leader artifact P Descriptive text TOC Table of content elements for hierarchical tables of content, as described for the TOC entry (Index) A sequence of entries containing identifying text accompanied by reference elements that point out occurrences of the specified text in the main body of a document. (Nonstructural element) A grouping element having no inherent structural significance; it serves solely for grouping purposes. This type of element differs from a division (structure type Div) in that it shall not be interpreted or exported to other document formats; however, its descendants shall be processed normally. (Private element) A grouping element containing private content belonging to the application producing it. The structural significance of this type of element is unspecified and shall be determined entirely by the conforming writer. Neither the Private element nor any of its descendants shall be interpreted or exported to other document formats. (Paragraph) A low-level division of text. (Heading) A label for a subdivision of a document's content. It should be the first child of the division that it heads. Level 1 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting. Level 2 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting. Level 3 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting. Level 4 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting. Level 5 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting. Level 6 Heading, for use in conforming writers that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting. (List) A sequence of items of like meaning and importance. Its immediate children should be an optional caption (structure type Caption) followed by one or more list items (structure type LI). (List item) An individual member of a list. Its children may be one or more labels, list bodies, or both (structure types Lbl or LBody). (Label) A name or number that distinguishes a given item from others in the same list or other group of like items. (List body) The descriptive content of a list item. In a dictionary list, for example, it contains the definition of the term. It may either contain the content directly or have other BLSEs, perhaps including nested lists, as children. (Table) A two-dimensional layout of rectangular data cells, possibly having a complex substructure. It contains either one or more table rows (structure type TR) as children; or an optional table head (structure type THead) followed by one or more table body elements (structure type TBody) and an optional table footer (structure type TFoot). In addition, a table may have a caption (structure type Caption) as its first or last child. (Table header row group; PDF 1.5) A group of rows that constitute the header of a table. If the table is split across multiple pages, these rows may be redrawn at the top of each table fragment (although there is only one THead element). (Table body row group; PDF 1.5) A group of rows that constitute the main body portion of a table. If the table is split across multiple pages, the body area may be broken apart on a row boundary. A table may have multiple TBody elements to allow for the drawing of a border or background for a set of rows. (Table footer row group; PDF 1.5) A group of rows that constitute the footer of a table. If the table is split across multiple pages, these rows may be redrawn at the bottom of each table fragment (although there is only one TFoot element.) (Table row) A row of headings or data in a table. It may contain table header cells and table data cells (structure types TH and TD). (Table header cell) A table cell containing header text describing one or more rows or columns of the table. (Table data cell) A table cell containing data that is part of the table's content. (Span) A generic inline portion of text having no particular inherent characteristics. It can be used, for example, to delimit a range of text with a given set of styling attributes. (Quotation) An inline portion of text attributed to someone other than the author of the surrounding text. The quoted text should be contained inline within a single paragraph. This differs from the block-level element BlockQuote, which consists of one or more complete paragraphs (or other elements presented as if they were complete paragraphs). (Note) An item of explanatory text, such as a footnote or an endnote, that is referred to from within the body of the document. It may have a label (structure type Lbl) as a child. The note may be included as a child of the structure element in the body text that refers to it, or it may be included elsewhere (such as in an endnotes section) and accessed by means of a reference (structure type Reference). Tagged PDF does not prescribe the placement of footnotes in the page content order. They may be either inline or at the end of the page, at the discretion of theconforming writer. (Reference) A citation to content elsewhere in the document. (Bibliography entry) A reference identifying the external source of some cited content. It may contain a label (structure type Lbl) as a child. Although a bibliography entry is likely to include component parts identifying the cited content's author, work, publisher, and so forth, no standard structure types are defined at this level of detail. (Code) A fragment of computer program text. (Link) An association between a portion of the ILSE's content and a corresponding link annotation or annotations. Its children should be one or more content items or child ILSEs and one or more object references identifying the associated link annotations. (Annotation; PDF 1.5) An association between a portion of the ILSE's content and a corresponding PDF annotation. Annot shall be used for all PDF annotations except link annotations and widget annotations. (Ruby; PDF 1.5) A side-note (annotation) written in a smaller text size and placed adjacent to the base text to which it refers. A Ruby element may also contain the RB, RT, and RP elements. (Ruby) The wrapper around the entire ruby assembly. It shall contain one RB element followed by either an RT element or a three-element group consisting of RP, RT, and RP. Ruby elements and their content elements shall not break across multiple lines. (Ruby base text) The full-size text to which the ruby annotation is applied. RB may contain text, other inline elements, or a mixture of both. It may have the RubyAlignattribute. (Ruby annotation text) The smaller-size text that shall be placed adjacent to the ruby base text. It may contain text, other inline elements, or a mixture of both. It may have the RubyAlign and RubyPosition attributes. (Ruby punctuation) Punctuation surrounding the ruby annotation text. It is used only when a ruby annotation cannot be properly formatted in a ruby style and instead is formatted as a normal comment, or when it is formatted as a warichu. It contains text (usually a single LEFT or RIGHT PARENTHESIS or similar bracketing character). (Warichu; PDF 1.5) A comment or annotation in a smaller text size and formatted onto two smaller lines within the height of the containing text line and placed following (inline) the base text to which it refers. A Warichu element may also contain the WT and WP elements. (Warichu) The wrapper around the entire warichu assembly. It may contain a three-element group consisting of WP, WT, and WP. Warichu elements (and their content elements) may wrap across multiple lines, according to the warichu breaking rules described in the Japanese Industrial Standard (JIS) X 4051-1995. (Warichu text) The smaller-size text of a warichu comment that is formatted into two lines and placed between surrounding WP elements. (Warichu punctuation) The punctuation that surrounds the WT text. It contains text (usually a single LEFT or RIGHT PARENTHESIS or similar bracketing character). According to JIS X 4051-1995, the parentheses surrounding a warichu may be converted to a SPACE (nominally 1/4 EM in width) at the discretion of the formatter. (Figure) An item of graphical content. Its placement may be specified with the Placement layout attribute. (Formula) A mathematical formula. This structure type is useful only for identifying an entire content element as a formula. No standard structure types are defined for identifying individual components within the formula. From a formatting standpoint, the formula shall be treated similarly to a figure (structure type Figure). (Form) A widget annotation representing an interactive form field. Gets tag name of . Tag name of . Gets category of Standard Structure Type. Category of Standard Structure Type. Performs an explicit conversion from to . The tag name. The result of the conversion. Returns a string that represents the current object. String that represents the current object.

The Aspose.Pdf.GroupProcessor namespace provides classes used to work text and fonts.

Represents factory for creating IPdfTypeExtractor objects. Conains creator of IPdfTypeExtractor object. Represents interface to interacting with extractor.

The Aspose.Pdf.GroupProcessor.Creators namespace provides classes used to create instances of GroupProcessor classes.

Represents an creator of IPdfTypeExtractor object. Creates IPdfTypeExtractor object. Path to a pdf document. Maximum size of content in bytes that can be kept in memory. Allows async initialization of resources. object of IPdfTypeExtractor Creates IPdfTypeExtractor object. Stream containing pdf document. Maximum size of content in bytes that can be kept in memory. Allows async initialization of resources. object of IPdfTypeExtractor Creates IPdfTypeExtractor object. Path to a pdf document. Document password. Maximum size of content in bytes that can be kept in memory. Allows async initialization of resources. object of IPdfTypeExtractor Creates IPdfTypeExtractor object. Stream containing pdf document. Document password. Maximum size of content in bytes that can be kept in memory. Allows async initialization of resources. object of IPdfTypeExtractor The exception that is thrown when a font is not found. Initializes a new instance of the class. The message. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The error message that explains the reason for the exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Defines different modes which can be used while extracting images from documents. Defines image extraction mode in which all images defined in resources for particular page are extracted. Defines image extraction mode in which only those images are extracted that are actually shown on a page. Used to specify the form presentation mode when printing or converting to image pdf documents. Specifies Production form presentation mode (used by default). Specifies Editor form presentation mode. The Editor mode is used by some products to display forms. In Editor mode some form elements are displayed as they are shown in form designer. Represents image device that helps to save pdf document pages into bmp. Initializes a new instance of the class with default resolution. Initializes a new instance of the class. Resolution for the result image file, see class. Initializes a new instance of the class with provided image dimensions and resolution. Image output width. Image output height. Resolution for the result image file, see class. Initializes a new instance of the class with provided page size and resolution. Page size of the output image. Resolution for the result image file, see class. Converts the page into bmp and saves it in the output stream. The page to convert. Output stream with bmp image. Initializes a new instance of the class with provided image dimensions, default resolution (=150). Image output width. Image output height. Initializes a new instance of the class with provided page size, default resolution (=150). Page size of the output image. Used to specify the parameter value passed to a Tiff image device. Default color depth. 32 bit depth is used by default. 8 bits per pixel. Equal 4 bits per pixel. Equal 1 bit per pixel. Equal Used to specify the parameter value passed to a Tiff image device. Specifies the LZW compression scheme. Can be passed to the Tiff encoder as a parameter that belongs to the Compression category. Specifies the CCITT4 compression scheme. Can be passed to the CCITT4 encoder as a parameter that belongs to the Compression category. Specifies the CCITT3 compression scheme. Can be passed to the CCITT3 encoder as a parameter that belongs to the Compression category. Specifies the RLE compression scheme. Can be passed to the RLE encoder as a parameter that belongs to the Compression category. Specifies no compression. Can be passed to the Tiff encoder as a parameter that belongs to the compression category. The Aspose.Pdf.Devices namespace provides classes which are used for representing document as image(s) or a plain text. So document can be sent on to textual or various graphic devices which means we want to get it textual or graphic representation. Abstract class for all types of devices. Device is used to represent pdf document in some format. For example, document page can be represented as image or text. Document which is processed by this device instance. Abstract class for all devices which is used to process the whole pdf document. Each device represents some operation on the document, e.g. we can convert pdf document into another format. The document to process. Defines the page from which to start processing. Defines the last page to process. Defines stream where the results of processing are stored. Processes the whole document and saves results into stream. The document to process. Defines stream where the results of processing are stored. Processes the whole document and saves results into file. The document to process. Defines file where the results of processing are stored. Processes certain pages of the document and saves results into file. The document to process. The first page to start processing. The last page of processing. Defines file where the results of processing are stored. Do Bradley binarization for input stream. The input image stream. The output image stream. The threshold value between 0.0 and 1.0. Represents image device that helps to save pdf document pages into gif. Initializes a new instance of the class with default resolution. Initializes a new instance of the class. Resolution for the result image file, see class. Initializes a new instance of the class with provided image dimensions and resolution. Image output width. Image output height. Resolution for the result image file, see class. Initializes a new instance of the class with provided page size and resolution. Page size of the output image. Resolution for the result image file, see class. Converts the page into gif and saves it in the output stream. The page to convert. Output stream with gif image. Initializes a new instance of the class with provided image dimensions, default resolution (=150). Image output width. Image output height. Initializes a new instance of the class with provided page size, default resolution (=150). Page size of the output image. An abstract class for image devices. Gets or sets the page coordinate type (Media/Crop boxes). CropBox value is used by default. Gets or sets rendering options. Gets or sets form presentation mode. Gets image resolution. Gets image output width. Gets image output height. Abstract initializer for descendants, set resolution to 150x150. Abstract initializer for descendants. Resolution for the result image file, see class. Initializes a new instance of the class with provided image dimensions and default resolution (=150). Image output width. Image output height. Initializes a new instance of the class with provided image dimensions and default resolution (=150). Page size of the output image. Initializes a new instance of the class with provided image dimensions and resolution. Image output width. Image output height. Resolution for the result image file, see class. Initializes a new instance of the class with provided image dimensions and resolution. Page size of the output image. Resolution for the result image file, see class. Represents image device that helps to save pdf document pages into jpeg. Initializes a new instance of the class with default resolution and maximum quality. Initializes a new instance of the class. Resolution for the result image file, see class. Initializes a new instance of the class. Specifies the level of compression for an image. The range of useful values for the quality is from 0 to 100. The lower the number specified, the higher the compression and therefore the lower the quality of the image. Zero would give you the lowest quality image and 100 the highest. Initializes a new instance of the class. Resolution for the result image file, see class. Specifies the level of compression for an image. The range of useful values for the quality is from 0 to 100. The lower the number specified, the higher the compression and therefore the lower the quality of the image. Zero would give you the lowest quality image and 100 the highest. Initializes a new instance of the class with provided image dimensions, default resolution (=150) and maximum quality. Image output width. Image output height. Initializes a new instance of the class with provided page size, default resolution (=150) and maximum quality. Page size of the output image. Initializes a new instance of the class with provided image dimensions, resolution and maximum quality. Image output width. Image output height. Resolution for the result image file, see class. Initializes a new instance of the class with provided page size, resolution and maximum quality. Page size of the output image. Resolution for the result image file, see class. Initializes a new instance of the class with provided image dimensions, resolution and quality. Image output width. Image output height. Resolution for the result image file, see class. Specifies the level of compression for an image. The range of useful values for the quality is from 0 to 100. The lower the number specified, the higher the compression and therefore the lower the quality of the image. Zero would give you the lowest quality image and 100 the highest. Initializes a new instance of the class with provided page size, resolution and quality. Page size of the output image. Resolution for the result image file, see class. Specifies the level of compression for an image. The range of useful values for the quality is from 0 to 100. The lower the number specified, the higher the compression and therefore the lower the quality of the image. Zero would give you the lowest quality image and 100 the highest. Converts the page into jpeg and saves it in the output stream. The page to convert. Output stream with jpeg image. This class represents margins of an image. Gets or sets the left. The left. Gets or sets the right. The right. Gets or sets the top. The top. Gets or sets the bottom. The bottom. Initializes a new instance of the class. The left coordinate. The right coordinate. The top coordinate. The bottom coordinate. Initializes a new instance of the class. Abstract class for all devices which is used to process certain page the pdf document. Perfoms some operation on the given page, e.g. converts page into graphic image. The page to process. This stream contains the results of processing. Perfoms some operation on the given page and saves results into the file. The page to process. This file contains the results of processing. Represents image device that helps to save pdf document pages into png. Initializes a new instance of the class with default resolution. Initializes a new instance of the class. Resolution for the result image file, see class. Initializes a new instance of the class with provided image dimensions and resolution. Image output width. Image output height. Resolution for the result image file, see class. Initializes a new instance of the class with provided page size and resolution. Page size of the output image. Resolution for the result image file, see class. Converts the page into png and saves it in the output stream. The page to convert. Output stream with png image. Initializes a new instance of the class with provided image dimensions, default resolution (=150). Image output width. Image output height. Initializes a new instance of the class with provided page size, default resolution (=150). Page size of the output image. Represents class for holding image resolution. Gets or sets horizontal image resolution. Gets or sets vertical image resolution. Initializes a new instance of the class. Value which represents the horizontal and vertical resolution. Initializes a new instance of the class. Horizontal resolution. Vertical resolution. This enum represents shape type for the extracted images. Original image shape. Landscape Shape. Portrait Shape. Represents class for converting pdf document pages into text. The object is basically used to extract text from pdf page. The example demonstrates how to extract text on the first PDF document page. Document doc = new Document(inFile); string extractedText; using (MemoryStream ms = new MemoryStream()) { // create text device TextDevice device = new TextDevice(); // convert the page and save text to the stream device.Process(doc.Pages[1], ms); // use the extracted text ms.Close(); extractedText = Encoding.Unicode.GetString(ms.ToArray()); } Gets or sets text extraction options. The example demonstrates how to extracted text in raw order. Document doc = new Document(inFile); string extractedText; // create text device TextDevice device = new TextDevice(new TextExtractionOptions(TextExtractionOptions.TextFormattingMode.Raw)); // convert the page and save text to the stream device.Process(doc.Pages[1], outFile); // use the extracted text extractedText = File.ReadAllText(outFile, Encoding.Unicode); Gets or sets encoding of extracted text. The example demonstrates how to represent extracted text in UTF-8 encoding. Document doc = new Document(inFile); string extractedText; // create text device TextDevice device = new TextDevice(Encoding.UTF8); // convert the page and save text to the stream device.Process(doc.Pages[1], outFile); // use the extracted text extractedText = File.ReadAllText(outFile, Encoding.UTF8); Convert page and save it as text stream. The example demonstrates how to extract text on the first PDF document page. Document doc = new Document(inFile); string extractedText; using (MemoryStream ms = new MemoryStream()) { // create text device TextDevice device = new TextDevice(); // convert the page and save text to the stream device.Process(doc.Pages[1], ms); // use the extracted text ms.Close(); extractedText = Encoding.Unicode.GetString(ms.ToArray()); } The page to convert. Result stream. Initializes a new instance of the with text extraction options. Text extraction options. Initializes a new instance of the with the Raw text formatting mode and Unicode text encoding. Initializes a new instance of the for the specified encoding. Encoding of extracted text Initializes a new instance of the for the specified encoding with text extraction options. Text extraction options. Encoding of extracted text. This class helps to save pdf document page by page into the one tiff image. Gets or sets rendering options. Gets or sets form presentation mode. Gets settings for mapping pdf into tiff image. Gets image resolution. Initializes a new instance of the class. Resolution for the result image file. Initializes a new instance of the class. Resolution for the output image. Tiff settings, see class. Initializes a new instance of the class. Resolution for the output image. Tiff settings, see class. External converter Initializes a new instance of the class. Tiff settings, see class. Initializes a new instance of the class. Tiff settings, see class. External converter Initializes a new instance of the class with default settings. Converts certain document pages into tiff and save it in the output stream. The document to convert. Defines page number from which converting will start. Defines page number which will end the converting. Output stream with tiff image. Initializes a new instance of the class. Image output width. Image output height. Resolution for the output image. Tiff settings, see class. Initializes a new instance of the class. Image output width. Image output height. Resolution for the output image. Tiff settings, see class. External converter Initializes a new instance of the class. Page size of the output image. Resolution for the output image. Tiff settings, see class. Initializes a new instance of the class. Page size of the output image. Resolution for the output image. Tiff settings, see class. External converter Initializes a new instance of the class. Image output width. Image output height. Resolution for the output image. Initializes a new instance of the class. Page size of the output image. Resolution for the output image. Initializes a new instance of the class. Image output width. Image output height. Tiff settings, see class. Initializes a new instance of the class. Image output width. Image output height. Tiff settings, see class. External converter Initializes a new instance of the class. Page size of the output image. Tiff settings, see class. External converter Initializes a new instance of the class. Page size of the output image. Tiff settings, see class. Initializes a new instance of the class. Image output width. Image output height. Initializes a new instance of the class. Page size of the output image. Gets image output width. Gets image output height. This class represents settings for importing pdf to Tiff. Gets the margins. Gets or sets a value indicating whether to skip blank pages. Default value is false true if need to skip blank pages; otherwise, false. Gets or sets the type of the compression. Default value is CompressionType.LZW The type of the compression. Gets or sets the color depth. Default value is ColorDepth.Default The color depth. Gets or sets the type of the shape. Default value is ShapeType.None The type of the shape. Initializes a new instance of the class. Initializes a new instance of the class. Type of the shape. Initializes a new instance of the class. Type of the compression. Initializes a new instance of the class. The color depth. Initializes a new instance of the class. The margins. Initializes a new instance of the class. Type of the compression. The color depth. The margins. Initializes a new instance of the class. Type of the compression. The color depth. The margins. if set to true need to skip blank pages. Initializes a new instance of the class. Type of the compression. The color depth. The margins. if set to true need to skip blank pages. Type of the shape. Initializes a new instance of the class. if set to true [skip blank pages]. Get or sets a value boundary of the transformation of colors in white and black. This parameter can be applied with EncoderValue.CompressionCCITT4, EncoderValue.CompressionCCITT3, EncoderValue.CompressionRle or ColorDepth.Format1bpp == 1 Value of brightness should be in the range from 0 to 1. By default value is equal to 0.33f Get or sets the page coordinate type (Media/Crop boxes). CropBox value is used by default. Represents image device that helps to save pdf document pages into emf. Initializes a new instance of the class with default resolution of raster image written to emf. Initializes a new instance of the class. Resolution for the raster image written to emf, see class. Initializes a new instance of the class with provided image dimensions, and default resolution for the raster image written to emf (=150) Image output width. Image output height. Initializes a new instance of the class with provided page size, and default resolution for the raster image written to emf (=150) Page size of the output image. Initializes a new instance of the class with provided image dimensions, and resolution for the raster image written to emf. Image output width. Image output height. Resolution for the for the raster image written to emf, see class. Initializes a new instance of the class with provided page size, and resolution for the raster image written to emf. Page size of the output image. Resolution for the for the raster image written to emf, see class. Converts the page into emf and saves it in the output stream. The page to convert. Output stream with emf image. Represents a abstract base object can be added to the page(doc.Paragraphs.Add()). Gets or sets a vertical alignment of paragraph Gets or sets a horizontal alignment of paragraph Gets or sets a outer margin for paragraph (for pdf generation) Gets or sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) Gets or sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation) Gets or sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) Gets or sets a paragraph is inline. Default is false.(for pdf generation) Gets or sets the fragment hyperlink(for pdf generator). Gets or sets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page. Clones this instance. Virtual method. Always return null. Enumerates the border corner styles for border. None border style. Round border style. This class represents border for graphics elements. Gets or sets a object that indicates left of the border. Gets or sets a object that indicates right of the border. Gets or sets a object that indicates the top border. Gets or sets a object that indicates bottom of the border. Gets or sets a rouded border radius Initializes a new instance of the class. Indicates the border sides info. For example: (int)(BorderSide.Left | BorderSide.Top). The border color. Initializes a new instance of the class. Initializes a new instance of the class. Indicates the border sides info. For example: (BorderSide.Left | BorderSide.Top). Initializes a new instance of the class. Indicates the border sides info. For example: (BorderSide.Left | BorderSide.Top). The width of the border. Initializes a new instance of the class. Indicates the border sides info. For example: (BorderSide.Left | BorderSide.Top). The width of the border. The border color. Initializes a new instance of the class. Indicates the border sides info. For example: (BorderSide.Left | BorderSide.Top). The border info. Clones a new BorderInfo object. The new BorderInfo object. Enumerates the border sides. No border. Left border. Top border. Right border. Bottom border. All sides borders.It has the same meaning when useing "Box" and will be replaced by "Box" one year later. So, please use "Box" if possible. Four sides borders. Represents a FloatingBox in a Pdf document. FloatingBox is custom positioned. Initializes a new instance of the class with specified width and height. The width of the box. The height of the box. Initializes a new instance of the class. Gets or sets a column info Gets or sets a float value that indicates the width of the floating box. Gets or sets a float value that indicates the height of the floating box. Gets or sets a bool value that indicates whether the paragraph need to be repeated on next page. Default value is false.The attribute is only valid when the paragraph itself and the object its ReferenceParagraphID referred to both are included in RepeatingRows. Gets or sets a collection that indicates all paragraphs in the cell. Gets or sets a object that indicates the border info of the floating box. Gets or sets a object that indicates the background color of the floating box. Gets or sets background image for page (for generator only). Gets or sets a object that indicates the padding of the floating box. Gets or sets the table left coordinate. Gets or sets the table top coordinate. Clones a new object. Paragraphs in the floating box are not cloned. The new object. Class represents header or footer pdf page. Gets or sets the end note paragraphs. Gets or sets the margin info. Clones a new object. The new object. Represents heading. Initializes a new instance of the Cell class. The headings level. Gets the page that contains this heading. Gets the top Y of this headings. Gets the heading start number. Gets the heading should be numered automatically. Gets the heading should be in toc list. Gets the destination page. Gets the level. Gets or sets style. Gets or sets user label. Clone the heading. The cloned object Clone the heading with all segments. The cloned object Represents abstract hyperlink. Represents image. Gets or sets the image file. Gets or sets the image width. Gets or sets the image height. Gets or sets the image file type. Gets or sets the image scale. Gets or sets the image stream. Gets or sets a bool value that indicates whether the image use resolution during generation Gets or sets a bool value that indicates whether the image is forced to be black-and-white. If TIFF image of CCITT subformat is used, this property must be set to true. Gets or sets a string value that indicates the title of the image. Clone the image. The cloned object Represents format of the table of contents. Gets or sets TOC line dash. Gets or sets a list level margin Gets or sets a subsequent lines indent Gets or sets a list level text state This class represents a margin for different objects. Initializes a new instance of the class. Constructor of Rectangle. Left margin. Bottom margin Right margin. Top margin. Gets or sets a float value that indicates the left margin. Gets or sets a float value that indicates the right margin. Gets or sets a float value that indicates the top margin. Gets or sets a float value that indicates the bottom margin. Clones a new object. The new object. Represents the page information. Clone page info. The cloned object Gets or sets page margin for any page except first. Gets or sets default font. Gets or sets page height. Gets or sets page pure height without margins. Gets or sets is page landscaped. Gets or sets page margin. Gets or sets page width. This class represents paragraph collection. Add paragraph to collection. The paragraph. Remove paragraphs range. The first paragraph index. The paragraphs count. The paragraphs collection Remove paragraphs range. The first paragraph index. The paragraphs count. Remove paragraph from collection. The paragraph. Insert paragraph to collection. The index for paragraph. The paragraph. Get paragraphs count. Clear paragraphs. Inserts the elements of a collection into the list at the specified index. Gets or sets paragraph from or to collection. The paragraph index. Gets the enumerator. Clones a new object. The new object. Represents table of contents info. Gets or sets column info. Gets or sets format array for table of contents. Gets or sets format array length Gets or sets table of contents title. Gets or sets is count or passed toc pages. Gets or sets TOC line dash. Initializes a new instance of the class. Represents web hyperlink object. Initializes a new instance of the class. Initializes a new instance of the class. Web url for hyperlink. Gets or sets the web url. Represents page layer. Initializes a new instance of the class. The layer id The layer name Gets the layer name. Gets the layer id. Gets the layer content. Save options for export to Xml format Class represents the collection of all destinations (a name tree mapping name strings to destinations (see 12.3.2.3, "Named Destinations") and (see 7.7.4, "Name Dictionary")) in the pdf document. Gets the number of elements contained in the collection. Gets a value indicating whether the collection is read-only. Gets the destination object by index. The index of destination to get. Destination. Returns the page number of destination by the name. The name of destination. Determines whether cached version of collection is used or not. The page number if destination was found; otherwise, -1. Returns the explicit destination by the name. The name of destination. Determines whether cached version of collection is used or not. The ExplicitDestination object for destination found; otherwise, null. Returns the enumerator. The enumerator. Returns the index of destination in collection. The value to find. The index of destination in collection. Determines whether this instance contains the object. The value. true if [contains] [the specified value]; otherwise, false. Adds the specified item. Collection is read-only. Always throws NotSupportedException exception. The item. Collection is read-only. Always throws NotSupportedException exception. Removes the specified item. Collection is read-only. Always throws NotSupportedException exception. The item. Enumeration of supported page numbering style for PageLabel class. Arabic decimal numbers. Uppercase roman numbers (I, II, III...). Lowercase roman numbers (i, ii, iii...). Uppercase latin letters (A, B, C...). Lowercase latin letters (a, b, c...). No numbering. This class describes page actions An action that shall be performed when the page is opened. An action that shall be performed when the page is closed. Describes page coordinate type. The MediaBox is used to specify the width and height of the page. For the average user, this probably equals the actual page size. The MediaBox is the largest page box in a PDF. The other page boxes can equal the size of the MediaBox but they cannot be larger. The CropBox defines the region to which the page contents are to be clipped. Acrobat uses this size for screen display and printing. Class representing Page Label range. Gets or sets starting value of the page numbering range. Gets or sets numbering style. Gets or sets page number prefix. Constructor for page label. Class represeingting page label collection. Gets page label by page index (page index is started from 0). Index of the page. Page label for specified page index or null if page label does not exist. Update label for given page index (page index is started from 0). Index of page to change lable of the page. New label of the page. Remove label by page index (page index is started from 0). Index of page where label must be deleted. true if operation was executed successfully. Gets page indexes in collection. Array of integers which contains indexes of the pages. Class representing size of page in PDF document. Gets or sets page width. Gets or sets page height. Gets page orientation. Returns true of this is landscape orientation and false if this is portrait. A0 size (1189x840 mm). A1 size (840x594 mm). A2 size (594x420 mm). A3 size (420x297 mm). A4 size (297x210 mm). A5 size (210x148 mm). A6 size (148x105 mm). B5 size (250x176 mm). Letter size (279x216 mm). Legal size (356x216 mm). Ledger size (432x279 mm). 11x17 inches format. Constructor for PageSize. Width of the page. Height of the page. Represents an object containing graphics compositing parameters of current graphics state. Initializes new instance of the object. Blend mode of current graphics state. Initializes new instance of the object. Blend mode of current graphics state. The image filter type. Initializes new instance of the object. Blend mode of current graphics state. The image filter type. The adding mask flag. Gets blend mode of current graphics state. Gets the image filter type. Gets the mask flag. The blend modes enumeration. Normal blend mode. Multiply blend mode. Screen blend mode. Overlay blend mode. Darken blend mode. Lighten blend mode. ColorDodge blend mode. ColorBurn blend mode. HardLight blend mode. SoftLight blend mode. Difference blend mode. Exclusion blend mode. Hue blend mode. Saturation blend mode. Color blend mode. Luminosity blend mode. Compatible blend mode. The exception that is thrown when an operation with form type is not valid. Initializes a new instance of the class. Initializes a new instance of the class. The message. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The error message that explains the reason for the exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. The exception that is thrown when a Cgm file is invalid. Initializes a new instance of the class. Initializes a new instance of the class. The message. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The error message that explains the reason for the exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. This class provides information about current product build. Assembly Version Product Name File Version Represents class for color value which can be expressed in different color space. Represents empty color. Gets the alpha component value Gets color value. Gets color space that the color represents. Extracts color components from the string. String value with color component values. Color object. Converts to string. String representation of the Color object. Converts color into rgb. Rgb color value. Gets valid pdf Color object from System.Drawing.Color value. System.Drawing.Color value. Color object with each component value in [0..1] range. Gets valid pdf Color object from RGB color components. The Red color component (value 0 - 255). The Green color component (value 0 - 255). The Blue color component (value 0 - 255). Color object with each component value in [0..255] range. Gets valid pdf Color object from RGB color components. The alpha component value (value 0 - 255). The Red color component (value 0 - 255). The Green color component (value 0 - 255). The Blue color component (value 0 - 255). Color object with each component value in [0..255] range. Gets valid pdf Color object from RGB color components. The Red color component (value 0 - 1). The Green color component (value 0 - 1). The Blue color component (value 0 - 1). Color object with each component value in [0..1] range. Gets valid pdf Color object from Gray color component. The Gray color component (value 0 - 1). Color object with each component value in [0..1] range. Gets valid pdf Color object from RGB color components. The Cyan color component (value 0 - 1). The Magenta color component (value 0 - 1). The Yellow color component (value 0 - 1). The Key color component (value 0 - 1). Color object with each component value in [0..1] range. Returns true if two Colors are equal. Object to compare. True in case Color objects are equal. Returns true if two Colors are equal. First Color object. Second Color object. True in case Color objects are equal. Returns true if two Colors are not equal. First Color object. Second Color object. True in case Color objects are not equal. Represents a object that indicates the pattern colorspace. Gets a system-defined color. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFF0F8FF. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFAEBD7. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF00FFFF. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF7FFFD4. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFF0FFFF. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFF5F5DC. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFE4C4. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF000000. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFEBCD. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF0000FF. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF8A2BE2. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFA52A2A. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFDEB887. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF5F9EA0. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF7FFF00. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFD2691E. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFF7F50. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF6495ED. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFF8DC. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFDC143C. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF00FFFF. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF00008B. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF008B8B. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFB8860B. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFA9A9A9. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF006400. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFBDB76B. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF8B008B. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF556B2F. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFF8C00. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF9932CC. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF8B0000. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFE9967A. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF8FBC8F. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF483D8B. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF2F4F4F. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF00CED1. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF9400D3. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFF1493. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF00BFFF. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF696969. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF1E90FF. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFB22222. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFFAF0. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF228B22. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFF00FF. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFDCDCDC. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFF8F8FF. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFD700. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFDAA520. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF808080. A strcture representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF008000. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFADFF2F. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFF0FFF0. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFF69B4. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFCD5C5C. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF4B0082. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFFFF0. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFF0E68C. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFE6E6FA. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFF0F5. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF7CFC00. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFFACD. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFADD8E6. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFF08080. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFE0FFFF. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFAFAD2. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF90EE90. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFD3D3D3. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFB6C1. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFA07A. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF20B2AA. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF87CEFA. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF778899. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFB0C4DE. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFFFE0. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF00FF00. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF32CD32. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFAF0E6. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFF00FF. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF800000. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF66CDAA. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF0000CD. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFBA55D3. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF9370DB. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF3CB371. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF7B68EE. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF00FA9A. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF48D1CC. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFC71585. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF191970. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFF5FFFA. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFE4E1. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFE4B5. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFDEAD. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF000080. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFDF5E6. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF808000. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF6B8E23. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFA500. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFF4500. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFDA70D6. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFEEE8AA. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF98FB98. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFAFEEEE. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFDB7093. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFEFD5. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFDAB9. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFCD853F. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFC0CB. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFDDA0DD. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFB0E0E6. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF800080. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFF0000. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFBC8F8F. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF4169E1. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF8B4513. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFA8072. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFF4A460. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF2E8B57. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFF5EE. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFA0522D. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFC0C0C0. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF87CEEB. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF6A5ACD. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF708090. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFFAFA. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF00FF7F. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF4682B4. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFD2B48C. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF008080. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFD8BFD8. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFF6347. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF40E0D0. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFEE82EE. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFF5DEB3. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFFFFF. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFF5F5F5. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FFFFFF00. A representing a system-defined color. Gets a system-defined color that has an ARGB value of #FF9ACD32. A representing a system-defined color. Represents enumeration of the Html document types. The XHtml Document Type. The HTML5 Document Type. Save options for export to Html format This handler can be used to handle conversion progress events f.e. it can be used to show progress bar or messages about current amount of processed pages, example of handler's code that shows progress on console is : public static void ConvertWithShowingProgress() { (new Aspose.Pdf.License()).SetLicense(@"F:\_Sources\Aspose_5\trunk\testdata\License\Aspose.Total.lic"); Document doc = new Document(@"F:\ExternalTestsData\Booklet.pdf"); HtmlSaveOptions saveOptions = new HtmlSaveOptions(); saveOptions.CustomProgressHandler = new HtmlSaveOptions.ConversionProgressEventHandler(ShowProgressOnConsole); doc.Save(@"F:\ExternalTestsData\Booklet.doc", saveOptions); Console.ReadLine(); } public static void ShowProgressOnConsole(HtmlSaveOptions.ProgressEventHandlerInfo eventInfo) { switch (eventInfo.EventType) { case HtmlSaveOptions.ProgressEventType.TotalProgress: Console.WriteLine(string.Format("{0} - Conversion progress : {1}% .", DateTime.Now.ToLongTimeString(), eventInfo.Value.ToString())); break; case HtmlSaveOptions.ProgressEventType.SourcePageAnalized: Console.WriteLine(string.Format("{0} - Source page {1} of {2} analyzed.", DateTime.Now.ToLongTimeString(), eventInfo.Value.ToString(), eventInfo.MaxValue.ToString())); break; case HtmlSaveOptions.ProgressEventType.ResultPageCreated: Console.WriteLine(string.Format("{0} - Result page's {1} of {2} layout created.", DateTime.Now.ToLongTimeString(), eventInfo.Value.ToString(), eventInfo.MaxValue.ToString())); break; case HtmlSaveOptions.ProgressEventType.ResultPageSaved: Console.WriteLine(string.Format("{0} - Result page {1} of {2} exported.", DateTime.Now.ToLongTimeString(), eventInfo.Value.ToString(), eventInfo.MaxValue.ToString())); break; default: break; } } Enumerates modes that can be used for saving of fonts referenced in saved PDF All referenced fonts will be saved and referenced as WOFF-fonts All referenced fonts will be saved and referenced as TTF-fonts All referenced fonts will be saved and referenced as EOT-fonts All referenced fonts will be saved (and referenced in CSS) as 3 independent files : EOT, TTH,WOFF. It increases size of output data but makes output sutable for overhelming majority of web brawsers All referenced fonts will not be saved. Indicates that full font will be saved, supports only True Type Fonts. By default SaveFullFont = false and the converter saves the subset of the initial font needed to display the text of the document. This enum describes possible antialiasing measures during conversion no special antialiasing processing in use. This is an optimal option for overhelming majority of documents and it does not require additional time during conversion In such case converter tries to detect places with ajacent background graphical elements and correct result HTML in relevant way. This option allows enhance result of export for documents that contain backgrounds built from several ajacent graphical elements (for such kind of documents PDF renderers , f.e. Acrobat Reader, usually try smooth boundaries of elements during rendering. With this option converter imitates that behaviour of PDF-renderers. This option allows enhance layout of result of export for some specific documents (that use such compound backgrounds), but it requires additional time for processng (usually about 10-15% of additional time). So usage of this mode in general case is not recommended. This parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML Pdf can contain transparent texts that can be selected to clipboard (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML Pdf can contain texts that are shadowed by another elements (f.e. by images) but can be selected to clipboard in Acrobat Reader (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML to mimic behaviour of Acrobat Reader (othervise such texts are usually saved as hidden, not available for copying to clipboard) Defines font saving mode that will be used during saving of PDF to desirable format This class represents set of data that related to custom saving of CSS during conversion of PDF to HTML format Set by converter. During conversion several CSS-files are created . This properties shows ordinal of saved CSS-file during conversion. It can be used in logic of custom code to decide how to process or where to save CSS content Set by converter. Supposed file name that goes from converter to code of custom method Can be used in custom code to decide how to process or where to save content Set by converter. Represents binary content of saved CSS If SplitToPages property of HtmlSaveOptions, then several HTML-files (one HTML file per converted page) are created during conversion of PDF to HTML. This class represents set of data that related to custom saving of one HTML-page's markup during conversion of PDF to HTML Set by converter. Supposed file name that goes from converter to code of custom method Can be used in custom code to decide how to process or where to save content Set by converter. Represents saved HTML as stream Set by converter. If SplitToPages property set, then several HTML-files(one HTML file per converted page) are created during conversion created . This property tells to custom code from what page of original PDF was created saved HTML-markup. If original page number for some reason is inknown or SplitOnPages=false,then this property allways contains '0' that signals that converter cannot supply exact original PDF's page number for supplied HTML-markup file. Set by converter. If set SplitToPages property, then several HTML-files(one HTML file per converted page) are created during conversion created . This property contains ordinal of saved HTML page's file. The property can be used in logic of custom code to decide how to process or where to save HTML page and If splitting on pages turned off this value always contains '1' since in such case only one big HTML page is generated for whole source document. Should be set in custom code when necessary. This flag must be set to "true" in custom code if for some reasons supplied html-markup should be processed not with custom code but with converter's code itself in standard for converter way. So, setting if this flag in custom code means that custom code did not process referenced file and converter must handle it itself Represents set of data that related to request from converter to custom code aimed to get desirable URL (or URL template)of subject CSS Should be set by custom code if it cannot or should not define URL that will be used in generated HTML for referencing of that CSS. If it's 'true', then CSS file will be saved in standard way in standard place. This attribute represents set of settings used for drawing border (if any) in result HTML document around area that represent source PDF page. In essence it concerns of showing of page's paper edges, not page border referenced in PDF page itself. This attribute represents set of extra page margin (if any) in result HTML document around area that represent source PDF page. It enumerates possible modes of positioning of letters in words in result HTML It's default method. It uses EM-units and special alhorithm of compensation of rounding errors It's preferable for usage in IE10.0 and more fresh versions and gives better scaling of captions when scaling is necessary It allows to get sometimes more precise results in old IE browser versions Sets mode of positioning of letters in words in result HTML This class represents set of data that related to external resource image file's saving during PDF to HTML conversion. Represents type of saved image referenced in HTML. Set by converter and can be used in custom code to decide what should be done Saved image can pertain to HTML itself or can be extracted. from SVG embedded to HTML. This property can tell to custom code what's that type of parent of processed image. It set by converter and can be used in custom code to decide what should be done with that image (f.e. custom code can decide where to save image or how it must be referenced in parent's content). Tells to custom code to what page of original PDF document pertains saved image Since it's possible that will be saved not all pages of original document, this value tells us about host page number in original PDF. If original page number for some reason is inknown, it allways return '1' Tells to custom code to what page of generated set of HTML page-files pertains saved image. If splitting on pages turned off this value always contains '1' since in such case Only one HTML page is generated. To this property You can assign delegate created from custom method that implements processing of external resource(Font or Image) that was extracted from PDF and must be saved as external resource during conversion of PDF to HTML. In such case processing (like saving in stream or disk) can be done in that custom code and that custom code must return path(or any another string without quotemarks) that will be afterwards incorporated into generated HTML instead of original supposed path to that image resource. In such case All the necessary actions for saving of image must be undertaken in code of supplied method, because saving of result in code of converter will be not in use . If processing for this or that file for some reason must be done by converter's code itself, not in custom code, please set in custom code flag 'CustomProcessingCancelled' of 'resourceSavingInfo' parameter's variable It signals to converter that all the necessary steps for processing of that resource must be done in converter itself as if there was no any external custom code . represents set of data for saving of resource must return URL to saved resource that will be used during generation of HTML Result of conversion can contain one or several HTML-pages ( that also can reference external files like images or fonts) You can assign to this property delegate created from custom method that implements processing of got HTML-page(HTML itself) that was created during conversion. In such case processing (like saving in stream or disk) can be done in that custom code . In such case All the necessary actions for saving of HTML page's markup must be undertaken in code of supplied method, because saving of result in code of converter will be not in use. If processing for this or that case for some reason must be done by converter's code itself, not in custom code, please set in custom code flag 'CustomProcessingCancelled' of 'htmlSavingInfo' parameter's variable : it signals to converter that all the necessary steps for processing of that resource must be done in converter itself in same way as if there was no any external custom saving code . represents data that can be used for saving or processing of supplied HTML page You can assign to this property custom strategy that implements processing or/and saving of one CSS's part that was created during conversion of PDF to HTML . In such case processing (like saving to stream or disk) must be done in that custom code represents set of data that can be used for saving of supplied CSS part You can assign to this property delegate created from custom method that implements creation of URL of CSS referenced in generated HTML document. F.e. if You want to make CSS referenced in HTML f.e. as "otherPage.ASPX?CssID=zjjkklj" Then such custom strategy must return "otherPage.ASPX?CssID=zjjkklj" represents set of data that can be used for generation of CSS' URL must return string that represents CSS's URL or URL's template List of PDF embedded font names that not be embedded in HTML. enumerates possible types of image files that can be saved as external resources during Pdf to Html conversion Jpeg format Png format Bmp format Gif format Tiff format Svg format Zipped Svg format Unknown - means that converter cannot detect type of content itself Enumerates possible types of image's parents Image can pertain to HTML page or to SVG parent image Image pertains to HTML page itself Image was embedded in SVG image This field can contain saving strategy that must be used (if present) during conversion for customized handling of created referenced resource files (like images and fonts) related to nodes of saved HTML. That strategy must process resources and return string that represents desirable URL of saved resource in generated HTML. This field can contain saving strategy that must be used (if present) during conversion of Pdf to Html for handling of saving of CSSes related to created HTML document as whole or to it's pages(if several HTMLpages are generated) If You want handle CSS file in some specific way, that just please create relevant method and assign delegate created from it to this property. Result of conversion can contain one or several HTML-pages You can assign to this property delegate created from custom method that implements processing of one HTML-page(to be accurately - markup-HTML, without exteranl linked files if any) that was created during conversion. In such case processing (like saving of paage's HTML in stream or disk) can be done in that custom code . In such case all the necessary actions for saving of HTML page must be undertaken in code of supplied method, because saving of result in code of converter will be not in use . If processing for this or that case for some reason must be done by converter's code itself, not in custom code, please set in custom code flag 'CustomProcessingCancelled' of 'htmlSavingInfo' parameter's variable : it will signal to converter that all the necessary steps for processing of that resource must be done in converter itself in same way as if there was no any external custom code for procesing . This field can contain custom method that returns URL (Or URL template if multipage generation is on - see details below) of subject CSS as it should be put in generated result HTML. F.e. if You want converter put some specific URL instead of standard CSS file name into generated CSS, then You should just create and put into this property method that generates desirable URL. If flag 'SplitCssIntoPages' set, then this custom strategy (if any) must return not exact URL of CSS but rather template string that (after substitution of placeholder with page number with string.Format() function inside converter) can be resolved into URL for this or that page's CSS' URL. Examples of expected return string in such case are: 'SomeTargetLocation-page_{0}.css','../PartHandlers/GetCss.aspx?DocumentId=45654&CssPage={0}') Initializes a new instance of the class. Initializes a new instance of the class. The . Initializes a new instance of the class. if set to true HTML is created as fixed layout. Initializes a new instance of the class. The . if set to true HTML is created as fixed layout. Gets or sets the . The . Gets or sets the flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving The . Gets or sets path to directory to which must be saved only SVG-images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG files(if any) wil be saved together with other image-files (near to output file) or in special folder for images (if it specified in SpecialImagesFolderIfAny option). It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file. Gets or sets path to directory to which must be saved any images if they are encountered during saving of document as HTML. If parameter is empty or null then image files(if any) wil be saved together with other files linked to HTML It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file. When multipage-mode selected(i.e 'SplitIntoPages' is 'true'), then this attribute defines whether should be created separate CSS-file for each result HTML page. By default this attribute is false, so, will be created one big common CSS for all created pages. Summary size of all CSSes generated in this mode(one CSS per page) usually much more than size of one big CSS file, because in former case CSS classes are duplicates in such case in several CSS files for each page. So, this setting is worse to be used only when You are interested in future processing of each HTML page independently, and therefore size of CSS of each one page taken apart is the most critical issue. When PDFtoHTML converter generates result CSSs, CSS class names (something like ".stl_01 {}" ... ".stl_NN {}) are generated and used in result CSS. This property allows forcibly set class name prefix For example, if You want that all class names start with 'my_prefix_' (i.e. were something like 'my_prefix_1' ... 'my_prefix_NNN' ) , then just assign 'my_prefix_' to this property before conversion. If this property will stay untouched(i.e. null will be leaved as value ), then converter will generate class names itself (it wil be something like ".stl_01 {}" ... ".stl_NN {}") Gets or sets the flag that indicates whether each page of source document will be converted into it's own target HTML document, i.e whether result HTML will be splitted into several HTML-pages. Converted PDF can contain raster images(.png, *.jpeg etc.) This enum defines methods of how raster images can be handled during conversion of PDF to HTML for each distinct raster file will be generated wrapper SVG image, and raster image will be embedded as Base64 encoded strings into that SVG image distinct raster images will be put apart as PNG files but will be referenced through wrapping SVG images, i.e. will be generated one PNG file and one SVG for each raster image, and each of such SVGs will contain links to relevant PNG file Will be generated one big PNG background file for each result page. Raster images will be embedded into that file and rendered as regions of that image. No external PNG files for each image will be generated, only one PNG file per page will be present in conversion result set of files. Sometimes specific reqirments to created HTML are present. This enum defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments. Default mode any specific requirments are absent. Will be generated output that will contain all parts of HTML without any special additional processing. will be stripped away all HTML content that is outside HTML's body, i.e. will be left only content that is inside tags This enum enumerates possible modes of embedding of files referenced in HTML It allows to control whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities Enforces embed all referenced files(Css,Images,Fonts) into generated HTML markup (i.e. into HTML itself) This approach generates one HTML file, but total size of output becames bigger(because Base64 encoding of binaries is in use) and not all browsers (especially legacy) successfully process binaries embedded into HTML. But it allows get HTML that contains whole result, without any additional files. Enforces put apart all referenced files except CSS (Images and Fonts) I.e. CSS will be embedded into result HTML , and all other referenced files(Images and Fonts) will be processed as external parts It generates HTML that is sutable for wide set of browsers Enforces put apart referenced files(Css,Images,Fonts) This approach generates set of files, but total size of output becames smaller(because no Base64 encoding of binaries is in use) Also such approach generates HTML that is sutable for wide set of browsers It defines whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities Sometimes specific reqirments to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments. Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML Defines whether in created HTML will be removed top and bottom empty area without any content (if any). With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1...[NumberOfPagesInConvertedDocument]) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF. If this list is null (as it is by default), all pages will be converted. If any page number of this list will go out of range of present pages(1-[amountOfPagesInDocument]) exception will be thrown. Gets or sets a value indicating whether that HTML is created as fixed layout. true if [fixed layout]; otherwise, false. Gets or sets resolution for image rendering. Resolution Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used. Font name Defines batch size if batched conversion is applicable to source and destination formats pair. Font sources of pre-saved fonts. Fonts may be saved preliminarily for cache purpose and then passed into Html conversion process. For example it may be useful in document splitting scenario and processing document pages in multiple threads with single set of fonts. This enumeration defines rules which tune encoding logic Leave encoding logic "as is" - in accordance with PDF specification ToUnicode is a special mechanism which helps to decode input codes to unicode symbols. According to specification it must be used first of all mechanisms to get unicode symbols for specific input code. But some documents has non-standard fonts and to convert these documents correctly it may be necessary to decrease ToUnicode priority and use another mechanisms to decode input codes. Defines encoding special rule to tune PDF decoding for current document If attribute 'SplitOnPages=false', than whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such way that flow of areas that represent PDF pages in result HTML will depend on screen resolution of viewer. Suppose width of screen on viewer side is big enough to put 2 or more pages one near other in horizontal direction. If this flag set to true, then this opportunity will be used (as many pages will be shown in horizontal direction one near another as it possible, then next horizontal group of pages will be shown under first one ). Otherwise pages will flow in such way: next page goes always under previous one. PDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text's underlining and put this info into CSS instead of drawing of underlining graphically If attribute 'SplitOnPages=false', than whole HTML representing all input PDF pages wont be not split into different HTML pages, but will be put into one big result HTML file. But each source PDF page will be represented with it's own rectangle area in HTML (if necessary that areas can be bordered to show page paper edges with special attribute 'PageBorderIfAny'. This parameter defines width of margin that will be forcibly left around that output HTML-areas that represent pages of source PDF document.In essence it defines guaranteed interval between HTML-representations of PDF "paper" pages such mode of conversion. If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects. This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers. This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true. This attribute specifies a sequential grouping of glyphs and words into strings For example tags and words has different order in converted HTML and you want them to match. This parameter will be applied to document only when the value of FixedLayout attribute is true. This attribute specifies full width paragraph text for Flow mode, FixedLayout = false If attribute RenderTextAsImage set to true, the text from the source becomes an image in HTML. May be useful to make text unselectable or HTML text is not rendered properly. Load options for TXT to PDF conversion. This enum describes possible progress event types that can occure during conversion means that occured event informs about total progress of conversion means that occured event informs about end of analysis of one of pages before conversion means that occured event informs about creation of one result page before phisical export means that occured event informs about finished saving of one result page Defines conversion options related to pipeline configuration. Specifies the size of a portion of pages to pass from node to node. Defines conversion options related to a set of pages to convert. Specifies the array of numbers of pages to convert. This class represents saving options for saving that uses unified conversion way (with unified internal document model) Sometimes PDFs contain background images (of pages or table cells) constructed from several same tiling background images put one near other. In such case renderers of target formats (f.e MsWord for DOCS format) sometimes generates visible boundaries beetween parts of background images, cause their techniques of image edge smoothing (anti-aliasing) is different from Acrobat Reader. If it looks like exported document contains such visible boundaries between parts of same background images, please try use this setting to get rid of that unwanted effect. ATTENTION! This optimization of quality usually essentially slows down conversion, so, please, use this option only when it's really necessary. This class represents information about conversion progress that can be used in external applicatuion to show conversion progress to end user Type of progress event that occured current value of progress value maximum possible value of progress value Represents method that usually supplied by calling side and handles progress events that comes from converter. Usually such suplied customer's handler can be used to show total conversion progress on console or in progress bar. represents information about occured progress event This atrribute turned on functionality for extracting image or text for PDF documents with OCR sublayer. true text will be extracted in result document; otherwise, false. Specifies import format. Computer Graphics Metafile format. ImportOptions type hold level of abstraction on individual import options. Constructor Import format. Import format. Import option for import from Computer Graphics Metafile(CGM) format. Gets or sets output page size for import. Default page size - A4 300dpi 2480 X 3508. Text direction. Left to right direction. Right to left direction. The Aspose.Pdf is a root namespace for all classes of Aspose.Pdf library which are either directly in it like Document or indirectly through several subnamespaces. Class representing PDF document Collection of JavaScript of document level. Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise. Gets or sets the page info.(for generator only) The page info. Gets or sets flag to manage signature fields sanitization. Enabled by default. Gets the is document pdfa compliant. Gets the is document pdfua compliant. Gets or sets the is document pdfa compliant. Collection of Named Destination in the document. Gets the collection of destinations. Obsolete. Please use NamedDestinations. Gets PDF format Property which declares that document must embed all standard Type1 fonts which has flag IsEmbedded set into true. All PDF fonts can be embedded into document simply via setting of flag IsEmbedded into true, but PDF standard Type1 fonts is an exception from this rule. Standard Type1 font embedding requires much time, so to embed these fonts it's necessary not only set flag IsEmbedded into true for specified font but also set an additiona flag on document's level - EmbedStandardFonts = true; This property can be set only one time for all fonts. By default false. Represents the method that will handle FontSubstitution event. original font new font Occurs when font replaces another font in document. Holds functionality to tune fonts Subsets all fonts in document strategy Returns all fonts from document fonts IDocumentFontUtilities instance Remove pdfa compliance from the document Remove pdfUa compliance from the document Set Title for Pdf Document Document's title Gets collection of document. Gets a version of Pdf from Pdf file header. Gets or sets action performed at document opening. Example demonstrates how to get CenterWindow flag: Document document = new Document("sample.pdf"); IAppointment value = document.OpenAction; Gets or sets flag specifying whether toolbar should be hidden when document is active. Example demonstrates how to get HideToolBar flag: Document document = new Document("sample.pdf"); bool value = document.HideToolBar; Gets or sets flag specifying whether menu bar should be hidden when document is active. Example demonstrates how to get HideMenubar flag: Document document = new Document("sample.pdf"); bool value = document.HideMenubar; Gets or sets flag specifying whether user interface elements should be hidden when document is active. Example demonstrates how to get HideWindowUI flag: Document document = new Document("sample.pdf"); bool value = document.HideWindowUI; Gets or sets flag specifying whether document window must be resized to fit the first displayed page. Example demonstrates how to get FitWindow flag: Document document = new Document("sample.pdf"); bool value = document.FitWindow; Gets or sets flag specifying whether position of the document's window will be centerd on the screen. Example demonstrates how to get CenterWindow flag: Document document = new Document("sample.pdf"); bool value = document.CenterWindow; Gets or sets flag specifying whether document's window title bar should display document title. Example demonstrates how to get DisplayDocTitle flag: Document document = new Document("sample.pdf"); bool value = document.DisplayDocTitle; Gets or sets collection of document pages. Note that pages are numbered from 1 in collection. Example below demonstrates how to operate with the document pages: How to obtain number of pages and how to obtain rectangle of starting page of the document. Aspose.Pdf.Document document = new Aspose.Pdf.Document("sample.pdf"); Aspose.Pdf.PageCollection pages = document.Pages; System.Console.WriteLine("Document contains " + pages.Count); Page page = pages[1]; Rectangle rect = page.Rect; Gets document outlines. Gets document actions. This property is instance of DocumentActions class which allows to get/set BeforClosing, BeforSaving, etc. actions. This example demonstrates how to obtain after open action of the document: Aspose.Pdf.Document document = new Aspose.Pdf.Document("d:\\work\\aspose\\aspose.pdf.kit.net.new\\trunk\\testdata\\Aspose.Pdf\\PdfWithOpenAction.pdf"); Aspose.Pdf.Annotations.DocumentActionCollection actions = document.Actions; Aspose.Pdf.Annotations.PdfAction afterSavingAction = actions.AfterSaving; Gets Acro Form of the document. Gets collection of files embedded to document. Gets or sets reading order of text: L2R (left to right) or R2L (right to left). Gets or sets page mode, specifying how document should be displayed when opened. Gets or sets page mode, specifying how to display the document on exiting full-screen mode. Gets or sets page layout which shall be used when the document is opened. Gets or sets print duplex mode handling option to use when printing the file from the print dialog. Name of the PDF file that caused this document Gets document info. Document metadata. (A PDF document may include general information, such as the document's title, author, and creation and modification dates. Such global information about the document (as opposed to its content or structure) is called metadata and is intended to assist in cataloguing and searching for documents in external databases.) Gets logical structure of the document. Initialize new Document instance from the stream. Stream with pdf document. Initialize new Document instance from the stream. Stream with pdf document. User or owner password. if set to true inner stream is closed before exit; otherwise, is not. Initialize new Document instance from the stream. Stream with pdf document. if set to true inner stream is closed before exit; otherwise, is not. Just init Document using . The same as . The name of the pdf document file. Process paragraphs for generator. Stores document into stream. Stream where document shell be stored. Initialize new Document instance from the stream. Input stream object, corresponding pdf is password protected. User or owner password. Saves document into the specified file. Path to file where the document will be stored. Exports all document annotations to XFDF file XFDF file name Export all document annotations into stream. Stream where store XFDF. Sends the whole document to the document device for processing. Document device which is used to process the document. Output stream contains the results of the document processing with given device. Sends the certain pages of the document to the document device for processing. Document device which is used to process the document. The first page for processing. The last page for processing. Output stream contains the results of the document pages processing with given device. Sends the whole document to the document device for processing. Document device which is used to process the document. Output file name with the results of processing. Sends the whole document to the document device for processing. Document device which is used to process the document. The first page for processing. The last page for processing. Output file name with the results of processing. Removes metadata from the document. Imports annotations from XFDF file to document. XFDF file name Imports annotations from stream to document. Stream contains XFDF data. Validate document into the specified file. Path to file where the comments will be stored. The pdf format. The operation result Convert document and save errors into the specified file. Path to file where the comments will be stored. The pdf format. Action for objects that can not be converted Action for image masked objects The operation result Convert document and save errors into the specified file. Stream where the comments will be stored. The pdf format. Action for objects that can not be converted Action for image masked objects The operation result Convert document and save errors into the specified file. Path to file where the comments will be stored. The pdf format. Action for objects that can not be converted The operation result Convert document using specified conversion options set of options for convert PDF document The operation result Convert page to PNG for DSR, OMR , OCR Validate document into the specified file. Stream where the comments will be stored. The pdf format. The operation result Validate document into the specified file. set of options for convert PDF document The operation result The call back procedure for hocr recognize. The hocr image. The hocr text Convert document and save errors into the specified file. Action for objects that can not be converted The operation result Convert document and save errors into the specified stream. Stream where the comments will be stored. Pdf format. Action for objects that can not be converted The operation result Initializes empty document. Opens an existing document from a file providing necessary converting options to get pdf document. Input file to convert into pdf document. Represents properties for converting into pdf document. Converts source file in source format into destination file in destination format. The source file name. The source file format. The destination file name. The destination file format. Converts stream in source format into destination file in destination format. The source stream. The source stream format. The destination file name. The destination file format. Converts source file in source format into stream in destination format. The source file name. The source file format. The destination stream. The destination stream format. Converts stream in source format into stream in destination format. The source stream. The source stream format. The destination stream. The destination file format. Opens an existing document from a stream providing necessary converting to get pdf document. Input stream to convert into pdf document. Represents properties for converting into pdf document. Removes all fields from the document and place their values instead. Removes all fields from the document and place their values instead. Settings for flattening process. Gets security settings if document is encrypted. If document is not encrypted then corresponding exception will be raised in .net 1.1 or CryptoAlgorithm will be null for other .net versions. Encrypts the document. Call then Save to get encrypted version of the document. User password. Owner password. Document permissions, see for details. Cryptographic algorithm, see for details. Support for revision 6 (Extension 8). Encrypts the document. Call then Save to get encrypted version of the document. User password. Owner password. Document permissions, see for details. Cryptographic algorithm, see for details. Encrypts the document. Call then Save to get encrypted version of the document. User password. Owner password. Document permissions, see for details. Cryptographic algorithm, see for details. Support for revision 6 (Extension 8). Changes document passwords. This action can be done only using owner password. Owner password. New user password. New owner password. Initializes new instance of the class for working with encrypted document. Document file name. User or owner password. Initializes new instance of the class for working with encrypted document. Document file name. User or owner password. if set to true inner stream is closed before exit; otherwise, is not. Gets or sets a value indicating whether document is linearized. Decrypts the document. Call then Save to obtain decrypted version of the document. Gets permissions of the document. Gets encrypted status of the document. True if document is encrypted. Linearize document in order to - open the first page as quickly as possible; - display next page or follow by link to the next page as quickly as possible; - display the page incrementally as it arrives when data for a page is delivered over a slow channel (display the most useful data first); - permit user interaction, such as following a link, to be performed even before the entire page has been received and displayed. Invoking this method doesn't actually saves the document. On the contrary the document only is prepared to have optimized structure, call then Save to get optimized document. Save document incrementally (i.e. using incremental update technque). In order to save document incremetally we should open the document file for writing. Therefore Document must be initialized with writable stream like in the next code snippet: Document doc = new Document(new FileStream("document.pdf", FileMode.Open, FileAccess.ReadWrite)); // make some changes and save the document incrementally doc.Save(); Saves the document with a new name along with a file format. Path to file where the document will be stored. Format options. Saves the document with a new name along with a file format. when is passed to a method. Save a document to the html stream is not supported. Please use method save to the file. Stream where the document will be stored. Format options. Saves the document with a new name setting its save options. Path to file where the document will be stored. Save options. Saves the document to a stream with a save options. when is passed to a method. Save a document to the html stream is not supported. Please use method save to the file. Stream where the document will be stored. Save options. Gets the ID. Closes all resources used by this document. Gets or sets the background color of the document. Optimize resources in the document: 1. Resources which are not used on the document pages are removed; 2. Equal resources are joined into one object; 3. Unused objects are deleted. Optimize resources in the document according to defined optimization strategy. Optimization strategy. Gets or sets optimization flag. When pages are added to document, equal resource streams in resultant file are merged into one PDF object if this flag set. This allows to decrease resultant file size but may cause slower execution and larger memory requirements. Default value: false. Allows to merge page contents to optimize docuement size. If used then differnet but duplicated pages may reference to the same content object. Please note that this mode may cause side effects like changing page content when other page is changed. Class which describes document optimization algorithm. Instance of this class may be used as parameter of OptimizeResources() method. Creates optimization strategy will all options activated. OptimizationOptions object. Gets or sets flag of ignoring errors in source files. When pages from source document copied into destination document, copying process is stopped with exception if some objects in source files are corrupted when this flag is false. example: dest.Pages.Add(src.Pages); If this flag is set to true then corrupted objects will be replaced with empty values. By default: true. Returns item value from catalog dictionary. The key of item. Item value - if key was successfully found; otherwise, null. Gets page labels in the document. Clears memory Save document to XML. The document model xml file Gets a object with specified ID in the document. The object id. The object with specified id. Null if the id is not found. Bind xml to document The xml file Repairs broken document. Bind xml/xsl to document The xml file. The xsl file if XSLT is used. Bind xml/xsl to document The xml stream. The xsl stream if XSLT is used. Bind xml/xsl to document The xml stream. The xsl stream if XSLT is used. The xml reader settings. Bind xml to document The xml stream. Get XMP metadata from document. Stream where metadata will be stored. Set XMP metadata of document. Stream which contains XMP metadata. Get or sets flag which enables document partially be unloaded from memory. This allow to decrease memory usage but may have negative effect on perfomance. Validates document. If true found issues will be repaired. Gets access to TaggedPdf content. The example demonstrates how to use tagged content for creating new document with header, paragraphs and images. // Create new document Document document = new Document(); // Get the tagged content ITaggedContent taggedContent = document.TaggedContent; // Set language for document taggedContent.SetLanguage("en-US"); // Set title for PDF document taggedContent.SetTitle("Example document"); // Creating and adding Section SectElement sect = taggedContent.CreateSectElement(); taggedContent.RootElement.AppendChild(sect); // Create Header HeaderElement h1 = taggedContent.CreateHeaderElement(1); h1.SetText("The Header"); sect.AppendChild(h1); // Create paragraph ParagraphElement p = taggedContent.CreateParagraphElement(); p.SetTag("Paragraph"); p.SetText("The text of paragraph."); sect.AppendChild(p); // Create illustration IllustrationElement figure1 = taggedContent.CreateFigureElement(); sect.AppendChild(figure1); figure1.AlternativeText = "Figure 1"; figure1.Title = "Image 1"; figure1.SetTag("Fig"); figure1.SetImage("path/of/image.jpg"); // Save document document.Save("example.pdf"); Represents meta information of PDF document. Gets or sets document title. Gets or sets document creator. Gets or sets document author. Gets or sets the subject of the document. Gets or set the keywords of the document. Gets or sets the document producer. Gets or sets the date of document creation. Time zone of creation date. Time zone of modification date. Gets or sets the date of document modification. Gets or sets the trapped flag. Initialize DocumentInfo instance. The info of this document will be used for initialization. Clears the document info. Adds an element with the specified key and value into the collection. The key of the element to add. The value of the element to add. The value can be null. Removes the element with the specified key from the collection. The key of the element to remove. Gets or sets the value associated with the specified key. The key whose value to get or set. Clears custom data only, leaves all other predefined values (Title, Author, etc.). Determines if the key is predefined (Title, Author, etc.), not custom. Selected key True in case the key is predefined. Class represents transformation matrix. Gets data of Matrix as array. A member of the transformation matrix. B member of the transformation matrix. C member of the transformation matrix. D member of the transformation matrix. E member of the transformation matrix. F member of the transformation matrix. Constructor creates stanrard 1 to 1 matrix: [ A B C D E F ] = [ 1, 0, 0, 1, 0, 0] Matrix m = new Matrix(); Constructor accepts a matrix with following array representation: [ A B C D E F ] Matrix data array. double[] c = new double[] { 1, 0, 0, 1, 10, 20 }; Matrix m = new Matrix(c); Constructor accepts a matrix with following array representation: [ A B C D E F ] Matrix data array. Elements of the matrix. Constructor accepts a matrix to create a copy Matrix object. Returns text reporesentation of the matrix. String representation for the matrix Compares matrix agains other object. Object to compare. Returns true is other object is Matrix and all matrix member are equal to correspondim members of the matrix Creates matrix for given rotation angle. Rotation angle in radians. Transformation matrix. Matrix m = Matrix.Rotation(Math.PI / 2); Creates matrix for given rotation. Rotation. Valid values are: None, on90, on180, on270 Creates matrix for given rotation angle. Skew x angle in radians. Skew y angle in radians. Transformation matrix. Matrix m = Matrix.Skew(Math.PI / 2, Math.PI / 2); Transaltes rotation into angle (degrees) Rotation value. double angle = Matrix.GetAngle(Rotation.on90); Matrix m = Matrix.Rotation(angle); Angle value. Multiplies the matrix by other matrix. Multiplier matrix. Result of multiplication. Matrix a = new Matrix(new double[] { 1, 0, 0, 1, 10, 20 }); Matrix b = new Matrix(new double[] { 0, -1, 1, 0, 0, 0 } ); Matrix c= a.Multiply(b); Adds matrix to other matrix. Matrix to be added. Result of matrix add. Transforms point using this matrix. Point which will be transformed. Transformation result. Aspose.Pdf.DOM.Matrix m = new Aspose.Pdf.DOM.Matrix(new double[] { 1, 0, 0, 1, 10, 20 } ); Aspose.Pdf.Rectangle r = new Aspose.Pdf.Rectangle(0, 0, 100, 100); Aspose.Pdf.Rectangle r1 = m.Transform(r); Transformes rectangle. If angle is not 90 * N degrees then bounding rectangle is returned. Rectangle to be transformed. Transformed rectangle. Matrix m = new Matrix(new double[] { 1, 0, 0, 1, 10, 20 } ); Rectangle r = new Rectangle(0, 0, 100, 100); Rectangle r1 = m.Transform(r1); Initializes transformation matrix with specified coefficients. A matrix value. B matrix value. C matrix value. D matrix value. E matrix value. F matrix value. Matrix m = new Matrix(1, 0, 0, 1, 3, 3); Calculates reverse matrix. Reverse matrix. Matrix m = Matrix.Rotation(Math.PI / 2); Matrix m1 = m.Reverse(); Hash-code for object. Hash-code. Class descibes used components of the document page. Dont use any components. Document outline visible. Thumbnail images visible. FullScreenFull-screen mode, with no menu bar, window controls, or any other window visible. Optional content group panel visible. Attachments panel visible. Class representing embedded files collection. Gets a value indicating whether access to this collection is synchronized (thread safe). Gets an object that can be used to synchronize access to this collection. Gets number of embedded files in collection. Copies array of FileSpecification object into colleciton. Array of objects which will be copied. Starting index from which copying will be started. Returns colleciton enumerator. Enumerator of colleciton. Adds embedded file specification into collection. FileSpecification which should be added into colleciton. Adds file to embedded files with the specified key. Key in the embedded files. File specification. Deletes file from the collection by its key in the collection. Returns list of file attachment keys. Returns embedded file by its name. Name of the file. Delete embedded file by name. Name of the embedded file which should be deleted. Remove all embedded files from document. Gets embedded file by its index. Index of embedded file. Numbering is started from 1. Retreived embedded file specification Gets embedded file by its name. Embedded file name. Retreived embedded file specification. Defines an embedded file parameter dictionary that shall contain additional file-specific information. The size of the uncompressed embedded file, in bytes. The date and time when the embedded file was created. The date and time when the embedded file was last modified. A 16-byte string that is the checksum of the bytes of the uncompressed embedded file. The checksum is calculated by applying the standard MD5 message-digest algorithm to the bytes of the embedded file stream. Constructor for FileParams class. File specification. Class representing embedded file. Gets or sets encoding format. Possible values: Zip - file is compressed with ZIP, None - file is not compressed. If true, contents of the file will be included in the file specification. Gets encrypted payload. Gets or sets text associated with the file specification. Associated file Relationship. Gets contents of file as stream. Contents is not loaded into memory which allows to decrease memory usage. But this stream does not support positioning and Length property. If you need this features please use Contents property instead. Gets or sets contents file. This property returns data loaded in memory which may cause Out of memory exception for large data. To decrease memory usage please use StreamContents. Gets file paramteres. Gets subtype of the embedded file Gets or sets file specification name. Gets or sets file specification unicode name. Constructor for FileSpecification File path. Constructor for file specification. Stream containing data file. File specification. Constructor for FileSpecification. File path. File description. Constructor for FileSpecification. Stream to be used in the document. A file specification string. File description. Constructor for FileSpecification. File path. The annotation. Create new empty file specification. Gets or sets name of the file system. Gets application-specific parameter. Parameter name. Sets application-specific parameter. Parameter name. New parameter value. Describes horizontal alignment. No alignment. Align to left. Center alignment. Align to right. Justify alignment. Text will be aligned on both left and right margins. Similar to 'Justify' alignment, except that the very last line will only be left-aligned in 'Justify' mode, while in 'FullJustify' mode all lines will be left- and right-aligned. Represents file identifier structure. Document doc = new Document("example.pdf"); string original = doc.Id.Original; string modified = doc.Id.Modified; Permanent identifier based on the contents of the document at the time it was originally created. Changing identifier based on the document's contents at the time it was last updated. Reresents graphic stamp. Gets image stream used for stamping. Gets or sets image width. Setting this property allos to scal image horizontally. Gets or sets image height. Setting this image allows to scale image vertically. Gets or sets quality of image stamp in percent. Valid values are 0..100%. Initializes a new instance of the class. Stream which contains image data. Adds graphic stamp on the page. Page for stamping. Creates image stamp by image in the specified file. Name of the file which contains image. Defines Visitor for visiting different pdf operators. Visit/select f operator. Fill path operator (nonzero winding number rule). Visit/select F operator. Fill path operator (nonzero winding number rule). Visit/select operator f*. Fill path operator (even-odd rule). Visit/select G operator. Set gray level operator (for stroking operations). Visit/select g operator. Set gray level operator (for nonstroking operations). Visit/select gs operator. Set graphics state operator. Visit/select h operator. Close subpath operator. Visit/select i operator. Set flatness tolerance operator. Visit/select ID operator. Begin inline image data operator. Visit/select ri operator. Set color rendering intent operator. Visit/select J operator. Set line cap style operator. Visit/select M operator. Set miter limit operator. Visit/select MP operator. Define marked-content point operator. Visit/select n operator. End path operator (without filling or stroking). Visit/select q operator. Save graphics state operator. Visit/select Q operator. Restore graphics state operator. Visit/select re operator. Append rectangle to path operator. Visit/select RG operator. Set RGB color operator (for stroking operations). Visit/select rg operator. Set RGB color operator (for nonstroking operations). Visit/select K operator. Set CMYK color operator (for stroking operations). Visit/select k operator. Set CMYK color operator (for nonstroking operations). Visit/select l operator. Append straight line segment to path operator. Visit/select m operator. Begin new subpath operator. Visit/select Tw operator. Set word spacing operator. Visit/select s operator. Close and stroke path operator. Visit/select TD operator. Move text position and set leading operator. Visit/select Tf operator. Set text font and size operator. Visit/select Tj operator. Show text operator. Visit/select TJ operator. Show text operator (allowing individual glyph positioning). Visit/select TL operator. Set text leading operator. Visit/select Tm operator. Set text matrix and text line matrix operator. Visit/select Tr operator. Set text rendering mode operator. Visit/select Ts operator. Set text rise operator. Visit/select S operator. Stroke path operator. Visit/select SC operator. Set color operator (for stroking operations). Visit/select sc operator. Set color operator (for nonstroking operations). Visit/select SCN operator. Set color operator (for stroking operations, ICCBasedand special colour spaces). Visit/select scn operator. Set color operator (for nonstroking operations, ICCBased and special colour spaces). Visit/select sh operator. Paint area defined by shading pattern operator. Visit/select T* operator. Move to start of next text line operator. Visit/select Tc operator. Set character spacing operator. Visit/select Td operator. Move text position operator. Visit/select y operator. Append curved segment to path operator (final point replicated). Visit/select W* operator. Set clipping path operator (even-odd rule). Visit/select Tz operator. Set horizontal text scaling operator. Visit/select v operator. Append curved segment to path operator (initial point replicated). Visit/select W operator. Set clipping path operator (nonzero winding number rule). Visit/select w operator. Set line width operator. Visit/select j operator. Set line join style operator. Visit/select EX operator. End compatibility section operator. Visit/select ET operator. End text object operator. Visit/select EMC operator. End marked-content sequence operator. Visit/select EI operator. End inline image object operator. Visit/select DP operator. Define marked-content point operator (with property list). Visit/select Do operator. Invoke named XObject operator. Visit/select d operator. Set line dash pattern operator. Visit/select d0 operator. Set glyph width in Type 3 font operator. Visit/select d1 operator. Set glyph width and bounding box in Type 3 font operator. Visit/select CS operator. Set color space operator (for stroking operations). Visit/select cs operator. Set color space operator (for nonstroking operations). Visit/select cm operator. Concatenate matrix to current transformation matrix operator. Visit/select c operator. Append curved segment to path operator (three control points). Visit/select BX operator. Begin compatibility section operator. Visit/select BT operator. Begin text object operator. Visit/select BMC operator. Begin marked-content sequence operator. Visit/select BI operator. Begin inline image object operator. Visit/select BDC operator. Begin marked-content sequence operator (with property list). Visit/select B operator. Fill and stroke path operator (nonzero winding number rule). Visit/select b operator. Close, fill, and stroke path operator (nonzero winding number rule). Visit/select B* operator. Fill and stroke path operator (even-odd rule). Visit/select b* operator. Close, fill, and stroke path operator (even-odd rule). Visit/select ' operator. Move to next line and show text operator. Visit/select '' operator. Set word and character spacing, move to next line, and show text operator. Visit/select any text operator operator. General text operator which is used to select the set of corresponding pdf operators. Provides methods to license the component. License number was added as embedded resource. Licenses the component.

Tries to find the license in the following locations:

1. Explicit path.

2. The folder that contains the Aspose component assembly.

3. The folder that contains the client's calling assembly.

4. The folder that contains the entry (startup) assembly.

5. An embedded resource in the client's calling assembly.

Note:On the .NET Compact Framework, tries to find the license only in these locations:

1. Explicit path.

2. An embedded resource in the client's calling assembly.

Can be a full or short file name or name of an embedded resource. Use an empty string to switch to evaluation mode.
Licenses the component. A stream that contains the license.

Use this method to load a license from a stream.

Provides access to XMP metadata stream. Registers namespace URI. The value of prefix. The value of namespace URI. Registers namespace URI. The value of prefix. The value of namespace URI. The value of schema description. Returns namespace URI by prefix. The value of prefix. The value of namespace URI. Returns prefix by namespace URI. Namespace URI. The value of prefix. Adds value to metadata. The key to add. Value which will be added. Adds value to metadata. The key to add. Value which will be added. Adds pdf extension to metadata. The prefix of extension. Value which will be added. Clears metadata. Checks does key is contained in metadata. The key of entry to find. True if key is contained in the metadata. Returns dictionary enumerator. Enumerator. Checks if colleciton has fixed size. Checks if collection is read-only. Gets collection of metadata keys. Removes entry from metadata. The key of entry to remove. Gets values in the metadata. Gets the dictionary of extension fields. Gets or sets data from metadata. The key name. Metadata object. Gets count of elements in the collection. Checks if collection is synchronized. Gets collection synchronization object. Determines does this dictionary contasins specified key. Key to search in the dictionary. true if key is found. Tries to find key in the dictionary and retreives value if found. Key to search in the dictionary. Retreived value. true if key was found. Adds pair with key and value into the dictionary. Item to be added. Checks does specified key-value pair is contained in the dictionary. Key-value pair. true if this pauir was found. Removes key/value pair from the colleciton. Key/value pair to be removed. true if pair was found and removed. Abstract class representing operator. Operator index in page operators list. Accepts visitor IOperatorSelector which provides operators processing. Visitor object Returns text of operator and its parameters. Operator text Determines if the operator is operator which responsible for text output (Tj, TJ, etc) Operator object True if this is text output operator This function is created to avoid .NET-specific IFormatProvider usage Value to be converted The Aspose.Pdf.Operators is a namespace for Operator implementations. These classes describes operators used in PDF page contents. Class representing b operator (close, fill and stroke path with nonzer winding rule). Initializes operator. Accepts visitor object to process operator. Visitor object. Returns string representation of operator. String representation Class representing B operator (fill and stroke path using nonzero winding rule) Initializes operator. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of operator. Class representing b* operator (close, fill and stroke path using even-odd rule). Initializes operator. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of operator. Class representing B* operator (fill and stroke path usign even-odd rule). Accepts visitor object to process operator. Visitor object. class representing BDC operator (Begin marked-content sequence) Initializes operator. Accepts visitor object to process operator. Visitor object. Gets or sets marked content tag Returns text representation of operator. Text representation of operator. Class representing BI operator (Begin inline image obect). Initializes operator. Accepts visitor object to process operator. Visitor object. Class representing BMC operator (Begin marked-content sequence). Initializes operator. Marked content tag. Gets or sets marked content tag Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of operator. Abstract base class for text-related operators (TJ, Tj, Tm, BT, ET, etc). Initializes operator. Text operator which accepts text properties. Text properties. Accepts visitor object to process operator. Visitor object. Abstract base class for text block operators i.e. Begin and End text operators (BT/ET) Initializes operator. Initializes BlockTextOperator which accepts TextProperties. Text properties. Abvstract base class for all operators which used to out text (Tj, TJ, etc). Gets text which operator out on the page. Initializes TextShowOperator. Initializes TextShowOperator which allows to pass TextProperties. Text properties. Abstract base class for operators which changes current text state (Tc, Tf, TL, etc). Initializes TextStateOperator. Initializes TextStateoperator which allows to pass TextProperties. Text properties. Abstract base class for operators which changes text position (Tm, Td, etc). Initializes TextPlaceOperator. Initializes TextPlaceOperator which accepts TextProperties. Text properties. Class representing BT operator (Begin of text block). Initializes operator. Accepts visitor object to process operator. Visitor object. Produces text code of operator. Text representation of operator. Class representing BX operator (begin compatibility section). Initializes operator. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of operator. Class representing c operator (append curve to path). Points of the curve. Initializes curve operator. Abscissa of first point. Ordinate of first point. Abscissa of second point. Ordinate of second point. Abscissa of third point. Ordinate of third point. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of operator. Class representing cm operator (concatenate matrix to current transformation matrix). Matrix argument of the operator. Initializes operator. A coefficient B coefficient C coefficient D coefficient E coefficient F coefficient Initializes operator by matrix. Transfomation matrix. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of representation Class representing CS operator (set color for stroking operations). Initializes operator. Color space name. Gets or sets color space name. Accepts visitor object to process operator. Visitor object. Class representing cs operator (set colorspace for non-stroking operations) Initializes operator. Color space name. Gets or sets color space name. Accepts visitor object to process operator. Visitor object. Class representing d operator (set line dash pattern). Dash pattern. Array�s elements shall be numbers that specify the lengths of alternating dashes and gaps. In case of one element array dash and gap lengths are equal. Dash phase. Before beginning to stroke a path, the dash array shall be cycled through, adding up the lengths of dashes and gaps. When the accumulated length equals the value specified by the dash phase, stroking of the path shall begin, and the dash array shall be used cyclically from that point onward. Creates set dash pattern operator. Array which defines dash pattern. Dash phase. Accepts visitor object to process operator. Visitor object. Gets operator string representation. [x1 x2] y d, where x1 - dash length, x2 - gap length, y - phase. Class representing d0 operator (set glyph width). Horizontal displacement of glyph coordinate. Vertical displacement of glyph coordinate. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of representation Class representing d1 operator (set glyph and bounding box). Horizontal displacement of glyph. Vertical displacement of glyph. Lower-left horizontal coordinate of bounding rectangle. Lower-left vertical coordinate of bounding rectangle. Upper-right horizontal coordinate of bounding rectangle. Upper-right vertical coordinate of bounding rectangle. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of representation Class representing Do operator (Invoke XObject). Name of XObject argument of the operator. Constructs new Do operator. Name of invoked XObject. Constructs new Do operator. Used for retrieving all Do operators, i.e. without checking their argument names. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of operator. Class represeting DP operator (designamte marked content point). Initializes operator. Accepts visitor object to process operator. Visitor object. Gets or sets marked content tag Returns text representation of operator. Text representation of operator. Class representing EI operator (End inline image object). Initializes operator. Accepts visitor object to process operator. Visitor object. Clsss representing EMC oeprator (End of marked-content sequence). Initializes operator. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of the operator. Class representing operator ET (End of text block). Initializes operator. Accepts visitor object to process operator. Visitor object. Produces text code of operator. Text representation of operator. Class representing EX operator (End of compatibility section). Initializes operator. Accepts visitor object to process operator. Visitor object. Class representing f operator (fill path with nonzero winding number rule). Initilizes new f operator. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of operator. Class representing F oeprator (fill path using nonzero winding rule). Initializes operator. Accepts visitor object to process operator. Visitor object. Class representing f* operator (fill path using even-odd rule). Initializes operator. Accepts visitor object to process operator. Visitor object. Class representing gs operator (set parameters from graphic state parameter dictionary). Gets or sets name of graphic state resource. Initializes gs operator. Name of graphic state. Returns string represnetation of operator. String representation of operator. Accepts visitor object to process operator. Visitor object. Class representing h operator (close path). Initializes operator. Accepts visitor object to process operator. Visitor object. Class representing i operator (set flatness tolerance). Initializes operator. The value of flatness. Gets or sets the flatness. Accepts visitor object to process operator. Visitor object. Class representing ID operator (Begin inline image data). Accepts visitor object to process operator. Visitor object. Class representing j operator (set line join style). Accepts visitor object to process operator. Visitor object. Class representing J operator (set line cap style). Accepts visitor object to process operator. Visitor object. Class representing l operator (add line to the path). X coordinate of line point. Y coordinate of line point. Initializes line operator. X coordinate. Y coordinate. Accepts visitor object to process operator. Visitor object. Returns text representation of the operator. Text representation of the operator. Class representing m operator (move to and begin new subpath). X coordinate Y coordinate Inintalizes new (move to) operator. The x-coordinate. The y-coordinate. Accepts visitor object to process operator. Visitor object. Returns text representation of the operator. Text representation of the operator. Class representing M operator (set miter limit). Initializes operator. Mitel limit. Gets or sets the miter limit. Accepts visitor object to process operator. Visitor object. Class representing MP operator (define marked-content point). Initializes operator. Marked content tag. Gets or sets marked content tag Accepts visitor object to process operator. Visitor object. Class representing n operator (end path without filling or stroking). Initializes operator. Accepts visitor object to process operator. Visitor object. Text representation of operator. Text representation of operator. Class representing q operator (save graphics state). Initializes q operator. Returns text of the operator. Text representation of the operator. Accepts visitor object to process operator. Visitor object. Class representing Q operator (restore graphics state). Initializes Q operator. Returns text of the operator. Text representation of the operator. Accepts visitor object to process operator. Visitor object. Class representing re operator (add rectangle to the path). X coordinate of most left side of rectangle. Y corrdinate of bottom side of rectangle. Width of the rectangle. Height of the rectangle. Initializes operator. Initializes operator. The x-coordinate of the bottom-left corner of the rectangle. The y-coordinate of the bottom-left corner of the rectangle. The width of the rectangle. The height of the rectangle. Accepts visitor object to process operator. Visitor object. Returns text representation of the operator. Text representation of the operator. Class representing set color operation. Retirns color specified by the operator. Color specified by operator. Class representing gray level for stroking operations. Returns color specified by operator. Color specified by operator. Initializes operator with the specified color. The level of gray value. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of operator. Set gray level for non-stroking operations. Returns color specified by operator. Color specified by operator. Initializes operator. The level of gray value. Accepts visitor object to process operator. Visitor object. Returns string represnetation of operator. String representation of operator. Class representing K operator (set CMYK color for stroking operations). Returns the RGB color Color specified by operator. Initializes operator. The level of cyan from 0.0 to 1.0 The level of magenta from 0.0 to 1.0 The level of yellow from 0.0 to 1.0 The level of black from 0.0 to 1.0 Accepts visitor object to process operator. Visitor object. Class representing k operator (set CMYK color for non-stroknig operations). Returns color. Color specified by operator. Initializes operator. The level of cyan from 0.0 to 1.0 The level of magenta from 0.0 to 1.0 The level of yellow from 0.0 to 1.0 The level of black from 0.0 to 1.0 Accepts visitor object to process operator. Visitor object. Class representing RG operator (set RGB color for stroking operators). Returns color specified by operator. Color specified by operator. Initializes operator. The level of red from 0.0 to 1.0 The level of green from 0.0 to 1.0 The level of blue from 0.0 to 1.0 Initializes operator with color. Operator color. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of operator. Class representing rg operator (set RGB color for non-stroknig operators). Returns color specified by operator. Color specified by operator. Initializes operator. The level of red from 0.0 to 1.0 The level of green from 0.0 to 1.0 The level of blue from 0.0 to 1.0 Initializes operator with color. Specfied color. Accepts visitor object to process operator. Visitor object. Returns text representation of the operator. Text representation of operator. Class representing ri operator (set color rendering intent). Set Color Rendering Intent operator constructor. Color Rendering Intent. Accepts visitor object to process operator. Visitor object. Gets or sets color rendering intent name. Class representing s operator (Close and stroke path). Initializes operator. Accepts visitor object to process operator. Visitor object. Returns text representation of the operator. Text representation of the operator. Class representing S operator (stroke path). Initializes operator. Accepts visitor object to process operator. Visitor object. Returns text representation of the operator. Text representation of the operator. Base class for set color operators. Gets red component of color Gets green component of color Gets red component of color Gets cyan compoent of CMYK color. Gets magenta compoent of CMYK color. Gets yellow compoent of CMYK color. Gets black compoent of CMYK color. Gets black compoent of gray color. Gets array of color components. Class representing SC operator set color for stroking color operators. Returns color specified by operator. Color specified by operator. Initializes operator. Set color for stroking operators for DeviceGrey, CalGrey and Indexed color spaces. Colro value. Set color for stroking operator for DeviceRGB, CalRGB, and Lab color spaces Red component. Green component. Blue component. Constructor which allows to set color components. Array of color components. Set color for strokinbg operator for CMYK colro space cyan component. Magenta component. Yellow component. Black component. Accepts visitor object to process operator. Visitor object. Represents class for sc operator (set color for non-stroknig operations). Returns color specified by the operator. Operator color. Initializes operator. Set color for stroking operators for DeviceGrey, CalGrey and Indexed color spaces. Color value. Set color for stroking operator for DeviceRGB, CalRGB, and Lab color spaces Red component. Green component. Blue component. Set color for non-stroking operator for CMYK colro space Cyan component. Magenta component. Yellow component. Black component. Constructor which allows to specify color components. Array of color components. Accepts visitor object to process operator. Visitor object. String represenation. Base operator for all Set Color operators. Gets Pattern Name. Class representing SCN operator (set color for stroking operations). Returns color specified by operator. Color specifid by operator. Initializes operator. Accepts visitor object to process operator. Visitor object. Constructor for scn operator Constructor for scn operator. Gray color value. Constructor for scn operator. Red component of the color/ Green component of the color. Blue component of the color. Constructor for scn operator. Cyan component of the color. Magenta component of the color. Yellow component of the color. Black component of the color Name of the pattern. Class representing scn operator (set color for non-stroking operations). Retuns color specified by operator. Color set by operator. Initializes operator. Accepts visitor object to process operator. Visitor object. Constructor for scn operartor. Color value. Pattern name. Constructor for scn operartor Color value. Constructor for scn operator. Red component of the color. Green component of the color. Blue component of the color. Constructor for scn operator. Cyan component of the color. Magenta component of the color. Yellow component of the color. Black component of the color. Class representing sh operator (paint area with shadeing pattern). Gets or sets the shading name. Accepts visitor object to process operator. Visitor object. Class representing T* operator (Move to start of the next line). Initializes operator. Accepts visitor object to process operator. Visitor object. Returns text of the operator. Text representation of operator. Class representing Tc operator (set character spacing). Initializes operator. Character spacing. Gets or sets the character spacing. Accepts visitor object to process operator. Visitor object. Class representing Td operator (move text position). X coordinate of text position. Y coordinate of text position. Initializes operator. X coordinate of text position. Y coordinate of text position. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of operator. Class representing TD operator (move position and set leading). X coordinate of text position. Y coordinate of text position. Initializes operator. X coordinate of text position. Y coordinate of text position. Accepts visitor object to process operator. Visitor object. Class representing Tf operator (set text font and size). Name of font. Size of text. Initializes operator. The name of font resource, e.g. F1, F2 etc. Size of the font. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of operator. Class representing Tj operator (show text). Text of operator. Initializes Tj opearor. Index of operator in operators list. argument of the operator. Initializes Tj operator. argument of the operator. Initializes Tj opearor. text to add. font that is used to draw the text. Initializes Tj operator. Accepts visitor object to process operator. Visitor object. Produces text code of operator. Text representation of operator. Class describes text and position to use with operator TJ (set glyph with position) Constructs glyph position. Constructor for Glyph Position. Text of operator. Position off the text in the operator. Class representing TJ operator (show text with glyph positioning). Returns positions of glyphs. Gets text from operator argument (glyph positioning is ignored). Constructor for TJ operator. List of Glyph Positions. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of operator. Class represenging TL operator (set text leading). Initializes text leading operator. Text leading. Gets or sets the text leading. Accepts visitor object to process operator. Visitor object. Produces text code of operator. Text representation of operator. Class representig Tm operator (set text matrix). Matrix argument of the operator. Initializes operator. A coefficient B coefficient C coefficient D coefficient E coefficient F coefficient Initializes operator by matrix. Transfomation matrix. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation of operator. Class representing Tr operator (set text rendering mode). Accepts visitor object to process operator. Visitor object. Class representing Ts operator (set text rise). Initializes operator. Text rise. Gets or sets the text rise. Accepts visitor object to process operator. Visitor object. Class representing Tw operator (set word spacing). Initializes operator. Word spacing. Gets or sets the word spacing. Accepts visitor object to process operator. Visitor object. Class representing Tz operator (set horizontal text scaling). Initializes operator. Horizontal scaling. Gets or sets the horizontal scaling. Accepts visitor object to process operator. Visitor object. Class representing v operator (append curve to path, initial point replicated). Points of the curve. Initializes curve operator. Abscissa of second point. Ordinate of second point. Abscissa of third point. Ordinate of third point. Accepts operator selector. Visitor object Class representing w operator (set line width). Gets or sets width of the line. Initializes operator with width value. Line width. Accepts visitor object to process operator. Visitor object. Returns text representation of operator. Text representation. Class representing W operator (set clipping path using non-zero winding rule). Initializes operator. Accepts visitor object to process operator. Visitor object. Returns text representation of operators. Text representation of operator. Class representing W* operator (set clipping path using even-odd rule). Accepts visitor object to process operator. Visitor object. Class representing y operator (append curve to path, final point replicated). Points of the curve. Initializes curve operator. Abscissa of second point. Ordinate of second point. Abscissa of third point. Ordinate of third point. Accepts visitor object to process operator. Visitor object. Class representing ' operator (move to next line and show text). Gets operator text. Initializesoperator. Accepts visitor object to process operator. Visitor object. Class representing " operator (set word and character spacing, move to the next line and show text). Gets word spacing. Get character spacing. Gets text of operator. Initializes operator. Accepts visitor object to process operator. Visitor object. Class represents collection of operators Gets a value indicating whether the collection is read-only. Gets count of operators in the collection. Indicates wheather collection is limited to fast text extraction Copies operators into operators list. Array with operators which must to be copied. This array must be Object[] or Operator[]. Starting index from which operators will be copied Returns enumerator for collection Collection enumerator Accepts IOperatorSelector visitor object to process operators. Visitor object Adds new operator into collection. Operator which must be added Example demonstrates how to add operators to the end of page.contents. Document doc = new Document("input.pdf"); doc.Pages[1].Contents.Add(new Aspose.Pdf.Operators.q()); doc.Pages[1].Contents.Add(new Aspose.Pdf.Operators.Q()); Deletes operator from collection. Index of operator which must be deleted. Operators numbering starts from 1. Example demonstrates how to delete operator by its index. Document doc = new Document("input.pdf"); OperatorCollection oc = doc.Pages[1].Contents; oc.Delete(3); Inserts operator into collection. Index where new operator must be added Operator which will be insterted Example demonstrates how to insert operator to the page contents. Document doc = new Document("input.pdf"); OperatorCollection oc = doc.Pages[1].Contents; oc.Insert(1, new Aspose.Pdf.Operators.q()); oc.Add(new Aspose.Pdf.Operators.Q()); Replace operators in collection with other operators. Operators list which will replace operators currently contained in the collection. Eash operator from the list must have correct index in range [1..N] where N is count of operators in the collection Add operators at the end of the contents operators. Array of operators to be added. Each operator can have any index (by default -1) because they come to the end of the contents operators i.e. indices are assigned automatically. Example demonstrates how to add operator to the end of page contents. Document doc = new Document("input.pdf"); OperatorCollection oc = doc.Pages[1].Contents; oc.Add(new Operator[] { new Aspose.Pdf.Operators.q(), new Aspose.Pdf.Operators.Q() } ); Insert operators at the the given position. Index from which operators are being started to insert. Array of operators to be inserted. Each operator can have any index (by default -1) because their indices adjusted automatically starting from . Example demonstrates how to insert operator to the page contents. Document doc = new Document("input.pdf"); OperatorCollection oc = doc.Pages[1].Contents; oc.Insert(1, new Operator[] { new Aspose.Pdf.Operators.q(), new Aspose.Pdf.Operators.Q() } ); Gets operator by its index. Index of operator. Numbering is starts from 1. Operator from requested index Example demonstrates how to get operator of page contents by index. Document doc = new Document("input.pdf"); OperatorCollection oc = doc.Pages[1].Contents; Operator first = oc[1]; Deletes operators from collection. Array of operators to delete Example demonstrates how to remove operator from page contents. Document doc = new Document("input.pdf"); OperatorCollection oc = doc.Pages[1].Contents; oc.Delete(new Operator[] { oc[1] } ); Deletes operators from collection. The list of operators to delete Example demonstrates how to remove operator from page contents. Document doc = new Document("input.pdf"); OperatorCollection oc = doc.Pages[1].Contents; List<Operator> opList = new List<Operator>(); opList.Add(oc[1]); oc.Delete(opList); Insert operators at the the given position. Index from which operators are being started to insert. Array of operators to be inserted. Example demonstrates how to insert operators to page contents. Document doc = new Document("input.pdf"); OperatorCollection oc = doc.Pages[1].Contents; List<Operator> opList = new List<Operator>(); opList.Add(new Operators.q()); opList.Add(new Operators.Q()); oc.Insert(1, opList); Removes all operators from list. Example demonstrates how to clear page contents. Document doc = new Document("input.pdf"); doc.Pages[1].Clear(); Returns text representation of the operator. Text representation of operator. Adds to collection all operators from other collection. collection whitch contains operators which will be added. Example demonstrates how to add operator collection to the page contents. Document doc = new Document("input.pdf"); OperatorCollection oc = doc.Pages[1].Contents; List<Operator> opList = new List<Operator>(); opList.Add(new AOperator.q()); opList.Add(new Operators.Q()); oc.Add(opList); Suppresses update contents data. The contents stream is not updated until ResumeUpdate is called. Resumes document update. Updates contents stream in case there are any pending changes. Cancels last update. This method may be called when the change should not raise contents update. Remove operator from the collection. Operator to be removed. True if operator was found and removed. False if operator did not belong to the collection. Returns true if the collection contains given operator. This class is used for selecting operators using Visitor template idea. The list of selected objects. Initializes new instance of the class. Initializes new . The operator to visit/select. Visit/select j operator. Set line join style operator. Visit/select EX operator. End compatibility section operator. Visit/select ET operator. End text object operator. Visit/select EMC operator. End marked-content sequence operator. Visit/select EI operator. End inline image object operator. Visit/select DP operator. Define marked-content point operator (with property list). Visit/select Do operator. Invoke named XObject operator. Visit/select d1 operator. Set glyph width and bounding box in Type 3 font operator. Visit/select d0 operator. Set glyph width in Type 3 font operator. Visit/select d operator. Set line dash pattern operator. Visit/select CS operator. Set color space operator (for stroking operations). Visit/select cs operator. Set color space operator (for nonstroking operations). Visit/select cm operator. Concatenate matrix to current transformation matrix operator. Visit/select c operator. Append curved segment to path operator (three control points). Visit/select BX operator. Begin compatibility section operator. Visit/select BT operator. Begin text object operator. Visit/select BMC operator. Begin marked-content sequence operator. Visit/select BI operator. Begin inline image object operator. Visit/select BDC operator. Begin marked-content sequence operator (with property list). Visit/select B operator. Fill and stroke path operator (nonzero winding number rule). Visit/select b operator. Close, fill, and stroke path operator (nonzero winding number rule). Visit/select B* operator. Fill and stroke path operator (even-odd rule). Visit/select b* operator. Close, fill, and stroke path operator (even-odd rule). Visit/select ' operator. Move to next line and show text operator. Visit/select '' operator. Set word and character spacing, move to next line, and show text operator. Visit/select operator f*. Fill path operator (even-odd rule). Visit/select f operator. Fill path operator (nonzero winding number rule). Visit/select F operator. Fill path operator (nonzero winding number rule). Visit/select g operator. Set gray level operator (for nonstroking operations). Visit/select G operator. Set gray level operator (for stroking operations). Visit/select gs operator. Set graphics state operator. Visit/select h operator. Close subpath operator. Visit/select i operator. Set flatness tolerance operator. Visit/select ID operator. Begin inline image data operator. Visit/select J operator. Set line cap style operator. Visit/select k operator. Set CMYK color operator (for nonstroking operations). Visit/select K operator. Set CMYK color operator (for stroking operations). Visit/select l operator. Append straight line segment to path operator. Visit/select m operator. Begin new subpath operator. Visit/select M operator. Set miter limit operator. Visit/select MP operator. Define marked-content point operator. Visit/select n operator. End path operator (without filling or stroking). Visit/select q operator. Save graphics state operator. Visit/select Q operator. Restore graphics state operator. Visit/select re operator. Append rectangle to path operator. Visit/select rg operator. Set RGB color operator (for nonstroking operations). Visit/select RG operator. Set RGB color operator (for stroking operations). Visit/select ri operator. Set color rendering intent operator. Visit/select s operator. Close and stroke path operator. Visit/select S operator. Stroke path operator. Visit/select sc operator. Set color operator (for nonstroking operations). Visit/select SC operator. Set color operator (for stroking operations). Visit/select scn operator. Set color operator (for nonstroking operations, ICCBased and special colour spaces). Visit/select SCN operator. Set color operator (for stroking operations, ICCBasedand special colour spaces). Visit/select sh operator. Paint area defined by shading pattern operator. Visit/select T* operator. Move to start of next text line operator. Visit/select Tc operator. Set character spacing operator. Visit/select Td operator. Move text position operator. Visit/select TD operator. Move text position and set leading operator. Visit/select Tf operator. Set text font and size operator. Visit/select Tj operator. Show text operator. Visit/select TJ operator. Show text operator (allowing individual glyph positioning). Visit/select TL operator. Set text leading operator. Visit/select Tm operator. Set text matrix and text line matrix operator. Visit/select Tr operator. Set text rendering mode operator. Visit/select Ts operator. Set text rise operator. Visit/select Tw operator. Set word spacing operator. Visit/select Tz operator. Set horizontal text scaling operator. Visit/select v operator. Append curved segment to path operator (initial point replicated). Visit/select W* operator. Set clipping path operator (even-odd rule). Visit/select w operator. Set line width operator. Visit/select W operator. Set clipping path operator (nonzero winding number rule). Visit/select y operator. Append curved segment to path operator (final point replicated). Visit/select any text operator operator. General text operator which is used to select the set of corresponding pdf operators. Represents document outline hierarchy. Count is the sum of the number of visible descendent outline items at all levels. Note: please don't confuse with Count which is number if items in collection. Count of collection items. Please dont confuse with VisibleCount: VisibleCount gets number of visible outline item on all levels. Gets an outline item representing the first top-level item in the outline. Gets an outline item representing the last top-level item in the outline. Gets a value indicating whether access to this collection is synchronized (thread safe). Gets an object that can be used to synchronize access to this collection. Gets a value indicating whether the collection is read-only. Adds outline item to collection. The outline item to be added. Deletes all outline items from the document outline. Deletes the outline item with specified title from the document outline. The title of outline item to be deleted Copies the outline items to an System.Array, starting at a particular System.Array index. The one-dimensional System.Array that is the destination. Must have zero-based indexing. The zero-based index in array at which copying begins. Returns an enumerator that iterates through the collection. An System.Collections.IEnumerator object that can be used to iterate through the collection. Clears all items from the collection. Checks does collection contains given item. The object to locate in the collection Always throws NotImplementedException The object to locate in the collection Remove item by index. Index of the item to be removed. Gets outline item from collection by index. Index of requested item. Represents outline entry in outline hierarchy of PDF document. Gets or sets the title for this outline item. Gets or sets the destination for this outline item. Gets or sets the action for this outline item. Gets or sets the color for the title text of this outline item. Gets or sets italic flag for the title text of this outline item Gets or sets bold flag for the title text of this outline item Gets the outline item representing the first top-level item in the outline hierarchy. Gets the outline item representing the last top-level item in the outline hierarchy. Gets the outline item representing previous item relatively this item in the outline hierarchy. Gets the outline item representing next item relatively this item in the outline hierarchy. Check if outline item representing next item relatively this item in the outline hierarchy. Gets the parent object of this outline item in the outline hierarchy. Gets the total number of outline items at all levels in the document outline hierarchy. Gets the value indicating whether access to this collection is synchronized (thread safe). Gets the object that can be used to synchronize access to this collection. Gets a value indicating whether the collection is read-only. Get or sets open status (true/false) for outline item. Deletes this outline item from the document outline hierarchy. Initializes outline item instance using root hierarchy object. Outlune collection. Deletes outline entry with specified name from the document outline hierarchy. Title of outline entry will be deleted. Copies the outline entries to an System.Array, starting at a particular System.Array index. The one-dimensional System.Array that is the destination. Must have zero-based indexing. The zero-based index in array at which copying begins. Returns an enumerator that iterates through the collection. An System.Collections.IEnumerator object that can be used to iterate through the collection. Adds outline item to collection. The outline item to be added. Inserts the outline item into collection at the specified place. The index specifying place for inserting. The outline item should be inserted. Clears all items from the collection. Checks if collection contains given item. The object to locate in the collection Remove outline collection item. Item to delete. Remove item by index. Index of item to be deleted. Count of collection items. Please dont confuse with VisibleCount: VisibleCount gets number of visible outline item on all levels. Gets outline item from the collection using index. Index within the collection. OutlineItemCollection object. Gets hierarchy level of outline item. Class representing page of PDF document. Gets or sets background image for page (for generator only). Gets or sets table of contents info. The table of contents info - default null. If it set this page will contain table of contents. Gets or sets page header. The page header. Gets or sets layers collection. The layers collection. Gets or sets page footer. The page footer. Gets the paragraphs. The paragraphs. Gets or sets the page info.(for generator only) The page info. Procedure for customize header and footer. /// The current page. Event for customize header and footer. Gets or sets rectangle of the page. Page crop box is returned if specified, otherwise page media box is returned. Please note that this property don't consider page rotation. To get page rectangle considering rotation please use ActualRect. Example demonstrates how to get page rectangle: Document document = new Document("sample.pdf"); Page page = document.Pages[1]; Rectangle pageRect = page.Rect; Sets color type of the pages based on information getting from operators SetColor, images and forms. Gets or sets the line style for notes.(for generator only) The note style. Gets the flag whether page is blank or not. The fill threshold value that manages the sensitivity of detection. Should be equal or greater than 0.01. Returns rectangle of the page. If true then rotation of the page will be considered in rect calculation. Rectangle of the page. Calculates bbox value - rectangle containing contents without visible margins. Bbox value - rectangle containing contents without visible margins Gets or sets tab order of the page. Possible values: Row, Column. Default, Manual Gets of set page display duration. This is time in seconds that page shall be displayed during presentation. Returs -1 if duration is not defined. Example demonstrates how to get page duration Document document = new Document("sample.pdf"); Page page = document.Pages[1]; int pageRect = page.Duration; Gets collection of operators in the content stream of the page. Example is demonstrates how to scan operators stream of page. Document document = new Document("sample.pdf"); Operators contents = document.Pages[1].Contents; foreach(Operator op in contents) { Console.WriteLine(op); } Gets or sets a group attributes class specifying the attributes of the page�s page group for use in the transparent imaging model. Gets collection of page annotations. Gets page resources. Resources object contains collections of images, forms and fonts. Example demonstrates scan through page images: Document document = new Document("sample.pdf"); DocumentActions actions = document.Actions; Resources resources = document.Pages[1].Resources; foreach(XImage image in resources.Images) { Console.WriteLine(image.Width + ":" + image.Height); } Gets or sets rotation of the page. Example demonstrates how to determine page rotation. Document document = new Document("sample.pdf"); Console.WriteLine(document.Pages[1].Rotate); Gets or sets trim box of the page. Example demonstrates how to get trim box of the page: Document document = new Document("sample.pdf"); Rectangle trimBox = document.Pages[1].TrimBox; Gets or sets art box of the page. Example demonstrates how to get art box of the page: Document document = new Document("sample.pdf"); Rectangle artBox = document.Pages[1].ArtBox; Gets or sets bleed box of the page. Example demonstrates how to get bleed box of the page: Document document = new Document("sample.pdf"); Rectangle bleedBox = document.Pages[1].BleedBox; Gets or sets crop box of the page. Example demonstrates how to get crop box of the page: Document document = new Document("sample.pdf"); Rectangle cropBox = document.Pages[1].CropBox; Gets or sets media box of the page. Example demonstrates how to get media box of the page: Document document = new Document("sample.pdf"); Rectangle mediaBox = document.Pages[1].MediaBox; Sends page to process with given page device. The device to process page. Result stream which is used with device to save its output. Accepts visitor object that provides functionality to work with annotations. Annotation selector sobject. Translates rotation enumeration member into integer value. Rotation enumeratioom member. Corresponding integer value Translates integer value into corresponding rotation enumeration member. Integer value to convert Rotation enumeration member Put stamp into page. Stamp can be page number, image or simple text, e.g. some logo. Stamp to add on the page. Each stamp has its coordinates and corresponding properties regarding to the kind of stamp, i.e. image or text value. Adds image onto the page and locates it in the middle of specified rectangle saving image's proportion. The stream of the image. The position of the image. Adds searchable image onto the page and locates it in the middle of specified rectangle saving image's proportion. The hocr of the image. The stream of the image. The position of the image. Adds image on page and places it depend on image rectangle position. The stream of the image. The default position of the image on page. The width of the image. The height of the image. If the flag set to true than image placed in rectangle position; otherwise, the size of rectange is becoming equal to image size. Adds image onto the page and locates it in the middle of specified rectangle saving image's proportion. The path to image. The position of the image. Sends page to process with given page device. The device to process page. File which is used with device to save its output. Removes all fields located on the page and place their values instead. Accepts visitor object that provides functionality to work with text objects. Text absorber object. Accepts visitor object that provides functionality to work with image placement objects. Image placement absorber object. Accepts visitor object that provides functionality to work with text objects. Text absorber object. Sets page size for page. Page width. Page size. Get number of the page. Gets transofmation matrix for the page. Gets or sets the background color of the page. Gets or sets the watermark of the page. Frees up memory Gets collection of artifacts on the page. Gets collection of page properties. Converts images on page as grayscaled. Clears cached data Returns notifications about inside operations with page content. (Only notifications about paragraph events in text adding scenarios are supported now.) String representing notifications about inside operations with page content. Converts current page as bitmap and than returns array of bytes. The resolution. Converted array of image bytes. Converts current page as xml in utf8 encoding. Converted xml string. Gets list of Field object in Tab order on this page. Collection of PDF document pages. Gets count of pages in the document. Returns true of object is synchorinzed. Gets synchronization object of the collection. Gets value indicating of collection is readonly. Always returns false. Adds page to collection. Page which should be added. Added page. Clear page collection. Delete specified page. Number of page that will be deleted. Pages numbers start from 1. Deletes all pages from collection. Returns index of the specified page. Pages numbers start from 1. Returns 0 in case collection doesn't contain the page. Page object. Pages numbers start from 1. Index of the page in collection. Copyies pages into document. Array containing Pages object to insert into document. It must be Object[] or Page[]. Starting index where pages will be inserted Returns enumerator of pages. Enumerator of pages Accepts visitor object that provides functionality to work with annotations. AnnotationSelector Visitor Delete pages specified which numbers are specified in array. Array of pages to be deleted. Insert empty apge into collection at the specified position. Position of the new page. Inserted page. Adds empty page Added page. Adds to collection all pages from list. List which contains all pages which must be added. Inserts page into page collection at specified place. Required page index in collection. Page to be inserted. Inserted page. Gets page by index. Index of page. Retreived page. Accepts visitor object that provides functionality to work with image placement objects. Image placement object. Accepts visitor object that provides functionality to work with text objects. Text fragment absorber object. Accepts visitor object that provides functionality to work with text objects. Text absorber object. Adds to collection all pages from array. Array of pages which will be added. Inserts pages from the collection into document. Starting position of the new pages. Pages collection. Inserts pages of the array into document. Starting number of the new pages. Array of pages which will be inserted. Removes all fields located on the pages and place their values instead. Clears cached data Determines whether this instance contains the object. The item. true if [contains] [the specified item]; otherwise, false. Removes the specified item. The item. Descibes page layout. Single page. Display the pages in one column. Display the pages in two columns, with odd-numbered pages on the left. Display the pages in two columns, with odd-numbered pages on the right. Display the pages two at a time, with odd-numbered pages on the left. Display the pages two at a time, with odd-numbered pages on the right. Default layout. Represents page number stamp and used to number pages. String value for stamping page numbers. Value must include char '#' which is replaced with the page number in the process of stamping. Gets or sets value of the number of starting page. Other pages will be numbered starting from this value. Initializes a new instance of the class. String value used for stamping. See property for details. Adds page number. Page for stamping. Initializes a new instance of the class. Format is set to "#". Creates PageNumberStamp by formatted text. Formatted text which used to create Page Number Stamp. Numbering style which used by this stamp. Class represents stamp which uses PDF page as stamp. Gets or sets page which will be used as stamp. Constructor of PdfPageStamp. Page which is used for stamping. Put stamp on the specified page. Page where stamp will be placed. Creates Pdf page stamp from specifed page of the document in specified file. Name and page of PDF file. Index of the page. Creates Pdf page stamp from specifed page in the document from the stream. Stream which contains PDF Index of the page. This enum represents user's permissions for a pdf. (Security handlers of revision 2) Print the document. (Security handlers of revision 3 or greater) Print the document (possibly not at the highest quality level, depending on whether is also set). Modify the contents of the document by operations other than those controlled by , , and 11. (Security handlers of revision 2) Copy or otherwise extract text and graphics from the document, including extracting text and graphics (in support of accessibility to users with disabilities or for other purposes). (Security handlers of revision 3 or greater) Copy or otherwise extract text and graphics from the document by operations other than that controlled by . Add or modify text annotations, fill in interactive form fields, and, if is also set, create or modify interactive form fields (including signature fields). (Security handlers of revision 3 or greater) Fill in existing interactive form fields (including signature fields), even if is clear. (Security handlers of revision 3 or greater) Extract text and graphics (in support of accessibility to users with disabilities or for other purposes). (Security handlers of revision 3 or greater) Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if is clear. (Security handlers of revision 3 or greater) Print the document to a representation from which a faithful digital copy of the PDF content could be generated. When this bit is clear (and bit 3 is set), printing is limited to a low-level representation of the appearance, possibly of degraded quality. Represent point with fractional coordinates. X coordinate value. Y coordinate value. Initializes new instance of the . x coordinate value. y coordinate value. Gets point with zero coordinates. Converts point into System.Drawing.PointF object. PointF structure. Class represents rectangle. Width of rectangle. Height of rectangle. X-coordinate of lower - left corner. Y - coordinate of lower-left corner. X - coordinate of upper-right corner. Y - coordinate of upper-right corner. Constructor of Rectangle. X of lower left corner. Y of lower left corner. X of upper right corner. Y of upper right corner. Converts rectangle to instance of System.Drawing.Rectangle. Floating-point positions and size are truncated. Result of conversion. Initializes new rectangle from given instance of System.Drawing.Rectangle. Source rectangle which position and size will be set to new rectangle. New rectangle. Gets rectangle string representation. String has format llx,lly,urx,ury. Try to parse string and extract from it rectangle components llx, lly, urx, ury. String to parse. Rectangle object. Empty rectangle Initializes trivial rectangle i.e. rectangle with zero position and size. Checks if rectangle is trivial i.e. has zero size and position. Checks if rectangle is empty. Checks if rectangle is point i.e. LLX is equal URX and LLY is equal URY. Check if rectangles are equal i.e. have same position and sizes. Rectangle which will be compared. True if rectangles are eqals, false otherwise. Check if rectangles are near equal i.e. have near same (up to delta) position and sizes. Rectangle which will be compared. Value of comparation tollerance. True if rectangles are eqals, false otherwise. Intersects to rectangles. Rectangle to which this recatangle be intersected. Intersection of rectangles; null if rectangles are not intersected. Joins rectangles. Rectangle to which this recatangle be joined. Described rectangle. Determines whether this rectangle intersects with other rectangle. Intersection will be tested with specified rectangle. True if this rectangle intersects with specified rectangle. Otherwise false. Determinces whether given point is inside of the rectangle. Point to check. True if point is inside of the recatngle. Returncs coordinates of center of the rectangle. Point which is center of the rectangle. Rotate rectangle by the specified angle. Angle of rotation. Member of Rotation enumeration. Rotate rectangle by the specified angle. Angle of rotation in degrees between 0 and 360. Clones the Rectangle object. Clone object. Class representing page resources. Gets forms collection Gets images collection Returns fonts collection. If resources don't contain fonts entry it will be created in depends of CreateIfAbsent flag. If this flag is true then fonts will be created if this entry is absent. Fonts collection. Gets resources collection Enumeration of possible rotation values. Non-rotated. Rotated on 90 degrees clockwise. Rotated on 180 degrees. Rotated on 270 degrees clockwise. An abstract class for various kinds of stamps which come as descendants. Horizontal alignment of the stamp. Vertical alignemtn of the stamp. Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top. Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. Gets or sets a value to indicate the stamp outline opacity. The value is from 0.0 to 1.0. By default the value is 1.0. Gets or sets a value of the stamp outline width. By default the value is 1.0. Sets or gets the rotation of stamp content according values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. Horizontal stamp coordinate, starting from the left. Vertical stamp coordinate, starting from the bottom. Gets or sets Horizontal alignment of stamp on the page. Gets or sets vertical alignment of stamp on page. Gets or sets left margin of stamp. Gets or sets right margin of stamp. Gets or sets bottom margin of stamp. Gets or sets top margin of stamp. Horizontal zooming factor of the stamp. Allows to scale stamp horizontally. Desired width of the stamp on the page. Desired height of the stamp on the page. Vertical zooming factor of the stamp. Allows to scale stamp vertically. Zooming factor of the stamp. Allows to scale stamp. Please note that pair of properties ZoomX and ZoomY allows to set zoom factor for every axe separately. Setting of this property changes both ZoomX and ZoomY properties. If ZoomX and ZoomY are different then Zoom property returns ZoomX value. Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. Adds stamp on the page. The page to add stamp. Returns point if the stamp on the page. Page where the stamp is placed. Point of the stamp. Add G state on the page for stamp. Page where Name of added GState. Returns transformation matrix for page. Page where stamp is placed. Rotation matrix of the stamp. Returns scaling matrix of the stamp. Scale matrix of the stamp. Sets stamp Id. New value of Stamp ID. Returns stamp ID. Identifier of the stamp. Represents characteristics of an image placed to Pdf document page. When an image is placed to a page it may have dimensions other than physical dimensions defined in . The object is intended to provide such information like dimensions, resolution and so on. The example demonstrates how to find images on the first PDF document page and get images as bitmaps with visible dimensions. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create ImagePlacementAbsorber object to perform image placement search ImagePlacementAbsorber abs = new ImagePlacementAbsorber(); // Accept the absorber for first page doc.Pages[1].Accept(abs); // Retrieve images with visible dimensions foreach (ImagePlacement imagePlacement in abs.ImagePlacements) { Bitmap scaledImage; using (MemoryStream imageStream = new MemoryStream()) { // Retrieve image from resources imagePlacement.Image.Save(imageStream, ImageFormat.Png); Bitmap resourceImage = (Bitmap) Bitmap.FromStream(imageStream); // Create new bitmap with actual dimensions scaledImage = new Bitmap(resourceImage, (int)imagePlacement.Rectangle.Width, (int)imagePlacement.Rectangle.Height); } } Current transformation matrix for this image. Gets rectangle of the Image. Operator used for displaying the image. Delete image from the page. Gets rotation angle of the Image. Gets resolution of the Image. Gets related XImage resource object. Gets the page containing the image. Gets compositing parameters of graphics state active for the image placed to the page. Replace image in collection with another image. Stream containing image data. Saves image with corresponding transformations: scaling, rotation and resolution. Stream where image will be saved Saves image with corresponding transformations: scaling, rotation and resolution. Stream where image will be saved Format which will be used for image enconding. Represents an image placements collection Gets the number of object elements actually contained in the collection. Gets an object that can be used to synchronize access to the collection. Gets a value indicating whether access to the collection is synchronized (thread safe). Gets a value indicating whether the collection is read-only. Adds the text fragment element at the specified index. Returns an enumerator for the entire collection. Enumerator object. Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array Array of objects which will be copied. Starting index from which copying will be started. Clears all items from the collection. Determines whether the collection contains a specific value. The object to locate in the collection true if item is found in the collection; otherwise, false. Deletes specified item from collection Item to delete true if item was deleted; otherwise, false. Gets the text fragment element at the specified index. Index of image placement. ImagePlacement object. Represents an absorber object of image placement objects. Performs search of image usages and provides access to search results via collection. The object is basically used in images search scenario. When the search is completed the occurrences are represented with objects that the collection contains. The object provides access to the image placement properties: dimensions, resolution etc. The example demonstrates how to find images on the first PDF document page and get the image placement properties. // Open document Document doc = new Document(@"D:\Tests\input.pdf"); // Create ImagePlacementAbsorber object to perform image placement search ImagePlacementAbsorber abs = new ImagePlacementAbsorber(); // Accept the absorber for first page doc.Pages[1].Accept(abs); // Display image placement properties for all placements foreach (ImagePlacement imagePlacement in abs.ImagePlacements) { Console.Out.WriteLine("image width:" + imagePlacement.Rectangle.Width); Console.Out.WriteLine("image height:" + imagePlacement.Rectangle.Height); Console.Out.WriteLine("image LLX:" + imagePlacement.Rectangle.LLX); Console.Out.WriteLine("image LLY:" + imagePlacement.Rectangle.LLY); Console.Out.WriteLine("image horizontal resolution:" + imagePlacement.Resolution.X); Console.Out.WriteLine("image vertical resolution:" + imagePlacement.Resolution.Y); } Gets/sets read only mode for parsing operations collection. It may help against out of memory exceptions. Gets collection of image placement occurrences that are presented with objects. Performs search on the specified page. Pdf pocument page object. Performs search on the specified document. Pdf pocument object. Represents a cell of the table's row. Gets or sets the cell have border. Gets or sets the padding. Gets or sets the border. Gets or sets the background color. Gets or sets the background image file. Gets or sets the background image Gets or sets the alignment. Gets or sets the default cell text state. Gets or sets the cell's formatted text. Gets or sets the cell's text word wrapped. Gets or sets the vertical alignment. Gets or sets the column span. Gets or sets the row span. Gets or sets the column width. Initializes a new instance of the Cell class. The rectangle of the cell in page's coordinates. Initializes a new instance of the Cell class. Clone the cell. The cloned object Represents a cells collection of row. Add cell to collection. The new cell Add cell to collection. The text for cell. The text state. The new cell Add cell to collection. The text for cell. The new cell Add cell to collection. The cell to collection. Remove cell set from collection. The collection index. The rows count. Remove cell set from collection. The object. Remove cell set from collection. The cell object. Insert cell to collection. The selected index. The selected cell. Gets collection's enumerator Dispose method The items count. Gets or sets cells. The cell index. Represents a row of the table. Clone the row. The cloned object Gets or sets the background color. Gets or sets the border. Gets the cells of the row. Gets default cell border; Gets height for row; Gets fixed row height - row may have fixed height; Gets fixed row is in new page - page with this property should be printed to next page Default false; Gets is row can be broken between two pages Gets or sets default text state for row cells Gets or sets default margin for row cells Gets or sets the vertical alignment. Represents a rows collection of table. Add row to collection. The new row Add row to cellection. The new row. Returns index of row in collection. The existing row. The row index Remove row from collection. The existing row. Remove row at position from collection. The collection index. Remove row set from collection. The collection index. The rows count. Gets collection's enumerator Dispose method The items count. Gets or sets row. The row index. Enumerates the table broken. No broken. Vertical broken. Vertical broken in same page. Represents rendering options. Gets or sets barcode optimization mode. Gets or sets optimize dimensions mode. Gets or sets a mode where system fonts are rendered natively. Gets or sets a flag determines whether new imaging engine is used or not. Gets or sets a value used to increase or decrease the width of rectangle for AppendRectangle operator. Indicates that all fonts will be converted to TTF unicode versions. That is useful for compatibility reasons and to optimize font usage, cause every new TTF font will have not all the symbols from source font, but only symbols which are used in text. Usage of this flag turn on font hinting mechanism. Font hinting is the use of mathematical instructions to adjust the display of an outline font. In some cases turning this flag on may solve problems with text legibility. At current moment usage of this flag could give effect only for TTF fonts, if these fonts are used in source document. Gets or sets a values used to scale all images on the page to fit page's width. Gets or sets hiqh quality mode for interpolation. Maximum count of fonts in fonts cache. Default value is 10. Maximum count of symbols in symbol cache. Default value is 100. Gets/sets the default name of font used to substitute of missing fonts. Reresents textual stamp. This property determines how stamp is drawn on page. If Draw = true stamp is drawn as graphic operators and if draw = false then stamp is drawn as text. Defines coordinate origin for placing text. If TreatYIndentAsBaseLine = true (default when Draw = true) YIndent value will be treated as text base line. If TreatYIndentAsBaseLine = false (default when Draw = false) YIndent value will be treated as bottom (descent line) of text. Defines word wrap. If this property set to true and Width value specified, text will be broken in the several lines to fit into specified width. Default value: false. Defines text justification. If this property is set to true, both left and right edges of the text are aligned. Default value: false. Defines scaling of the text. If this property is set to true and Width value specified, text will be scaled in order to fit to specified width. Gets or sets string value which is used as stamp on the page. Gets text properties of the stamp. See for details. Alignment of the text inside the stamp. Initializes a new instance of the class. Stamp value. Initializes a new instance of the class. Stamp value. Stamp text state. Adds textual stamp on the page. Page for stamping. Initializes a new instance of the class with formattedText object FormattedText object which contains text of the stamp. Creates XForm which contains operators for text output. Page where stamp should be placed. Created XForm. Desired width of the stamp on the page. Desired height of the stamp on the page. Max row height for WordWrap option. Enumeration of possible vertical alignment values. No alignment (use specified position). Align to top. Center alignment. Align to bottom. The Aspose.Pdf.XfaConverter namespace provides classes that allow to convert XFA. class to handle related data incapsulation Initializes a new instance of the class. Size of the page. Gets or sets the URI resolver. The URI resolver. Gets or sets the size of the page. The size of the page. If this property is true then document will be converted with using of xfa form stream (if it exists). If it is false then xfa form stream will be ignored. This property was inrtoduced because it's not clear how to calculate check sum that used for checking sygnature. If this property is true then additional red rectangles will be drawn for required Xfa "excluded groups" This property was introduced because absences of analogues of excluded groups during conversion Xfa representation of forms to standard. It is false by default. Gets or sets the base path. The base path. Class represent XForm Gets or sets form bounding box. Gets or sets form name. Form name is name which used to reference form in XObejct ductionary in page resources. Gets operators of the form. Gets The Open Prepress Interface (OPI). Gets or sets matrix of the form. Returns resources of Form X-Object If For does not have resources and allowCreate is true, Resources will be automatically created for the form. Gets Form XObject resources. Creates XForm which duplicates contents of the page. Source page Document where new XForm will be added. Newly created XForm. Gets or sets rectangel of the form. Clears cached data Class represents collection of XFormCollection. Gets count of XForms in collection. Returns true if object is synchronized. Synchronization object. Gets a value indicating whether the collection is read-only. Adds new XForm into collection. XForm to add into collection Delete XForm from collectin Index of XForm which must be deleted Deletes all XForms from collection. Copies XFormCollection into collection. Array of XForm to be copied Index where XFormCollection will be copied Retunrs collection enumerator. Enumerator for collection Deletes XForm from collection by form name. Name of XForm to be deleted. Returns XForm by index. Index of XFormCollection. XForms numbering is started from 1 Retreived XForm Returns XForm by its name. Exception is thrown if XForm with specified name is not found. Name of XForm Clears all items from the collection. Determines whether the collection contains a specific value. The object to locate in the collection true if item is found in the collection; otherwise, false. Deletes specified item from collection. The object to delete true if item was deleted from collection; otherwise, false. Enumeration representing image filter type. Class representing image X-Object. If the image contains transparancy than return true; otherwise, false. Gets grayscaled version of image. Gets image filter type. Gets width of the image. Gets height of the image. Gets or sets image name. Please note that if you change name of the image which has references in page contents, document may became incorrect. Please use XImage.Rename method in this case. Renames image and replaces all references to the image with the new name New image name. Saves image data into stream as JPEG image. Stream where image data will be saved. Saves image into stream with requested format. Stream where image will be saved Format which will be used for image enconding. Saves image data into stream as JPEG image with specified resolution. Stream where image data will be saved. Image resolution Saves image into stream with requested format with specified resolution. Stream where image will be saved Format which will be used for image enconding. Image resolution Returns color type of image. The color type value. Returns true if both images references to the same object. Image to be compared with "this" image. Boolean value which is true if images references to the same object. Returns name of the image in ints collection. Image key (name). Returns the original image stream. The original image stream. Metadata of the image. Action which performed with image object when image is removed from collection. If image object is removed Image will be removed from the collection. If page contents contains references to the image they will not be removed. Document may became invalid. Image will be removed from the collection and from page contents, but image object will not be deleted. File size will not be decreased. Image will be removed from the collection and image object will be removed from the document. If other references on the same object exist the document may be corrupted. Image will be removed from the collection and image object will be removed only if no other references to the image from other pages. This may require more time in comparision with ForeDelete option. Class representing XImage collection. Count of images in collection. Returns true if object is synchronized. Returns synchronization object. Gets array of image names. Gets a value indicating whether the collection is read-only. Adds new image to Image list. This method adds image as reference to the same PdfObject (which allows to decrease file size) XImage to be added. Name of the added image. Adds entity to the end of the collection, so entity can be accessed by the last index. Stream containing image data (in JPEG format). Name of the added image. Adds entity to the end of the collection, so entity can be accessed by the last index. Stream containing image data. The image filter type. Adds entity to the end of the collection, so entity can be accessed by the last index. Stream containing image data (in JPEG format). JPEG quality. Removes index from collection by index. Image index. Removes item from collection by name. Name of image which must to be deleted. Removes item from collection by name. Name of image which must to be deleted. Action to be performed with image object. Deletes images from collection. Returns collection enumerator. Enumerator of collection Copies array of images into collection. Array to be copied. Index where images will be copied into collection. Replace image in collection with another image. Index of collection item which will be replaced. Stream containing image data (in JPEG format). Replace image in collection with another image. Index of collection item which will be replaced. Stream containing image data (in JPEG format). Quality of JPEG compression, in percent (valid vaues are 0..100). If true, image is compressed with CCITT compression method which provides better compression for black nad white image. May be used only for black and white images. Replace image in collection with another image. Index of collection item which will be replaced. Stream containing image data (in JPEG format). JPEG quality. Gets image from collection by its index. Image index Retreived image. Gets image from collection by its name. Image name. Retreived image. Returns name in images list which is key of the given image. Image to search. Name (key) of the found image; null if images was not found. Clears all items from the collection. Determines whether the collection contains a specific value. The object to locate in the collection true if item is found in the collection; otherwise, false. Always throws NotImplementedException This schema describes a field in a structured type. It is very similar to the PDF/A Property Value Type schema, but defines a field in a structure instead of a property. Schema namespace URI: http://www.aiim.org/pdfa/ns/field# Required schema namespace prefix: pdfaField. Field name. Field names must be valid XML element names. Field value type, drawn from XMP Specification 2004, or an embedded PDF/A value type extension schema. Predefined XMP type names or names of custom types. Initializes object. The field name. The field value. The field value type. The field description. Returns the list of xml elements that represent field in xml tree. The source xml document. The list of fields. Represents the base class for field, property, value type instances. Gets the description. Gets or sets the value. Returns the list of xml elements that represent object in xml tree. The source xml document. >The list of xml elements. Initializes new object. The value. The description. Describes a single property. Schema namespace URI: http://www.aiim.org/pdfa/ns/property# Required schema namespace prefix: pdfaProperty Gets the property category. Initializes new object. The property name. The property value. The property value type. The property category. The property description. Returns the list of xml elements that represent property in xml tree. The source xml document. The list of xml elements. Property category: internal or external. Internal properties are created automatically from document content. External properties are based on user input. Describes the XMP extension schema which is provided by PDF/A-1. Default extension namespace prefix. Default extension namespace uri. Default schema namespace prefix. Default schema namespace uri. Default property namespace prefix. Default property namespace uri. Default valie type namespace prefix. Default value namespace uri. Default field namespace prefix. Default extension namespace uri. Default rdf namespace prefix. Default rdf namespace uri. Gets the schema description. Gets the list of objects (properties, value types). Initializes new object. The schema description. Adds new object into schema. The new object. Determines whether obj exists in schema. The obj to find. True - object exists in schema; otherwise, false. Removes the object from schema. The object to remove. Returns the xml element (tag - li) that represents schema in xml tree. The source xml document. The xml element. Gets the values of properties as xml tree representation. The source xml document. The root node of properties values list. Returns PDF/A property by its name. Property name. Represents the description of XMP extension schema which is provided by PDF/A-1. Gets the prefix. Gets the namespace URI. Gets the optional description. Initializes new object. The prefix. The namespace URI. The optional desciption. Returns the list of xml elements that represent schema description in xml tree. The source xml document. The list of xml elements. The PDF/A ValueType schema is required for all property value types which are not defined in the XMP 2004 specification, i.e. for value types outside of the following list: - Array types (these are container types which may contain one or more fields): Alt, Bag, Seq - Basic value types: Boolean, (open and closed) Choice, Date, Dimensions, Integer, Lang Alt, Locale, MIMEType, ProperName, Real, Text, Thumbnail, URI, URL, XPath - Media Management value types: AgentName, RenditionClass, ResourceEvent, ResourceRef, Version - Basic Job/Workflow value type: Job - EXIF schema value types: Flash, CFAPattern, DeviceSettings, GPSCoordinate, OECF/SFR, Rational Schema namespace URI: http://www.aiim.org/pdfa/ns/type# Required schema namespace prefix: pdfaType Gets the value type. Gets the namespace URI. Gets the prefix. Gets the list of fields. Initializes new object. The value type. The namespace URI. The prefix. The description. Add new field. The field to add. Adds the range of fields. The fields to add. Removes the field from the list of fields. The field to remove. Clears all fields. Returns the list of xml elements that represent value type in xml tree. The source xml document. The list of xml elements. Save options for export to Doc format Allows to control how a PDF document is converted into a word processing document. Use the mode when the resulting document is not goining to be heavily edited futher. Textboxes are easy to modify when there is not a lot to do. Use the mode when the output document needs further editing. Paragraphs and texlines in the flow mode allow easy modification of text, but unupported formatting objects will look worse than in the mode. This mode is fast and good for maximally preserving original look of the PDF file, but editability of the resulting document could be limited. Every visually grouped block of text int the original PDF file is converted into a textbox in the resulting document. This achieves maximal resemblance of the output document to the original PDF file. The output document will look good, but it will consist entirely of textboxes and it could makes further editing of the document in Microsoft Word quite hard. This is the default mode. Full recognition mode, the engine performs grouping and multi-level analysis to restore the original document author's intent and produce a maximally editable document. The downside is that the output document might look different from the original PDF file. An early alfa version of a new Flow mode supporting recognition of tables. Allows to specify .doc or .docx file format. [MS-DOC]: Word (.doc) Binary File Format Office Open XML (.docx) File Format Recognition mode. In Pdf words may be innerly represented with operators that prints words by independently printing their letters or syllables. So, to detect words sometimes we need detect groups of independent chars that are in fact words. This setting defines width of space between text elements(letters, syllables) that must be treated as distance between words during recognition of words in source PDF. (presence of empty space at least with this width between letters means that textual elements pertain to different words). It's normed to font size - 1.0 means 100% of supposed word's font size. ATTENTION!It's used only in cases when source PDF contains specific rarely used fonts for which optimal value cannot be calculated from font. So, in vast majority of cases this parameter changes nothing in result document. Switch on the recognition of bullets Use paragraph or line breaks Converted images X resolution. Converted images Y resolution. Output format Defines batch size if batched conversion is applicable to source and destination formats pair. Defines the path (file name or directory name) to hold temporary data when converting in memory save mode. This handler can be used to handle conversion progress events f.e. it can be used to show progress bar or messages about current amount of processed pages, example of handler's code that shows progress on console is : public static void ConvertWithShowingProgress() { (new Aspose.Pdf.License()).SetLicense(@"F:\_Sources\Aspose_5\trunk\testdata\License\Aspose.Total.lic"); Document doc = new Document(@"F:\ExternalTestsData\Booklet.pdf"); HtmlSaveOptions saveOptions = new HtmlSaveOptions(); saveOptions.CustomProgressHandler = new HtmlSaveOptions.ConversionProgressEventHandler(ShowProgressOnConsole); doc.Save(@"F:\ExternalTestsData\Booklet.doc", saveOptions); Console.ReadLine(); } public static void ShowProgressOnConsole(HtmlSaveOptions.ProgressEventHandlerInfo eventInfo) { switch (eventInfo.EventType) { case HtmlSaveOptions.ProgressEventType.TotalProgress: Console.WriteLine(string.Format("{0} - Conversion progress : {1}% .", DateTime.Now.ToLongTimeString(), eventInfo.Value.ToString())); break; case HtmlSaveOptions.ProgressEventType.SourcePageAnalized: Console.WriteLine(string.Format("{0} - Source page {1} of {2} analyzed.", DateTime.Now.ToLongTimeString(), eventInfo.Value.ToString(), eventInfo.MaxValue.ToString())); break; case HtmlSaveOptions.ProgressEventType.ResultPageCreated: Console.WriteLine(string.Format("{0} - Result page's {1} of {2} layout created.", DateTime.Now.ToLongTimeString(), eventInfo.Value.ToString(), eventInfo.MaxValue.ToString())); break; case HtmlSaveOptions.ProgressEventType.ResultPageSaved: Console.WriteLine(string.Format("{0} - Result page {1} of {2} exported.", DateTime.Now.ToLongTimeString(), eventInfo.Value.ToString(), eventInfo.MaxValue.ToString())); break; default: break; } } Save options for export to Pdf format Font name used by default for fonts which are absent on computer. When the PDF document that is saved into PDF contains fonts, that are not available in the document itself and on the device, API replaces this fonts with the default font(if font with is found on device) Specifies format means saving without change of format, i.e. as PDF use it please instead of 'SaveFormat.None', that is obsolete one means saving without change of format, i.e. as PDF It's obsolete one and will be deleted eventually, please use instead 'SaveFormat.Pdf' means saving in DOC format means saving in XPS format means saving in HTML format means saving in XML format means saving in TEX format i.e. format suitable for Latex text editor means saving in DOCX format means saving in SVG format means saving in MobiXML format(special format of e-books) means saving in MsExcel format means saving in EPUB format(special format of e-books) means saving in PPTX format Saving as APS XML file. Internal PDF document structure in XML format SaveOptions type hold level of abstraction on individual save options Represents line types that can be used in result document for drawing borders or another lines No line will be shown dotted line will be shown dashed line will be shown solid line will be shown double line will be shown grove line will be shown ridhe line will be shown inset line will be shown outset line will be shown Represents information of one part of border(top, botom, left side or right side) Represents border line's line color Represents border line's type - f.e. Dashed or Solid Represents border line's width in points. Must be number greater then zero. Instance of this class represents information about border That can be drown on some result document. Creates instance of BorderInfo class Creates instance of BorderInfo class and initializes all elements of border(Top, Left, Right, Bottom) with attributes copied from supplied border style style of border parts that will be used for all elements of border(left, right, top, bottom) Represents top part(if any) of border Represents left part(if any) of border Represents right part(if any) of border Represents bottom part(if any) of border Instance of this class represents information about page margin That can be drown on some result document. Represents top page margin(if any) Represents right page margin(if any) Represents bottom page margin(if any) Represents left page margin(if any) Creates instance of MarginInfo Creates instance of MarginInfo class and initializes all elements of page margin(Top, Left, Right, Bottom) with attributes copied from supplied margin style style of margin parts that will be used for all elements of margin(left, right, top, bottom) Represents information of one part of margin(top, botom, left side or right side) Creates instance of MarginPartStyle class and set its value in points Integer value in points Creates instance of MarginPartStyle class and initializes its value in points Mark margin auto Gets or sets a value indicating whether this instance is auto. true if this instance is auto; otherwise, false. Represents margin in points. Must be number greater then zero. enumerates possible types of saved external resources Means that supplied resource is image Means that supplied resource is font This class represents set of data that related to external resource file's saving that occures during conversion of PDF to some other format (f.e. HTML) Set by converter. Supposed file name that goes from converter to code of custom method Can be use in custom code to decide how to process or where save that file Set by converter. Supposed file name that goes from converter to code of custom method Can be use in custom code to decide how to process or where save that file Set by converter. Represents binary content of saved file. this flag must set to "true" in custom code if for some reasons proposed file should be processed not with custom code but with converter's code itself in standard for converter way. So, it' setting set to true means that custom code did not process referenced file and converter must handle it itself (in both sences - for saving somewhere and for naming in referencing file). Callback to handle any warnings generated. The WarningHandler returns ReturnAction enum item specifying either Continue or Abort. Continue is the default action and the Save operation continues, however the user may also return Abort in which case the Save operation should cease. Format of data save. Gets or sets boolean value which indicates will Response object be closed after document saved into response. Contains options for loading/importing CGM file into pdf document. Gets or sets output page size for import. Creates default load options for converting CGM file into pdf document. Default pdf page size - A4 300dpi 2480 X 3508. Creates load options with defined . Defines pdf page width and height. MIME protocol Content-Disposition header. Result is shown inline. Result is saved as attachment. Represents options for loading/importing html file into pdf document. Gets or sets rendering all document to single page Gets or sets fonts embedding to result document Gets or sets possible media types used during rendering. Gets or sets the attribute specifying the encoding used for this document at the time of the parsing. If this attribute is null the encoding will determine from document character set atribute. The base path/url for the html file. Creates load options for converting html into pdf document with empty base path. If loading of external data referenced in HTML requirs credentials, You can put them into this parameter - they will be used during loading of external resources Creates load options for converting html into pdf document with defined base path. The base path/url for the html file. Sometimes it's necessary to avoid usage of internal loader of external resources(like images or CSSes) and supply custom method that will get requested resources from somewhere. For example, during usage of Aspose.PDF in cloude direct access to referenced files impossible: in such case some custome code put into special method should be used, and delegate that refers that method should be assygned to this attribute. Gets or sets document page info Represents options for loading/importing of .mht-file into pdf document. Gets or sets document page info Specifies load format. means loading of document in CGM format means loading of document in HTML format means loading of document in EPUB format(special format of e-books) means loading of document in XML format(special XML that represent logical structure of PDF document) means loading of document in XSLFO format means loading of document in PCL format means loading of document in XPS format means loading of document in TEX format - format of Latex text editor means loading of document in SVG format - format of Latex text editor means loading of document in MHT format(that is packed HTML format) means loading of document in PS format(format of PostScript document) means loading document is in MD format (markdown). means loading document is in TXT format. means loading document in APS format. Internal PDF document structure in XML format. Enum represented warning type. The file is corrupted. Text/chart/image or other data is completely missing from either the documet tree following load, or the created document following save. Major formatting losses compared to the original document. This is for occasions when the formatting loss is substantial but the data is still there. Minor formatting losses compared to the original document. This is for minor losses of fidelity. Known issue that will prevent the document being opened by certain user agents, or previous versions of user agents. Invalid input stream type The file has unexpected content. Immutable object for encapsulating warning information. Constructs instance for gathering information. the warning type to set the warning message to set Returns string representation of warning message. the warning message Returns warning type. the warning type Interface for user's callback mechanism support. The callback method for some program notifications. the warning information for some happened warning the result of further program workflow Enum represented a program workflow action in case of invoking the method. Used for continue flow. Used for abort flow. LoadOptions type holds level of abstraction on individual load options Represents mode of usage of margins area during conversion (like HTML, EPUB etc), defines treatement of instructions of imported format related to usage of margins. In this mode converter obeyes format of imported document (f.e. CSS of imported HTML) in usage of margins area.So, if format of imported document requires usage of margins area for rendering , converter will allow that This mode strictly forbids usage of margins area, so, converter will never use area of margins for rendering, even if CSS or format of source document allows or requirs that ATTENTION! The feature implemented but did not put yet to public API since blocker issue in OSHARED layer revealed for sample document. Represents mode of usage of page size during conversion. Formats (like HTML, EPUB etc), usually have float design, so, it allows to fit required pagesize. But sometimes content has specifies horizontal positions or size that does not allow put content into required page size. In such case we can define what should be done in this case (i.e when size of content does not fit required initial page size of result PDF document). In this mode result pages will have required pagesize defined in LoadOptions, no matter whether content after conversion goes out of page boundaries or no. This mode defines such behaviour: after getting of conversion result , and detecting of fact that some content has been truncated, width of portview is enlarged to fit content and conversion is repeated. This mode allows getting of less pages in result in such case but requires repeated rendering(and therefore more processing time). Callback to handle any warnings generated. The WarningHandler returns ReturnAction enum item specifying either Continue or Abort. Continue is the default action and the Load operation continues, however the user may also return Abort in which case the Load operation should cease. Represents file format which describes. Result of custom loading of resource Creates instance of loading result reult of custom loading must be allways provided, it can be zero-length array if it's impossible to get any result Bynary data that loaded with custom loader - it must be set after loading Sometimes encoding of resource is known after or during loading. In such case custom code can provide converter with that knowledge via this parameter. You can leave null in this parameter if encoding is unknown or does not matter. Sometimes it's impossible to load requested resource for some reason. Unavailability of resource often does not lead to crash of conversiov and result document can be created anyway(but maybe in a bit worse quality, without images etc.). If exception occured during loading, just catch it and put in this parameter - sometimes that information is usefull for converter for rendering of result. Sometimes knowledge about MIME type of loaded resource is usefull for converter You can provide MIME type(if it'd known after loading) in this parameter. Please leave parameter equal to null when MIME type unknown or it's not necessary to supply it. Sometimes for some reasons loading should not occure custom code. In such case please set this flag as True. In such case converter will try use internal default resource loader to get that result(as it behave in situation when custom strategy not supplied). Sometimes it's necessary to avoid usage of internal loader of external resources(like images or CSSes) and supply custom method, that will get requested resources from somewhere. For example during usage of Aspose.Pdf in cloud direct access to referenced files impossible, and some custome code put into special method should be used. This delegate defines signature of such custom method. Resource URI. ResourceLoadingResult object. This enum represents known password types used for password protected pdf documents. Pdf document is not password protected. Pdf document was opened using document open password (restricted access). Pdf document was opened using change permissions password (full access). Pdf document is password protected but both user and owner passwords are not empty and none of the passwords was defined or supplied password was incorrect. So it impossible to deduce the type of the password. The Aspose.Pdf.Structure namespace provides classes which help to work with a logical structure of a document which presents the organization of the document into chapters and sections or the identification of special elements such as figures, tables, and footnotes. Class representing base element of logical structure. Gets child elements collection. (Optional; PDF 1.4) A language specifying the natural language for all text in the structure element except where overridden by language specifications for nested structure elements or marked content. (Optional; PDF 1.4) Text that is an exact replacement for the structure element and its children. This replacement text (which should apply to as small a piece of content as possible) is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes. (Optional) An alternate description of the structure element and its children in human-readableform, which is useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes. (Optional; PDF 1.5) The expanded form of an abbreviation. General structure element. Root structure element. Class representing logical structure figure. Gets the value of figure structure element. General text element of document logical structure. Gets the value of text structure element. Represents options for loading(import) PCL file into pdf document. Defines conversion engine that will be used for conversion Gets or sets boolean value which indicates will PCL conversion errors should be supressed. List of conversion errors. Enumerates conversion engines that can be used for conversion Legacy conversion engine is conversion engine thay was used for a while and is used by default. New conversion engine is currently in A-testing state. We open it into public API to get some feedback. It's currently recommended to use it only when old conversion engine cannot convert document for some reasons. Defines batch size if batched conversion is applicable to source and destination formats pair. Represents options for loading/importing SVG file into pdf document. Enumerates conversion engines that can be used for conversion Represents legacy SVG to PDF conversion engine. Represents new SVG to PDF conversion engine. Allows select conversion engine that will be in use during conversion. Currently new engine is in B-testing stage, so this value by default set to ConversionEngines.LegacyEngine Gets or sets page info that should be applied during loading of document. NOTE that this parameter only works when ConversionEngine == ConversionEngines.NewEngine Adust pdf page size to svg size Represents class for Collection(12.3.5 Collections). Initializes new Collection object. Default embedded file name. Represents options for loading/importing XML file into pdf document. Gets xsl data for converting xml into pdf document. Creates object without xsl data. Creates object with xsl data. Xsl file to convert xml document into pdf document. Creates object with xsl data. Xsl stream to convert xml document into pdf document. Save options for export to Xml format Save options for export to Xps format Indicates whether to preserve transparent (OCR'ed) text. Defines batch size if batched conversion is applicable to source and destination formats pair. Represents options for loading/importing XSL-FO file into pdf document. Source XSLFO document can contain formatting errors. This enum enumerates possible strategies of handling of such formatting errors In this case converter will be instructed to try proceed with conversion and ignore found formatting errors. In this case success not guaranteed, serious problems can occure later in converter, anf in suck case will be thrown exception with list of found formatting errors. In this case conversion will be stopped immediately and exception will be thrown immediately after detecting of first formatting error This is the most agile method - custom code must supply (in WarningCallback property) special handler that will be called when formatting error detected. That handler can f.e. log or count errors etc and will supply decision whether processing can be continued for this or that error. Source XSLFO document can contain formatting errors. This enum enumerates possible strategies of handking of that errors Creates object without xsl data. Creates object with xsl data. Xsl file to convert XSL-FO document into pdf document. Creates object with xsl data. Xsl stream to convert XSL-FO document into pdf document. The base path/url from which are searched relative pathes to external resources (if any) referenced in loaded SVG file. Save options for export to TeX format Property for parameter. Adds a font ancoding to the font encoding list The font encs. Clears the font encoding list Returns the number of pages after conversion. Save options for export to TeX format. Resource loading callback. Resource loading Represents resource loading result object. Initializes a new instance of the class. The resource data. Initializes a new instance of the class. The resource data. The encoding. Gets the resource data. Gets the encoding. Represents resource loading event arguments. Gets the URI. The URI. Initializes a new instance of the class. The URI path. Represents options for loading/importing TeX file into PDF document. Sets/Gets name of the font used for rendering math formulas. Resource loading callback. Sets/Gets callback object for info/errors notification. Sets/Gets name of the font used for rendering math formulas. Sets/Gets name of the font used for rendering special symbols, e.g. \sigma, \textbraceright, \vdots, etc. Sets/Gets the value indicating whether the LaTeX parser should save normalized content into a temp file or into memory. Represents options for loading/importing TeX file into PDF document. The color spaces enumeration. The device-dependent RGB color space. The device-dependent CMYK color space. The device-dependent gray color space. A group attributes class specifying the attributes of the page’s page group for use in the transparent imaging model. The constructor. Pdf page object. The group color space. Tab order on the page No tab order. Row order. Column order. Default tab order. Manual tab order. Represents options for loading/importing xps file into pdf document. Defines batch size if batched conversion is applicable to source and destination formats pair. Represents a table that can be added to the page. Gets or sets table background color Gets or sets break text for table Gets or sets the styles of the border corners Gets the style for repeating rows Gets or sets the maximum columns count for table Gets the first rows count repeated for several pages Gets the column widths of the table. Gets or sets table vertial broken; Gets default cell border; Gets default cell border; Gets the rows of the table. Gets or sets the border. Gets or sets the default cell padding. Gets or sets the default cell text state. Gets or sets the table alignment. Gets or sets the table left coordinate. Gets or sets the table top coordinate. Gets or sets the table is broken - will be truncated for next page. Gets or sets border included in column widhts. Gets or sets the table column adjustment. Get width. The table width Get height. The table height Set height. The column number. The text state for column. Imports one-dimensional array of data into table. Import goes one cell per each array's item and starts from row and column defined in parameters. During import, if detected that necessary rows are still absent(i.e. target table is too small to absorb all data), necessary rows will be created imported data, nulls will be imported as empty strings define number of first target row in target table from wich import will start. If amount of rows in target table less then required, missing rows will be created first. specifies number of first target column in target table , column must be present in target table before start of import If 'isLeftColumnsFilled'=false, then in second and all subsequent filled rows cells that are on the left hand from firstFilledColumn will be skipped Imports data from System.Data.DataTable into Aspose.Pdf.Table source instance of System.Data.DataTable specifies whether column names will be imported as first row specifies zero based number of first row in target table from which import will start, if row with such number(and some previous rows) are absent in target table, they will be created first specifies number of first target column in target table , column must be present in target table before start of import Imports a object into the table. The object to be imported. Specifies whether the column names of the source datatable will be imported as first row. specifies zero based number of first row in target table from which import will start, if row with such number(and some previous rows) are absent in target table, they will be created first specifies number of first target column in target table , column must be present in target table before start of import Maximum amount of rows to be imported from source table. Maximum amount of columns to be imported from source table. Specifies whether the text is html string. Imports a object, but not as whole entity. Only specified rows and columns are imported. The object to be imported. The array of numbers of rows in source object that must be imported. List must be not null and must contain only numbers of existing rows, otherwise exception will be thrown. The array of numbers of columns in source object that must be imported. List must be not null and must contain only numbers of existing columns, otherwise exception will be thrown. The zero based row number of the first cell in targer table from which import will start. If target table does not contain that row, it (and all previous if necessary) will be created The zero based column number of the first cell in targer table from which import will start. The target table must contain that column befor import starts, otherwise exception will be thrown. Specifies whether the column names of source datatable will be imported as first row. Specifies whether the text is html string. Imports a object's data into the table. The object to be imported. Indicates whether the column names will be imported as first row. The zero based row number of the first cell in targer table from which import will start. If target table does not contain that row, it (and all previous if necessary) will be created The zero based column number of the first cell in targer table from which import will start. The target table must contain that column before import starts, otherwise exception will be thrown. Maximum amount of rows to be imported from source dataview. Maximum columns to be imported from source dataview. Clone the table. The cloned object Represents a watermark of the page. Initializes a watermark object with an image and it's position on a page. Image of the watermark. Position of the watermark on the page. Initializes a watermark object with an image. Image of the watermark. Gets an image of the watermark. Gets a position of the watermark's image on a page. Gets a flag the watermark is present. Class represetns PDF Artifact object. Enumeration of possuble artifact types. Pagination artifacts. Ancillary page features such as running heads and folios (page numbers). Layout artifacts. Purely cosmetic typographical or design elements such as footnote rules or background screens. Page artifacts. Production aids extraneous to the document itself, such as cut marks and colour bars. Background artifacts. Images, patterns or coloured blocks. Artifact type is not defined or unknown. Enumeration of possible artifacts subtype. Header artifact. Footer artifact. Watermark artifact. Background artifact. Artifact subtype is not defined or unknown. Constructor of artifact with specified type and subtype Name of artifact type. NAme of artifact subtype. Constructor of artifact with specified type and subtype Artifact type. Artifact subtype. Gets name of artifact type. May be used if artifact type is non standard. Gets name of artifact subtype. May be used if artifact subtype is not standard subtype. Gets artifact type. Gets artifact subtype. If artifact has non-standard subtype, name of the subtype may be read via CustomSubtype. Gets collection of artifact internal operators. Gets XForm of the artifact (if XForm is used). Gets rectangle of the artifact. Gets or sets artifact position. If this property is specified, then margins and alignments are ignored. Right margin of artifact. If position is specified explicitly (in Position property) this value is ignored. Left margin of artifact. If position is specified explicitly (in Position property) this value is ignored. Top margin of artifact. If position is specified explicitly (in Position property) this value is ignored. Bottom margin of artifact. If position is specified explicitly (in Position property) this value is ignored. Horizontal alignment of artifact. If position is specified explicitly (in Position property) this value is ignored. Vertical alignment of artifact. If position is specified explicitly (in Position property) this value is ignored. Gets or sets artifact rotation angle. Gets text of the artifact. Gets image of the artifact (if presents). Gets or sets opacity of the artifact. Possible values are in range 0..1. Sets text of the artifact. FormattedText object which contains artifact text. Set text and text properties of the artifact. Text string. Text properties (color, Lines of multiline text artifact. Text state for artifact text. Set text and text properties of the artifact. Allows to specify multiple lines. Array of text string. Text properties. Sets image of the artifact. Stream which contains image data. Sets image of the artifact. Name of image file. Sets PDF page which is placed on the document page as artifact. Page which is placed as Artifcact. Dispose the artifact. Gets custom value of artifact. Name of value. Value, or null if value does not exists. Sets custom value of artifact. Name of custom value. Custom value in the artifact. Remove custom value from the artifact. Name of custom value to be removed. Start delated updates. Use this feature if you need make several changes to the same artifact to improve performance. Usually artifact operators are changed anytime when artifact property was changed. This causes changing of page contents everytime when artifact was changed. To avoid this effect put all artifact updates between StartUpdates/SaveUpdates calls. This allows to change page contents only once. Artifact art = doc.Pages[1].Artifacts[1]; art.BeginUpdates(); art.Opacity = 0.3f; art.Position = new Point(10,10); art.Rotation = 30; art.SaveUpdates(); Saves all updates in artifact which were made after BeginUpdates() call. If true Artifact is placed behind page contents. Class represents artifact collection. Is this object synchronized. Gets count of artifacts in collection. Gets synchronization object of the collection. Copies colection into an array. Destination array. Starting index. Gets enumerator for the collection. Enumerator object. Gets artifact by index. Index is started from 1. Index of the artifact. Artifact on the page. Adds artifacts to the collection. Artifact which sould be added to collection. Finds artifacts by custom value. Name of custom value. Value to find. List of found artifacts. Gets if collection is readonly. Always returns false. Deletes specified artifact. Artifact which will be deleted. Update artifact inside the collection. Artifact to be updated. Deletes artifact by its index. Index of artifact to delete. Class descibes background artifact. This artifact allows to set background of the page. Initializes BackgroundArtifact object. Gets or sets bacground color of background artifact Gets or sets bacground image of background artifact Describes footer artifact. This may be used to set footer of the page. Creates Footer Artifact instance. Class describes Heaader artifact. This artifacgt may be used to set heading of the page. Creates Header Artifact instance. Class describes watermark artifact. This may be used to Creates instance of Watermark artifact. Contains options for loading/importing EPUB file into pdf document. Gets or sets output page size for import. Represents mode of usage of margins area - defines treatement of instructions (if any) of CSS of imported document related to usage of margins. ATTENTION! The feature implemented but did not put yet to public API since blocker issue in OSHARED layer revealed for sample document. Represents mode of usage of page size during conversion. Formats (like HTML, EPUB etc), usually have float design, so, it allows to fit required pagesize. But sometimes content has specified horizontal positions or size that does not allow put content into required page size. In such case we can define what should be done in this case (i.e when size of content does not fit required initial page size of result PDF document). Gets reference on object that represent marging info. Creates default load options for converting EPUB file into pdf document. Default pdf page size - A4 300dpi 2480 X 3508. Creates load options with specified page size. Defines pdf page width and height. Save options for export to SVG format To property of such type You can assign delegate created from custom method that implements processing of external saving of image that was extracted from SVG created from PDF and must be saved as external resource during conversion of PDF to HTML. In such case processing (like self-made saving into stream or on disk) can be done in that custom code and that custom code must return path(or any another string without quotemarks) that will be afterwards incorporated into generated SVG instead of original supposed path to that image resource. In such case all the necessary actions for saving of image must be undertaken in code of supplied method, because saving of result in code of converter will be not in use. If processing for this or that file for some reason must be done by converter's code itself, not in custom code, please set in custom code flag 'CustomProcessingCancelled' of 'imageSavingInfo' parameter's variable It signals to converter that all the necessary steps for processing of that resource must be done in converter itself as if there was no any external custom code . represents information about saved image that can be use in custom code must return string that represents URL of image that will be put into SVG This field can contain saving strategy that must be used (if present) during conversion for customized handling of created referenced external images files (like embedded BMP or JPEG) embedded into saved SVG. That strategy must process resources and return string that represents desirable URI of saved resource in generated SVG. If processing for this or that file for some reason must be done by converter's code itself, not in custom code, please set in custom code flag 'CustomProcessingCancelled' of 'imageSavingInfo' parameter's variable It signals to converter that all the necessary steps for processing of that resource must be done in converter itself as if there was no any external custom code . enumerates possible types of image files that can be saved as external resources during during Pdf to SVG conversion Jpeg format Png format Bmp format Gif format Tiff format Unknown - means that converter cannot detect type of content itself This options defines whether will be created target directory (if absent yet) with same name as requested output file instead of requested output file itself. It so, that directory will contain all output SVG-images of pages (like described below). If no, output files of pages other then first one will be created exactly in requested directory as main output file, but will contain in file name suffix _[2...n], that is defined by page number, f.e. if You define output file "C:\AsposeTests\output.svg" and output will contain several svg-files of pages, then files of pages will be created also in directory "C:\AsposeTests\" and have names 'output.svg', 'output_2.svg', 'output_3.svg' etc. Specifies whether output will be created as one zip-archive. Please refer comment to 'TreatTargetFileNameAsDirectory' options to see rules of naming of svg-files of pages for multipage source document, that are also applied to zipped set of output files. Specifies whether to scale the output document from typographic points to pixels. This class represents set of data that related to external resource image file's saving during PDF to HTML conversion. represent type os saved image referenced in HTML. Set by converter and can be used in custom code to decide what should be done Save options for export to EPUB format When PDF file (that usually has fixed layout) is being converted, the conversion engine tries to perform grouping and multi-level analysis to restore the original document author's intent and produce result in flow layout. This property tunes that conversion for this or that desirable method of recognition of content. Full recognition mode, the engine tries to perform grouping and multi-level analysis to restore the original document author's intent and produce xhtml in flow layout. The main idea of this conversion is based on saving "natural" order of content rendering that is formed during processing of pdf documents. In the general cases pdf documents keep top-down\left-right rendering order (see attachment directions.png). This assumption allows to create a single-path algorithm that will transform Aps elements that have positions (fixed-layout) into flow formats like HTML,EPUB,DOC. This mode will be especially useful for converting from PDF(APS) into EPUB, because the EPUB format was developed for e-readers like the Kindle or smart-phones. The size of screen those devices usually is less than the size of screen of ordinary PC. Therefore the content of EPUB documents is better to save in the flow format, for correct rendering on screens with different sizes. In this mode every column will be added to the end of previous column this allows to keep the logical structure of transformed document during "pagination" in EPUB readers. This achievement allows correctly render scientific or magazine articles. This mode is fast and good for maximally preserving the original look pages, but unfortunately many EPUB readeres don't support xhtml with fixed layout When PDF file (that usually has fixed layout) is being converted, the conversion engine tries to perform grouping and multi-level analysis to restore the original document author's intent and produce result in flow layout. This property tunes that conversion for this or that desirable method of recognition of content. Save options for export to SVG format If set to true then all the content is recognized as images (one per page) Gets or sets the image resolution (dpi). Default is 192 dpi. If set to true then images are separated from all other graphics Toggles text columns recognition This handler can be used to handle conversion progress events f.e. it can be used to show progress bar or messages about current amount of processed pages, example of handler's code that shows progress on console is : public static void ConvertWithShowingProgress() { (new Aspose.Pdf.License()).SetLicense(@"F:\_Sources\Aspose_5\trunk\testdata\License\Aspose.Total.lic"); Document doc = new Document(@"F:\ExternalTestsData\Booklet.pdf"); HtmlSaveOptions saveOptions = new HtmlSaveOptions(); saveOptions.CustomProgressHandler = new HtmlSaveOptions.ConversionProgressEventHandler(ShowProgressOnConsole); doc.Save(@"F:\ExternalTestsData\Booklet.doc", saveOptions); Console.ReadLine(); } public static void ShowProgressOnConsole(HtmlSaveOptions.ProgressEventHandlerInfo eventInfo) { switch (eventInfo.EventType) { case HtmlSaveOptions.ProgressEventType.TotalProgress: Console.WriteLine(string.Format("{0} - Conversion progress : {1}% .", DateTime.Now.ToLongTimeString(), eventInfo.Value.ToString())); break; case HtmlSaveOptions.ProgressEventType.SourcePageAnalized: Console.WriteLine(string.Format("{0} - Source page {1} of {2} analyzed.", DateTime.Now.ToLongTimeString(), eventInfo.Value.ToString(), eventInfo.MaxValue.ToString())); break; case HtmlSaveOptions.ProgressEventType.ResultPageCreated: Console.WriteLine(string.Format("{0} - Result page's {1} of {2} layout created.", DateTime.Now.ToLongTimeString(), eventInfo.Value.ToString(), eventInfo.MaxValue.ToString())); break; case HtmlSaveOptions.ProgressEventType.ResultPageSaved: Console.WriteLine(string.Format("{0} - Result page {1} of {2} exported.", DateTime.Now.ToLongTimeString(), eventInfo.Value.ToString(), eventInfo.MaxValue.ToString())); break; default: break; } }