Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека разработчика Mac

Разработчик

Кварцевая ссылка платформы ссылка класса PDFAnnotation

Опции
Развертывание Target:

На этой странице
Язык:

PDFAnnotation

PDFAnnotation, подкласс NSObject, представляет аннотацию в документе в формате PDF, связывающем объект (такой как примечание или звук) с расположением в документе в формате PDF.

В дополнение к его основному текстовому содержанию файл PDF может содержать аннотации, представляющие ссылки, элементы формы, выделяя круги, текстовые примечания, и т.д. Каждая аннотация связана с определенным расположением на странице и может предложить интерактивность с пользователем. Посмотрите Adobe PDF Specification для больше на аннотациях.

Вы вряд ли будете работать с a PDFAnnotation возразите отдельно, потому что определенные подклассы, такой как PDFAnnotationCircle, намного более полезны. Когда файл PDF анализируется, однако, любая неизвестная или неподдерживаемая аннотация представлена как a PDFAnnotation объект.

PDFAnnotation абстрактный суперкласс следующих реальных классов:

  • PDFAnnotationButtonWidget

  • PDFAnnotationCircle

  • PDFAnnotationFreeText

  • PDFAnnotationInk

  • PDFAnnotationLine

  • PDFAnnotationLink

  • PDFAnnotationMarkup

  • PDFAnnotationPopup

  • PDFAnnotationSquare

  • PDFAnnotationStamp

  • PDFAnnotationText

  • PDFAnnotationTextWidget

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

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

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

Swift

import Quartz

Objective C

@import Quartz;

Доступность

Доступный в OS X v10.4 и позже.

Инициализация аннотации
  • init (границы:) - initWithBounds:

    Инициализирует объект пометок PDF.

    Объявление

    Swift

    init!(bounds bounds: NSRect)

    Objective C

    - (id)initWithBounds:(NSRect)bounds

    Параметры

    bounds

    Ограничительная рамка аннотации, в пространстве страницы.

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

    Инициализированный PDFAnnotation экземпляр, или NULL если не мог бы быть инициализирован объект.

    Обсуждение

    Подклассы PDFAnnotation должен использовать этот метод для инициализации экземпляров аннотации. Обеспечить bounds в пространстве страницы. Вызов initWithBounds: непосредственно на a PDFAnnotation объект создает нелегала NULL ввести.

    Пространство страницы является системой координат на 72 точки на дюйм с источником в нижнем левом углу текущей страницы.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

