Reference Guide
GdPicture14.WPF Namespace / GdViewer Class / GetRegionPage Method
A unique region identifier of the specified region. You can obtain this identifier using the GetRegionID method or when creating regions using the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method.
Example





In This Topic
    GetRegionPage Method (GdViewer)
    In This Topic
    Gets the number of the page on which a highlighted region is drawn (placed). The region is specified by its unique identifier related to the document currently displayed in the GdViewer control. These regions, if present, determines the currently defined highlighted regions on the displayed document.

    You can redefine the page of each highlighted region using the SetRegionPage method.

    Syntax
    'Declaration
     
    
    Public Function GetRegionPage( _
       ByVal RegionID As Integer _
    ) As Integer
    public int GetRegionPage( 
       int RegionID
    )
    public function GetRegionPage( 
        RegionID: Integer
    ): Integer; 
    public function GetRegionPage( 
       RegionID : int
    ) : int;
    public: int GetRegionPage( 
       int RegionID
    ) 
    public:
    int GetRegionPage( 
       int RegionID
    ) 

    Parameters

    RegionID
    A unique region identifier of the specified region. You can obtain this identifier using the GetRegionID method or when creating regions using the AddRegion(String,Double,Double,Double,Double,Color,RegionFillMode) method.

    Return Value

    The number of the page, where the specified region is drawn. Please always use the GetStat method to determine if this method has been successful.
    Remarks
    Be aware that if the required region does not exist, the method will fail.
    Example
    How to draw a rectangle on the document's page according to the user's selection of the highlighted rectangle in the GdViewer control.
    'We assume that the GdViewer1 control has been properly integrated
    'and some PDF document is loaded and displayed as well.
                
    'Here we make use of the RegionSelected event.
    Sub GdViewer1_RegionSelected(ByVal sender As Object, ByVal e As GdPicture14.WPF.GdViewer.RegionSelectedEventArgs)
        Dim page As Integer = GdViewer1.GetRegionPage(e.RegionID)
        'Converting pixels to PDF points.
        Dim left As Integer = GdViewer1.GetRegionLeftPixels(e.RegionID) * 0.75
        Dim top As Integer = GdViewer1.GetRegionTopPixels(e.RegionID) * 0.75
        Dim width As Integer = GdViewer1.GetRegionWidthPixels(e.RegionID) * 0.75
        Dim height As Integer = GdViewer1.GetRegionHeightPixels(e.RegionID) * 0.75
        Using oPDF As GdPicturePDF = New GdPicturePDF()
            If oPDF.LoadFromFile(GdViewer1.GetLastPath(), False) = GdPictureStatus.OK Then
                oPDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitPoint)
                oPDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
                'Drawing a rectangle on the document's page according to the selected rectangle in the GdViewer1 control.
                If (oPDF.SelectPage(page) = GdPictureStatus.OK) AndAlso
                   (oPDF.SetFillAlpha(150) = GdPictureStatus.OK) AndAlso
                   (oPDF.SetFillColor(0, 191, 255) = GdPictureStatus.OK) AndAlso
                   (oPDF.DrawRectangle(left, top, width, height, True, False) = GdPictureStatus.OK) Then
                    If oPDF.SaveToFile("test_region.pdf") = GdPictureStatus.OK Then
                        MessageBox.Show("The file has been saved successfully.", "GdViewer.GetRegionPage")
                    Else
                        MessageBox.Show("The file can't be saved. Status: " + oPDF.GetStat().ToString(), "GdViewer.GetRegionPage")
                    End If
                Else
                    MessageBox.Show("The graphics operations have failed. Status: " + oPDF.GetStat().ToString(), "GdViewer.GetRegionPage")
                End If
            Else
                MessageBox.Show("The file can't be loaded. Status: " + oPDF.GetStat().ToString(), "GdViewer.GetRegionPage")
            End If
        End Using
    End Sub
    //We assume that the GdViewer1 control has been properly integrated.
    //and some PDF document is loaded and displayed as well.
                
    //Here we make use of the RegionSelected event.
    void GdViewer1_RegionSelected(object sender, GdPicture14.WPF.GdViewer.RegionSelectedEventArgs e)
    {
        int page = GdViewer1.GetRegionPage(e.RegionID);
        //Converting pixels to PDF points.
        int left = (int)(GdViewer1.GetRegionLeftPixels(e.RegionID) * 0.75);
        int top = (int)(GdViewer1.GetRegionTopPixels(e.RegionID) * 0.75);
        int width = (int)(GdViewer1.GetRegionWidthPixels(e.RegionID) * 0.75);
        int height = (int)(GdViewer1.GetRegionHeightPixels(e.RegionID) * 0.75);
        using (GdPicturePDF oPDF = new GdPicturePDF())
        {
            if (oPDF.LoadFromFile(GdViewer1.GetLastPath(), false) == GdPictureStatus.OK)
            {
                oPDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitPoint);
                oPDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
                //Drawing a rectangle on the document's page according to the selected rectangle in the GdViewer1 control.
                if ((oPDF.SelectPage(page) == GdPictureStatus.OK) &&
                    (oPDF.SetFillAlpha(150) == GdPictureStatus.OK) &&
                    (oPDF.SetFillColor(0, 191, 255) == GdPictureStatus.OK) &&
                    (oPDF.DrawRectangle(left, top, width, height, true, false) == GdPictureStatus.OK))
                {
                    if (oPDF.SaveToFile("test_region.pdf") == GdPictureStatus.OK)
                        MessageBox.Show("The file has been saved successfully.", "GdViewer.GetRegionPage");
                    else
                        MessageBox.Show("The file can't be saved. Status: " + oPDF.GetStat().ToString(), "GdViewer.GetRegionPage");
                }
                else
                    MessageBox.Show("The graphics operations have failed. Status: " + oPDF.GetStat().ToString(), "GdViewer.GetRegionPage");
            }
            else
                MessageBox.Show("The file can't be loaded. Status: " + oPDF.GetStat().ToString(), "GdViewer.GetRegionPage");
        }
    }
    See Also