Adobe FDK Programmer’s Reference Frame Maker 11.0 Framemaker11 Fdkref
User Manual: adobe FrameMaker - 11.0 - FDK Programmer’s Reference Free User Guide for Adobe FrameMaker Software, Manual
Open the PDF directly: View PDF
Page Count: 1049 [warning: Documents this large are best viewed by clicking the View PDF Link!]
- FDK Programmer’s Reference
- Contents
- What’s New in FDK 11
- Key catalogs for key-based (indirect) referencing
- New FDK APIs to update DITA references
- Support for object styles
- Support for multiple views
- Support for hotspots in objects
- Interactive multimedia links for 3D objects
- Support for referring to content using line numbers
- Support for guided structured authoring with banner text
- New APIs, notifications, error codes, objects, and properties
- CMS Connector Framework
- Function Summary
- Client-defined callback functions
- Books
- Characters
- Clipboard
- Commands and menus
- Data structures: copying
- Debugging
- DITA references: updating
- Dialog boxes: predefined
- Dialog boxes: client-defined
- Documents: comparing
- Documents: file operations
- Documents: formatting
- Documents: updating
- F-codes
- Files, directories, and filepaths
- Fonts
- Graphic insets
- Hash tables
- Hypertext
- I/O
- Insets
- Key Catalogs
- Memory: allocating and deallocating structures
- Memory: manipulating with handles
- Memory: manipulating with pointers
- Menus
- Metrics
- Maker Interchange Format (MIF)
- Objects: creating and deleting
- Objects: getting IDs
- Printing
- Properties
- Selection
- Sessions
- Sleep
- String lists
- Strings: allocating, copying, and deallocating
- Strings: comparing and parsing
- Strings: concatenating
- Strings: miscellaneous
- Strings: encoded
- Structure: manipulating elements
- Structure: manipulating element definitions and format rules
- Tables
- Text
- Text: find and replace
- Text insets
- Unicode
- Undo/Redo
- Utility
- FDK Function Reference
- F_Alloc()
- F_AllocHandle()
- F_ApiAddCols()
- F_ApiAddCommandToMenu()
- F_ApiAddMenuToMenu()
- F_ApiAddRows()
- F_ApiAddText()
- F_ApiAlert()
- F_ApiAlive()
- F_ApiAllocatePropVals()
- F_ApiAllocateTextItems()
- F_ApiApplyAttributeExpression()
- F_ApiApplyAttributeExpressionAsCondition()
- F_ApiApplyPageLayout()
- F_ApiBailOut()
- F_ApiCallClient()
- F_ApiCenterOnText()
- F_ApiCheckStatus()
- F_ApiChooseFile()
- F_ApiClear()
- F_ApiClearAllChangebars()
- F_ApiClientDir()
- F_ApiClientName()
- F_ApiClientPath()
- F_ApiClose()
- F_ApiCombinedFamilyFonts()
- F_ApiCommand()
- F_ApiCompare()
- F_ApiConnectToSession()
- F_ApiCopy()
- F_ApiCopyStructureType()
- F_ApiCustomDoc()
- F_ApiCut()
- F_ApiDeallocateStructureType()
- F_ApiDefineAndAddCommand()
- F_ApiDefineAndAddCommandEx()
- F_ApiDefineAndAddMenu()
- F_ApiDefineCommand()
- F_ApiDefineCommandEx()
- F_ApiDefineMenu()
- F_ApiDelete()
- F_ApiDeleteAllKeyDefinitions()
- F_ApiDeleteCols()
- F_ApiDeletePropByName()
- F_ApiDeleteRows()
- F_ApiDeleteText()
- F_ApiDeleteTextInsetContents()
- F_ApiDialogEvent()
- F_ApiDialogItemId()
- F_ApiDisconnectFromSession()
- F_ApiEnableUnicode()
- F_ApiErr()
- F_ApiFamilyFonts()
- F_ApiFcodes()
- F_ApiFind()
- F_ApiGetAllKeyDefinitions()
- F_ApiGetAllKeys()
- F_ApiGetEncodingForFamily()
- F_ApiGetEncodingForFont()
- F_ApiGetId()
- F_ApiGetImportDefaultParams()
- F_ApiGetInt()
- F_ApiGetIntByName()
- F_ApiGetInts()
- F_ApiGetKeyCatalog()
- F_ApiGetKeyDefinition()
- F_ApiGetMetric()
- F_ApiGetMetricByName()
- F_ApiGetMetrics()
- F_ApiGetNamedObject()
- F_ApiGetNewXMLDefaultParams()
- F_ApiGetObjectType()
- F_ApiGetOpenDefaultParams()
- F_ApiGetPoints()
- F_ApiGetPropIndex()
- F_ApiGetProps()
- F_ApiGetPropVal()
- F_ApiGetSaveDefaultParams()
- F_ApiGetString()
- F_ApiGetStrings()
- F_ApiGetSupportedEncodings()
- F_ApiGetTabs()
- F_ApiGetText()
- F_ApiGetText2()
- F_ApiGetTextForRange()
- F_ApiGetTextForRange2()
- F_ApiGetTextLoc()
- F_ApiGetTextProps()
- F_ApiGetTextPropVal()
- F_ApiGetTextRange()
- F_ApiGetTextVal()
- F_ApiGetUBytesByName()
- F_ApiGetUniqueObject()
- F_ApiGetUpdateBookDefaultParams()
- F_ApiGetVal()
- F_ApiHypertextCommand()
- F_ApiImport()
- F_ApiInitialize()
- F_ApiIsEncodingSupported()
- F_ApiLoadMenuCustomizationFile()
- F_ApiMakeTblSelection()
- F_ApiMenuItemInMenu()
- F_ApiMessage()
- F_ApiModalDialog()
- F_ApiModelessDialog()
- F_ApiMoveComponent()
- F_ApiNetLibSetAuthFunction()
- F_ApiNewAnchoredFormattedObject()
- F_ApiNewAnchoredObject()
- F_ApiNewBookComponentOfTypeInHierarchy()
- F_ApiNewGraphicObject()
- F_ApiNewKeyCatalog()
- F_ApiNewKeyDefinition()
- F_ApiNewNamedObject()
- F_ApiNewSeriesObject()
- F_ApiNewTable()
- F_ApiNewXML()
- F_ApiNotification()
- F_ApiNotify()
- F_ApiObjectValid()
- F_ApiOpen()
- F_ApiOpenResource()
- F_ApiPaste()
- F_ApiPopClipboard()
- F_ApiPrintFAErrno()
- F_ApiPrintImportStatus()
- F_ApiPrintOpenStatus()
- F_ApiPrintPropVal()
- F_ApiPrintPropVals()
- F_ApiPrintSaveStatus()
- F_ApiPrintTextItem()
- F_ApiPrintTextItems()
- F_ApiPrintUpdateBookStatus()
- F_ApiProgressBarEx()
- F_ApiPromptInt()
- F_ApiPromptMetric()
- F_ApiPromptString()
- F_ApiPushClipboard()
- F_ApiQuickSelect()
- F_ApiRedisplay()
- F_ApiReformat()
- F_ApiRehyphenate()
- F_ApiResetEqnSettings()
- F_ApiResetReferenceFrames()
- F_ApiRestartPgfNumbering()
- F_ApiReturnValue()
- F_ApiSave()
- F_ApiScrollBox()
- F_ApiScrollToText()
- F_ApiService()
- F_ApiSetAttributeSimple()
- F_ApiSetClientDir()
- F_ApiSetId()
- F_ApiSetInt()
- F_ApiSetIntByName()
- F_ApiSetInts()
- F_ApiSetMetric()
- F_ApiSetMetricByName()
- F_ApiSetMetrics()
- F_ApiSetPoints()
- F_ApiSetProps()
- F_ApiSetPropVal()
- F_ApiSetString()
- F_ApiSetStrings()
- F_ApiSetTabs()
- F_ApiSetTextLoc()
- F_ApiSetTextProps()
- F_ApiSetTextPropVal()
- F_ApiSetTextRange()
- F_ApiSetTextVal()
- F_ApiSetUBytesByName()
- F_ApiShutDown()
- F_ApiSilentPrintDoc()
- F_ApiSimpleGenerate()
- F_ApiSimpleImportFormats()
- F_ApiSimpleNewDoc()
- F_ApiSimpleOpen()
- F_ApiSimpleSave()
- F_ApiSleep()
- F_ApiStraddleCells()
- F_ApiStringLen()
- F_ApiUndoCancel()
- F_ApiUndoEndCheckPoint()
- F_ApiUndoStartCheckPoint()
- .F_ApiUnStraddleCells()
- F_ApiUpdateBook()
- F_ApiUpdateDITAReference()
- F_ApiUpdateDITAReferences()
- F_ApiUpdateKeyDefinition()
- F_ApiUpdateTextInset()
- F_ApiUpdateVariables()
- F_ApiUpdateXRef()
- F_ApiUpdateXRefs()
- F_ApiUserCancel()
- F_ApiUSleep()
- F_ApiWinConnectSession()
- F_ApiWinInstallDefaultMessageFilter()
- F_Assert()
- F_Calloc()
- F_ChannelAppend()
- F_ChannelClose()
- F_ChannelCloseTmp()
- F_ChannelEof()
- F_ChannelFlush()
- F_ChannelMakeTmp()
- F_ChannelOpen()
- F_ChannelPeek()
- F_ChannelRead()
- F_ChannelSeek()
- F_ChannelSize()
- F_ChannelTell()
- F_ChannelWrite()
- F_CharIsAlphabetic()
- F_CharIsAlphaUTF8()
- F_CharIsAlphaNumeric()
- F_CharIsAlphaNumericUTF8()
- F_CharIsControl()
- F_CharIsControlUTF8()
- F_CharIsDoubleByte()
- F_CharIsDoubleByteFirst()
- F_CharIsDoubleByteSecond()
- F_CharIsEol()
- F_CharIsEolUTF8()
- F_CharIsHexadecimal()
- F_CharIsHexadecimalUTF8()
- F_CharIsLower()
- F_CharIsLowerUTF8()
- F_CharIsNumeric()
- F_CharIsNumericUTF8()
- F_CharIsUpper()
- F_CharIsUpperUTF8()
- F_CharToLower()
- F_CharToLowerUTF8()
- F_CharToUpper()
- F_CharToUpperUTF8()
- F_CharUTF16ToUTF8()
- F_CharUTF32ToUTF8()
- F_CharUTF8ToUTF16()
- F_CharUTF8ToUTF32()
- F_ClearHandle()
- F_ClearPtr()
- F_CopyPtr()
- F_DeleteFile()
- F_DigitValue()
- F_DuplicateHandle()
- F_DuplicatePtr()
- F_Exit()
- F_FdeEncodingsInitialized()
- F_FdeInit()
- F_FdeInitFontEncs()
- F_FilePathBaseName()
- F_FilePathCloseDir()
- F_FilePathCopy()
- F_FilePathFree()
- F_FilePathGetNext()
- F_FilePathOpenDir()
- F_FilePathParent()
- F_FilePathProperty()
- F_FilePathToPathName()
- F_FontEncId()
- F_FontEncName()
- F_FontEncToTextEnc()
- F_Free()
- F_FreeHandle()
- F_GetFilePath()
- F_GetICUDataDir()
- F_GetHandleSize()
- F_HandleEqual()
- F_HashCreate()
- F_HashDestroy()
- F_HashEnumerate()
- F_HashGet()
- F_HashRemove()
- F_HashReportOnData()
- F_HashSet()
- F_IsValidUTF8()
- F_LanguageNumber()
- F_LanguageString()
- F_LockHandle()
- F_MakeDir()
- F_MetricApproxEqual()
- F_MetricConstrainAngle()
- F_MetricDiv()
- F_MetricFloat()
- F_MetricFractMul()
- F_MetricMake()
- F_MetricMul()
- F_MetricNormalizeAngle()
- F_MetricSqrt()
- F_MetricSquare()
- F_MetricToFloat()
- F_MifBegin()
- F_MifComment()
- F_MifDecimal()
- F_MifEnd()
- F_MifGetIndent()
- F_MifIndent()
- F_MifIndentDec()
- F_MifIndentInc()
- F_MifInteger()
- F_MifNewLine()
- F_MifSetIndent()
- F_MifSetOutputChannel()
- F_MifSpace()
- F_MifTab()
- F_MifText()
- F_MifTextString()
- Simple MIF library
- F_PathNameToFilePath()
- F_PathNameType()
- F_Printf()
- F_Progress()
- F_PtrEqual()
- F_ReadBytes()
- F_ReadLongs()
- F_ReadShorts()
- F_Realloc()
- F_ReallocHandle()
- F_RenameFile()
- F_ResetByteOrder()
- F_ResetDirHandle()
- F_Scanf()
- F_SetAssert()
- F_SetByteOrder()
- F_SetDSExit()
- F_SetICUDataDir()
- F_Sprintf()
- F_Sscanf()
- F_StrAlphaToInt()
- F_StrAlphaToIntUnicode()
- F_StrAlphaToReal()
- F_StrAlphaToRealUnicode()
- F_StrBrk()
- F_StrBrkUTF8 ()
- F_StrCat()
- F_StrCatCharN()
- F_StrCatDblCharNEnc()
- F_StrCatIntN()
- F_StrCatN()
- F_StrCatNEnc()
- F_StrCatUTF8CharNByte ()
- F_StrChr()
- F_StrChrEnc()
- F_StrChrUTF8()
- F_StrCmp()
- F_StrCmpN()
- F_StrCmpNEnc()
- F_StrICmpNUTF8Char
- F_StrCmpUTF8()
- F_StrCmpUTF8Locale()
- F_StrICmpUTF8Locale()
- F_StrConvertEnc(), F_StrConvertEnc_IgnoreControlChars(), F_StrConvertEnc_ConvertControlChars()
- F_StrCopyString()
- F_StrCpy()
- F_StrCpyN()
- F_StrCpyNEnc()
- F_StrCpyNUTF8Char ()
- F_StrEqual()
- F_StrEqualN()
- F_StrICmp()
- F_StrICmpEnc()
- F_StrICmpN()
- F_StrICmpNEnc()
- F_StrIEqual()
- F_StrIEqualEnc()
- F_StrIEqualN()
- F_StrIEqualNEnc()
- F_StrIEqualNUTF8Char ()
- F_StrIPrefixEnc()
- F_StrIsEmpty()
- F_StrISuffixEnc()
- F_StrLen()
- F_StrLenEnc()
- F_StrLenUTF16()
- F_StrListAppend()
- F_StrListCat()
- F_StrListCopy()
- F_StrListCopyList()
- F_StrListFirst()
- F_StrListFree()
- F_StrListGet()
- F_StrListIIndex()
- F_StrListIndex()
- F_StrListInsert()
- F_StrListLast()
- F_StrListLen()
- F_StrListNew()
- F_StrListRemove()
- F_StrListSetString()
- F_StrListSort()
- F_StrNew()
- F_StrPrefix()
- F_StrPrefixN()
- F_StrRChr()
- F_StrRChrEnc()
- F_StrReverse()
- F_StrReverseUTF8Char ()
- F_StrStrip()
- F_StrStripLeadingSpaces()
- F_StrStripTrailingSpaces()
- F_StrStripUTF8Chars ()
- F_StrStripUTF8String ()
- F_StrStripUTF8Strings ()
- F_StrSubString()
- F_StrSuffix()
- F_StrTok()
- F_StrTokUTF8 ()
- F_StrTrunc()
- F_StrTruncEnc()
- F_TextEncToFontEnc()
- F_UnlockHandle()
- F_UTF16CharSize()
- F_UTF16NextChar()
- F_UTF8CharSize()
- F_UTF8NextChar()
- F_Warning()
- F_WriteBytes()
- F_WriteLongs()
- F_WriteShorts()
- Object Reference
- Books
- Character formats
- Colors
- Columns
- Combined font definitions
- Commands, menus, menu items, and menu item separators
- Conditions
- Cross-references
- Dialog boxes
- Documents
- Elements
- Flows
- Footnotes
- Format change lists
- Format rules
- Frames
- Graphics
- Insets
- Markers
- Marker types
- Menus
- Menu items
- Pages
- Paragraphs
- Rubi composites
- Table ruling formats
- Separators
- Session
- Structural elements
- Tables
- Table formats
- Text columns
- Text frames
- Text insets
- Text properties
- Variables
- Data Types and Structures Reference
- Data types
- Data structures
- ChannelT
- DirHandleT
- FilePathT
- HandleT
- HashT
- StringListT
- F_AttributeDefsT
- F_AttributeDefT
- F_AttributesT
- F_AttributeT
- F_CombinedFontsT
- F_CombinedFontT
- F_CompareRetT
- F_ElementLocT
- F_ElementRangeT
- F_FontEncT
- F_FontsT
- F_FontT
- F_ElementCatalogEntryT
- F_ElementCatalogEntriesT
- F_IntsT
- F_MetricsT
- F_PointT
- F_PointsT
- F_PropIdentT
- F_PropValT
- F_PropValsT
- F_StringsT
- F_TabT
- F_TabsT
- F_TextItemT
- F_TextItemsT
- F_TextLocT
- F_TextRangeT
- F_TypedValT
- F_UBytesT
- F_UIntsT
- Error Codes
- Calling Clients Shipped with FrameMaker
- CMS Connector FrameWork
- CMS API Data Structures and Enum Constants
- Error Codes
- CMS API Functions
- F_ApiAllocateCMSInfos
- F_ ApiDeallocateCMSInfos
- F_ ApiAllocateCMSProperties
- F_ApiDeallocateCMSProperties
- F_ApiCMSCommand
- F_ApiCMSRegister
- F_ApiCMSCreateObject
- F_ApiCMSEnableCommand
- F_ApiCMSDisableCommand
- F_ApiCMSAddMenuEntry
- F_ApiCMSGetProperties
- F_ApiCMSGetProperty
- F_ApiCMSSetProperties
- F_ApiCMSSetProperty
- F_ApiCMSConfigLoginUI
- F_ApiCMSShowCheckoutUI
- F_ApiCMSShowCheckinUI
- F_ApiCMSShowCancelCheckoutUI
- F_ApiCMSShowDeleteUI
- F_ApiCMSShowCommonListUI
- F_ApiCMSShowPropertyUI
- F_ApiCMSShowBrowseRepositoryUI
- F_ApiCMSGetCmsIdFromName
- F_ApiCMSGetCMSInfo
- F_ApiCMSGetCmsIdFromSession
- F_ApiCMSGetCmsInfoList
- APIs to automate the CMS connectors functionality