Ссылка CGPDFDocument

Наследование

Не применимый

Соответствует

Не применимый

Оператор импорта

Swift

import CoreGraphics

Objective C

@import CoreGraphics;

CGPDFDocumentRef непрозрачный тип инкапсулирует документ, содержащий PDF (Формат Переносимого документа) рисование информации. PDF обеспечивает эффективный формат для межплатформенного обмена документами с богатым содержанием. Файлы PDF могут содержать многократные страницы изображений и текста. Объект документа в формате PDF содержит всю информацию, касающуюся документа в формате PDF, включая его каталог и содержание.

Обратите внимание на то, что документы в формате PDF могут быть зашифрованы, и что некоторые операции могут быть ограничены, пока действительный пароль не предоставляется — посмотрите функции, перечисленные в Управляющем Шифровании. Кварц также поддерживает зашифрованные документы дешифрования.

Кварц может и вывести на экран и генерировать файлы, которые совместимы со стандартом PDF. При обработке изображений файлов PDF, CGPDFDocumentRef основной тип, используемый для представления документа в формате PDF.

Функции

Создание объектов документа в формате PDF

CGPDFDocumentCreateWithProvider (_:) CGPDFDocumentCreateWithProvider

Создает Кварцевый документ в формате PDF с помощью провайдера данных.

Объявление

Swift

func CGPDFDocumentCreateWithProvider(_ provider: CGDataProvider!) -> CGPDFDocument!

Objective C

CGPDFDocumentRef CGPDFDocumentCreateWithProvider ( CGDataProviderRef provider );

Параметры

provider

Провайдер данных, снабжающий данными документа в формате PDF.

Возвращаемое значение

Новый Кварцевый документ в формате PDF, или NULL если не может быть создан документ. Вы ответственны за выпуск объектного использования CGPDFDocumentRelease.

Обсуждение

Распределительные отдельные страницы документа в формате PDF для разделения потоков не поддерживаются. Если Вы хотите использовать потоки, рассмотрите создание отдельного документа для каждого потока и работы на блоке страниц на поток.

Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.
CGPDFDocumentCreateWithURL (_:) CGPDFDocumentCreateWithURL

Создает Кварцевый документ в формате PDF с помощью данных, указанных URL.

Объявление

Swift

func CGPDFDocumentCreateWithURL(_ url: CFURL!) -> CGPDFDocument!

Objective C

CGPDFDocumentRef CGPDFDocumentCreateWithURL ( CFURLRef url );

Параметры

url

URL адресуется, в котором расположены данные документа в формате PDF.

Возвращаемое значение

Новый Кварцевый документ в формате PDF, или NULL если не мог бы быть создан документ. Вы ответственны за выпуск объектного использования CGPDFDocumentRelease.

Обсуждение

Распределительные отдельные страницы документа в формате PDF для разделения потоков не поддерживаются. Если Вы хотите использовать потоки, рассмотрите создание отдельного документа для каждого потока и работы на блоке страниц на поток.

Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.

Сохранение и выпуск документов в формате PDF

CGPDFDocumentRelease

Декременты сохранить количество документа в формате PDF.

Объявление

Objective C

void CGPDFDocumentRelease ( CGPDFDocumentRef document );

Параметры

document

Документ в формате PDF для выпуска.

Обсуждение

Эта функция эквивалентна CFRelease, за исключением того, что это не вызывает ошибку если document параметр NULL.

Оператор импорта

Objective C

@import CoreGraphics;

Доступность

Доступный в iOS 2.0 и позже.
CGPDFDocumentRetain

Инкременты сохранить количество Кварцевого документа в формате PDF.

Объявление

Objective C

CGPDFDocumentRef CGPDFDocumentRetain ( CGPDFDocumentRef document );

Параметры

document

Документ в формате PDF для сохранения.

Возвращаемое значение

Тот же документ Вы передали в как document параметр.

Обсуждение

Эта функция эквивалентна CFRetain, за исключением того, что это не вызывает ошибку если document параметр NULL.

Оператор импорта

Objective C

@import CoreGraphics;

Доступность

Доступный в iOS 2.0 и позже.

Получение ID CFType для объекта документа в формате PDF

CGPDFDocumentGetTypeID () CGPDFDocumentGetTypeID

Возвращает идентификатор типа для Кварцевых документов в формате PDF.

Объявление

Swift

func CGPDFDocumentGetTypeID() -> CFTypeID

Objective C

CFTypeID CGPDFDocumentGetTypeID ( void );

Возвращаемое значение

Идентификатор для непрозрачного типа CGPDFDocumentRef.

Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.

