GrapeCity.Documents.Pdf Namespace (GrapeCity.Documents.Pdf)

In This Topic

Classes

	Class	Description
	AFRelationship	Contains string constants with predefined values for FileSpecification.Relationship property.
	ContentStream	Base abstract class for classes representing content streams in a GcPdfDocument.
	DecryptionOptions	Represents decryption options used when loading a PDF document.
	Destination	The abstract base class for types representing a destination that defines a particular view of a document. A destination consists of: The page of the document to be displayed. The location of the document window on that page. The magnification (zoom factor) to use when displaying the page. Important note about vertical coordinates: In PDFs, all coordinates are specified relative to the bottom left corner, with the Y axis going up. GcPdf uses the more common coordinate system with the origin in the top left corner, with the Y axis going down. In most situations the Y coordinates are automatically converted by GcPdf. In classes derived from Destination this is also done if the destination's target page is specified as the Page object. But if the destination's target page is specified by index, automatic conversion of the Y coordinate cannot be done, and it should be specified relative to the bottom left corner as per the PDF spec. When the Y coordinate is specified relative to the page bottom, it is noted in the parameter's description. (It is recommended that constructors accepting a Page object are used instead.) All properties defining the Y coordinate has linked property with "Pdf" prefix, for example Y and PdfY, the property with "Pdf" prefix contains a value relative to the bottom left corner with the Y axis going up.
	DestinationBase	Base class for classes defining destination within document.
	DestinationFit	Display the page designated by 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.
	DestinationFitB	Display the page designated by 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.
	DestinationFitBH	Display the page designated by 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.
	DestinationFitBV	Display the page designated by 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.
	DestinationFitH	Display the page designated by 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.
	DestinationFitR	Display the page designated by page, with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top 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 rectangle within the window in the other dimension.
	DestinationFitV	Display the page designated by 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.
	DestinationRef	Defines destination as reference to another destination, referenced destination can be in Dests dictionary of PDF document or in Dests subtree of Name Tree.
	DestinationUnknown	Represents a destination object in a format that is unsupported by GcPdf.
	DestinationXYZ	Display the page designated by 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.
	DocAction	Abstract base class for GrapeCity.Documents.Pdf.Actions.ActionBase and DestinationBase.
	DocumentInfo	Contains information about the document. This information includes the document author, title, keywords, etc.
	EmbeddedFileStream	Represents embedded file stream in PDF.
	ExportFormDataOptions	Represents options used by GcPdfDocument.ExportFormDataToFDF, GcPdfDocument.ExportFormDataToFDF, GcPdfDocument.ExportFormDataToXFDF, GcPdfDocument.ExportFormDataToXFDF, GcPdfDocument.ExportFormDataToXML and GcPdfDocument.ExportFormDataToXML methods.
	FileSpecification	Represents a PDF File Specification. The complex architecture of this class is based on the PDF Specification, for full details please consult that spec. In many practical scenarios while generating PDFs, using the provided static constructors on the derived classes (FileSpecification, EmbeddedFileStream etc.) may be enough though.
	FileSpecification.FileInfo	Represents information about a file for a particular platform.
	FileSpecification.RelatedFile	Represents information about a related file.
	FileSpecification.RelatedFileCollection	Represents a collection of FileSpecification.RelatedFile objects.
	FindTextParams	Represents find text parameters.
	FontHandler	Represents and manages a GrapeCity.Documents.Text.Font used in a GcPdfDocument.
	FontHandlerCollection	Represents a collection of FontHandler objects.
	FoundPosition	Defines a position in the page of the GcPdfDocument where a text was found.
	GcGraphicsExt	Provides extension methods that draw certain PDF elements (such as AcroForm fields) on a GrapeCity.Documents.Drawing.GcGraphics.
	GcPdfDocument	Represents a PDF document. The object model provided by this class follows the PDF 1.7 Reference specification.
	GcPdfDocument.FontsUsageStats	Represents statistical data about fonts and font optimizations. An instance of this class is created and returned by the GcPdfDocument.OptimizeFonts method.
	GcPdfDocument.FontsUsageStats.FontInfo	Represents information about a font and its usage in a PDF.
	GcPdfDocument.FontsUsageStats.FontSubsetInfo	Represents a font subset and its usage in a PDF.
	GcPdfDocument.FontsUsageStats.MergeInfo	Represents information about fonts that were merged.
	GcPdfGraphics	Represents a graphics object that can be used to draw on a PDF page. The origin (0,0) is in the top left corner of the page, the axis go right and down. All coordinates and sizes are expressed in printer points (1/72 of an inch) by default. This can be changed using the Resolution property.
	ImageOptions	Represents options controlling how native images are processed when inserted in a PDF file.
	MergeDocumentOptions	Represents the various options controlling the behavior of the GcPdfDocument.MergeWithDocument method.
	Metadata	Represents XMP metadata associated with a document.
	Metadata.UserProp	Represents a custom metadata property. Note that the only allowed namespaces are: "http://purl.org/dc/elements/1.1/" (Dublin Core Properties) "http://ns.adobe.com/xap/1.0/" (XMP Core Properties) "http://ns.adobe.com/pdf/1.3/" (PDF Properties) Attempting to add a property with a different namespace will throw an exception.
	OptimizeFontsOptions	Represents options controlling the behavior of the GcPdfDocument.OptimizeFonts method.
	OutlineNode	Defines the outline node within PDF document.
	OutlineNodeCollection	Defines the collection of OutlineNode objects.
	OutputIntent	Represents a PDF Output Intent. Output intents provide a means for matching the color characteristics of page content in a PDF document with those of a target output device or production environment in which the document will be printed.
	Page	Represents a page in a GcPdfDocument.
	PageCollection	A collection of Page objects that make up a PDF document.
	PageContentStream	Defines content stream of the page of GcPdfDocument.
	PageLabelingRange	Represents a page labeling range. A document is divided into labeling ranges, each of which is a series of consecutive pages using the same numbering system. Labeling ranges shall not overlap, so that each page shall have only one label. Pages within a range shall be numbered sequentially in ascending order. A page's label consists of a numeric portion based on its position within its labeling range, optionally preceded by a label prefix denoting the range itself.
	PdfException	Represents an exception that occurred while processing a PDF document.
	PdfImageInfo	Represents an image and its locations in a PDF document.
	PdfImageLocation	Represents a position of an image in a PDF document.
	PdfPasswordException	Represents an exception that occurred if an invalid password was used while parsing PDF content.
	PdfSecurityException	Represents an exception that occurred while performing a security related task such as signing, encrypting, decrypting etc.
	Pkcs7SignatureBuilder	Implements the ISignatureBuilder interface, can be used to build a PKCS#7 signature.
	RawImage	Represents an image natively supported by the PDF format. Raw images are inserted into PDF as is, without any processing.
	RedactOptions	Represents additional options to use when a document is being redacted.
	RedactOptions.RenderOptionsDef	Represents options that are used when a redact action requires that some PDF content is rendered as an image.
	RenderingCache	Represents a cache used to speed up rendering. An instance of this class can be passed to Page.Draw, Page.DrawAnnotations, Page.DrawAnnotations methods to improve the rendering speed.
	SaveAsImageOptions	Represents options used by the SaveAs* methods on GcPdfDocument and Page, such as GcPdfDocument.SaveAsJpeg, Page.SaveAsJpeg, etc.
	SignatureAppearance	Represents properties used to generate signature appearance when a document is signed.
	SignatureProperties	Represents properties used to sign a PDF document.
	SoundEncodingFormat	Defines possible encoding formats for sample data in a SoundObject.
	SoundObject	Represents a sound object, which is a stream containing sample values that define a sound to be played through the computer's speakers.
	StandardFonts	Contains 14 Standard PDF fonts.
	TimeStamp	Encapsulates the information that is used to include timestamps from a Time Stamping Authority into digital signatures in PDF documents.
	TimeStampProperties	Represents properties used to time stamp a PDF document.
	TransitionEffect	Represents a page transition effect, describing the style and duration of the visual transition to use when moving from another page to the given page during a presentation.
	TriggerEvents	Abstract base class for all classes defining set of events associated with some PDF object: annotation, AcroForm field etc.
	ViewerPreferences	Represents viewer preferences to be used when displaying the document.

