IPXC_Annotation Interface

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IPXC_Annotation Interface}}
 
{{#customTitle:IPXC_Annotation Interface}}
 
{{#parentPage:PXV:PXC_Interfaces|IPXC_Annotation|interface}}
 
{{#parentPage:PXV:PXC_Interfaces|IPXC_Annotation|interface}}
 
  
 
PDF ''annotations'' located on pages of PDF document are often and widely used in PDF files, and often there are a lot of annotations in PDF documents. To reduce the amount of memory used by PDF files in general usage, PDF-XChange PDF SDK splits annotations in two different objects.
 
PDF ''annotations'' located on pages of PDF document are often and widely used in PDF files, and often there are a lot of annotations in PDF documents. To reduce the amount of memory used by PDF files in general usage, PDF-XChange PDF SDK splits annotations in two different objects.
Line 19: Line 18:
 
| [[PXV:IPXC_Annotation_Handler|Handler]]
 
| [[PXV:IPXC_Annotation_Handler|Handler]]
 
| [[PXV:IPXC_Annotation_OC|OC]]
 
| [[PXV:IPXC_Annotation_OC|OC]]
| [[PXV:IPXC_Annotation_Rect|Rect]]
+
| [[PXV:IPXC_Annotation_Popup|Popup]]
 
|-
 
|-
 
| [[PXV:IPXC_Annotation_CreationDate|CreationDate]]
 
| [[PXV:IPXC_Annotation_CreationDate|CreationDate]]
 
| [[PXV:IPXC_Annotation_IndexOnPage|IndexOnPage]]
 
| [[PXV:IPXC_Annotation_IndexOnPage|IndexOnPage]]
| [[PXV:IPXC_Annotation_Page|Page]]
+
| [[PXV:IPXC_Annotation_OnValue|OnValue]]
| [[PXV:IPXC_Annotation_ReplyTo|ReplyTo]]
+
| [[PXV:IPXC_Annotation_Rect|Rect]]
 
|-
 
|-
 
| [[PXV:IPXC_Annotation_Data|Data]]
 
| [[PXV:IPXC_Annotation_Data|Data]]
 
| [[PXV:IPXC_Annotation_IsMarkup|IsMarkup]]
 
| [[PXV:IPXC_Annotation_IsMarkup|IsMarkup]]
| [[PXV:IPXC_Annotation_PageIndex|PageIndex]]
+
| [[PXV:IPXC_Annotation_Page|Page]]
| [[PXV:IPXC_Annotation_ReplyType|ReplyType]]
+
| [[PXV:IPXC_Annotation_ReplyTo|ReplyTo]]
 
|-
 
|-
 
| [[PXV:IPXC_Annotation_Field|Field]]
 
| [[PXV:IPXC_Annotation_Field|Field]]
 
| [[PXV:IPXC_Annotation_ModificationDate|ModificationDate]]
 
| [[PXV:IPXC_Annotation_ModificationDate|ModificationDate]]
| [[PXV:IPXC_Annotation_PDFObject|PDFObject]]
+
| [[PXV:IPXC_Annotation_PageIndex|PageIndex]]
| [[PXV:IPXC_Annotation_Type|Type]]
+
| [[PXV:IPXC_Annotation_ReplyType|ReplyType]]
 
|-
 
|-
 
| [[PXV:IPXC_Annotation_Flags|Flags]]
 
| [[PXV:IPXC_Annotation_Flags|Flags]]
 
| [[PXV:IPXC_Annotation_Name|Name]]
 
| [[PXV:IPXC_Annotation_Name|Name]]
| [[PXV:IPXC_Annotation_Popup|Popup]]
+
| [[PXV:IPXC_Annotation_PDFObject|PDFObject]]
|  
+
| [[PXV:IPXC_Annotation_Type|Type]]
 
|}
 
|}
  
 
== See Also ==
 
== See Also ==
 
[[PXV:IPXC_Page_AddAnnotToGroup|IPXC_Page::AddAnnotToGroup]], [[PXV:IPXC_Page_ExcludeAnnotFromGroup|IPXC_Page::ExcludeAnnotFromGroup]], [[PXV:IPXC_Page_GetAnnot|IPXC_Page::GetAnnot]], [[PXV:IPXC_Page_GetAnnotGroupMembers|IPXC_Page::GetAnnotGroupMembers]], [[PXV:IPXC_Page_GetAnnotReplies|IPXC_Page::GetAnnotReplies]], [[PXV:IPXC_Page_InsertNewAnnot|IPXC_Page::InsertNewAnnot]], [[PXV:IPXC_Page_InsertNewAnnotFromDict|IPXC_Page::InsertNewAnnotFromDict]], [[PXV:IPXC_Page_MoveAnnot|IPXC_Page::MoveAnnot]], [[PXV:IPXC_AnnotHandler_CopyAnnot|IPXC_AnnotHandler::CopyAnnot]], [[PXV:IPXC_AnnotHandler_CreateAnnotUndoInfo|IPXC_AnnotHandler::CreateAnnotUndoInfo]], [[PXV:IPXC_AnnotHandler_GetAnnotData|IPXC_AnnotHandler::GetAnnotData]], [[PXV:IPXC_AnnotHandler_GetAnnotRotatePoint|IPXC_AnnotHandler::GetAnnotRotatePoint]], [[PXV:IPXC_AnnotHandler_GetAnnotTipPoint|IPXC_AnnotHandler::GetAnnotTipPoint]], [[PXV:IPXC_AnnotHandler_GetAppearance|IPXC_AnnotHandler::GetAppearance]], [[PXV:IPXC_AnnotHandler_GetPrintAppearance|IPXC_AnnotHandler::GetPrintAppearance]], [[PXV:IPXC_AnnotHandler_HasAppearanceForAppType|IPXC_AnnotHandler::HasAppearanceForAppType]], [[PXV:IPXC_AnnotHandler_LoadAnnotData|IPXC_AnnotHandler::LoadAnnotData]], [[PXV:IPXC_AnnotHandler_RotateAnnot|IPXC_AnnotHandler::RotateAnnot]], [[PXV:IPXC_AnnotHandler_SaveAnnotData|IPXC_AnnotHandler::SaveAnnotData]], [[PXV:IPXC_AnnotHandler_ScaleAnnot|IPXC_AnnotHandler::ScaleAnnot]], [[PXV:IPXC_AnnotHandler_SerializeAnnot|IPXC_AnnotHandler::SerializeAnnot]], [[PXV:IPXC_AnnotHandler_TransformAnnot|IPXC_AnnotHandler::TransformAnnot]], [[PXV:IPXC_AnnotHandler_UndoAnnot|IPXC_AnnotHandler::UndoAnnot]], [[PXV:IPXC_OCContext_GetAnnotAppStyle|IPXC_OCContext::GetAnnotAppStyle]], [[PXV:IPXC_OCContext_IsAnnotVisible|IPXC_OCContext::IsAnnotVisible]], [[PXV:IPXC_AnnotsVisibilityCallback_GetAnnotVisibility|IPXC_AnnotsVisibilityCallback::GetAnnotVisibility]], [[PXV:IPXC_FormField_GetWidgetIndex|IPXC_FormField::GetWidgetIndex]], [[PXV:IPXC_FormField_Widget|IPXC_FormField::Widget]], [[PXV:IPXC_AnnotsList_Insert|IPXC_AnnotsList::Insert]], [[PXV:IPXC_AnnotsList_Item|IPXC_AnnotsList::Item]], [[PXV:IPXV_Inst_GetAnnotHandler|IPXV_Inst::GetAnnotHandler]], [[PXV:IPXV_Document_FireAnnotChangedEvent|IPXV_Document::FireAnnotChangedEvent]], [[PXV:IPXV_Document_FireAnnotDeletedEvent|IPXV_Document::FireAnnotDeletedEvent]], [[PXV:IPXV_Document_FireAnnotInsertedEvent|IPXV_Document::FireAnnotInsertedEvent]], [[PXV:IPXV_Document_InvalidateAnnot|IPXV_Document::InvalidateAnnot]], [[PXV:IPXV_PagesView_EnsureVisibleAnnot|IPXV_PagesView::EnsureVisibleAnnot]], [[PXV:IPXV_PagesView_GetAnnotFromPt|IPXV_PagesView::GetAnnotFromPt]], [[PXV:IPXV_PagesView_GetAnnotRectOnDevice|IPXV_PagesView::GetAnnotRectOnDevice]], [[PXV:IPXV_PagesView_GetAnnotRectOnPage|IPXV_PagesView::GetAnnotRectOnPage]], [[PXV:IPXV_PagesView_GetLastHitTestRes|IPXV_PagesView::GetLastHitTestRes]], [[PXV:IPXV_PagesView_GetLinkFromPt|IPXV_PagesView::GetLinkFromPt]], [[PXV:IPXV_PagesView_InvalidateAnnot|IPXV_PagesView::InvalidateAnnot]], [[PXV:IPXV_PagesView_IsAnnotVisible|IPXV_PagesView::IsAnnotVisible]], [[PXV:IPXV_InvalidatePagesInfo_GetGroupItem|IPXV_InvalidatePagesInfo::GetGroupItem]], [[PXV:IPXV_InvalidatePagesInfo_InvalidateAnnot|IPXV_InvalidatePagesInfo::InvalidateAnnot]], [[PXV:IPXV_AnnotsList_Find|IPXV_AnnotsList::Find]], [[PXV:IPXV_AnnotsList_Insert|IPXV_AnnotsList::Insert]], [[PXV:IPXV_AnnotsList_Remove2|IPXV_AnnotsList::Remove2]], [[PXV:IPXV_AnnotsList_Item|IPXV_AnnotsList::Item]], [[PXV:IPXV_AnnotHandler_HitTest|IPXV_AnnotHandler::HitTest]], [[PXV:IPXV_AnnotHandler_IsAnnotHandler|IPXV_AnnotHandler::IsAnnotHandler]], [[PXV:IPXV_AnnotHandler_OnAnnotEnter|IPXV_AnnotHandler::OnAnnotEnter]], [[PXV:IPXV_AnnotHandler_OnAnnotExit|IPXV_AnnotHandler::OnAnnotExit]]
 
[[PXV:IPXC_Page_AddAnnotToGroup|IPXC_Page::AddAnnotToGroup]], [[PXV:IPXC_Page_ExcludeAnnotFromGroup|IPXC_Page::ExcludeAnnotFromGroup]], [[PXV:IPXC_Page_GetAnnot|IPXC_Page::GetAnnot]], [[PXV:IPXC_Page_GetAnnotGroupMembers|IPXC_Page::GetAnnotGroupMembers]], [[PXV:IPXC_Page_GetAnnotReplies|IPXC_Page::GetAnnotReplies]], [[PXV:IPXC_Page_InsertNewAnnot|IPXC_Page::InsertNewAnnot]], [[PXV:IPXC_Page_InsertNewAnnotFromDict|IPXC_Page::InsertNewAnnotFromDict]], [[PXV:IPXC_Page_MoveAnnot|IPXC_Page::MoveAnnot]], [[PXV:IPXC_AnnotHandler_CopyAnnot|IPXC_AnnotHandler::CopyAnnot]], [[PXV:IPXC_AnnotHandler_CreateAnnotUndoInfo|IPXC_AnnotHandler::CreateAnnotUndoInfo]], [[PXV:IPXC_AnnotHandler_GetAnnotData|IPXC_AnnotHandler::GetAnnotData]], [[PXV:IPXC_AnnotHandler_GetAnnotRotatePoint|IPXC_AnnotHandler::GetAnnotRotatePoint]], [[PXV:IPXC_AnnotHandler_GetAnnotTipPoint|IPXC_AnnotHandler::GetAnnotTipPoint]], [[PXV:IPXC_AnnotHandler_GetAppearance|IPXC_AnnotHandler::GetAppearance]], [[PXV:IPXC_AnnotHandler_GetPrintAppearance|IPXC_AnnotHandler::GetPrintAppearance]], [[PXV:IPXC_AnnotHandler_HasAppearanceForAppType|IPXC_AnnotHandler::HasAppearanceForAppType]], [[PXV:IPXC_AnnotHandler_LoadAnnotData|IPXC_AnnotHandler::LoadAnnotData]], [[PXV:IPXC_AnnotHandler_RotateAnnot|IPXC_AnnotHandler::RotateAnnot]], [[PXV:IPXC_AnnotHandler_SaveAnnotData|IPXC_AnnotHandler::SaveAnnotData]], [[PXV:IPXC_AnnotHandler_ScaleAnnot|IPXC_AnnotHandler::ScaleAnnot]], [[PXV:IPXC_AnnotHandler_SerializeAnnot|IPXC_AnnotHandler::SerializeAnnot]], [[PXV:IPXC_AnnotHandler_TransformAnnot|IPXC_AnnotHandler::TransformAnnot]], [[PXV:IPXC_AnnotHandler_UndoAnnot|IPXC_AnnotHandler::UndoAnnot]], [[PXV:IPXC_OCContext_GetAnnotAppStyle|IPXC_OCContext::GetAnnotAppStyle]], [[PXV:IPXC_OCContext_IsAnnotVisible|IPXC_OCContext::IsAnnotVisible]], [[PXV:IPXC_AnnotsVisibilityCallback_GetAnnotVisibility|IPXC_AnnotsVisibilityCallback::GetAnnotVisibility]], [[PXV:IPXC_FormField_GetWidgetIndex|IPXC_FormField::GetWidgetIndex]], [[PXV:IPXC_FormField_Widget|IPXC_FormField::Widget]], [[PXV:IPXC_AnnotsList_Insert|IPXC_AnnotsList::Insert]], [[PXV:IPXC_AnnotsList_Item|IPXC_AnnotsList::Item]], [[PXV:IPXV_Inst_GetAnnotHandler|IPXV_Inst::GetAnnotHandler]], [[PXV:IPXV_Document_FireAnnotChangedEvent|IPXV_Document::FireAnnotChangedEvent]], [[PXV:IPXV_Document_FireAnnotDeletedEvent|IPXV_Document::FireAnnotDeletedEvent]], [[PXV:IPXV_Document_FireAnnotInsertedEvent|IPXV_Document::FireAnnotInsertedEvent]], [[PXV:IPXV_Document_InvalidateAnnot|IPXV_Document::InvalidateAnnot]], [[PXV:IPXV_PagesView_EnsureVisibleAnnot|IPXV_PagesView::EnsureVisibleAnnot]], [[PXV:IPXV_PagesView_GetAnnotFromPt|IPXV_PagesView::GetAnnotFromPt]], [[PXV:IPXV_PagesView_GetAnnotRectOnDevice|IPXV_PagesView::GetAnnotRectOnDevice]], [[PXV:IPXV_PagesView_GetAnnotRectOnPage|IPXV_PagesView::GetAnnotRectOnPage]], [[PXV:IPXV_PagesView_GetLastHitTestRes|IPXV_PagesView::GetLastHitTestRes]], [[PXV:IPXV_PagesView_GetLinkFromPt|IPXV_PagesView::GetLinkFromPt]], [[PXV:IPXV_PagesView_InvalidateAnnot|IPXV_PagesView::InvalidateAnnot]], [[PXV:IPXV_PagesView_IsAnnotVisible|IPXV_PagesView::IsAnnotVisible]], [[PXV:IPXV_InvalidatePagesInfo_GetGroupItem|IPXV_InvalidatePagesInfo::GetGroupItem]], [[PXV:IPXV_InvalidatePagesInfo_InvalidateAnnot|IPXV_InvalidatePagesInfo::InvalidateAnnot]], [[PXV:IPXV_AnnotsList_Find|IPXV_AnnotsList::Find]], [[PXV:IPXV_AnnotsList_Insert|IPXV_AnnotsList::Insert]], [[PXV:IPXV_AnnotsList_Remove2|IPXV_AnnotsList::Remove2]], [[PXV:IPXV_AnnotsList_Item|IPXV_AnnotsList::Item]], [[PXV:IPXV_AnnotHandler_HitTest|IPXV_AnnotHandler::HitTest]], [[PXV:IPXV_AnnotHandler_IsAnnotHandler|IPXV_AnnotHandler::IsAnnotHandler]], [[PXV:IPXV_AnnotHandler_OnAnnotEnter|IPXV_AnnotHandler::OnAnnotEnter]], [[PXV:IPXV_AnnotHandler_OnAnnotExit|IPXV_AnnotHandler::OnAnnotExit]]

Revision as of 00:46, 22 November 2016

PDF annotations located on pages of PDF document are often and widely used in PDF files, and often there are a lot of annotations in PDF documents. To reduce the amount of memory used by PDF files in general usage, PDF-XChange PDF SDK splits annotations in two different objects.

An IPXC_Annotation object that is common interface for all types of annotations in PDF Document and provides an access to common most used properties of annotations.

And a set of objects delivered from IPXC_AnnotData base that implements properties and methods specific for each type of annotations.

Also, each type of annotation has an annotation handler associated with this particular type. For UI interactivity, Editor SDK also provides UI handlers for supported annotation types.

Properties

Actions Handler OC Popup
CreationDate IndexOnPage OnValue Rect
Data IsMarkup Page ReplyTo
Field ModificationDate PageIndex ReplyType
Flags Name PDFObject Type

See Also

IPXC_Page::AddAnnotToGroup, IPXC_Page::ExcludeAnnotFromGroup, IPXC_Page::GetAnnot, IPXC_Page::GetAnnotGroupMembers, IPXC_Page::GetAnnotReplies, IPXC_Page::InsertNewAnnot, IPXC_Page::InsertNewAnnotFromDict, IPXC_Page::MoveAnnot, IPXC_AnnotHandler::CopyAnnot, IPXC_AnnotHandler::CreateAnnotUndoInfo, IPXC_AnnotHandler::GetAnnotData, IPXC_AnnotHandler::GetAnnotRotatePoint, IPXC_AnnotHandler::GetAnnotTipPoint, IPXC_AnnotHandler::GetAppearance, IPXC_AnnotHandler::GetPrintAppearance, IPXC_AnnotHandler::HasAppearanceForAppType, IPXC_AnnotHandler::LoadAnnotData, IPXC_AnnotHandler::RotateAnnot, IPXC_AnnotHandler::SaveAnnotData, IPXC_AnnotHandler::ScaleAnnot, IPXC_AnnotHandler::SerializeAnnot, IPXC_AnnotHandler::TransformAnnot, IPXC_AnnotHandler::UndoAnnot, IPXC_OCContext::GetAnnotAppStyle, IPXC_OCContext::IsAnnotVisible, IPXC_AnnotsVisibilityCallback::GetAnnotVisibility, IPXC_FormField::GetWidgetIndex, IPXC_FormField::Widget, IPXC_AnnotsList::Insert, IPXC_AnnotsList::Item, IPXV_Inst::GetAnnotHandler, IPXV_Document::FireAnnotChangedEvent, IPXV_Document::FireAnnotDeletedEvent, IPXV_Document::FireAnnotInsertedEvent, IPXV_Document::InvalidateAnnot, IPXV_PagesView::EnsureVisibleAnnot, IPXV_PagesView::GetAnnotFromPt, IPXV_PagesView::GetAnnotRectOnDevice, IPXV_PagesView::GetAnnotRectOnPage, IPXV_PagesView::GetLastHitTestRes, IPXV_PagesView::GetLinkFromPt, IPXV_PagesView::InvalidateAnnot, IPXV_PagesView::IsAnnotVisible, IPXV_InvalidatePagesInfo::GetGroupItem, IPXV_InvalidatePagesInfo::InvalidateAnnot, IPXV_AnnotsList::Find, IPXV_AnnotsList::Insert, IPXV_AnnotsList::Remove2, IPXV_AnnotsList::Item, IPXV_AnnotHandler::HitTest, IPXV_AnnotHandler::IsAnnotHandler, IPXV_AnnotHandler::OnAnnotEnter, IPXV_AnnotHandler::OnAnnotExit