Documents for PDF, .NET Edition Documentation
Page Class Members
Properties  Methods 

GrapeCity.Documents.Pdf Assembly > GrapeCity.Documents.Pdf Namespace : Page Class

The following tables list the members exposed by Page.

Public Properties
 NameDescription
Public PropertyAnnotationsGets the list annotations associated with the current page.  
Public PropertyAnnotationsTabsOrderGets or sets the tab order to be used for annotations on the page.  
Public PropertyArtBoxGets or sets a rectangle, in points, defining the extent of the page's meaningful content (including potential white space) as intended by the page's creator. Default value is CropBox.  
Public PropertyArticleBeadsGets the list of GrapeCity.Documents.Pdf.Articles.ArticleBead objects displayed on this page.  
Public PropertyAssociatedFilesGets the list of embedded files associated with this page.  
Public PropertyBleedBoxGets or sets a rectangle, in points, defining the region to which the contents of the page should be clipped when output in a production environment. Default value is CropBox.  
Public PropertyBoundsGets the bounds of the current page in points. The return value is the same as returned by MediaBox.  
Public PropertyContentStreamsGets the PageContentStreamCollection containing content streams representing content of this page.

Note that while manipulating the ContentStreams collection (inserting, removing or moving elements) is allowed, the result of such manipulations may produce an invalid PDF if the original document was created or modified by a tool other than GcPdf. Generally speaking, it is safe to insert new content streams at the first position in the collection, or add them to the end of it, provided any content in the new stream(s) was created by rendering on PageContentStream.GetGraphics. Any other operations on this collection in documents that were not created by GcPdf might yield invalid PDFs.

 
Public PropertyCropBoxGets or sets a rectangle, in points, defining the visible region of default user space. When the page is displayed or printed, its contents are to be clipped (cropped) to this rectangle and then imposed on the output medium in some implementation-defined manner. Default value is MediaBox.  
Public PropertyDocGets the GcPdfDocument object owning this object.  
Public PropertyGraphicsGets an instance of GcPdfGraphics that can be used to draw on the current page, graphics created from the last page content stream, if ContentStreams collection is empty then new PageContentStream automatically added.  
Public PropertyIndexGets the index of the page in its document.  
Public PropertyLandscapeGets or sets a value indicating whether the current page has landscape orientation.  
Public PropertyMediaBoxGets or sets the bounds of the page in points.  
Public PropertyOwnerGets the PageCollection collection containing this Page.  
Public PropertyPaperKindGets or sets the paper kind of the current page.  
Public PropertyRotateGets or sets the number of degrees by which the page should be rotated clockwise when displayed or printed. The value must be a multiple of 90. Default value: 0.  
Public PropertySizeGets or sets the size of the current page in points.  
Public PropertyTagGets or sets an arbitrary application-defined object associated with the current page.  
Public PropertyTransitionDurationGets or sets the page’s display duration (also called its advance timing): the maximum length of time, in seconds, that the page shall be displayed during presentations before the viewer application shall automatically advance to the next page Default: null (the viewer shall not advance automatically).  
Public PropertyTransitionEffectGets or sets the TransitionEffect object describing the transition effect that shall be used when displaying the page during presentations  
Public PropertyTrimBoxGets or sets a rectangle, in points, defining the intended dimensions of the finished page after trimming Default value is CropBox.  
Public PropertyUserUnitGets or sets a positive number greater than 1 giving the size of default user space units, in multiples of 1/72 inch.

Default value: 1.0 (user unit is 1/72 inch).

 
Top
Public Methods
 NameDescription
Public MethodDrawDraws the page on a GrapeCity.Documents.Drawing.GcGraphics.  
Public MethodDrawAnnotationsOverloaded. Draws specified annotations on a GrapeCity.Documents.Drawing.GcGraphics.

Note that the specified annotations must belong to the current page.

 
Public MethodGetImagesGets the list of images on this page.  
Public MethodGetLabelReturns the page label specified via PageLabelingRange, returns empty string if page does not belong to document.  
Public MethodGetPageLabelingRangeGets the PageLabelingRange object that specifies the label of this page, or null if no such range exists.  
Public MethodGetRenderSizeGets the size of the page on a device with specified horizontal and vertical resolutions.  
Public MethodGetStreamGets a System.IO.Stream containing the content of this Page.

Notes:

  1. The stream returned by this method should be disposed after use.
  2. This method can return null if the current page is empty.
  3. In sequential generate mode this method is not supported and will throw an exception.
 
Public MethodGetTextRetrieves all text on the current page.  
Public MethodGetTextMapBuilds and returns a GrapeCity.Documents.Pdf.TextMap.ITextMap for this page.  
Public MethodGetUsedFontsGets the list of fonts referenced from content streams on this page.  
Public MethodGetUserToDeviceMatrixReturns the matrix used to convert coordinates in content stream of this page to device coordinates.  
Public MethodSaveAsBmpOverloaded. Saves the page as an image to a stream in BMP format.  
Public MethodSaveAsGifOverloaded. Saves the page as an image to a stream in GIF format.  
Public MethodSaveAsJpegOverloaded. Saves the page as an image to a stream in JPEG format.  
Public MethodSaveAsPngOverloaded. Saves the page as an image to a stream in PNG format.  
Public MethodSaveAsTiffOverloaded. Saves the page as an image to a stream in TIFF format.  
Top
See Also

Reference

Page Class
GrapeCity.Documents.Pdf Namespace

 

 

Copyright © GrapeCity, Inc. All rights reserved.

Product Support Forum | Print this page