Получение информации о кварцевых документах в формате PDF

CGPDFDocumentGetCatalog (_:) CGPDFDocumentGetCatalog

Возвращает каталог документа Кварцевого документа в формате PDF.

Объявление

Swift

func CGPDFDocumentGetCatalog(_ document: CGPDFDocument!) -> CGPDFDictionaryRef

Objective C

CGPDFDictionaryRef CGPDFDocumentGetCatalog ( CGPDFDocumentRef document );

Параметры

document

Документ в формате PDF.

Возвращаемое значение

Каталог документа указанного документа.

Обсуждение

Записи в каталоге документа в формате PDF рекурсивно описывают содержание документа в формате PDF. Можно получить доступ к содержанию каталога документа в формате PDF путем вызывания функции CGPDFDocumentGetCatalog. Для получения информации о доступе к метаданным PDF посмотрите Кварц 2D Руководство по программированию.

Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.
CGPDFDocumentGetNumberOfPages (_:) CGPDFDocumentGetNumberOfPages

Возвращает число страниц в документе в формате PDF.

Объявление

Swift

func CGPDFDocumentGetNumberOfPages(_ document: CGPDFDocument!) -> Int

Objective C

size_t CGPDFDocumentGetNumberOfPages ( CGPDFDocumentRef document );

Параметры

document

Документ в формате PDF для исследования.

Возвращаемое значение

Общее количество страниц в документе в формате PDF.

Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.


    
    CGPDFDocumentGetPage (_: _:)
    CGPDFDocumentGetPage

Возвращает страницу из Кварцевого документа в формате PDF.

Объявление

Swift

func CGPDFDocumentGetPage(_ document: CGPDFDocument!, _ pageNumber: Int) -> CGPDFPage!

Objective C

CGPDFPageRef CGPDFDocumentGetPage ( CGPDFDocumentRef document, size_t pageNumber );

Параметры

`document`	Документ в формате PDF.
`pageNumber`	Число страницы требуют.

Возвращаемое значение

Возвратите страницу PDF, соответствующую указанному номеру страницы, или NULL если никакая такая страница не существует в документе. Страницы пронумерованы, запустившись в 1.

Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.


    
    CGPDFDocumentGetVersion (_: _: _:)
    CGPDFDocumentGetVersion

Возвращает номера основной версии и номера вспомогательной версии Кварцевого документа в формате PDF.

Объявление

Swift

func CGPDFDocumentGetVersion(_ document: CGPDFDocument!, _ majorVersion: UnsafeMutablePointer<Int32>, _ minorVersion: UnsafeMutablePointer<Int32>)

Objective C

void CGPDFDocumentGetVersion ( CGPDFDocumentRef document, int *majorVersion, int *minorVersion );

Параметры

`document`	Документ в формате PDF.
`majorVersion`	По возврату, содержит номер основной версии документа.
`minorVersion`	По возврату, содержит номер вспомогательной версии документа.

Возвращаемое значение

По возврату, значениям majorVersion и minorVersion параметры устанавливаются на номера основной версии и номера вспомогательной версии документа соответственно.

Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.

CGPDFDocumentGetInfo (_:) CGPDFDocumentGetInfo

Получает информационный словарь для документа в формате PDF.

Объявление

Swift

func CGPDFDocumentGetInfo(_ document: CGPDFDocument!) -> CGPDFDictionaryRef

Objective C

CGPDFDictionaryRef CGPDFDocumentGetInfo ( CGPDFDocumentRef document );

Параметры

document

Документ, словарь которого Вы хотите получить.

Возвращаемое значение

Информационный словарь для документа.

Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.
CGPDFDocumentGetID (_:) CGPDFDocumentGetID

Получает идентификатор файла для документа в формате PDF.

Объявление

Swift

func CGPDFDocumentGetID(_ document: CGPDFDocument!) -> CGPDFArrayRef

Objective C

CGPDFArrayRef CGPDFDocumentGetID ( CGPDFDocumentRef document );

Параметры

document

Документ, идентификатор файла которого Вы хотите получить.

Возвращаемое значение

Возвращает идентификатор файла для документа.

Обсуждение

Идентификатор файла PDF определяется в спецификации PDF как массив двух строк, первой из которых является постоянный идентификатор, не изменяющийся, даже когда обновляется файл. Вторая строка изменяется каждый раз, когда файл обновляется. Для получения дополнительной информации посмотрите Ссылку PDF: Версия 1.3 (Второй Выпуск), Adobe Systems Incorporated.

Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.

Управление шифрованием

CGPDFDocumentAllowsCopying (_:) CGPDFDocumentAllowsCopying

