Specifies if the hidden text objects will be ignored. Hidden text is usually text with a text rendering mode which makes it invisible on the page.
Example





In This Topic

IsPageImage(Boolean) Method

In This Topic
Returns if the currently selected page of the loaded PDF is entirely image-based ignoring or not the hidden text according to the parameter you have specified.

Image-based pages are considered to contain nothing but one fully visible image covering the whole page area. This image must not be in any way rotated and must not contain any other particular drawing operation such as a clipping path.

Syntax
'Declaration

 

Public Overloads Function IsPageImage( _

   ByVal IgnoreHiddenText As Boolean _

) As Boolean
public bool IsPageImage( 

   bool IgnoreHiddenText

)
public function IsPageImage( 

    IgnoreHiddenText: Boolean

): Boolean; 
public function IsPageImage( 

   IgnoreHiddenText : boolean

) : boolean;
public: bool IsPageImage( 

   bool IgnoreHiddenText

) 
public:

bool IsPageImage( 

   bool IgnoreHiddenText

) 

Parameters

IgnoreHiddenText
Specifies if the hidden text objects will be ignored. Hidden text is usually text with a text rendering mode which makes it invisible on the page.

Return Value

true if the currently selected page is entirely image-based as defined above, otherwise false. The GdPicturePDF.GetStat method can be subsequently used to determine if this method has been successful.
Remarks
This method is only allowed for use with non-encrypted documents.

It is recommend to use the GdPicturePDF.GetStat method to identify the specific reason for the method's failure, if any.

Example
How to find out if pages in the PDF document are image-based or not ignoring any hidden text if present.
Dim caption As String = "Example: IsPageImage"

Dim gdpicturePDF As New GdPicturePDF()

Dim status As GdPictureStatus = gdpicturePDF.LoadFromFile("image.pdf", False)

If status = GdPictureStatus.OK Then

    Dim pageCount As Integer = gdpicturePDF.GetPageCount()

    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then

        Dim result As Boolean = False

        For i As Integer = 1 To pageCount

            status = gdpicturePDF.SelectPage(i)

            If status = GdPictureStatus.OK Then

                result = gdpicturePDF.IsPageImage(True)

                status = gdpicturePDF.GetStat()

                If status = GdPictureStatus.OK Then

                    If result Then

                        MessageBox.Show("The page nr." + i.ToString() + " IS image-based.", caption)

                    Else

                        MessageBox.Show("The page nr." + i.ToString() + " IS NOT image-based.", caption)

                    End If

                Else

                    MessageBox.Show("The IsPageImage() method has failed with the status: " + status.ToString(), caption)

                End If

            Else

                MessageBox.Show("The SelectPage() method has failed with the status: " + status.ToString(), caption)

            End If

        Next

        MessageBox.Show("Finished successfully.", caption)

    Else

        MessageBox.Show("The GetPageCount() method has failed with the status: " + status.ToString(), caption)

    End If

Else

    MessageBox.Show("The file can't be loaded.", caption)

End If

gdpicturePDF.Dispose()
string caption = "Example: IsPageImage";

GdPicturePDF gdpicturePDF = new GdPicturePDF();

GdPictureStatus status = gdpicturePDF.LoadFromFile("image.pdf", false);

if (status == GdPictureStatus.OK)

{

    int pageCount = gdpicturePDF.GetPageCount();

    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)

    {

        bool result = false;

        for (int i = 1; i <= pageCount; i++)

        {

            status = gdpicturePDF.SelectPage(i);

            if (status == GdPictureStatus.OK)

            {

                result = gdpicturePDF.IsPageImage(true);

                status = gdpicturePDF.GetStat();

                if (status == GdPictureStatus.OK)

                {

                    if (result)

                    {

                        MessageBox.Show("The page nr." + i.ToString() + " IS image-based.", caption);

                    }

                    else

                    {

                        MessageBox.Show("The page nr." + i.ToString() + " IS NOT image-based.", caption);

                    }

                }

                else

                {

                    MessageBox.Show("The IsPageImage() method has failed with the status: " + status.ToString(), caption);

                }

            }

            else

            {

                MessageBox.Show("The SelectPage() method has failed with the status: " + status.ToString(), caption);

            }

        }

        MessageBox.Show("Finished successfully.", caption);

    }

    else

    {

        MessageBox.Show("The GetPageCount() method has failed with the status: " + status.ToString(), caption);

    }

}

else

{

    MessageBox.Show("The file can't be loaded.", caption);

}

gdpicturePDF.Dispose();
See Also