How to Migrate from IPDFDocument3 to IPDFDocument4
Knowledge Base :: PDF Creator Pilot 3 Knowledge Base

See Also
Collapse All

IPDFDocument4 is a new interface. It is not compatible with IPDFDocument3. It contains many features that do not exist in IPDFDocument3, but you can migrate from IPDFDocument3 to IPDFDocument4 using the following table.

Method/property in IPDFDocument3

Equivalent in IPDFDocument4

General document methods

Abort Clear
Aborted No equivalent.
AddImageFromBitmapHandle AddImageFromHandle
AddImageFromFilename,
AddImageFromFile
AddImageFromFile
AddImageFromBuffer AddImageFromBLOB
AddImageFromMemory AddImageFromBuffer
AddImageWithColorMask AddImageWithColorMask
AddImageWithMask AddImageWithMask
AddTTFFontFromFile,
AddTTFFontFromFile2,
AddType1FontFromFile
See AddFont, AddFontFromFile, AddBuiltInFont.
AutoCreateURL AutoCreateURL
AutoLaunch SaveToFile
BeginDoc No equivalent. If you need to create one more document, call the Clear method.
BinaryImage GetBuffer
Compression Compression
CreateWaterMark AddWatermark
CurrentWaterMarkIndex AttachWatermark
DocumentInfo_Author SetAuthor, UnicodeAuthor
DocumentInfo_CreationDate No equivalent. There is no such property any more.
DocumentInfo_Creator SetCreator, UnicodeCreator
DocumentInfo_Keywords SetKeywords, UnicodeKeywords
DocumentInfo_Producer SetProducer, UnicodeProducer
DocumentInfo_Subject SetSubject, UnicodeSubject
DocumentInfo_Title SetTitle, UnicodeTitle
EndDoc SaveToFile
FileName SaveToFile
FlipImage TransformImage
FontEmbedStyle FontEmbedStyle
GenerateInMemoryFile No equivalent. If you need an in-memory bufer, call GetBuffer or GetBufferAsBSTR.
GetCurrentPageIndex CurrentPage
GetImageCount GetImageCount
GetImageHeight GetImageHeight
GetImageResolution GetImageResolution
GetImageWidth GetImageWidth
GetUsedDC,
GetUsedDCResolution,
GlyphsToUnicodeStr
No equivalent.
HDC GetDC
InitialZoom InitialZoomPercent
InitialZoom2 InitialZoom
JPEGQuality No equivalent.
LastError GetLastError
LoadICCProfile AddColorSpace
LogActionsAndErrors UseLogging
LogTextOperation No equivalent.
MakeImageGrayScale TransformImage
MakeImageNegative TransformImage
MemoryFileSize GetBufferSize
MetafileImagesCompressionType,
MetafileImagesJpegCompression
No equivalent.
NewPage NewPage, AddPage
NonEmbeddedFonts_Add Set FontEmbedStyle to needed value before adding a font with AddFont, AddFontFromFile, AddBuiltInFont.
NotEmbedAnyFonts Set FontEmbedStyleto EmbedStyle.esNotEmbed.
OutputByteStream GetBufferAsBSTR
OwnerPassword OwnerPassword
PageCount GetPageCount
PageHeight PageHeight
PageLayout ViewerPageLayout
PageMode ViewerMode
PageNumber CurrentPage
PageWidth PageWidth
PlaceImageToCurrentPage ShowImage
PlayEMF PlayMetaFileFromHandle
PrinterForVirtualDC PrinterNameForDC
Printing No equivalent.
ProducePDFA ProducePDFA
ProtectionEnabled No equivalent.
ProtectionKeyLength DocumentEncryption
ProtectionOptions_coAssembly,
ProtectionOptions_coFillAnnotation,
ProtectionOptions_coModifyAnnotation,
ProtectionOptions_coModifyStructure
AllowChangeDocument
ProtectionOptions_coCopyInformation,
ProtectionOptions_coExtractInfo
AllowCopyContent
ProtectionOptions_coPrint,
ProtectionOptions_coPrintHigh
AllowPrintDocument
Resolution PageResolution
SetCurrentPage CurrentPage
SetPDFAOutputIntent SetPDFAOutputIntent
SetPDFXOutputIntent SetPDFXOutputIntent
StartEngine SetLicenseData
SwitchedToWatermarktrue SwitchToWatermark
SwitchedToWatermarkfalse SwitchToCurrentPage
UserPassword UserPassword
UseScreenDC UseScreenBasedDC
Version There is no such property any more, the library will try to set the minimal PDF compatibility version regarding to all features that PDF document has.
ViewerPreferences_vpCenterWindow CenterWindow
ViewerPreferences_vpFitWindow FitWindow
ViewerPreferences_vpHideMenuBar HideViewerMenuBar
ViewerPreferences_vpHideToolBar HideViewerToolBar
ViewerPreferences_vpHideWindowUI HideViewerUI

