Adobe FDK Programmer’s Guide Frame Maker 12.0 Programmer’s Reference Fm 12 Rg En

User Manual: adobe FrameMaker - 12.0 - FDK Programmer’s Reference Free User Guide for Adobe FrameMaker Software, Manual

Open the PDF directly: View PDF .
Page Count: 560 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Scroll down to view the document on your mobile browser.

Contents
Using Frame Developer Tools
- The Frame Developer’s Kit
- Choosing the right Frame tools
- FDK documentation
  - FDK Programmer’s Reference
  - FDK Programmer’s Guide
- Naming conventions
- Style conventions
  - Structured program interface
  - Typographic conventions
Getting Started with FDK 12
- Downloading and installing the FDK
- System requirements
- Reviewing the sample programs in the samples/hello folder
- Getting familiar with how the FDK works on Windows
- Writing FDK clients for Windows
- Compiling, Registering, and Running FDK Clients
- Writing an Asynchronous FDK Client
- Example: adding menus and commands
- Next Steps
Frame Session Architecture
- Identifying objects
  - Unique object names
  - Unique persistent identifiers (UIDs)
- Representing object characteristics with properties
  - Property lists
- FrameMaker product sessions
  - How the API represents sessions
Frame Document Architecture
- Documents
  - What the user sees
  - How the API represents documents
- Global document information
  - What the user sees
  - How the API represents global document information
- Pages
  - What the user sees
  - How the API represents pages
- Graphic objects
  - What the user sees
  - How the API represents graphic objects
- Flows
  - What the user sees
  - How the API represents flows
- Paragraph Catalog formats
  - What the user sees
  - How the API represents Paragraph Catalog formats
- Paragraphs
  - What the user sees
  - How the API represents paragraphs
- Character Catalog formats
  - What the user sees
  - How the API represents Character Catalog formats
- Condition Formats
  - What the user sees
  - How the API represents condition formats
- Text
  - What the user sees
  - How the API represents text
- Markers
  - What the user sees
  - How the API represents markers
  - Adding marker types to documents
  - Mapping old marker types to named marker types
  - The standard list of marker types
- Cross-reference formats
  - What the user sees
  - How the API represents cross-reference formats
- Cross-references
  - What the user sees
  - How the API represents cross-reference instances
  - Client-owned cross references
- Variable formats
  - What the user sees
  - How the API represents variable formats
- Variables
  - What the user sees
  - How the API represents instances of variables
- Footnotes
  - What the user sees
  - How the API represents footnotes
- Ruling Formats
  - What the user sees
  - How the API represents ruling formats
- Table Catalog formats
  - What the user sees
  - How the API represents Table Catalog formats
- Tables
  - What the user sees
  - How the API represents tables
- Colors
  - What the user sees
  - How the API represents colors
  - Library colors, FP_FamilyName, and FP_InkName
  - Tinted colors
  - Reserved colors
- Structural element definitions
  - What the user sees
  - How the API represents structural element definitions
- Format rules and format rule clauses
  - What the user sees
  - How the API represents format rules and format rule clauses
- Format change lists
  - What the user sees
  - How the API represents format change lists
- Structural elements
  - What the user sees
  - How the API represents structural elements
  - Changing an element
Frame Book Architecture
- What the user sees
- How the API represents books
  - How the API organizes book components
  - How the API represents structured books
- Creating new books and components
- Updating a book
- Using the book error log
Introduction to the Frame API
- How the API works
- Special types of clients
- Running clients with different FrameMaker product interfaces
- Creating and running a client
- A simple example
  - Compiling and running the example client
- Using old clients with FDK 12
API Client Initialization
- Responding to the FrameMaker product’s initialization call
- Initialization types
- Disabling the API
- FrameMaker Product Activation by Asynchronous Clients
Creating Your Client’s User Interface
- Using API dialog boxes to prompt the user for input
- Using commands, menu items, and menus in your client
- Replacing FrameMaker product menus and commands
- Allowing users to configure your client’s interface
- Using hypertext commands in your client’s user interface
- Responding to user-initiated events or FrameMaker product operations
  - Requesting notification for events
  - Adding the F_ApiNotify() callback
- Implementing quick keys
- Freeing system resources by bailing out
Executing Commands with API Functions
- Handling errors
- Handling messages and warnings
  - Using simple functions
  - Using scriptable functions