Interfaces

	Interface	Description
	ICMapProvider	This interface is used by GcPdfDocument to request predefined CMap tables from external sources.
	IPdfImage	Provides access to an image in a PDF document.
	IPkcs7SignatureGenerator	Defines properties and methods that are used to sign the attribute set in a PKCS#7 signature.
	ISignatureBuilder	Defines methods used to build the signature PDF dictionary and the binary signature container that is stored as Contents entry in the signature PDF dictionary.
	ISignatureParser	Defines properties and methods that allow parsing and validating an existing PDF binary signature that is stored in the /Contents property of the PDF signature dictionary.
	ITextLayoutHandler	Provides a mechanism for receiving callback notifications when a GrapeCity.Documents.Text.TextLayout is rendered on a GcPdfGraphics.
	ITimeStampGenerator	Defines methods used to generate time-stamp tokens. This interface is implemented by the TimeStamp class. It can also be implemented in user code to provide customized time-stamp token generation, see TimeStampProperties.TimeStamp.

Structures

	Structure	Description
	PdfDateTime	Represents a PDF DateTime type.
	PdfEnum<TEnum>	Represents a PDF enumeration type.

Delegates

	Delegate	Description
	GcPdfDocument.SaveAsImageDelegate	Defines the method signature called for each page when GcPdfDocument.SaveAsImage is called.
	TimeStamp.HashDelegate	Represents a delegate used to calculate the hash over data. The data can be represented by an array of bytes or by a System.IO.Stream. Outputs the hash value and the hash algorithm OID.