PDF page methods

PDFPAGE_Arc DrawArc
PDFPAGE_Arc2 DrawAngleArc
PDFPAGE_ArcTo DrawArcTo
PDFPAGE_BeginText No equivalent.
PDFPAGE_CanvasCurrentPointX GetCurrentX
PDFPAGE_CanvasCurrentPointY GetCurrentY
PDFPAGE_Circle DrawCircle
PDFPAGE_Clip Clip
PDFPAGE_ClosePath ClosePath
PDFPAGE_Comment AddComment
PDFPAGE_CurrentTextPositionX GetCurrentTextX
PDFPAGE_CurrentTextPositionY GetCurrentTextY
PDFPAGE_CurveTo DrawCurveTo
PDFPAGE_DrawWatermark AttachWatermark
PDFPAGE_Ellipse DrawEllipse
PDFPAGE_EndText No equivalent.
PDFPAGE_EoClip AlternateClip
PDFPAGE_EoFill AlternateFill
PDFPAGE_EoFillAndStroke AlternateFillAndStroke
PDFPAGE_Fill Fill
PDFPAGE_FillAndStroke FillAndStroke
PDFPAGE_GetColorSpace No equivalent.
PDFPAGE_GetColorSpaceType No equivalent.
PDFPAGE_GetTextHeight GetTextHeight
PDFPAGE_GetTextWidth GetTextWidth
PDFPAGE_GetUnicodeTextHeight GetUnicodeTextHeight
PDFPAGE_GetUnicodeTextWidth GetUnicodeTextWidth
PDFPAGE_GStateRestore RestoreGraphicsState
PDFPAGE_GStateSave SaveGraphicsState
PDFPAGE_Height PageHeight
PDFPAGE_InPath InPath
PDFPAGE_LineTo DrawLineTo
PDFPAGE_MoveTo MoveTo
PDFPAGE_NewPath ResetPath
PDFPAGE_NoDash SetLineDash
PDFPAGE_Orientation PageOrientation
PDFPAGE_PageRotate PageRotate
PDFPAGE_Pie DrawPie
PDFPAGE_Pie2 DrawAnglePie
PDFPAGE_PlayMetaFile,
PDFPAGE_PlayMetaFileEx
PlayMetaFileFromHandle
PDFPAGE_PlayMetaFileExFromFileName,
PDFPAGE_PlayMetaFileFromFileName
PlayMetaFile
PDFPAGE_Rectangle,
PDFPAGE_RectRotated
DrawRectangle
PDFPAGE_Resolution PageResolution
PDFPAGE_Rotate RotateCoords
PDFPAGE_RotateText TextAngle
PDFPAGE_RoundRect DrawRoundRectangle
PDFPAGE_Scale ScaleCoords
PDFPAGE_SetActiveFont UseFont
PDFPAGE_SetCharacterSpacing SetCharacterSpacing
PDFPAGE_SetCMYKColor,
PDFPAGE_SetColor,
PDFPAGE_SetGray,
PDFPAGE_SetRGBColor
SetColor
PDFPAGE_SetCMYKColorFill,
PDFPAGE_SetColorFill,
PDFPAGE_SetGrayFill,
PDFPAGE_SetRGBColorFill
SetColorFill
PDFPAGE_SetCMYKColorStroke,
PDFPAGE_SetColorStroke,
PDFPAGE_SetGrayStroke,
PDFPAGE_SetRGBColorStroke
SetColorStroke
PDFPAGE_SetColorSpace SetColorSpace
PDFPAGE_SetDash SetLineDash
PDFPAGE_SetDefaultCMYKColorSpace,
PDFPAGE_SetDefaultGrayColorSpace,
PDFPAGE_SetDefaultRGBColorSpace
SetColorSpaceType
PDFPAGE_SetFlat SetFlatness
PDFPAGE_SetHorizontalScaling SetTextHorizontalScaling
PDFPAGE_SetLineCap SetLineCapStyle
PDFPAGE_SetLineJoin SetLineJoinStyle
PDFPAGE_SetLineWidth SetLineWidth
PDFPAGE_SetLinkToPage AddLinkToPage
PDFPAGE_SetMiterLimit SetMiterLimit
PDFPAGE_SetPixel Use DrawRectangle with width and height equal to 1px.
PDFPAGE_SetTextPosition SetTextPosition
PDFPAGE_SetTextRenderingMode SetTextRenderingMode
PDFPAGE_SetTextRise SetTextRise
PDFPAGE_SetURL AddHyperLink
PDFPAGE_SetWordSpacing SetWordSpacing
PDFPAGE_ShowImage ShowImage, DrawImage
PDFPAGE_Size PageSize
PDFPAGE_Stroke Stroke
PDFPAGE_TextBox ShowTextAligned
PDFPAGE_TextInitiated No equivalent.
PDFPAGE_TextOut ShowTextAt
PDFPAGE_TextOutBox,
PDFPAGE_TextOutBox2
ShowTextLines
PDFPAGE_TextShow ShowText
PDFPAGE_Thumbnail Thumbnail
PDFPAGE_Translate TranslateCoords
PDFPAGE_UnicodeTextBox ShowUnicodeTextAligned
PDFPAGE_UnicodeTextOut ShowUnicodeTextAt
PDFPAGE_UnicodeTextOutBox,
PDFPAGE_UnicodeTextOutBox2
ShowUnicodeTextLines
PDFPAGE_UnicodeTextShow ShowUnicodeText
PDFPAGE_Watermark AttachWatermark
PDFPAGE_Width PageWidth