Доступ к информации об аннотации
  • страница () - страница

    Возвращает страницу, с которой связана аннотация.

    Объявление

    Swift

    func page() -> PDFPage!

    Objective C

    - (PDFPage *)page

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

    Страница PDF связалась с аннотацией.

    Обсуждение

    addAnnotation: метод в PDFPage класс позволяет Вам связать аннотацию со страницей.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

  • modificationDate () - modificationDate

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

    Объявление

    Swift

    func modificationDate() -> NSDate!

    Objective C

    - (NSDate *)modificationDate

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

    Дата модификации аннотации, или NULL если нет никакой даты модификации.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.5 и позже.

    См. также

    – setModificationDate

  • setModificationDate (_:) - setModificationDate:

    Назначает дату модификации аннотации.

    Объявление

    Swift

    func setModificationDate(_ date: NSDate!)

    Objective C

    - (void)setModificationDate:(NSDate *)date

    Параметры

    date

    Дата модификации для соединения с аннотацией.

    Обсуждение

    Дата модификации является дополнительной.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.5 и позже.

    См. также

    – modificationDate

  • имя пользователя () - имя пользователя

    Возвращает имя пользователя, создавшего аннотацию.

    Объявление

    Swift

    func userName() -> String!

    Objective C

    - (NSString *)userName

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

    Имя пользователя, создавшего аннотацию или NULL, если не установлено никакое имя пользователя.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.5 и позже.

    См. также

    – setUserName

  • setUserName (_:) - setUserName:

    Определяет имя пользователя, создавшего аннотацию.

    Объявление

    Swift

    func setUserName(_ name: String!)

    Objective C

    - (void)setUserName:(NSString *)name

    Параметры

    name

    Имя пользователя, создавшего аннотацию.

    Обсуждение

    Имя пользователя является дополнительным.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.5 и позже.

    См. также

    – имя пользователя

  • раскрывающийся () - раскрывающийся

    Возвращает раскрывающуюся аннотацию, связанную с аннотацией.

    Объявление

    Swift

    func popup() -> PDFAnnotationPopup!

    Objective C

    - (PDFAnnotationPopup *)popup

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

    Раскрывающаяся аннотация связалась с аннотацией, или NULL если не раскрываются, существует.

    Обсуждение

    Раскрывающиеся аннотации не используются со ссылками или виджетами. Границы и открытое состояние раскрывающейся аннотации указывают размещение и открытое состояние всплывающего окна.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.5 и позже.

    См. также

    – setPopup

  • setPopup (_:) - setPopup:

    Устанавливает раскрывающуюся аннотацию, связанную с аннотацией.

    Объявление

    Swift

    func setPopup(_ popup: PDFAnnotationPopup!)

    Objective C

    - (void)setPopup:(PDFAnnotationPopup *)popup

    Параметры

    popup

    Раскрывающаяся аннотация для соединения с аннотацией.

    Обсуждение

    Раскрывающаяся аннотация не связана со ссылками или виджетами. Границы и открытое состояние раскрывающейся аннотации указывают размещение и открытое состояние всплывающего окна.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.5 и позже.

    См. также

    – раскрывающийся

  • mouseUpAction () - mouseUpAction

    Возвращает дополнительное действие, выполняемое когда разъединения абонентом кнопка мыши в аннотации.

    Объявление

    Swift

    func mouseUpAction() -> PDFAction!

    Objective C

    - (PDFAction *)mouseUpAction

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

    Действие PDF, выполняемое, когда разъединения абонентом кнопка мыши в аннотации.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.5 и позже.

    См. также

    – setMouseUpAction

  • setMouseUpAction (_:) - setMouseUpAction:

    Устанавливает действие, выполняемое когда разъединения абонентом кнопка мыши в аннотации.

    Объявление

    Swift

    func setMouseUpAction(_ action: PDFAction!)

    Objective C

    - (void)setMouseUpAction:(PDFAction *)action

    Параметры

    action

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

    Обсуждение

    Действие мыши является дополнительным.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.5 и позже.

    См. также

    – mouseUpAction

  • введите () - ввести

    Возвращает тип аннотации.

    Объявление

    Swift

    func type() -> String!

    Objective C

    - (NSString *)type

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

    Тип аннотации. Типы включают Line, Link, Text, и т.д., обращение к PDFAnnotation подклассы. В Adobe PDF Specification вызывают этот атрибут Subtype, и общий «тип» для всех аннотаций в Спецификации PDF Annot.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

  • содержание () - содержание

    Возвращает текстовое содержание (если таковые имеются) связанный с аннотацией.

    Объявление

    Swift

    func contents() -> String!

    Objective C

    - (NSString *)contents

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

    Строка, представляющая текстовое содержание, связалась с аннотацией.

    Обсуждение

    Текстовое содержание обычно связывается с PDFAnnotationText и PDFAnnotationFreeText аннотации.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – setContents:
    – подсказка

  • setContents (_:) - setContents:

    Указывает текстовое содержание, связанное с аннотацией.

    Объявление

    Swift

    func setContents(_ contents: String!)

    Objective C

    - (void)setContents:(NSString *)contents

    Параметры

    contents

    Строка, представляющая текстовое содержание, связалась с аннотацией.

    Обсуждение

    Текстовое содержание обычно связывается с PDFAnnotationText и PDFAnnotationFreeText аннотации. Для большинства типов аннотации, PDFView выводит на экран связанное текстовое содержание как тег справки.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – содержание
    – подсказка

  • подсказка () - подсказка

    Текст возвратов для дисплея как тег справки.

    Объявление

    Swift

    func toolTip() -> String!

    Objective C

    - (NSString *)toolTip

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

    Строка, содержащая содержание тега справки, или NULL если нет никакого текста, связанного с аннотацией.

    Обсуждение

    Этот метод эквивалентен отправке сообщения [self contents]. Подклассы аннотации Набора PDF переопределяют это поведение как надлежащее. Например, a PDFAnnotationLink отображения объекта URL или место назначения страницы для ее тега справки.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

