The 0-based index of the image within the current page. It must be a value from 0 to GetPageImageCount-1.
Example





In This Topic
GdPicture14 Namespace / GdPicturePDF Class / GetPageImageColorSpace Method

GetPageImageColorSpace Method (GdPicturePDF)

In This Topic
Returns the color space of an image, specified by its index within the currently selected page of the loaded PDF document.
Syntax
'Declaration

 


Public Function GetPageImageColorSpace( _

   ByVal ImageIdx As Integer _

) As PdfColorSpace
public PdfColorSpace GetPageImageColorSpace( 

   int ImageIdx

)
public function GetPageImageColorSpace( 

    ImageIdx: Integer

): PdfColorSpace; 
public function GetPageImageColorSpace( 

   ImageIdx : int

) : PdfColorSpace;
public: PdfColorSpace GetPageImageColorSpace( 

   int ImageIdx

) 
public:

PdfColorSpace GetPageImageColorSpace( 

   int ImageIdx

)

Parameters

ImageIdx
The 0-based index of the image within the current page. It must be a value from 0 to GetPageImageCount-1.

Return Value

A member of the PdfColorSpace enumeration. A color space of a specified image.

The 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 GetStat method to identify the specific reason for the method's failure, if any.

Example
How to find out the colorspace of all images contained within the PDF document. 
Dim caption As String = "Example: GetPageImageColorSpace"

Dim gdpicturePDF As New GdPicturePDF()

If gdpicturePDF.LoadFromFile("test.pdf", False) = GdPictureStatus.OK Then

    Dim message As String = ""

    Dim imageCount As Integer = 0

    Dim colorspace As PdfColorSpace = PdfColorSpace.PdfColorSpaceUnknown

    Dim pageCount As Integer = gdpicturePDF.GetPageCount()

    Dim status As GdPictureStatus = gdpicturePDF.GetStat()

    If (status = GdPictureStatus.OK) AndAlso (pageCount > 0) Then

        For i As Integer = 1 To pageCount

            If gdpicturePDF.SelectPage(i) = GdPictureStatus.OK Then

                message = message + "Page nr." + i.ToString() + ":" + vbCrLf

                imageCount = gdpicturePDF.GetPageImageCount()

                status = gdpicturePDF.GetStat()

                If (status = GdPictureStatus.OK) AndAlso (imageCount > 0) Then

                    For j As Integer = 0 To imageCount - 1

                        colorspace = gdpicturePDF.GetPageImageColorSpace(j)

                        status = gdpicturePDF.GetStat()

                        If status = GdPictureStatus.OK Then

                            message = message + "The image indexed as " + j.ToString() + " has the following color space: " + colorspace.ToString() + "." + vbCrLf

                        Else

                            message = message + "The GetPageImageColorSpace() method has failed for the image nr. " + j.ToString() + " with the status: " + status.ToString() + vbCrLf

                        End If

                    Next

                Else

                    If status = GdPictureStatus.OK Then

                        message = message + "This page doesn't contain any image." + vbCrLf

                    Else

                        message = message + "The GetPageImageCount() method has failed for the page nr. " + i.ToString() + " with the status: " + status.ToString() + vbCrLf

                    End If

                End If

            Else

                message = message + "The SelectPage() method has failed for the image nr. " + i.ToString() + " with the status: " + gdpicturePDF.GetStat().ToString() + vbCrLf

            End If

        Next

        MessageBox.Show(message, caption)

    Else

        If status = GdPictureStatus.OK Then

            MessageBox.Show("This file doesn't contain any page.", caption)

        Else

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

        End If

    End If

Else

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

End If

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

GdPicturePDF gdpicturePDF = new GdPicturePDF();

if (gdpicturePDF.LoadFromFile("test.pdf", false) == GdPictureStatus.OK)

