Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# DocumentImage.pixelFormat Property

Module: DocumentImage

Type: PixelFormat

## Definition

Pixel format.

Python

    pixel_format: PixelFormat

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Dart

    PixelFormat get pixelFormat => getPixelFormat();

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

C#

    public PixelFormat pixelFormat
    {
        get => GetpixelFormat();
    }

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Java

    public PixelFormat getPixelFormat() throws DocumentException

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Swift

    public var pixelFormat: PixelFormat
        get {
            return try! getPixelFormat()
        }
    }

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

C

    int id3DocumentImage_GetPixelFormat (ID3_DOCUMENT_IMAGE hDocumentImage, id3DocumentPixelFormat * ePixelFormat)

Returns

> `int`
> An error code.
> See id3DocumentError file for the list of possible error codes.