Управление характеристиками дисплея аннотации
  • границы () - границы

    Возвращает ограничительную рамку для аннотации в пространстве страницы.

    Объявление

    Swift

    func bounds() -> NSRect

    Objective C

    - (NSRect)bounds

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

    Ограничительная рамка для аннотации в пространстве страницы.

    Обсуждение

    Пространство страницы является системой координат на 72 точки на дюйм с источником в нижнем левом углу текущей страницы.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – setBounds:

  • setBounds (_:) - setBounds:

    Устанавливает ограничительную рамку для аннотации.

    Объявление

    Swift

    func setBounds(_ bounds: NSRect)

    Objective C

    - (void)setBounds:(NSRect)bounds

    Параметры

    bounds

    Ограничительная рамка для аннотации. Используйте пространство страницы для bounds. Атрибут границ требуется для всех аннотаций.

    Обсуждение

    Пространство страницы является системой координат на 72 точки на дюйм с источником в нижнем левом углу текущей страницы.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – границы

  • граница () - граница

    Возвращает стиль границ для аннотации.

    Объявление

    Swift

    func border() -> PDFBorder!

    Objective C

    - (PDFBorder *)border

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

    Стиль границ для аннотации. Посмотрите Константы в классе PDFBorder для возможных значений.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – setBorder:

  • setBorder (_:) - setBorder:

    Устанавливает стиль границ для аннотации.

    Объявление

    Swift

    func setBorder(_ border: PDFBorder!)

    Objective C

    - (void)setBorder:(PDFBorder *)border

    Параметры

    border

    Стиль границ для аннотации. Посмотрите Константы в классе PDFBorder для доступных стилей. Атрибут стиля границ является дополнительным.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – граница

  • цвет () - цвет

    Возвращает цвет обводки для аннотации.

    Объявление

    Swift

    func color() -> NSColor!

    Objective C

    - (NSColor *)color

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

    Цвет обводки для аннотации.

    Обсуждение

    То, где этот цвет используется, зависит от типа аннотации.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – setColor:

  • setColor (_:) - setColor:

    Выбирает цвет обводки для аннотации.

    Объявление

    Swift

    func setColor(_ color: NSColor!)

    Objective C

    - (void)setColor:(NSColor *)color

    Параметры

    color

    Цвет обводки для аннотации.

    Обсуждение

    То, где этот цвет используется, зависит от типа аннотации.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – цвет

  • hasAppearanceStream () - hasAppearanceStream

    Возвращает булево значение, указывающее, связали ли аннотации поток появления с ним.

    Объявление

    Swift

    func hasAppearanceStream() -> Bool

    Objective C

    - (BOOL)hasAppearanceStream

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

    YEStrue если аннотация имеет поток появления; иначе NOfalse.

    Обсуждение

    Поток появления является последовательностью инструкций получения, используемых для рендеринга элемента PDF. Если поток появления существует, Набор PDF составляет аннотацию с помощью потока, который может переопределить существующие параметры набора (такие как набор цвета обводки с setColor).

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

Управление получением аннотации и выводом
  • drawWithBox (_:) - drawWithBox:

    Составляет аннотацию на ее связанной странице.

    Объявление

    Swift

    func drawWithBox(_ box: PDFDisplayBox)

    Objective C

    - (void)drawWithBox:(PDFDisplayBox)box

    Параметры

    box

    Ограничительная рамка раньше составляла аннотацию в.

    Обсуждение

    Аннотация составлена относительно источника box в пространстве страницы.

    Пространство страницы является системой координат на 72 точки на дюйм с источником в нижнем левом углу текущей страницы.

    Поскольку дополнительная информация видит раздел Constants в PDFPage класс.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – boundsForBox:

  • shouldDisplay () - shouldDisplay

    Возвращает булево значение, указывающее, должна ли аннотация быть выведена на экран.

    Объявление

    Swift

    func shouldDisplay() -> Bool

    Objective C

    - (BOOL)shouldDisplay

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

    YEStrue если аннотация должна быть выведена на экран; иначе NOfalse.

    Обсуждение

    PDFPage отношения этот флаг при рисовании.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – setShouldDisplay:

  • setShouldDisplay (_:) - setShouldDisplay:

    Указывает, должна ли аннотация быть выведена на экран.

    Объявление

    Swift

    func setShouldDisplay(_ display: Bool)

    Objective C

    - (void)setShouldDisplay:(BOOL)display

    Параметры

    display

    Установите это значение в YEStrue вывести на экран аннотацию или NOfalse иначе.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – shouldDisplay

  • shouldPrint () - shouldPrint

    Возвращает булево значение, указывающее, должна ли аннотация появиться, когда распечатан документ.

    Объявление

    Swift

    func shouldPrint() -> Bool

    Objective C

    - (BOOL)shouldPrint

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

    YEStrue когда документ в формате PDF распечатан, если должна появиться аннотация; иначе NOfalse.

    Обсуждение

    PDFPage отношения этот флаг при печати.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – setShouldPrint:

  • setShouldPrint (_:) - setShouldPrint:

    Указывает, должна ли аннотация появиться, когда распечатан документ.

    Объявление

    Swift

    func setShouldPrint(_ print: Bool)

    Objective C

    - (void)setShouldPrint:(BOOL)print

    Параметры

    print

    Установите это значение в YEStrue когда документ распечатан или, гарантировать аннотацию появляется NOfalse иначе.

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

    Objective C

    @import Quartz;

    Swift

    import Quartz

    Доступность

    Доступный в OS X v10.4 и позже.

    См. также

    – shouldPrint