{

    string message = "";

    int imageCount = 0;

    PdfColorSpace colorspace = PdfColorSpace.PdfColorSpaceUnknown;

    int pageCount = gdpicturePDF.GetPageCount();

    GdPictureStatus status = gdpicturePDF.GetStat();

    if ((status == GdPictureStatus.OK) && (pageCount > 0))

    {

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

        {

            if (gdpicturePDF.SelectPage(i) == GdPictureStatus.OK)

            {

                message = message + "Page nr." + i.ToString() + ":\n";

                imageCount = gdpicturePDF.GetPageImageCount();

                status = gdpicturePDF.GetStat();

                if ((status == GdPictureStatus.OK) && (imageCount > 0))

                {

                    for (int j = 0; j < imageCount; j++)

                    {

                        colorspace = gdpicturePDF.GetPageImageColorSpace(j);

                        status = gdpicturePDF.GetStat();

                        if (status == GdPictureStatus.OK)

                            message = message + "The image indexed as " + j.ToString() + " has the following colorspace: " + colorspace.ToString() + ".\n";

                        else

                            message = message + "The GetPageImageColorSpace() method has failed for the image nr. " + j.ToString() + " with the status: " + status.ToString() + "\n";

                    }

                }

                else

                {

                    if (status == GdPictureStatus.OK)

                        message = message + "This page doesn't contain any image.\n";

                    else

                        message = message + "The GetPageImageCount() method has failed for the page nr. " + i.ToString() + " with the status: " + status.ToString() + "\n";

                }

            }

            else

            {

                message = message + "The SelectPage() method has failed for the image nr. " + i.ToString() + " with the status: " + gdpicturePDF.GetStat().ToString() + "\n";

            }

        }

        MessageBox.Show(message, caption);

    }

    else

    {

        if (status == GdPictureStatus.OK)

            MessageBox.Show("This file doesn't contain any page.", 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();
Example
How to find out the colorspace of all images contained within the PDF document. Dim caption As String = "Example: GetPageImageColorSpace" Dim gdpicturePDF As New GdPicturePDF() If gdpicturePDF.LoadFromFile("test.pdf", False) = GdPictureStatus.OK Then Dim message As String = "" Dim imageCount As Integer = 0 Dim colorspace As PdfColorSpace = PdfColorSpace.PdfColorSpaceUnknown Dim pageCount As Integer = gdpicturePDF.GetPageCount() Dim status As GdPictureStatus = gdpicturePDF.GetStat() If (status = GdPictureStatus.OK) AndAlso (pageCount > 0) Then For i As Integer = 1 To pageCount If gdpicturePDF.SelectPage(i) = GdPictureStatus.OK Then message = message + "Page nr." + i.ToString() + ":" + vbCrLf imageCount = gdpicturePDF.GetPageImageCount() status = gdpicturePDF.GetStat() If (status = GdPictureStatus.OK) AndAlso (imageCount > 0) Then For j As Integer = 0 To imageCount - 1 colorspace = gdpicturePDF.GetPageImageColorSpace(j) status = gdpicturePDF.GetStat() If status = GdPictureStatus.OK Then message = message + "The image indexed as " + j.ToString() + " has the following color space: " + colorspace.ToString() + "." + vbCrLf Else message = message + "The GetPageImageColorSpace() method has failed for the image nr. " + j.ToString() + " with the status: " + status.ToString() + vbCrLf End If Next Else If status = GdPictureStatus.OK Then message = message + "This page doesn't contain any image." + vbCrLf Else message = message + "The GetPageImageCount() method has failed for the page nr. " + i.ToString() + " with the status: " + status.ToString() + vbCrLf End If End If Else message = message + "The SelectPage() method has failed for the image nr. " + i.ToString() + " with the status: " + gdpicturePDF.GetStat().ToString() + vbCrLf End If Next MessageBox.Show(message, caption) Else If status = GdPictureStatus.OK Then MessageBox.Show("This file doesn't contain any page.", caption) Else MessageBox.Show("The GetPageCount() method has failed with the status: " + status.ToString(), caption) End If End If Else MessageBox.Show("The file can't be loaded.", caption) End If gdpicturePDF.Dispose() string caption = "Example: GetPageImageColorSpace"; GdPicturePDF gdpicturePDF = new GdPicturePDF(); if (gdpicturePDF.LoadFromFile("test.pdf", false) == GdPictureStatus.OK) { string message = ""; int imageCount = 0; PdfColorSpace colorspace = PdfColorSpace.PdfColorSpaceUnknown; int pageCount = gdpicturePDF.GetPageCount(); GdPictureStatus status = gdpicturePDF.GetStat(); if ((status == GdPictureStatus.OK) && (pageCount > 0)) { for (int i = 1; i <= pageCount; i++) { if (gdpicturePDF.SelectPage(i) == GdPictureStatus.OK) { message = message + "Page nr." + i.ToString() + ":\n"; imageCount = gdpicturePDF.GetPageImageCount(); status = gdpicturePDF.GetStat(); if ((status == GdPictureStatus.OK) && (imageCount > 0)) { for (int j = 0; j < imageCount; j++) { colorspace = gdpicturePDF.GetPageImageColorSpace(j); status = gdpicturePDF.GetStat(); if (status == GdPictureStatus.OK) message = message + "The image indexed as " + j.ToString() + " has the following colorspace: " + colorspace.ToString() + ".\n"; else message = message + "The GetPageImageColorSpace() method has failed for the image nr. " + j.ToString() + " with the status: " + status.ToString() + "\n"; } } else { if (status == GdPictureStatus.OK) message = message + "This page doesn't contain any image.\n"; else message = message + "The GetPageImageCount() method has failed for the page nr. " + i.ToString() + " with the status: " + status.ToString() + "\n"; } } else { message = message + "The SelectPage() method has failed for the image nr. " + i.ToString() + " with the status: " + gdpicturePDF.GetStat().ToString() + "\n"; } } MessageBox.Show(message, caption); } else { if (status == GdPictureStatus.OK) MessageBox.Show("This file doesn't contain any page.", 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

Reference

GdPicturePDF Class
GdPicturePDF Members
GetPageImageCount Method
GetStat Method
GetStat Method
GetPageImageCount Method
GetPageImageBitDepth Method
GetPageImageResName Method
DrawImage Method
SelectPage Method
LoadFromFile Method