Actions

AddControlToAction AddControlToAction
CreateGoToPageAction CreateGoToPageAction
CreateImportDataAction CreateImportDataAction
CreateJavascriptAction CreateJavascriptAction
CreateResetFormAction CreateResetFormAction
CreateSubmitFormAction CreateSubmitFormAction
CreateURLAction CreateHyperLinkAction
CreateVisibleControlAction CreateHideControlAction, CreateShowControlAction
OpenDocumentAction OnOpenDocument
PDFANNOTATION_OnBeforeFormatting OnControlBeforeFormatting
PDFANNOTATION_OnChange OnControlChange
PDFANNOTATION_OnKeyPress OnControlKeyPress
PDFANNOTATION_OnSetFocus OnControlSetFocus
PDFANNOTATION_OnLostFocus OnControlLostFocus
PDFANNOTATION_OnMouseDown OnControlMouseDown
PDFANNOTATION_OnMouseUp OnControlMouseUp
PDFANNOTATION_OnMouseEnter OnControlMouseEnter
PDFANNOTATION_OnMouseExit OnControlMouseExit
PDFANNOTATION_OnOtherControlChanged OnControlOtherChanged

Outlines

GetCurrentPDFOutlineNode No equivalent.
PDFOUTLINENODE_Action GetOutlineAction, SetOutlineAction
PDFOUTLINENODE_CharSet Charset is now specified in methods AddOutlineAfter, AddOutlineBefore, AddOutlineChild.
PDFOUTLINENODE_Count GetOutlineChildCount
PDFOUTLINENODE_Delete,
PDFOUTLINENODE_DeleteChildren
DeleteOutline
PDFOUTLINENODE_Expanded IsOutlineExpanded, SetOutlineExpanded
PDFOUTLINENODE_GetFirstChild GetOutlineFirstChild
PDFOUTLINENODE_GetLastChild GetOutlineLastChild
PDFOUTLINENODE_GetNext GetNextOutline
PDFOUTLINENODE_GetNextSibling GetNextSiblingOutline
PDFOUTLINENODE_GetPrev GetPrevOutline
PDFOUTLINENODE_GetPrevSibling GetPrevSiblingOutline
PDFOUTLINENODE_GetSubItem GetOutlineChild
PDFOUTLINENODE_HasChildren Check GetOutlineChildCount > 0 instead.
PDFOUTLINENODE_Title GetOutlineUnicodeTitle, SetOutlineTitle, SetOutlineUnicodeTitle
PDFOUTLINES_Add,
PDFOUTLINES_AddFirst
AddOutlineAfter, AddOutlineBefore, AddUnicodeOutlineAfter, AddUnicodeOutlineBefore
PDFOUTLINES_AddChild AddOutlineChild, AddUnicodeOutlineChild
PDFOUTLINES_Clear RemoveOutlines
PDFOUTLINES_Count GetOutlineCount
PDFOUTLINES_Delete DeleteOutline
PDFOUTLINES_GetFirstNode No equivalent. See GetRootOutline.
PDFOUTLINES_Insert AddOutlineBefore, AddUnicodeOutlineBefore
SetCurrentPDFOutlineNode No equivalent.