Enumerations

	Enumeration	Description
	AnnotationsTabsOrder	Defines possible values for annotations tabs order.
	AudioFormat	Defines audio formats supported by SoundObject.
	Duplex	(PDF 1.7) The paper handling option to use when printing the file from the print dialog.
	FontEmbedMode	Specifies available font embedding modes.
	ImageOptions.ImageFormat	Defines formats that can be used to encode images in a PDF.
	LineCapStyle	Specifies the shape to be used at the ends of open subpaths (and dashes, if any) when they are stroked.
	LineJoinStyle	Specifies the shape to be used at the corners of paths that are stroked. Join styles are significant only at points where consecutive segments of a path connect at an angle; segments that meet or intersect fortuitously receive no special treatment.
	NonFullScreenPageMode	Specifies how the document should be displayed on exiting full-screen mode.
	NumberingStyle	Defines possible numbering styles.
	OutlineMergeMode	Specifies how outlines are handled when merging two documents.
	OutlineNode.FontStyle	Defines possible styles of outline text.
	PageBoundary	Specifies the types of page boundaries. See PDF specification for details.
	PageLayout	Specifies the page layout to be used when the document is opened.
	PageMode	Specifies how the document should be displayed when opened.
	PdfAConformanceLevel	Defines the PDF conformance levels.
	Pkcs7SignatureBuilder.SignatureFormat	Defines the supported signature formats.
	PrintScaling	(PDF 1.6) The page scaling option to be selected when a print dialog is displayed for this document.
	RawImageFormat	Specifies a format of RawImage.
	ReadingDirection	Specifies the possible predominant reading order for text.
	RenderingIntent	Defines possible PDF rendering intents.
	SaveMode	Defines the modes of saving a PDF.
	SignatureDigestAlgorithm	Defines digest algorithms used to generate signatures.
	SignatureFormat	Defines signature formats supported by GcPdfDocument.
	TextRenderingMode	PDF text rendering mode.
	TransitionDimension	Defines the possible dimensions in which the transition effect shall occur.
	TransitionDirection	Defines the possible directions in which the specified transition effect shall moves.
	TransitionMotionDirection	Defines the possible directions of motion for a transition effect.
	TransitionStyle	Defines the possible transition styles.
	VariableTextJustification	Specifies text justification to be used when displaying variable text in GrapeCity.Documents.Pdf.Annotations.FreeTextAnnotation, GrapeCity.Documents.Pdf.Annotations.WidgetAnnotation etc.

Reference

GrapeCity.Documents.Pdf Assembly