Возвраты, позволяет ли указанный документ в формате PDF копировать.

Объявление

Swift

func CGPDFDocumentAllowsCopying(_ document: CGPDFDocument!) -> Bool

Objective C

bool CGPDFDocumentAllowsCopying ( CGPDFDocumentRef document );

Параметры

document

Документ в формате PDF.

Возвращаемое значение

Булевская переменная это, если true, указывает, что документ позволяет копировать. Если значение false, документ не позволяет копировать.

Обсуждение

Эта функция возвраты true если указанный документ в формате PDF позволяет копировать. Это возвращается false если документ шифруется, и текущий пароль не дает разрешение выполнять копирование.

Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.
CGPDFDocumentAllowsPrinting (_:) CGPDFDocumentAllowsPrinting

Возвраты, позволяет ли документ в формате PDF распечатывать.

Объявление

Swift

func CGPDFDocumentAllowsPrinting(_ document: CGPDFDocument!) -> Bool

Objective C

bool CGPDFDocumentAllowsPrinting ( CGPDFDocumentRef document );

Параметры

document

Документ в формате PDF.

Возвращаемое значение

Булевская переменная это, если true, указывает, что документ позволяет распечатывать. Если значение false, документ не позволяет распечатывать.

Обсуждение

Эта функция возвраты true если указанный документ в формате PDF позволяет распечатывать. Это возвращается false если документ шифруется, и текущий пароль не дает разрешение выполнять печать.

Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.
CGPDFDocumentIsEncrypted (_:) CGPDFDocumentIsEncrypted

Возвраты, шифруется ли указанный файл PDF.

Объявление

Swift

func CGPDFDocumentIsEncrypted(_ document: CGPDFDocument!) -> Bool

Objective C

bool CGPDFDocumentIsEncrypted ( CGPDFDocumentRef document );

Параметры

document

Документ в формате PDF.

Возвращаемое значение

Булевская переменная это, если true, указывает, что шифруется документ. Если значение false, документ не шифруется.

Обсуждение

Если документ шифруется, пароль должен быть предоставлен, прежде чем определенные операции включены. Для получения дополнительной информации посмотрите CGPDFDocumentUnlockWithPassword.

Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.
CGPDFDocumentIsUnlocked (_:) CGPDFDocumentIsUnlocked
Возвраты, разблокирован ли в настоящее время указанный документ в формате PDF.

Объявление

Swift

func CGPDFDocumentIsUnlocked(_ document: CGPDFDocument!) -> Bool

Objective C

bool CGPDFDocumentIsUnlocked ( CGPDFDocumentRef document );

Параметры

document

Документ в формате PDF.

Возвращаемое значение

Булевская переменная это, если true, указывает, что не заблокирован документ. Если значение false, документ заблокирован.
Обсуждение

Существует две возможных причины, почему разблокирован документ в формате PDF:
- Документ не шифруется.
- Документ шифруется, и действительный пароль был ранее указан с помощью CGPDFDocumentUnlockWithPassword.
Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.


    
    CGPDFDocumentUnlockWithPassword (_: _:)
    CGPDFDocumentUnlockWithPassword

Если действительный пароль предоставляется, разблокировал зашифрованный документ в формате PDF.

Объявление

Swift

func CGPDFDocumentUnlockWithPassword(_ document: CGPDFDocument!, _ password: UnsafePointer<Int8>) -> Bool

Objective C

bool CGPDFDocumentUnlockWithPassword ( CGPDFDocumentRef document, const char *password );

Параметры

`document`	Документ в формате PDF.
`password`	Указатель на строку, содержащую пароль.

Возвращаемое значение

Булевская переменная это, если true, указывает, что был успешно разблокирован документ. Если значение false, документ не был разблокирован.

Обсуждение

Учитывая зашифрованный документ в формате PDF и пароль, эта функция делает следующее:

Устанавливает состояние блокировки документа, на основе законности пароля.
Возвраты true если разблокирован документ.
Возвраты false если документ не может быть разблокирован с указанным паролем.

Разблокирование документа в формате PDF позволяет дешифровать документ и выполнить другие привилегированные операции. Различные пароли включают различные операции.

Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.

Типы данных

CGPDFDocumentRef

Непрозрачный тип, представляющий PDF (Формат Переносимого документа) документ.

Объявление

Swift

typealias CGPDFDocumentRef = CGPDFDocument

Objective C

typedef struct CGPDFDocument * CGPDFDocumentRef;

Оператор импорта

Objective C

@import CoreGraphics;

Swift

import CoreGraphics

Доступность

Доступный в iOS 2.0 и позже.