Annotanions

CurrentAnnotationIndex CurrentAnnotation
CurrentAnnotationType GetAnnotType
PDFANNOTATION_Action AnnotAction
PDFANNOTATION_Color ControlBackColor
PDFANNOTATION_BorderColor AnnotBorderColor
PDFANNOTATION_BorderStyle AnnotBorderStyle
PDFANNOTATION_Box_X AnnotLeft
PDFANNOTATION_Box_Y AnnotTop
PDFANNOTATION_Box_H AnnotHeight
PDFANNOTATION_Box_W AnnotWidth
PDFANNOTATION_Caption SetAnnotCaption, AnnotUnicodeCaption
PDFANNOTATION_Charset SetAnnotCaption
PDFANNOTATION_Checked ControlChecked
PDFANNOTATION_EditEnabled ComboBoxEditEnabled
PDFANNOTATION_ExportValue RadioButtonExportValue
PDFANNOTATION_Flags_afHidden AnnotHidden
PDFANNOTATION_Flags_afInvisible AnnotInvisible
PDFANNOTATION_Flags_afNoRotate AnnotNoRotate
PDFANNOTATION_Flags_afNoView AnnotNoView
PDFANNOTATION_Flags_afNoZoom AnnotNoZoom
PDFANNOTATION_Flags_afPrint AnnotPrint
PDFANNOTATION_Flags_afReadOnly AnnotReadOnly

PDFANNOTATION_Font_Charset,
PDFANNOTATION_Font_Name,
PDFANNOTATION_Font_Style_fsBold,
PDFANNOTATION_Font_Style_fsItalic,
PDFANNOTATION_Font_Style_fsStrikeout,
PDFANNOTATION_Font_Style_fsUnderline

ControlFont
PDFANNOTATION_Font_Color ControlTextColor
PDFANNOTATION_Font_Size ControlFontSize
PDFANNOTATION_Hint_Caption SetControlHint, ControlUnicodeHint
PDFANNOTATION_Hint_Charset SetControlHint
PDFANNOTATION_IsPassword IsPasswordEditBox
PDFANNOTATION_Items SetComboBoxItems, ComboBoxUnicodeItems
PDFANNOTATION_Justification ControlTextAlign
PDFANNOTATION_MaxLength EditBoxMaxLength
PDFANNOTATION_Multiline IsMultilineEditBox
PDFANNOTATION_Name ControlName
PDFANNOTATION_Opened IsOpenedTextAnnot
PDFANNOTATION_ReadOnly IsReadOnlyControl
PDFANNOTATION_Required IsReaquiredControl
PDFANNOTATION_ShowBorder ControlShowBorder
PDFANNOTATION_Text SetAnnotText, AnnotUnicodeText
PDFANNOTATION_TextAnnotationIcon TextAnnotIcon
PDFPAGE_CreateControl_Button AddButton
PDFPAGE_CreateControl_Checkbox AddCheckBox
PDFPAGE_CreateControl_Combobox AddComboBox
PDFPAGE_CreateControl_Edit AddEditBox
PDFPAGE_CreateControl_RadioButton AddRadioButton
PDFPAGE_SetAction AddActionArea
PDFPAGE_SetAnnotation AddTextAnnotation, AddUnicodeTextAnnotation

See Also

Reference