Document Solutions for PDF
DS.Documents.Pdf Assembly / GrapeCity.Documents.Pdf Namespace / Page Class
Properties Methods

In This Topic
    Page Class Members
    In This Topic

    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 PropertyObjIDGets the PDF object ID. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public PropertyOwnerGets the PageCollection collection containing this Page.  
    Public PropertyPaperKindGets or sets the paper kind of the current page.  
    Public PropertyPdfDictGets the underlying GrapeCity.Documents.Pdf.Spec.IPdfDict. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfDictWrapper)
    Public PropertyPdfObjectGets the underlying GrapeCity.Documents.Pdf.Spec.IPdfObject. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapper<IPdfDict>)
    Public PropertyPieceInfoGets the GrapeCity.Documents.Pdf.Spec.IPdfDict object defining page-piece dictionary associated with the 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.

    This property is a wrapper around MediaBox or CropBox properties. If CropBox is not null then this property gets or sets its value, otherwise it gets or sets the value of MediaBox.

     
    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 MethodAdjustCoordinatesOverloaded. Converts specified visual coordinates (usually in the coordinate system with the origin in the top left corner of the page and the Y axis going down, see fromBottomLeft) to coordinates that take into account Rotate, CropBox and MediaBox (if CropBox is not specified) values.

    This method should be used when positioning annotations or destinations on a page. Do not use this method when drawing on Graphics.

     
    Public MethodDeleteTextOverloaded. Deletes a specified text from the current page.  
    Public MethodDrawOverloaded. Draws 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 MethodGetImagesOverloaded. Gets 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 MethodGetOperatorsReturns the list of PDF operators forming the page content.  
    Public MethodGetPageLabelingRangeGets the PageLabelingRange object that specifies the label of this page, or null if no such range exists.  
    Public MethodGetPdfStreamGets the System.IO.Stream object containing the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. Note! The stream should be disposed after usage. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public MethodGetPdfStreamDataGets the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public MethodGetPdfStreamInfoGets the GrapeCity.Documents.Pdf.Spec.PdfStreamInfo object containing the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. Note! The stream should be disposed after usage. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    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 MethodGetTableOverloaded. Tries to recognize a table within specified bounds, if the table is found returns an object that allows accessing the table's rows, columns and cells.  
    Public MethodGetTextOverloaded. Retrieves all text on the current page.  
    Public MethodGetTextMapOverloaded. Builds and returns a text map for the current page.

    Note that the X/Y resolutions of pixels used by the text map's methods and properties are the X/Y resolutions passed to this method (dpiX and dpiY).

    Note also that the current value of the RecognitionAlgorithm property affects the map that is created.

     
    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 MethodRemoveLayersContentRemoves the content associated with specified PDF layers.

    Note that if any content was removed from a page by this method, all remaining content on that page will be merged into a single content stream, and the ContentStreams collection will contain just that single element.

     
    Public MethodReplaceTextOverloaded. Replaces a specified text on the current page.

    Note that the results may be affected by the current value of the GrapeCity.Documents.Pdf.Recognition.RecognitionAlgorithm property.

     
    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 MethodSaveAsSvgOverloaded. Saves the page to a stream in SVG format.  
    Public MethodSaveAsTiffOverloaded. Saves the page as an image to a stream in TIFF format.  
    Public MethodToSvgzOverloaded. Saves the page to a byte array in SVGZ format.  
    Top
    See Also

    Reference

    Page Class
    GrapeCity.Documents.Pdf Namespace