- Opening documents and books
  - Opening a document or book with F_ApiSimpleOpen()
  - Opening a document or book with F_ApiOpen()
- Creating documents
- Printing documents and books
  - Changing the print settings for a document
  - Examples
- Saving documents and books
  - Saving a document or book with F_ApiSimpleSave()
  - Saving a document or book with F_ApiSave()
- Closing documents and books
  - Examples
- Quitting a Frame session
- Comparing documents and books
  - Example
- Updating and generating documents and books
- Simulating user input
- Straddling table cells
  - Example
- Executing FrameMaker commands
Getting and Setting Properties
- What you can do with object properties
- Getting the IDs of the objects you want to change
- Manipulating properties
- Getting and setting session properties
  - Making a document or book active
  - Disabling redisplaying to avoid screen flicker
- Getting and setting document properties
- Getting and setting graphic object properties
- Getting and setting paragraph properties
  - Applying paragraph and Paragraph Catalog formats
  - Adding tabs
- Getting and setting book properties
- Getting and setting FrameMaker properties
Manipulating Text
- Getting text
- Getting and setting the insertion point or text selection
- Adding and deleting text
  - Adding text to table cells
- Getting and setting text formatting
- Executing Clipboard functions
  - Executing Frame Clipboard functions
  - Saving the Clipboard contents
Manipulating Asian Text
- Creating a rubi group
- Text encodings
  - Encoding schemes
  - FrameMaker Roman encoding
- Using encoding data
- Inspecting and manipulating encoded text
  - Getting encoding IDs
  - Functions for encoded strings
- Parsing an encoded string
- Getting the encoding for a text item
- Special issues with double byte encodings
Creating and Deleting API Objects
- Creating objects
- Deleting objects
  - Deleting flows and text frames
  - Deleting table columns and rows
- Implicit property changes
Manipulating Commands and Menus with the API
- How the API represents commands and menus
  - Lists of menus, menu items, and commands in a session
- Getting the IDs of commands and menus
- Determining a session’s menu configuration
- Arranging menus and menu items
- Getting and setting menu item labels
  - Setting the labels of FrameMaker product menu items
  - Setting the labels of client-defined menu items
- Manipulating expandomatic menu items
- Using check marks
- Using context-sensitive commands and menu items
  - Enabling commands for specific contexts
  - Using shift menu items
Creating Custom Dialog Boxes for Your Client
- Overview
  - Designing a dialog box in a FrameMaker product
  - Saving dialog box information
- How to create a dialog box
- Creating a DRE file
- Designing the layout of the dialog box
- Setting the properties of the dialog box
- Setting the properties of a dialog item
- Saving a DRE file
- Modeless Dialog Boxes
- Testing a dialog box
- A simple example
- General tips for dialog editing
- Summary of keyboard shortcuts
Handling Custom Dialog Box Events
- How the API represents dialog boxes
- Overview of using a custom dialog box in your client
  - A simple example
- Opening dialog resources
- Initializing items in a dialog box
- Displaying a dialog box
- Updating items in a dialog box
- Handling user actions in dialog boxes
- Closing a dialog box
Using Imported Files and Insets
- Types of imported files and insets
- Importing text and graphics
- Updating text insets
- Client text insets
- Writing filter clients
- Specifying format IDs and filetype hint strings
- Associating a file format with signature bytes
Working with Unicode
- Introduction to Unicode Support
- Unicode Mode
- Compatibility mode
- International Components for Unicode (ICU)
- Mixed Mode operations
- Handling for special characters
Introduction to FDE
- How the FDE works
  - The virtual environment
  - Utility libraries
- How to make your client portable
- A simple FDE filter
Making I/O and Memory Calls Portable
- Initializing the FDE
- Using platform-independent representations of pathnames
  - Converting pathnames to filepaths
  - Manipulating filepaths
- Making I/O portable with channels
- Assertion-handler functions
- Making memory allocation portable
  - Allocating memory with handles
  - Allocating memory with pointers
- Error and progress reporting
FDE Utility Libraries
- String library
- The string list library
- Character library
- The I/O library
- The hash library
  - Creating hash tables
  - Structures and pointers in keys
- Metric library
- MIF data structures and macros
- The MIF library
- Simple MIF library
Glossary

Navigation menu