manualshive.com logo in svg

Adobe 65030365 - FrameMaker - PC, Manual, Page: 327 / 697

Share
Download
Adobe 65030365 - FrameMaker - PC Manual Download Page 327

319

ADOBE FRAMEMAKER SCRIPTING GUIDE

Object Reference

Last updated 9/26/2011

FCodes.KBD_VAL_DOC

int

Value: 

0xFE3

FCodes.KBD_VAL_IGNORE

int

Value: 

0xFE4

FCodes.KBD_VAL_START

int

Value: 

0xFE5

FCodes.KBD_VAL_ALLOW

int

Value: 

0xFE6

FCodes.KBD_VAL_CLEAR

int

Value: 

0xFE7

FCodes.SW_CSR_UP

int

Value: 

0xFE8

FCodes.SW_CSR_DOWN

int

Value: 

0xFE9

FCodes.SW_CSR_RIGHT

int

Value: 

0xFEA

FCodes.SW_CSR_LEFT

int

Value: 

0xFEB

FCodes.KBD_ATTRIBUTE_EDIT

int

Value: 

0xFEC

FCodes.KBD_ATTR_CONFIG_FILE_MAKER

int

Value: 

0xFFA

FCodes.KBD_ATTR_DISP_OPTS

int

Value: 

0xFEE

FCodes.KBD_FB_EDIT_PREFS

int

Value: 

0xFEF

FCodes.KBD_REMOVE_STRUCT

int

Value: 

0xFF0

FCodes.KBD_TOGGLE_INCLUSION

int

Value: 

0xFF1

FCodes.KBD_TOGGLE_COLLAPSE

int

Value: 

0xFF2

FCodes.KBD_TOGGLE_COLLAPSE_ALL

int

Value: 

0xFF3

FCodes.KBD_TOGGLE_COLLAPSE_CHILDREN

int

Value: 

0xA0D

Property name

Data Type

Summary of Contents for 65030365 - FrameMaker - PC

Page 1: ...Scripting Guide ADOBE FRAMEMAKER 10...

Page 2: ...1990 All rights reserved Proximity Technology A Division of Franklin Electronic Publishers Inc Burlington New Jersey USA Copyright 2003 Franklin Electronic Publishers Inc Copyright 2003 All rights res...

Page 3: ...r Software and Commercial Computer Software Documentation as such terms are used in 48 C F R 12 212 or 48 C F R 227 7202 as applicable Consistent with 48 C F R 12 212 or 48 C F R 227 7202 1 through 22...

Page 4: ...ing the table properties in a document 6 Chapter 3 Differences between scripts and FDK Naming differences between scripts and FDK 8 Notifications 11 Menus and Commands 12 Chapter 4 Object Reference AF...

Page 5: ...t 328 FmtRule 334 FmtRuleClause 334 Fn 335 Font 336 Fonts 336 Group 337 HiddenPage 339 Inset 340 Ints 343 Line 343 Marker 345 MarkerType 346 MasterPage 346 Math 347 Menu 350 MenuItemSeparator 350 Metr...

Page 6: ...TypedVals 400 UBytes 401 UInts 401 UnanchoredFrame 401 Var 404 VarFmt 405 XRef 406 XRefFmt 407 app 407 Chapter 5 Function Summary AFrame 412 Arc 415 AttrCondExpr 416 Attribute 417 AttributeDef 418 At...

Page 7: ...tRule 559 FmtRuleClause 561 Fn 564 Font 565 Fonts 566 Group 567 HiddenPage 568 Inset 570 Ints 576 Line 577 Marker 579 MarkerType 580 MasterPage 581 Math 583 Menu 584 MenuItemSeparator 591 Metrics 592...

Page 8: ...d 9 26 2011 TblFmt 622 TextFrame 622 TextItems 624 TextLine 625 TextLoc 627 TextRange 627 TiApiClient 628 TiFlow 630 TiText 631 TiTextTable 632 TypedVals 633 UBytes 634 UInts 635 UnanchoredFrame 637 V...

Page 9: ...n text like this Function names property names structure names returned values constants filter names program names paths and filenames are also shown in text like this Type Naming Convention Example...

Page 10: ...ements The Graphic customization objects provide the ability to customize the appearance of user interface controls before they are drawn For details see Chapter 4 User Interface Tools in JavaScript T...

Page 11: ...FrameMaker File Script ExtendScript Toolkit is already connected to FrameMaker Only when you launch ExtendScript Toolkit from Windows Start Programs complete the following steps to connect ESTK to Fra...

Page 12: ...ile Script Catalog to display the script library Using the script catalog you can manage your existing scripts Favorites Scripts you tag as your favorite appear here Autorun These scripts run when Fra...

Page 13: ...arch for a class method or property Bookmark a class method or property It then appears under the Bookmarks section ExtendScript use cases Some of the ExtendScript use cases can be Scripts to automate...

Page 14: ...veDoc var tl new TextLoc var firstPgf doc MainFlowInDoc FirstTextFrameInFlow FirstPgf tl obj firstPgf doc AddText tl Hello doc AutoChangeBars 1 The script creates a text location using the new TextLoc...

Page 15: ...ow Using a for loop for each table use the TblLeftIndent method to change the left indentation Use the TblColWidths method to change the width of the column This method accepts the argument in a metri...

Page 16: ...cripts Every API in FDK starts with F_APImethodname Methods are used directly in scripts Remove the F_API prefix before using the methods in scripts For example F_ApiSplitElement becomes just SplitEle...

Page 17: ...e Example 1 demonstrates how FDK properties FP_ActiveDoc FP_MainFlowInDoc and FP_FlowIsSynchronized are mapped to script properties ActiveDoc MainFlowInDoc and FlowIsSynchronized Example 2 Example 2 b...

Page 18: ...tLocT beg The beginning of the range F_TextLocT end The end of the range F_TextRangeT This structure is mapped to the TextRange object with both the properties beg and end being of type TextLoc Notice...

Page 19: ...function and is available readily in scripting Similar to F_ApiNotification The Syntax for Notification is Notification int int int bool it takes a list of notifications FA_Note_preOpenDoc FA_Note_Po...

Page 20: ...ram Note for more details please see F_ApiNotify in FDK reference guide function Notify note object sparam iparam switch note case FA_Note_PostOpenDoc alert Opened document sparam break The line of co...

Page 21: ...t should be unique to the script nMenu1 DefineAndAddCommand 1 cmd1 command1 nMenu2 DefineAndAddCommand 2 cmd2 command2 Another way for creating a command and adding it to menu items cmd3 DefineCommand...

Page 22: ...ed in step 2 4 Finally the block of code function Command cmd case 1 alert Command 1 executed break case 2 alert command 2 executed break assigns the relevant commands to the menu entries defined in s...

Page 23: ...Indicates the frame is cropped AFrameIsFloating bool Indicates whether the anchored frame is set to be floatable or not Possible values are 0 Default Indicates the frame is not floatable 1 Indicates...

Page 24: ...NCHOR_RUN_INTO_PARAGRAPH 17 BaselineOffset int Baseline Offset Element Element If the anchored frame is in a structured flow in a FrameMaker document Element indicates the element containing the ancho...

Page 25: ...e length of an object s border The pattern is stored in a MetricsT structure The 0th element of the MetricsT MetricsT_val array stores the length of the first dash the 1st element stores the following...

Page 26: ...Denotes the next graphic object in the frame NextGraphicInGroup FMObject Denotes the next graphic object in the group NextSelectedGraphicInDoc FMObject Denotes the next selected graphic object in the...

Page 27: ...ts FirstGraphicInFrame FMObject Contains the first object in the anchored frame LastGraphicInFrame FMObject Contains the last object in the anchored frame Property name Data Type Description DTheta in...

Page 28: ...The patterns are denoted by numbers between 0 and 15 The following constants are provided for the fill patterns 0 7 and 15 Constants FV_FILL_BLACK 0 Constants FV_FILL_WHITE 7 Constants FV_FILL_CLEAR 1...

Page 29: ...cates the next graphic object in the group NextSelectedGraphicInDoc FMObject Specifies the next selected graphic object in the document ObjectAttributes Strings Contains a list of strings each string...

Page 30: ...the arrowhead is enabled at the beginning of the line Set to False otherwise TintPercent int Specifies the tint percentage Unique int Denotes the internal identifier of the graphic object Width int S...

Page 31: ...rty name Data Type Description name string Name of the attribute required int Set to True if the attribute is required Else set to False flags uint The flag value determines whether an attribute is hi...

Page 32: ...gers optionally restricted to a range of values Constants FV_AT_REAL 5 A real number optionally restricted to a range of values Constants FV_AT_REALS 6 One or more real numbers optionally restricted t...

Page 33: ...ndexing and a length property AttributesEx methods concat pop push Property name Data Type Description name string The name of the attribute values Strings The attribute value valflags uint The valida...

Page 34: ...cument is single sided Constants FV_BGD_NONE 0x01 The page has no master page background Constants FV_BGD_OTHER 0x02 The page has the custom master page background specified by the MasterPage property...

Page 35: ...to False otherwise Note The IsOnScreen property is always True for books and setting it to False has no effect Label string Denotes the title in the book window title bar Name string Indicates the pat...

Page 36: ...mining the paragraph level are disabled Set to False otherwise DocAcrobatElementList Strings Contains a list of the element tags and context labels to include in bookmarks Note The DocPDFElementList p...

Page 37: ...agraphs or elements that are targets of hypertext links PDFDistillerAbsent int A value of 1 indicates that there is no Acrobat Distiller available Any other value indicates that Acrobat Distiller is a...

Page 38: ...otes the zoom percentage of the PDF document metric 25 to 1600 If the value is negative or zero the value of Constants FV_PDFZoomDefault 1 takes effect PDFZoomType int Denotes the PDF zoom setting at...

Page 39: ...to False PrintNumCopies int Denotes the number of copies to print PrintOddPages int Set to True if Print Odd Numbered Pages is enabled PrintPaperHeight int Specifies the height of the printing paper...

Page 40: ...fInDoc ElementDef Denotes the first element definition in the list of element definitions in the document FO_ElementDef ID HighestLevelElement Element Denotes the top most element for a structured boo...

Page 41: ...parameter for the XML document that is the source of the current document The permissible values are Constants FV_XML_STANDALONE_YES 1 Constants FV_XML_STANDALONE_NO 2 Constants FV_XML_STANDALONE_NONE...

Page 42: ...ts FV_XML_USEBOM_UTF16LE 5 Constants FV_XML_USEBOM_UTF32BE 6 Constants FV_XML_USEBOM_UTF32LE 7 When saving as XML if this property is set to Constants FV_XML_USEBOM_YES 1 FrameMakerwrites a byte order...

Page 43: ...FrameMaker document The property helps in importing back the comments correctly When this flag is turned ON the behavior is same as if the Generate for review only checkbox is ON in the PDF setup dia...

Page 44: ...st of paragraphs Constants FV_BK_LIST_MARKER 4 List of markers Constants FV_BK_LIST_MARKER_ALPHA 5 Alphabetical list of markers Constants FV_BK_LIST_PGF_ALPHA 6 Alphabetical list of paragraphs Constan...

Page 45: ...le int Denotes the chapter numbering style The possible value are Constants FV_NUMSTYLE_NUMERIC 0x00 Arabic Constants FV_NUMSTYLE_ROMAN_UC 0x01 Roman uppercase Constants FV_NUMSTYLE_ROMAN_LC 0x02 Roma...

Page 46: ...Method property is set to Constants FV_NUM_RESTART 0x02 FnFirstNum string Number for the first footnote in the component used when the FnNumComputeMethod property is set to Constants FV_NUM_RESTART 0x...

Page 47: ...nts to be updated with imported formats or element definitions when the user or a client executes Import Formats or Import Element Definitions otherwise set to False InsertLinks int Set to True if hyp...

Page 48: ...he page side on which to start the component document The possible values are Constants FV_BK_START_FROM_FILE 0x01 Constants FV_BK_START_NEXT_AVAILABLE 0x02 Constants FV_BK_START_LEFT 0x03 Constants F...

Page 49: ...numbering type of the component document s table footnote Possible values are Constants FV_NUM_READ_FROM_FILE 0x00 Usethe numbering properties from the document associated with this book component Co...

Page 50: ...EXT 0x0b Text VolumeNumText string If the VolNumStyle property is set to Constants FV_NUMSTYLE_TEXT 0x0b use the string specified in the VolumeNumText property as the chapter number ComponentElement E...

Page 51: ...ESTART 0x02 Constants FV_NUM_SAME 0x03 SectionNumStyle int Denotes the section numbering style Possible values are Constants FV_PAGE_NUM_NUMERIC 0x00 Arabic Constants FV_PAGE_NUM_ROMAN_UC 0x01 Roman u...

Page 52: ...ants FV_PAGE_NUM_ZENKAKU 0x06 Zenkaku Constants FV_PAGE_NUM_ZENKAKU_UC 0x07 Zenkaku uppercase Constants FV_PAGE_NUM_ZENKAKU_LC 0x08 Zenkaku lowercase Constants FV_PAGE_NUM_KANJI_KAZU 0x09 Kazu Constan...

Page 53: ...omRuling RulingFmt Indicates the cell s default bottom ruling FO_RulingFmt ID CellDefaultLeftRuling RulingFmt Specifies the cell s default left ruling FO_RulingFmt ID CellDefaultRightRuling RulingFmt...

Page 54: ...pattern specified by the table format set to False otherwise CellUseOverrideLRuling int Set to True if the cell s left ruling specified by the CellOverrideLeftRuling property overrides the ruling spe...

Page 55: ...on type The possible values are Constants FV_CAPITAL_CASE_NORM 0 Normal capitalization mixed uppercase and lowercase Constants FV_CAPITAL_CASE_SMALL 1 Small caps Constants FV_CAPITAL_CASE_LOWER 2 Lowe...

Page 56: ...hearray of font weights provided by the session property FontWeightNames Language int Denotes the hyphenation and spell checking language to use The possible languages are Constants FV_LANG_NOLANGUAGE...

Page 57: ...ikethrough int Returns True if Strikethrough is enabled otherwise returns False Underlining int Indicates the character tracking expressed as a percentage of an em metric 100 to 1000 UseCapitalization...

Page 58: ...if the Stretch property overrides the default value returns False if the As Is setting is used UseStrikethrough int Returns True if the Strikethrough property overrides the default value returns Fals...

Page 59: ...FV_COLOR_NOT_TINTED 0x7fffffff if the color is not a tint ColorViewCtl int A 12 bit number for spot color views The least significant 2 bits are View 1 the next 2 bits are View 2 and so on The values...

Page 60: ...nstants FV_COLOR_BLACK 4 Constants FV_COLOR_WHITE 5 Constants FV_COLOR_RED 6 Constants FV_COLOR_GREEN 7 Constants FV_COLOR_BLUE 8 TintBaseColor Color Denotes the color from which the tint is derived F...

Page 61: ...specifies index into the arrays of font families provided by the session property FontFamilyNames WesternFamily int Specifies the western font family specifies index into the arrays of font families p...

Page 62: ...nu item is defined by FrameMaker you can read this property but not set it EnabledWhen int The context in which the menu item is enabled If the menu item is defined by FrameMaker you can read this pro...

Page 63: ...ants FV_ENABLE_COPY_FONT 23 The insertion point or selection is in the text of a paragraph a math object a table or a text line Constants FV_ENABLE_CAN_PASTE 24 The Clipboard contains an object or tex...

Page 64: ...uct help directory Note The HelpLink property is valid only for commands created by clients and is not valid for commands created directly by FrameMaker KeyboardShortcutLabel string The keyboard short...

Page 65: ...mmand If the HasShiftOrUnshiftCommand property is set to Constants FV_ITEM_HAS_SHIFT_COMMAND 1 the ShiftOrUnshiftCommand property represents the command to use when the user holds down the Shift key I...

Page 66: ...property of the Doc object to False Name string Denotes the name of the condition format NextCondFmtInDoc CondFmt Denotes the next condition format in the document FO_CondFmt ID SepOverride Color Ind...

Page 67: ...at the color is applied as the background color of the text over which the character format is applied UseBkColor bool The UseBkColor is a Boolean flag which indicates whether the BkColor is set or no...

Page 68: ...alue 12 Constants FE_NotGroup int Value 13 Constants FE_BadNewFrame int Value 14 Constants FE_BadNewGroup int Value 15 Constants FE_BadNewSibling int Value 16 Constants FE_BadDelete int Value 17 Const...

Page 69: ...onNum int Value 30 Constants FE_BadContainer int Value 104 Constants FE_BadTemplatePath int Value 105 Constants FE_BadXmlApplication int Value 106 Constants FE_DupName int Value 32 Constants FE_BadNam...

Page 70: ...nt Value 47 Constants FE_WantsPortrait int Value 48 Constants FE_ViewOnly int Value 49 Constants FE_BadSaveFileName int Value 50 Constants FE_GenRuleItemExpected int Value 51 Constants FE_GenRuleMixed...

Page 71: ...tId int Value 64 Constants FE_BadInsertPos int Value 65 Constants FE_BadBookId int Value 66 Constants FE_BookUnStructured int Value 67 Constants FE_BadCompPath int Value 68 Constants FE_BadElementSele...

Page 72: ...nts FE_BadFileType int Value 83 Constants FE_MissingFile int Value 84 Constants FE_CantUpdateMacEdition int Value 85 Constants FE_CanceledByClient int Value 86 Constants FE_EmptyTextObject int Value 8...

Page 73: ...onstants FE_XRefUnresolved int Value 102 Constants FE_BadXRefSrcDocId int Value 103 Constants FE_InvalidAttrExpr int Value 107 Constants FE_DocAlreadyHasTrackedEdits int Value 108 Constants FE_BookCom...

Page 74: ...dModelessDialogForNonContainer Elem int Value 10009 Constants FR_CancelInsertElementOperation int Value 10010 Constants FR_HideDialogOnClose int Value 10011 Constants FR_DisplayedModalDialogForNonCont...

Page 75: ...FV_HELP_KEYS int Value 1 Constants FV_HELP_SAMPLES int Value 2 Constants FV_HELP_OVERVIEW int Value 3 Constants FV_HELP_ONLINE_MANUALS int Value 4 Constants FV_HELP_CONTEXT int Value 5 Constants FV_HE...

Page 76: ...91 Constants AlertString int Value 2292 Constants AlertType int Value 2293 Constants FV_AlertOneButton int Value 1 Constants FV_AlertTwoButton int Value 2 Constants FV_AlertThreeButton int Value 3 Con...

Page 77: ...ants FF_CMP_HYPERLINKS int Value 0x04 Constants FF_CMP_SUMKIT int Value 0x08 Constants FF_CMP_COMPKIT int Value 0x10 Constants FF_CMP_ATTRIBUTES int Value 0x20 Constants FF_IMAGE_BACKGROUND int Value...

Page 78: ...0 Constants FF_UFF_PGF int Value 0x0001 Constants FF_UFF_FONT int Value 0x0002 Constants FF_UFF_PAGE int Value 0x0004 Constants FF_UFF_TABLE int Value 0x0008 Constants FF_UFF_COND int Value 0x0010 Con...

Page 79: ...Value 0x0004 Constants FF_INSERT_BELOW_RIGHT int Value 0x0008 Constants FF_VISIBLE_ONLY int Value 0x0010 Constants FF_REPLACE_CELLS int Value 0x0020 Constants FF_DONT_APPLY_ALL_ROWS int Value 0x0040...

Page 80: ...Constants FF_CELLS_RES int Value 25 Constants FF_VIEWER_MENU int Value 32 Constants FF_CONTEXT_MENU int Value 33 Constants FF_STRUCTURE_MENU int Value 34 Constants FF_HYPERTEXT int Value 41 Constants...

Page 81: ...TE_CLIP_OBJ int Value 61 Constants FF_OBJ_SEL int Value 62 Constants FF_OBJ_EXT int Value 63 Constants FF_OBJ_EXT_BOR int Value 64 Constants FF_OBJ_Q_COPY int Value 65 Constants FF_OBJ_ROTATE int Valu...

Page 82: ...Constants FF_CMD_KEY int Value 0x0010 Constants FF_ATTRDISP int Value 86 Constants FF_ATTRDISP_ALL int Value 87 Constants FF_EDIT_ATTRIBUTE int Value 88 Constants FF_ATTR_SEL int Value 89 Constants F...

Page 83: ...rceOpenAsText int Value 13 Constants FS_UseRecoverFile int Value 14 Constants FS_UseAutoSaveFile int Value 15 Constants FV_DoCancel int Value 0 Constants FV_DoOK int Value 1 Constants FV_DoYes int Val...

Page 84: ...stants FV_StripStructureAndOpen int Value 10 Constants FS_FontNotFoundInDoc int Value 22 Constants FS_FontChangedMetric int Value 23 Constants FS_RefFileNotFound int Value 24 Constants FV_AllowAllRefF...

Page 85: ...nstants FV_DoUserPreference int Value 12 Constants FS_StructuredOpenApplication int Value 38 Constants FS_SgmlBookFileName int Value 39 Constants FS_OpenFileNotWritable int Value 40 Constants FS_OpenA...

Page 86: ...e 1 Constants FS_OpenNativeError int Value 2 Constants FS_OpenStatus int Value 3 Constants FS_NumOpenReturnParams int Value 3 Constants FV_NumOpenStatusFields int Value 5 Constants FV_LockWasReset int...

Page 87: ...FV_FontsMappedInCatalog int Value 38 Constants FV_LanguagesWerentFound int Value 39 Constants FV_BeefyDoc int Value 40 Constants FV_FileIsOldVersion int Value 41 Constants FV_FileStructureStripped int...

Page 88: ...Value 66 Constants FV_BadFileName int Value 67 Constants FV_CantNewBooks int Value 68 Constants FV_CantOpenBooksViewOnly int Value 69 Constants FV_BadScriptValue int Value 70 Constants FV_MissingScri...

Page 89: ...ants FV_CancelLanguagesNotFound int Value 102 Constants FV_CancelFontsMapped int Value 103 Constants FV_CancelFontMetricsChanged int Value 104 Constants FV_CancelFontsMappedInCatalog int Value 105 Con...

Page 90: ...s FV_CancelFileIsXml int Value 119 Constants FV_TooManyWindows int Value 128 Constants FV_BadTemplate int Value 129 Constants FV_FileNotReadable int Value 130 Constants FS_FileType int Value 1 Constan...

Page 91: ...15 Constants FV_SaveFmtBinary90 int Value 16 Constants FV_SaveFmtInterchange90 int Value 17 Constants FV_SaveFmtCompositeDoc int Value 18 Constants FV_SaveFmtBookWithXml int Value 19 Constants FV_Sav...

Page 92: ...e 2 Constants FS_MakePageCount int Value 7 Constants FV_UseCurrentSetting int Value 0 Constants FV_DontChangePageCount int Value 1 Constants FV_MakePageCountEven int Value 2 Constants FV_MakePageCount...

Page 93: ...Value 16 Constants FS_StructuredSaveApplication int Value 18 Constants FS_SaveFileNotWritable int Value 20 Constants FS_ModDateChanged int Value 21 Constants FS_DitavalFile int Value 22 Constants FS_...

Page 94: ...FV_ProductIsMaker int Value 39 Constants FV_BadSaveObjectId int Value 40 Constants FV_Unstructured int Value 41 Constants FV_InvalidSaveFilter int Value 42 Constants FV_UserCanceledSave int Value 48...

Page 95: ...nstants FS_FileIsGraphic int Value 13 Constants FS_FitGraphicInSelectedRect int Value 14 Constants FS_GraphicDpi int Value 15 Constants FV_DoImportAsTable int Value 8 Constants FS_ForceImportAsText in...

Page 96: ...ts FS_TblNumHeadingRows int Value 26 Constants FS_LeaveHeadingRowsEmpty int Value 27 Constants FS_TreatParaAsRow int Value 28 Constants FS_CellSeparator int Value 29 Constants FS_NumCellSeparators int...

Page 97: ...s FS_ImportedFileName int Value 1 Constants FS_ImportNativeError int Value 2 Constants FS_ImportStatus int Value 3 Constants FS_NumImportReturnParams int Value 3 Constants FV_NumImportStatusFields int...

Page 98: ...ortScript int Value 19 Constants FV_CantForceImportAsText int Value 20 Constants FV_DisallowedImportType int Value 21 Constants FV_NoMainFlow int Value 22 Constants FV_NoFlowWithSpecifiedName int Valu...

Page 99: ...ue 37 Constants FV_CancelImportBrowser int Value 38 Constants FV_CancelFileIsMacEdition int Value 39 Constants FV_CancelFileSgml int Value 40 Constants FV_CancelFileXml int Value 41 Constants FV_Impor...

Page 100: ...tants FS_ExportStatus int Value 3 Constants FV_NumExportStatusFields int Value 2 Constants FS_NumExportReturnParams int Value 3 Constants FV_ExportFileHasNewName int Value 0 Constants FV_ExportProduct...

Page 101: ...nts FS_AllowNonFMFiles int Value 1 Constants FS_AllowViewOnlyFiles int Value 3 Constants FS_ShowBookErrorLog int Value 4 Constants FS_AllowInconsistentNumProps int Value 6 Constants FS_UpdateBookGener...

Page 102: ...Constants FV_CancelViewOnlyFileInBook int Value 33 Constants FV_CancelInconsistentNumPropsInFileInBook int Value 34 Constants FV_UserCanceledUpdateBook int Value 35 Constants FV_BadUpdateBookFileId i...

Page 103: ...Value 0x00000004 Constants FV_ChooseMultiSelect int Value 0x00000008 Constants FV_ChooseMultiOpen int Value 0x00000010 Constants FV_BrowseLocalOnly int Value 0x00010000 Constants FV_BrowseCmsOnly int...

Page 104: ...nts FA_Note_PreFileType int Value 9 Constants FA_Note_PostFileType int Value 10 Constants FA_Note_PreQuitDoc int Value 11 Constants FA_Note_DirtyDoc int Value 12 Constants FA_Note_ClientCall int Value...

Page 105: ...e_PostQuitSession int Value 27 Constants FA_Note_PreRevertDoc int Value 28 Constants FA_Note_PostRevertDoc int Value 29 Constants FA_Note_PreRevertBook int Value 30 Constants FA_Note_PostRevertBook in...

Page 106: ..._PostMouseCommand int Value 45 Constants FA_Note_PreHypertext int Value 46 Constants FA_Note_PostHypertext int Value 47 Constants FA_Note_PrePrint int Value 48 Constants FA_Note_PostPrint int Value 49...

Page 107: ...A_Note_PostSetAttrValue int Value 63 Constants FA_Note_PreImportElemDefs int Value 64 Constants FA_Note_PostImportElemDefs int Value 65 Constants FA_Note_ECMInternal int Value 66 Constants FA_Note_Pre...

Page 108: ...oXrefSrc int Value 80 Constants FA_Note_PostGoToXrefSrc int Value 81 Constants FA_Note_PreOpenSGML int Value 82 Constants FA_Note_PostOpenSGML int Value 83 Constants FA_Note_Dialog int Value 84 Consta...

Page 109: ...e 99 Constants FA_Note_PostSaveSGML int Value 100 Constants FA_Note_U3DCommand int Value 101 Constants FA_Note_Not_U3DCommand int Value 102 Constants FA_Note_Not_RSC_Supported_File int Value 103 Const...

Page 110: ...pFile int Value 117 Constants FA_Note_NewBookmapFile int Value 118 Constants FA_Note_NewTopicFile int Value 119 Constants FA_Note_NewTaskFile int Value 120 Constants FA_Note_NewConceptFile int Value 1...

Page 111: ...nts FA_Note_PostSetPropertyValue int Value 135 Constants FA_Note_Not_AI_Supported_File int Value 136 Constants FA_Note_AI_Supported_File int Value 137 Constants FA_Note_Poster_Applied int Value 138 Co...

Page 112: ...blAnchor int Value 0x00002000 Constants FTI_MarkerAnchor int Value 0x00004000 Constants FTI_XRefBegin int Value 0x00008000 Constants FTI_XRefEnd int Value 0x00010000 Constants FTI_VarBegin int Value 0...

Page 113: ...Constants FTI2_RubiTextBegin int Value 0x80000001 Constants FTI2_RubiTextEnd int Value 0x80000002 Constants FTI2_RubiCompositeBegin int Value 0x80000004 Constants FTI2_RubiCompositeEnd int Value 0x80...

Page 114: ...onstants FTF_KERNX int Value 0x00080000 Constants FTF_KERNY int Value 0x00040000 Constants FTF_SPREAD int Value 0x00020000 Constants FTF_COLOR int Value 0x00010000 Constants FTF_CHARTAG int Value 0x00...

Page 115: ...Value 1 Constants FT_Metric int Value 2 Constants FT_String int Value 3 Constants FT_Id int Value 4 Constants FT_Metrics int Value 5 Constants FT_Strings int Value 6 Constants FT_Points int Value 7 Co...

Page 116: ...Constants FT_AttributesEx int Value 21 Constants FT_Num int Value 22 Constants FI_PLUGIN_PRODUCTNAME int Value 1 Constants FI_PLUGIN_NAME int Value 2 Constants FI_PLUGIN_TYPE int Value 3 Constants FI...

Page 117: ...tants FO_Doc int Value 4 Constants FO_BodyPage int Value 5 Constants FO_MasterPage int Value 6 Constants FO_RefPage int Value 7 Constants FO_HiddenPage int Value 8 Constants FO_Last_Page int Value 8 C...

Page 118: ...stants FO_Math int Value 21 Constants FO_DBGroup int Value 22 Constants FO_Last_Graphic int Value 22 Constants FO_AFrame int Value 23 Constants FO_XLast_Graphic int Value 23 Constants FO_Marker int Va...

Page 119: ...nt Value 37 Constants FO_Row int Value 38 Constants FO_Cell int Value 39 Constants FO_RulingFmt int Value 40 Constants FO_ElementDef int Value 41 Constants FO_Element int Value 42 Constants FO_DialogR...

Page 120: ...nt Value 55 Constants FO_Command int Value 56 Constants FO_MenuItemSeparator int Value 57 Constants FO_FmtChangeList int Value 58 Constants FO_FmtRule int Value 59 Constants FO_FmtRuleClause int Value...

Page 121: ...int Value 73 Constants FO_First_Internal int Value 73 Constants FO_Page int Value 73 0 Constants FO_Graphic int Value 73 1 Constants FO_Frame int Value 73 2 Constants FO_Cblock int Value 73 3 Constan...

Page 122: ...lue 73 15 Constants FO_CMSObject int Value 73 16 Constants FO_Bad int Value 255 Constants FO_AnchoredFrame int Value 23 Constants FO_UFrame int Value 9 Constants Name int Value 20 Constants Unique int...

Page 123: ...nMajor int Value 43 Constants VersionMinor int Value 44 Constants Platform int Value 45 Constants OperatingSystem int Value 46 Constants WindowSystem int Value 47 Constants AutoSave int Value 48 Const...

Page 124: ...e 2408 Constants TechSuiteInternal int Value 2409 Constants IsTechnicalSuiteLicensed int Value 2410 Constants TechSuiteInternal2 int Value 2411 Constants IsFMRunningInTrialPeriod int Value 2412 Consta...

Page 125: ...Names int Value 59 Constants FontFamilyAttributes int Value 60 Constants FV_FAMILY_VISIBLE int Value 0x00000001 Constants FV_FAMILY_SELECTABLE int Value 0x00000002 Constants FV_FAMILY_MAPPED int Value...

Page 126: ...1 Constants CTFontContext int Value 72 Constants FontFamilyFullNames int Value 73 Constants RpcPropertyName int Value 76 Constants RpcProgramNumber int Value 77 Constants DisplayName int Value 78 Cons...

Page 127: ...Constants FM_StructureDir int Value 2031 Constants FM_XmlDir int Value 2032 Constants Reformatting int Value 91 Constants Displaying int Value 92 Constants ApplyFormatRules int Value 93 Constants App...

Page 128: ...04 Constants ActiveAlert int Value 105 Constants Snap int Value 151 Constants Gravity int Value 107 Constants KByteAllocationSize int Value 106 Constants ImportFilters int Value 2288 Constants ExportF...

Page 129: ...ue 109 Constants IsOnScreen int Value 110 Constants NextOpenDocInSession int Value 111 Constants FirstGraphicInDoc int Value 112 Constants FirstPgfInDoc int Value 113 Constants FirstMarkerInDoc int Va...

Page 130: ...7 Constants FirstSelectedGraphicInDoc int Value 128 Constants SelectedTbl int Value 129 Constants FileExtensionOverride int Value 2813 Constants FirstAttrCondExprInDoc int Value 2815 Constants DocOpen...

Page 131: ...Value 138 Constants FV_VOX_NOT_ACTIVE int Value 0 Constants FV_VOX_GOTO_BEHAVIOR int Value 1 Constants FV_VOX_OPEN_BEHAVIOR int Value 2 Constants FV_VOX_ALERT int Value 3 Constants ViewOnlySelect int...

Page 132: ...ants MarkerTypeNames int Value 149 Constants AddMarkerTypeToStandardMarkers int Value 150 Constants ShowAll int Value 155 Constants ShowCondIndicators int Value 156 Constants DontUpdateXRefs int Value...

Page 133: ...188 Constants WideRubiSpaceForJapanese int Value 189 Constants NarrowRubiSpaceForOther int Value 190 Constants WideRubiSpaceForOther int Value 191 Constants FV_WIDE int Value 0 Constants FV_NARROW in...

Page 134: ...olumeNumStyle int Value 213 Constants VolumeNumText int Value 214 Constants ChapNumComputeMethod int Value 215 Constants ChapterNumber int Value 216 Constants ChapterNumStyle int Value 217 Constants F...

Page 135: ...tants FV_NUMSTYLE_FULLWIDTH_UC int Value 0x0d Constants FV_NUMSTYLE_FULLWIDTH_LC int Value 0x0e Constants FV_NUMSTYLE_CHINESE_NUMERIC int Value 0x10 Constants ChapterNumText int Value 218 Constants Fi...

Page 136: ...LWIDTH_UC int Value 0x0d Constants FV_PAGE_NUM_FULLWIDTH_LC int Value 0x0e Constants FV_PAGE_NUM_CHINESE_NUMERIC int Value 0x10 Constants DocIsDoubleSided int Value 226 Constants FirstPageVerso int Va...

Page 137: ...E_FULLWIDTH int Value 0x0c Constants FV_POINT_PAGE_FULLWIDTH_UC int Value 0x0d Constants FV_POINT_PAGE_FULLWIDTH_LC int Value 0x0e Constants FV_POINT_PAGE_CHINESE_NUMERIC int Value 0x10 Constants Page...

Page 138: ...nts CurrentInset int Value 240 Constants ChangeBarDistance int Value 259 Constants ChangeBarPosition int Value 260 Constants FV_CB_COL_LEFT int Value 0x00 Constants FV_CB_COL_RIGHT int Value 0x01 Cons...

Page 139: ...ts FnHeightPerCol int Value 289 Constants FnNumStyle int Value 290 Constants FV_FN_NUM_NUMERIC int Value 0x00 Constants FV_FN_NUM_ROMAN_UC int Value 0x01 Constants FV_FN_NUM_ROMAN_LC int Value 0x02 Co...

Page 140: ...HINESE_NUMERIC int Value 0x10 Constants FnNumberingPerPage int Value 291 Constants FnRefPosition int Value 292 Constants FnRefSuffix int Value 293 Constants FnInstancePrefix int Value 294 Constants Fn...

Page 141: ...rings int Value 337 Constants Numbers int Value 338 Constants Functions int Value 339 Constants HorizontalSpreadSmall int Value 340 Constants HorizontalSpreadMed int Value 341 Constants HorizontalSpre...

Page 142: ...ue 354 Constants EqnLevel2SizeSmall int Value 355 Constants EqnLevel2SizeMed int Value 356 Constants EqnLevel2SizeLarge int Value 357 Constants EqnLevel3SizeSmall int Value 358 Constants EqnLevel3Size...

Page 143: ..._FIT_WINDOW_TO_PAGE int Value 3 Constants ViewTextSymbols int Value 388 Constants ViewGrid int Value 389 Constants ViewDisplayUnits int Value 390 Constants TrackChangesOn int Value 2819 Constants Prev...

Page 144: ...stants LeftMasterPage int Value 413 Constants RightMasterPage int Value 414 Constants FirstBodyPageInDoc int Value 415 Constants LastBodyPageInDoc int Value 416 Constants FirstMasterPageInDoc int Valu...

Page 145: ...int Value 446 Constants PrintLowRes int Value 447 Constants PrintThumbnails int Value 448 Constants PrinterName int Value 449 Constants PrintScale int Value 450 Constants PrintFileName int Value 451...

Page 146: ...perWidth int Value 461 Constants PrintPaperHeight int Value 462 Constants PrintSeps int Value 463 Constants SkipBlankSeps int Value 464 Constants PrintImaging int Value 465 Constants FV_IMG_POSITIVE i...

Page 147: ...D_35 int Value 4 Constants PrintDownloadAsianFonts int Value 501 Constants PrintDownloadTrueTypeAsType1 int Value 502 Constants GenerateAcrobatInfo int Value 2250 Constants AcrobatBookmarkDisplayTags...

Page 148: ...mType int Value 2265 Constants FV_PDFZoomNone int Value 0 Constants FV_PDFZoomDefault int Value 1 Constants FV_PDFZoomPage int Value 2 Constants FV_PDFZoomWidth int Value 3 Constants FV_PDFZoomHeight...

Page 149: ...age int Value 2273 Constants PDFConvertCMYKtoRGB int Value 2274 Constants PDFBookmarksOpenLevel int Value 2275 Constants PDFDistillerAbsent int Value 2276 Constants PDFJobOptionsAbsent int Value 2277...

Page 150: ...ceAbove int Value 479 Constants MaxSpaceBelow int Value 480 Constants MinSpaceBelow int Value 481 Constants MaxLeading int Value 482 Constants MinLeading int Value 483 Constants MaxFontSize int Value...

Page 151: ...710 Constants MaxStretch int Value 711 Constants MinStretch int Value 712 Constants MagicMarker int Value 488 Constants XmlVersion int Value 2800 Constants XmlEncoding int Value 2801 Constants XmlStan...

Page 152: ...t Value 5 Constants FV_XML_USEBOM_UTF32BE int Value 6 Constants FV_XML_USEBOM_UTF32LE int Value 7 Constants XmlWellFormed int Value 2806 Constants FV_XML_WELLFORMED_YES int Value 1 Constants FV_XML_WE...

Page 153: ...tUpdateReferences int Value 494 Constants BookIsViewOnly int Value 497 Constants BookIsSelected int Value 499 Constants TypeOfDisplayText int Value 500 Constants FV_BK_FILENAME int Value 1 Constants F...

Page 154: ...int Value 525 Constants PrevComponentInBook int Value 526 Constants NextComponentInBook int Value 527 Constants InsertLinks int Value 528 Constants ComponentIsSelected int Value 529 Constants NextSel...

Page 155: ...EFERENCES int Value 12 Constants FV_BK_INDEX_FORMATS int Value 13 Constants FV_BK_INDEX_REFERENCES int Value 14 Constants FV_BK_NUM_BOOK_LIST int Value 15 Constants FV_BK_NOT_GENERATABLE int Value 16...

Page 156: ...ts FV_BK_GROUP int Value 0x40 Constants FV_BK_DITAMAP int Value 0x80 Constants FV_BK_BOOKMAP int Value 0x100 Constants FV_BK_FILE int Value 0x200 Constants NextBookComponentInDFSOrder int Value 2333 C...

Page 157: ...FV_PGF_RIGHT int Value 0x02 Constants FV_PGF_CENTER int Value 0x03 Constants FV_PGF_JUSTIFIED int Value 0x04 Constants AutoNumString int Value 548 Constants AutoNumChar int Value 549 Constants Letter...

Page 158: ...ants Hyphenate int Value 564 Constants KeepWithNext int Value 565 Constants UseNextTag int Value 566 Constants Start int Value 567 Constants FV_PGF_ANYWHERE int Value 0x00 Constants FV_PGF_TOP_OF_COL...

Page 159: ...Value 577 Constants FV_LANG_NOLANGUAGE int Value 0x00 Constants FV_LANG_ENGLISH int Value 0x01 Constants FV_LANG_BRITISH int Value 0x02 Constants FV_LANG_GERMAN int Value 0x03 Constants FV_LANG_SWISS_...

Page 160: ..._LANG_SWEDISH int Value 0x11 Constants FV_LANG_JAPANESE int Value 0x12 Constants FV_LANG_TRADITIONAL_CHINESE int Value 0x13 Constants FV_LANG_SIMPLIFIED_CHINESE int Value 0x14 Constants FV_LANG_KOREAN...

Page 161: ...22 Constants FV_LANG_ESTONIAN int Value 0x23 Constants FV_LANG_LATVIAN int Value 0x24 Constants FV_LANG_LITHUANIAN int Value 0x25 Constants FV_LANG_ROMANIAN int Value 0x26 Constants FV_LANG_NUM int Va...

Page 162: ...nts CellRightMargin int Value 584 Constants CellVAlignment int Value 585 Constants FV_PGF_V_ALIGN_TOP int Value 0 Constants FV_PGF_V_ALIGN_MIDDLE int Value 1 Constants FV_PGF_V_ALIGN_BOTTOM int Value...

Page 163: ...Constants MinJRomSpace int Value 591 Constants OptJRomSpace int Value 592 Constants MaxJRomSpace int Value 593 Constants MinJLetSpace int Value 594 Constants OptJLetSpace int Value 595 Constants MaxJ...

Page 164: ...Value 607 Constants Underlining int Value 608 Constants FV_CB_NO_UNDERLINE int Value 0 Constants FV_CB_SINGLE_UNDERLINE int Value 1 Constants FV_CB_DOUBLE_UNDERLINE int Value 2 Constants FV_CB_NUMERI...

Page 165: ...int Value 1 Constants FV_CAPITAL_CASE_LOWER int Value 2 Constants FV_CAPITAL_CASE_UPPER int Value 3 Constants Position int Value 620 Constants FV_POS_NORM int Value 0 Constants FV_POS_SUPER int Value...

Page 166: ...utline int Value 629 Constants UseShadow int Value 630 Constants UsePairKern int Value 631 Constants UseFontSize int Value 632 Constants UseKernX int Value 633 Constants UseKernY int Value 634 Constan...

Page 167: ...ants WesternFontPostScriptName int Value 647 Constants WesternFontPanoseName int Value 648 Constants Tsume int Value 649 Constants UseTsume int Value 650 Constants FV_TAB_LEFT int Value 0x1 Constants...

Page 168: ..._BGD_OTHER int Value 0x02 Constants MasterPage int Value 690 Constants PageWidth int Value 691 Constants PageHeight int Value 692 Constants PagePrev int Value 693 Constants PageNext int Value 694 Cons...

Page 169: ...ILL_BLACK int Value 0 Constants FV_FILL_WHITE int Value 7 Constants FV_FILL_CLEAR int Value 15 Constants Pen int Value 742 Constants HeadArrow int Value 743 Constants TailArrow int Value 744 Constants...

Page 170: ...Constants FV_CAP_ROUND int Value 0x01 Constants FV_CAP_SQUARE int Value 0x02 Constants RunaroundGap int Value 754 Constants TintPercent int Value 755 Constants Overprint int Value 756 Constants FV_KNO...

Page 171: ...e 779 Constants Angle int Value 780 Constants LocX int Value 781 Constants LocY int Value 782 Constants Width int Value 783 Constants Height int Value 784 Constants NextSelectedGraphicInDoc int Value...

Page 172: ...1 Constants InsetEditor int Value 850 Constants InsetUpdater int Value 851 Constants InsetFile int Value 852 Constants InsetFileOrigName int Value 2814 Constants InsetDpi int Value 853 Constants Inset...

Page 173: ...stants FV_MATH_LARGE int Value 2 Constants AnchorType int Value 875 Constants FV_ANCHOR_INLINE int Value 1 Constants FV_ANCHOR_TOP int Value 2 Constants FV_ANCHOR_BELOW int Value 3 Constants FV_ANCHOR...

Page 174: ...s FV_ANCHOR_TEXTFRAME_OUTSIDE int Value 16 Constants FV_ANCHOR_RUN_INTO_PARAGRAPH int Value 17 Constants AFrameIsFloating int Value 876 Constants SideOffset int Value 877 Constants AFrameIsCropped int...

Page 175: ...ants MifFileEntity int Value 2828 Constants MifFileName int Value 2829 Constants PolyIsBezier int Value 906 Constants NumPoints int Value 907 Constants Points int Value 908 Constants RectangleIsSmooth...

Page 176: ...4 Constants ColGapWidth int Value 985 Constants FirstSubCol int Value 986 Constants LastSubCol int Value 987 Constants LineSpacingFactor int Value 988 Constants PgfSpacingFactor int Value 989 Constant...

Page 177: ...c int Value 1003 Constants PrevFn int Value 1004 Constants NextFn int Value 1005 Constants FnAnchorString int Value 1006 Constants OldTypeNum int Value 1024 Constants MarkerText int Value 1025 Constan...

Page 178: ...ue 3 Constants FV_VAR_CURRENT_DATE_SHORT int Value 4 Constants FV_VAR_MODIFICATION_DATE_LONG int Value 5 Constants FV_VAR_MODIFICATION_DATE_SHORT int Value 6 Constants FV_VAR_CREATION_DATE_LONG int Va...

Page 179: ...ADER_FOOTER_8 int Value 22 Constants FV_VAR_HEADER_FOOTER_9 int Value 23 Constants FV_VAR_HEADER_FOOTER_10 int Value 24 Constants FV_VAR_HEADER_FOOTER_11 int Value 25 Constants FV_VAR_HEADER_FOOTER_12...

Page 180: ...int Value 1156 Constants XRefRetainKeydefText int Value 1157 Constants NextXRefFmtInDoc int Value 1074 Constants TextLineType int Value 1095 Constants FV_TEXTLINE_LEFT int Value 0 Constants FV_TEXTLI...

Page 181: ...nts FV_CN_DOUBLE_UNDERLINE int Value 4 Constants FV_CN_CHANGEBAR int Value 5 Constants FV_CN_NUMERIC_UNDERLINE int Value 6 Constants FV_CN_NMRIC_AND_CHNGBAR int Value 7 Constants NextAttrCondExprInDoc...

Page 182: ...1163 Constants MinHang int Value 1164 Constants FlowIsAutoConnect int Value 1165 Constants FlowIsFeathered int Value 1166 Constants Spacing int Value 1167 Constants FlowIsPostScript int Value 1168 Co...

Page 183: ...rrideShading int Value 1197 Constants CellRow int Value 1198 Constants NextCellInTbl int Value 1199 Constants CellBelowInTbl int Value 1200 Constants PrevCellInRow int Value 1201 Constants NextCellInR...

Page 184: ...llDefaultBottomRuling int Value 1215 Constants CellDefaultLeftRuling int Value 1216 Constants CellDefaultRightRuling int Value 1217 Constants CellIsShown int Value 1218 Constants PrevCell int Value 12...

Page 185: ..._PAGE int Value 3 Constants FV_ROW_TOP_OF_RIGHT_PAGE int Value 4 Constants RowType int Value 1253 Constants FV_ROW_HEADING int Value 0 Constants FV_ROW_BODY int Value 1 Constants FV_ROW_FOOTING int Va...

Page 186: ...onstants FV_TBL_TOP_OF_COL int Value 1 Constants FV_TBL_TOP_OF_PAGE int Value 2 Constants FV_TBL_TOP_OF_LEFT_PAGE int Value 3 Constants FV_TBL_TOP_OF_RIGHT_PAGE int Value 4 Constants FV_TBL_FLOAT int...

Page 187: ...nts TblCatalogEntry int Value 1292 Constants TblColRulingPeriod int Value 1293 Constants TblBodyRowRulingPeriod int Value 1294 Constants TblLastBodyRuling int Value 1295 Constants TblHFFill int Value...

Page 188: ...nts TblBodyRowRuling int Value 1310 Constants TblHFSeparatorRuling int Value 1311 Constants TblHFRowRuling int Value 1312 Constants TblOtherBodyRowRuling int Value 1313 Constants TblOtherColRuling int...

Page 189: ...tion int Value 1342 Constants LeftColNum int Value 1343 Constants RightColNum int Value 1344 Constants TblColWidths int Value 1345 Constants TblTitleSelected int Value 1346 Constants NextRulingFmtInDo...

Page 190: ...Constants FV_SEP_WHITE int Value 0x2 Constants ColorPrintCtl int Value 1462 Constants FV_PRINT_SPOT int Value 0x0 Constants FV_PRINT_PROCESS int Value 0x1 Constants FV_PRINT_NO int Value 0x2 Constants...

Page 191: ...11 Constants FV_COLOR_ROYALBLUE int Value 12 Constants FV_COLOR_MAUVE int Value 13 Constants FV_COLOR_LIGHTSALMON int Value 14 Constants FV_COLOR_DARKYELLOW int Value 15 Constants FV_COLOR_SALMON int...

Page 192: ...2 Constants HypertextParseErr int Value 2303 Constants FV_HypertextSyntaxOK int Value 0 Constants FV_HypertextEmptyCommand int Value 1 Constants FV_HypertextUnrecognizedCommand int Value 2 Constants F...

Page 193: ...alue 221 Constants FV_HypertextPageNameNotFound int Value 230 Constants FV_HypertextUnrecognizedObjectType int Value 240 Constants FV_HypertextObjectIDNotFound int Value 241 Constants FV_HypertextBadM...

Page 194: ...2307 Constants FV_CmdNotTyped int Value 0 Constants FV_CmdError int Value 1 Constants FV_CmdUnknown int Value 2 Constants FV_CmdNoop int Value 3 Constants FV_CmdAlert int Value 8 Constants FV_CmdAler...

Page 195: ...Constants FV_CmdOpenLinkFitWin int Value 23 Constants FV_CmdOpenNew int Value 24 Constants FV_CmdOpenObjectId int Value 25 Constants FV_CmdOpenObjectIdFitWin int Value 26 Constants FV_CmdOpenPage int...

Page 196: ...lue 263 Constants FV_CmdEndRange int Value 264 Constants HypertextParsedCmdDest int Value 2308 Constants FV_DestNowhere int Value 0 Constants FV_DestMarkerNewLink int Value 1 Constants FV_DestFirstPag...

Page 197: ...ObjectDataLink int Value 7 Constants HypertextParsedCmdDestObjID int Value 2310 Constants HypertextParsedCmdMatrixRows int Value 2311 Constants HypertextParsedCmdMatrixColumns int Value 2312 Constants...

Page 198: ...onTag int Value 995 Constants IsDitamapInResourceManager int Value 2332 Constants FV_ELEM_DISP_NONE int Value 0 Constants FV_ELEM_DISP_BRACKETS int Value 1 Constants FV_ELEM_DISP_TAGS int Value 2 Cons...

Page 199: ...g int Value 1491 Constants FV_ATTR_EDIT_NONE int Value 0 Constants FV_ATTR_EDIT_REQUIRED int Value 1 Constants FV_ATTR_EDIT_ALWAYS int Value 2 Constants UseInitialStructure int Value 1492 Constants Se...

Page 200: ...e 0x01 Constants FV_LOOSELY_VALID int Value 0x02 Constants FV_ALTERNATIVE int Value 0x04 Constants FV_INCLUSION int Value 0x08 Constants HighestLevelElement int Value 1509 Constants ComponentElement i...

Page 201: ...ue 1584 Constants InitStructurePattern int Value 1585 Constants TableTagging int Value 1585 Constants ElementPgfFormat int Value 1586 Constants PrefixRules int Value 1587 Constants SuffixRules int Val...

Page 202: ...stants FV_FO_CONTAINER int Value 1 Constants FV_FO_SYS_VAR int Value 2 Constants FV_FO_XREF int Value 3 Constants FV_FO_MARKER int Value 4 Constants FV_FO_FOOTNOTE int Value 5 Constants FV_FO_GRAPHIC...

Page 203: ...INTEGER int Value 1 Constants FV_DT_FLOAT int Value 2 Constants FV_DT_NUMTYPES int Value 3 Constants FV_AT_STRING int Value 0 Constants FV_AT_STRINGS int Value 1 Constants FV_AT_CHOICES int Value 2 Co...

Page 204: ...nt Value 2101 Constants StopCountingAt int Value 2102 Constants FmtRuleClauses int Value 2103 Constants FmtRuleClause int Value 2104 Constants FV_CONTEXT_RULE int Value 0 Constants FV_LEVEL_RULE int V...

Page 205: ...ForCSS int Value 2162 Constants ParseFullSpecification int Value 2163 Constants FV_RC_TAG int Value 0 Constants FV_RC_SUB_FMTRULE int Value 1 Constants FV_RC_CHANGELIST int Value 2 Constants FV_RC_CHA...

Page 206: ...23 Constants FV_EDT_ONLY int Value 62 Constants FV_EDT_ATTRGRPO int Value 30 Constants FV_EDT_ELEMENT int Value 25 Constants ElementDef int Value 1621 Constants ParentElement int Value 1622 Constants...

Page 207: ...AttrValue int Value 1637 Constants MatchingFirstPgfClauses int Value 1638 Constants MatchingLastPgfClauses int Value 1639 Constants MatchingPrefixClauses int Value 1640 Constants MatchingSuffixClauses...

Page 208: ...TblHeaderElement int Value 2173 Constants TblBodyElement int Value 2174 Constants TblFooterElement int Value 2175 Constants RubiElement int Value 2176 Constants AllowAsSpecialCase int Value 1649 Cons...

Page 209: ...ComponentMissing int Value 1662 Constants ErrorInBookComponent int Value 1663 Constants NextInvalidElement int Value 1664 Constants ContentMustBeEmpty int Value 1665 Constants AttributeValueRequired i...

Page 210: ...NOT_VALID_AS_ROOT int Value 0x0400 Constants FV_ELEM_BOOK_COMP_MISSING int Value 0x0800 Constants FV_ELEM_BOOK_COMP_INVALID int Value 0x1000 Constants FV_ELEM_ATTRVAL_REQUIRED int Value 0x2000 Constan...

Page 211: ...FV_OVERRIDDEN_DEFAULT int Value 0x00 Constants FV_OVERRIDDEN_NOVALUE int Value 0x01 Constants FV_OVERRIDDEN_CONREF_DUCT int Value 0x02 Constants FV_OVERRIDDEN_KEYDEF_TO_KEYREF int Value 0x03 Constant...

Page 212: ...BottomSepAtIndent int Value 2010 Constants FontSizeChange int Value 2012 Constants SpreadChange int Value 2013 Constants MoveTabs int Value 2014 Constants CellTopMarginFixed int Value 2015 Constants...

Page 213: ...nts FF_IED_DO_NOT_IMPORT_EDD int Value 0x0004 Constants FF_IED_NO_NOTIFY int Value 0x0008 Constants FF_IED_DELETE_EMPTY_PAGES int Value 0x0010 Constants Text int Value 1701 Constants State int Value 1...

Page 214: ...alue 1713 Constants PasswordStyle int Value 1714 Constants TabStops int Value 1715 Constants Icon int Value 1716 Constants WindowHandle int Value 1717 Constants SortingEnabled int Value 1718 Constants...

Page 215: ...Value 10 Constants FV_DlgShow int Value 11 Constants FV_EvShift int Value 0x0001 Constants FV_EvControl int Value 0x0002 Constants FV_EvMeta int Value 0x0004 Constants FV_EvOption int Value 0x0004 Co...

Page 216: ...tButton int Value 1809 Constants DbOKButton int Value 1810 Constants DbCancelButton int Value 1811 Constants DbFbTextBox int Value 1812 Constants DbFbScrollBox int Value 1813 Constants DbFbCurrentDir...

Page 217: ...alue 1926 Constants FV_MENU_MENUBAR int Value 1 Constants FV_MENU_POPUP int Value 2 Constants FV_MENU_ADHOCRULER int Value 3 Constants FV_MENU_DEFAULT int Value 4 Constants FirstMenuItemInMenu int Val...

Page 218: ...s FV_ENABLE_ALWAYS_DISABLE int Value 2 Constants FV_ENABLE_IN_PARA_TEXT int Value 3 Constants FV_ENABLE_IN_TEXT_LINE int Value 4 Constants FV_ENABLE_IS_TEXT_SEL int Value 5 Constants FV_ENABLE_IN_MATH...

Page 219: ...LE_IS_GRAPHIC_INSET int Value 20 Constants FV_ENABLE_IN_FLOW int Value 21 Constants FV_ENABLE_COPY int Value 22 Constants FV_ENABLE_COPY_FONT int Value 23 Constants FV_ENABLE_CAN_PASTE int Value 24 Co...

Page 220: ...COM MAND int Value 3 Constants ShiftOrUnshiftCommand int Value 1940 Constants Mode int Value 1941 Constants FV_MODE_MATH int Value 1 Constants FV_MODE_NONMATH int Value 2 Constants FV_MODE_ALL int Val...

Page 221: ...2057 Constants TiIsNested int Value 2058 Constants TiMainFlow int Value 2059 Constants TiFlowName int Value 2060 Constants TiFlowPageSpace int Value 2061 Constants FV_BODY_PAGE int Value 0x00 Constan...

Page 222: ...Value 8 Constants FV_EUC_CNS int Value 9 Constants FV_GB int Value 10 Constants FV_HZ int Value 11 Constants FV_Korean int Value 12 Constants TiEOLisEOP int Value 2065 Constants TiTblTag int Value 20...

Page 223: ...s ParentTextFrame int Value 2200 Constants PrevSubCol int Value 2201 Constants NextSubCol int Value 2202 Constants Overflowed int Value 983 Constants FirstCombinedFontDefnInDoc int Value 2280 Constant...

Page 224: ...lue 2 1 Constants FS_FindCharFmt int Value 3 Constants FS_FindPgfTag int Value 4 Constants FS_FindCharTag int Value 5 Constants FS_FindTableTag int Value 6 Constants FS_FindObject int Value 8 Constant...

Page 225: ...acterFormatOverride int Value 13 Constants FV_FindTableFormatOverride int Value 14 Constants FS_FindMarkerOfType int Value 9 Constants FS_FindMarkerText int Value 10 Constants FS_FindXRefWithFormat in...

Page 226: ...s FV_WriteUnknownWordsToFile int Value 3 Constants FS_OutputFilePathName int Value 1006 Constants FS_SpellWrap int Value 1007 Constants FS_NumSpellParams int Value 1007 1000 1 Constants FV_SpellMisspe...

Page 227: ...int Value 6 Constants FV_ClearDocDictionary int Value 7 Constants FV_ChangePersonalDictionary int Value 8 Constants FV_GetDictionaryStrings int Value 9 Constants CursorData int Value 2294 Constants Cu...

Page 228: ...lowNewFileURL int Value 2416 Constants DoPostXSLTValidationOnExport int Value 2417 Constants DoNotExportInvalidXML int Value 2418 Constants SuppressXMLParserWarnings int Value 2419 Constants RemoveExt...

Page 229: ...nts FV_ListViewAddColumnParam4 int Value 1 Constants FV_ListViewAddRowNumParams int Value 1 Constants FV_ListViewAddRowParam1 int Value 6 Constants FV_ListViewDeleteAllRowsNumParams int Value 0 Consta...

Page 230: ...oc Rubi Specifies the first rubi composite in the list of the document s rubi composites FirstRulingFmtInDoc RulingFmt Indicates the first ruling format in the list of the document s ruling formats Fi...

Page 231: ...ID in the document AcrobatBookmarkDisplayTags int Set to True if Include Paragraph Tags in Bookmark Text is on the paragraph tag is added before the paragraph text in each bookmark False otherwise Do...

Page 232: ...be any integer or one of the following defined values Constants FV_PDFBookmarksOpenDefaultLevel 1 Constants FV_PDFBookmarksOpenAllLevels 2 Constant FV_PDFBookmarksOpenNoneLevel 3 Ifyouspecifyaninteger...

Page 233: ...ns the generated PDF document PDFPageHeight int Indicates the page height for the generated PDF PDFPageWidth int Indicates the page width for the generated PDF PDFPrintPageRange int Set to True to gen...

Page 234: ...notes the component document s chapter numbering type The possible value is one of Constants FV_NUM_CONTINUE 0x01 Continue the numbering from the previous chapter Constants FV_NUM_RESTART 0x02 Use the...

Page 235: ...Text ChapterNumText string If the ChapNumStyle property is set to Constants FV_NUMSTYLE_TEXT 0x0b use the value of the ChapterNumText property as the chapter number Dictionary Strings List of words t...

Page 236: ...d only if the text formatting at the insertion point overrides the character format If the insertion point is in a text range that does not have a character format applied to it the FormatOverride pro...

Page 237: ...e Specifies the currently selected text range or insertion point in the document Untouchable int Set to False by default Setting this to True allows your client to modify a document without setting th...

Page 238: ...Text VolumeNumText string Use the value of the VolumeNumText property if the VolNumStyle property is set to Constants FV_NUMSTYLE_TEXT 0x0b AutoChangeBars int Returns True if Automatic Change Bars ar...

Page 239: ...l 3 expressions in large equations 2 pt to 400 pt EqnLevel3SizeMed int Indicates the point size of level 3 expressions in medium equations 2 pt to 400 pt EqnLevel3SizeSmall int Indicates the point siz...

Page 240: ...dCode value Constants FV_HypertextMissingArguments 3 Oneor more arguments required for the command is missing Constants FV_HypertextExtraArguments 4 More than the required number of arguments for the...

Page 241: ...rtextUnrecognizedObjectType 240 The referenced file is valid but the link is to an object with an unrecognized object type Constants FV_HypertextObjectIDNotFound 241 The file is a link to an object bu...

Page 242: ...2011 HypertextParseBadParam int Denotes the index into the string list contained in the HypertextParsedArgs property in case of a parser error HypertextParseErrMsg string Denotes the message that Fram...

Page 243: ...V_CmdGoToNew 13 gotonew command Constants FV_CmdGoToPage 14 gotopage command Constants FV_CmdGoToObjectId 15 gotoObjectId command Constants FV_CmdGoToObjectIdFitWin 16 gotoObjectIdfitwin command Const...

Page 244: ...Destination is a cross reference HypertextParsedCmdDestObjType int Denotes the type of the object in the target document for links to objects The possible value is one of Constants FV_ObjectUnknown 0...

Page 245: ...mdMessage 18 HypertextParsedDIFileName string Denotes the absolute path to the target file expressed in platform independent syntax for links to external files MenuBar Menu Denotes the identifier of t...

Page 246: ..._NUM_ALPHA_LC 0x04 Alphabetic lowercase Constants FV_FN_NUM_KANJI 0x06 Kanji characters Constants FV_FN_NUM_ZENKAKU 0x07 Zenkaku Constants FV_FN_NUM_ZENKAKU_UC 0x08 Zenkaku uppercase Constants FV_FN_N...

Page 247: ...nts FV_PAGE_NUM_NUMERIC 0x01 Arabic Constants FV_PAGE_NUM_ROMAN_UC 0x01 Roman uppercase Constants FV_PAGE_NUM_ROMAN_LC 0x02 Roman lowercase Constants FV_PAGE_NUM_ALPHA_UC 0x03 Alphabetic uppercase Con...

Page 248: ...uppercase Constants FV_PAGE_NUM_ZENKAKU_LC 0x08 Zenkaku lowercase Constants FV_PAGE_NUM_KANJI_KAZU 0x09 Kazu Constants FV_PAGE_NUM_DAIJI 0x0a Daiji RightMargin int Denotes the Right page margin SmartQ...

Page 249: ...ll PrintEvenPages int Set to True if Print Even Numbered Pages is enabled Set to False otherwise PrintFileName string Name of the file to which to print You can set the filename to the default filenam...

Page 250: ...nt is in the fluid view PrintStartPageName int Indicates the page number string for the first page to print This property is valid only when the pages are numbered with a style other than Constants FV...

Page 251: ...the value for a composite ruby object The value is one of Constants FV_Wide 0 Constants FV_Narrow 1 Constants FV_Proportional 2 ElementSelection ElementRange Denotes the currently selected element ra...

Page 252: ...st indent allowed in the document MaxFontSize int Denotes the maximum font size allowed in the document MaxLeading int Denotes the maximum leading allowed in the document MaxLeftIndent int Specifies t...

Page 253: ...inTopMargin int Indicates the minimum top margin allowed in the document NewElemAttrDisplay int Specifies the attribute display properties for new elements The value is one of Constants FV_ATTR_DISP_N...

Page 254: ...parameter for the XML document that is the source of the current document The value is one of Constants FV_XML_STANDALONE_YES 1 Constants FV_XML_STANDALONE_NO 2 Constants FV_XML_STANDALONE_NODEC 3 Con...

Page 255: ...the resulting XML when saving as XML XmlVersion string Indicates the XML Version that was specified in the XML Declaration when the file was opened If no XML version was specified the GetString metho...

Page 256: ...JI 0x0B Daiji Constants FV_FN_NUM_CUSTOM 0x05 Custom numbering TblFnPosition int Denotes the placement of the footnote number in the text The value is one of Constants FV_FN_POS_SUPER 0x00 Superscript...

Page 257: ...t int Denotes the font weight specifies an index into the array of font weights provided by the session property FontWeightNames InCond Objects Indicates the condition tags that apply to the text an a...

Page 258: ...otes the character stretch set width for small caps expressed as a percentage of normal stretch for the font metric 10 to 1000 SubScriptShift int Denotes the baseline offset of subscripts expressed as...

Page 259: ...pot color separation view The values range from 0 to 6 0 specifies View 1 1 specifies View 2 and so on ViewBorders int Returns True if Borders is enabled else returns False ViewDisplayUnits int Denote...

Page 260: ...window menu bar Else returns False ViewOnlyWinPalette int Returns True if the document is a palette Else returns False ViewOnlyWinPopup int Returns True if the document window pop up menu is available...

Page 261: ...etic uppercase Constants FV_PAGE_NUM_ALPHA_LC 0x04 Alphabetic lowercase Constants FV_PAGE_NUM_KANJI 0x05 Kanji characters Constants FV_PAGE_NUM_ZENKAKU 0x06 Zenkaku Constants FV_PAGE_NUM_ZENKAKU_UC 0x...

Page 262: ...Indicates the text to use for the SubsectionNumber parameter TrackChangesOn bool Set to True if Track Changes are on in the document Else set to False PreviewState int Sets retrieves the state of Tra...

Page 263: ...wNamedRulingFmt NewNamedTblFmt NewNamedVarFmt NewNamedXRefFmt NewPolygon NewPolyline NewRectangle NewRoundRect NewSeriesBodyPage NewSeriesObject NewSeriesPgf NewTable NewTextFrame NewTextLine NewUnanc...

Page 264: ...type of element The value is one of Constants FV_FO_CONTAINER 1 Constants FV_FO_SYS_VAR 2 Constants FV_FO_XREF 3 Constants FV_FO_MARKER 4 Constants FV_FO_FOOTNOTE 5 Constants FV_FO_GRAPHIC 6 Constant...

Page 265: ...lement MatchingTextClauses Objects IDs of the text clauses FO_FmtRuleClause IDs in the element s definition that apply to the element TextRange TextRange Denotes the Text range that the element encomp...

Page 266: ...t Element s parent element FO_Element ID PrevSiblingElement Element Element s previous sibling element FO_Element ID Namespace Strings Prefix path pairs defining namespaces for the element This list m...

Page 267: ...he element ContentNeededAtEnd is obsolete but is supported for backward compatibility ElementIsExcludedInContext int True if the element is excluded ElementIsInvalidInParent int True if the element ca...

Page 268: ...example if the ElementTypeMismatch property is True the Constants FV_ELEM_TYPE_MISMATCH 0x0002 flag is set The various bit flags are as follows Constants FV_ELEM_UNDEFINED 0x0001 Constants FV_ELEM_TYP...

Page 269: ...turned The value is one of the following Constants FV_STRICTLY_VALID 0x01 Catalogentryis strictly valid Constants FV_LOOSELY_VALID 0x02 Catalogentryis loosely valid Constants FV_ALTERNATIVE 0x04 Catal...

Page 270: ...InCatalog int True if the element is in the Element Catalog ElementPgfFormat string The name of the paragraph format applied to the element Exclusions Strings List of excluded elements FirstPgfRules O...

Page 271: ...nts FV_DT_FLOAT 2 AllowedDataRange TBD Defines the permissible range of values for the values defined in the ElementDataType property DescriptiveTag string A small description about the element If the...

Page 272: ...wn to nearest 1 16 point It is not used if the ArrowScaleHead property is set to False ArrowScaleHead int Set to True if arrowhead is scaled as the line width changes Set to False otherwise ArrowTipAn...

Page 273: ...nt Distance from the left side of the parent frame 216 inches to 216 inches Note For anchored frames the distance is automatically calculated from the left side of the page frame You cannot manually s...

Page 274: ...n the frame PrevGraphicInGroup FMObject Previous graphic object in the group Runaround int Specifies whether text can flow around the object and if so whether the text follows the contour of the objec...

Page 275: ...OW int Value 0xC400 FCodes END_WINDOW int Value 0xC500 FCodes LEAVE_DOC int Value 0xC600 FCodes SERVER_CANCEL int Value 0xC001 FCodes SERVER_QUERY int Value 0xC002 FCodes MENU_BARSTART int Value 0xC30...

Page 276: ...4 FCodes CSR_BOL int Value 0x105 FCodes CSR_EOL int Value 0x106 FCodes CSR_BOW int Value 0x107 FCodes CSR_EOW int Value 0x108 FCodes CSR_BOS int Value 0x109 FCodes CSR_EOS int Value 0x10A FCodes CSR_B...

Page 277: ...ue 0x118 FCodes DEL_BOL int Value 0x119 FCodes KBD_KERNUP int Value 0x11A FCodes KBD_KERNDOWN int Value 0x11B FCodes KBD_KERNLEFT int Value 0x11C FCodes KBD_KERNRIGHT int Value 0x11D FCodes KBD_KERNHO...

Page 278: ...nt Value 0x143 FCodes CSR_NEXT_COL int Value 0x144 FCodes CSR_NEXT_ELEMENT int Value 0x145 FCodes CSR_PREV_ELEMENT int Value 0x146 FCodes CSR_BOE int Value 0x149 FCodes CSR_EOE int Value 0x14A FCodes...

Page 279: ...t Value 0x222 FCodes KBD_TABLE_TAB int Value 0x223 FCodes KBD_TAB int Value 0x219 FCodes KBD_XCHARS int Value 0x224 FCodes KBD_SOFTHYPHEN int Value 0x225 FCodes KBD_DONTHYPHEN int Value 0x226 FCodes K...

Page 280: ...KBD_RGLOBAL int Value 0x233 FCodes KBD_RANDF int Value 0x234 FCodes KBD_SETSEARCH int Value 0x235 FCodes HIGH_CHAR int Value 0x240 FCodes HIGH_WORD int Value 0x241 FCodes HIGH_LINE int Value 0x242 FCo...

Page 281: ...ORT_DLGS int Value 0x254 FCodes KBD_WAIT_DLGS int Value 0x255 FCodes TXT_BOLD int Value 0x260 FCodes TXT_ITALIC int Value 0x261 FCodes TXT_UNDERLINE int Value 0x262 FCodes TXT_PLAIN int Value 0x263 FC...

Page 282: ...AM int Value 0x26B FCodes TXT_STRIKEOUT int Value 0x26C FCodes TXT_DEFAULT int Value 0x26D FCodes TXT_OVERLINE int Value 0x26E FCodes TXT_CHANGEBAR int Value 0x26F FCodes TXT_KERN int Value 0x270 FCod...

Page 283: ..._SELUNDERLINE int Value 0x27C FCodes TXT_SELPLAIN int Value 0x27D FCodes TXT_7 int Value 0xC00 FCodes TXT_9 int Value 0xC01 FCodes TXT_10 int Value 0xC02 FCodes TXT_12 int Value 0xC03 FCodes TXT_14 in...

Page 284: ..._GRAPHIC int Value 0xC15 FCodes KBD_EXPORT_DOCUMENT int Value 0xC16 FCodes TXT_FONT int Value 0xC17 FCodes PGF_APPLY_CAT_TO_SEL int Value 0xF3D FCodes CHAR_APPLY_CAT_TO_SEL int Value 0xF3E FCodes PGF_...

Page 285: ...PGF_LEFTTOP int Value 0x28C FCodes PGF_RIGHTTOP int Value 0x28D FCodes PGF_ANYPLACE int Value 0x28E FCodes KBD_ALIGN_TOP int Value 0x290 FCodes KBD_ALIGN_MIDDLE int Value 0x291 FCodes KBD_ALIGN_BOTTO...

Page 286: ...ALL int Value 0x298 FCodes PGF_NEW_FORMAT int Value 0x299 FCodes KBD_HELP_INDEX int Value 0x2A0 FCodes KBD_HELP_KEYS int Value 0x2A1 FCodes KBD_HELP_SAMPLES int Value 0x2A2 FCodes KBD_HELP_OVERVIEW in...

Page 287: ..._BOOKEDITDEFINE int Value 0x30B FCodes KBD_BOOKRENAMEFILE int Value 0x30C FCodes KBD_BOOKDISPLAYFILENAME int Value 0x30D FCodes KBD_BOOKDISPLAYTEXT int Value 0x30E FCodes KBD_BOOKCOMP_EXCLUDE int Valu...

Page 288: ...t Value 0x3EE FCodes KBD_DELETE_FILE int Value 0x30F FCodes KBD_COLLAPSE_ALL int Value 0x3FA FCodes KBD_EXPAND_ALL int Value 0x3FB FCodes SWITCH_TO_RESOURCEMANAGER int Value 0x9EA FCodes SWITCH_TO_DOC...

Page 289: ...SRATION int Value 0x965 FCodes AMT_DEACTIVATION int Value 0x967 FCodes AMT_UPDATES int Value 0x968 FCodes KBD_REVERT int Value 0x312 FCodes KBD_DOCINFO int Value 0x3DA FCodes KBD_SETPOSTER int Value 0...

Page 290: ...es KBD_PODLOCATION int Value 0x31E FCodes KBD_COMPARE int Value 0x31F FCodes KBD_UNDO int Value 0x320 FCodes KBD_REDO int Value 0x935 FCodes KBD_HIST int Value 0x936 FCodes KBD_REPEAT int Value 0x939...

Page 291: ...int Value 0x32E FCodes KBD_SELECT_FM_FILES int Value 0x315 FCodes KBD_SELECT_PRINTABLE_FILES int Value 0x9E2 FCodes KBD_SELECT_EXCLUDED_FILE int Value 0x9D1 FCodes KBD_SELECT_NONEXCLUDED_FILE int Val...

Page 292: ...O int Value 0x3D6 FCodes KBD_LINK_BOUNDARIES int Value 0x3D7 FCodes KBD_FONTDESIGN int Value 0x330 FCodes KBD_PGFDESIGN int Value 0x331 FCodes KBD_RUBIPROPS int Value 0x3DD FCodes KBD_COLLAYOUT int Va...

Page 293: ...lue 0x35A FCodes KBD_SPLITR int Value 0xA02 FCodes KBD_SPLITL int Value 0xA03 FCodes KBD_ROTPAGE_PLUS int Value 0x34E FCodes KBD_ROTPAGE_MINUS int Value 0x34F FCodes KBD_ROTPAGE_NORM int Value 0xA05 F...

Page 294: ...t Value 0x346 FCodes KBD_DELETEPAGE int Value 0x347 FCodes KBD_FREEZE int Value 0x34B FCodes KBD_TEXTCOLPRO int Value 0x339 FCodes KBD_PREVPAGE int Value 0x34C FCodes KBD_NEXTPAGE int Value 0x34D FCod...

Page 295: ...des KBD_NEWMARKER int Value 0x356 FCodes KBD_EDITMARKERTYPE int Value 0x409 FCodes KBD_DELMARKERTYPE int Value 0x358 FCodes KBD_RENAMEMARKERTYPE int Value 0x35F FCodes KBD_ADDMARKERTYPE int Value 0x41...

Page 296: ...ue 0xC1A FCodes WEB_TOPISSUES int Value 0xC1B FCodes WEB_ADOBEHELP int Value 0xC22 FCodes WEB_CORPORATENEWS int Value 0xC1D FCodes WEB_REGISTRATION int Value 0xC1E FCodes WEB_FRAME_BOOKMARKS int Value...

Page 297: ...s KBD_ACCEPTALLCHANGE int Value 0x960 FCodes KBD_REJECTALLCHANGE int Value 0x961 FCodes KBD_PREVIEW_ACCEPTALL int Value 0x962 FCodes KBD_PREVIEW_REJECTALL int Value 0x963 FCodes KBD_PREVIEW_OFF int Va...

Page 298: ...int Value 0x2B6 FCodes KBD_LIST_REFERENCES int Value 0x2B7 FCodes KBD_INDEX_STANDARD int Value 0x2C0 FCodes KBD_INDEX_AUTHOR int Value 0x2C1 FCodes KBD_INDEX_SUBJECT int Value 0x2C2 FCodes KBD_INDEX_M...

Page 299: ...t Value 0x36E FCodes KBD_VIEWSEP3 int Value 0x36F FCodes KBD_VIEWSEP4 int Value 0x37D FCodes KBD_VIEWSEP5 int Value 0x37E FCodes KBD_VIEWSEP6 int Value 0x39E FCodes KBD_MENUCOMPLETE int Value 0x33D FC...

Page 300: ...int Value 0x3F9 FCodes KBD_HIDE_BORDERS int Value 0x4F1 FCodes KBD_HIDE_SYMBOLS int Value 0x4F2 FCodes KBD_HIDE_RULERS int Value 0x4F3 FCodes KBD_HIDE_GRID int Value 0x4F4 FCodes KBD_HIDE_LINK_BOUNDA...

Page 301: ...H int Value 0x375 FCodes KBD_RESHAPE int Value 0x376 FCodes KBD_JOINCURVES int Value 0x377 FCodes KBD_SETSIDES int Value 0x378 FCodes KBD_CONSTRAIN int Value 0x379 FCodes KBD_SNAP int Value 0x37A FCod...

Page 302: ...0x382 FCodes KBD_UNGROUP int Value 0x383 FCodes KBD_ALIGN int Value 0x384 FCodes KBD_DISTRIBUTE int Value 0x385 FCodes KBD_ROTATE_CW int Value 0x386 FCodes KBD_ROT_MINUS int Value 0x386 FCodes KBD_RO...

Page 303: ...OPENWIN int Value 0x391 FCodes KBD_CLOPWIN int Value 0x392 FCodes KBD_MOVEWIN int Value 0x393 FCodes KBD_EXPOSEWIN int Value 0x395 FCodes KBD_HIDEWIN int Value 0x396 FCodes KBD_HISHWIN int Value 0x397...

Page 304: ...OVALTOOL int Value 0x3A6 FCodes KBD_TEXTLTOOL int Value 0x3A7 FCodes KBD_TEXTRTOOL int Value 0x3A8 FCodes KBD_FREETOOL int Value 0x3A9 FCodes KBD_FRAMETOOL int Value 0x3AA FCodes KBD_LASTTOOL int Valu...

Page 305: ...8 FCodes KBD_SETPEN int Value 0x3B9 FCodes KBD_SETWIDTH int Value 0x3BA FCodes KBD_SETCAP int Value 0x3BB FCodes KBD_SETSEP int Value 0x3BC FCodes KBD_SETSEP_KEEP int Value 0x3BE FCodes KBD_SETSEP_ALL...

Page 306: ..._A int Value 0x43A FCodes KBD_SETFILL_B int Value 0x43B FCodes KBD_SETFILL_C int Value 0x43C FCodes KBD_SETFILL_D int Value 0x43D FCodes KBD_SETFILL_E int Value 0x43E FCodes KBD_SETFILL_F int Value 0x...

Page 307: ...e 0x44C FCodes KBD_SETPEN_D int Value 0x44D FCodes KBD_SETPEN_E int Value 0x44E FCodes KBD_SETPEN_F int Value 0x44F FCodes KBD_SETWIDTH_0 int Value 0x450 FCodes KBD_SETWIDTH_1 int Value 0x451 FCodes K...

Page 308: ...nt Value 0x473 FCodes KBD_SETDASH_4 int Value 0x474 FCodes KBD_SETDASH_5 int Value 0x475 FCodes KBD_SETDASH_6 int Value 0x476 FCodes KBD_SETDASH_7 int Value 0x477 FCodes KBD_SETDASH_8 int Value 0x478...

Page 309: ...alue 0x405 FCodes KBD_INCDASH int Value 0x406 FCodes KBD_DECDASH int Value 0x407 FCodes KBD_DASHOPTION int Value 0x408 FCodes KBD_CHECKSEL int Value 0x3C0 FCodes KBD_CHECKDOC int Value 0x3C1 FCodes KB...

Page 310: ...KBD_REFORMATDOC int Value 0x3CF FCodes KBD_ASC_CORRECT int Value 0x995 FCodes KBD_ASC_ADDUSRDICT int Value 0x996 FCodes KBD_ASC_ADDDOCDICT int Value 0x997 FCodes KBD_ASC_ENABLE_AUTO_SPELL_CHECK int V...

Page 311: ...e 0x416 FCodes HIGH_COL_TOP int Value 0x417 FCodes HIGH_COL_BOT int Value 0x418 FCodes HIGH_FLOW_BEG int Value 0x419 FCodes HIGH_FLOW_END int Value 0x41A FCodes HIGH_LINE_BEG int Value 0x41B FCodes HI...

Page 312: ...int Value 0x510 FCodes HIGH_WORD_NEXT int Value 0x511 FCodes HIGH_LINE_NEXT int Value 0x512 FCodes HIGH_SENT_NEXT int Value 0x513 FCodes HIGH_PGF_NEXT int Value 0x514 FCodes HIGH_SAMECB int Value 0x5...

Page 313: ...OCUS_INPUT_DOC int Value 0x620 FCodes FOCUS_INPUT_SEARCH int Value 0x621 FCodes FOCUS_INPUT_MARKER int Value 0x622 FCodes FOCUS_INPUT_SPELL int Value 0x623 FCodes FOCUS_INPUT_HYPERTEXT int Value 0x624...

Page 314: ...lue 0x683 FCodes KBD_CLOSE_PGFFMT int Value 0x684 FCodes KBD_CLOSE_FONTFMT int Value 0x685 FCodes KBD_CLOSE_COND int Value 0x686 FCodes KBD_CLOSE_CUSTRS int Value 0x687 FCodes KBD_CLOSE_TBLFMT int Val...

Page 315: ...Value 0x666 FCodes KBD_PURIFY_NEW_LEAKS int Value 0x650 FCodes KBD_PURIFY_ALL_LEAKS int Value 0x651 FCodes KBD_PURIFY_CLEAR_LEAKS int Value 0x652 FCodes KBD_COUNT_SBLOCKS int Value 0x653 FCodes KBD_A...

Page 316: ...int Value 0xF06 FCodes KBD_UPDATEREF int Value 0xF07 FCodes KBD_DEREFREF int Value 0xF08 FCodes KBD_HEATREF int Value 0xF09 FCodes KBD_DOC_REPORT int Value 0xF10 FCodes KBD_FULLRULERS int Value 0x3BD...

Page 317: ...e 0xF31 FCodes KBD_ZOOM_FIT_PAGE int Value 0xF32 FCodes KBD_ZOOM_FIT_WINDOW int Value 0xF33 FCodes KBD_ZOOM int Value 0xF34 FCodes KBD_ZOOM100 int Value 0xF35 FCodes KBD_ZOOM_SET int Value 0xF3C FCode...

Page 318: ...e 0xF44 FCodes KBD_CONDNOTINQUICK int Value 0xF45 FCodes KBD_UNCOND int Value 0xF46 FCodes KBD_CONDVISONLYQUICK int Value 0xF47 FCodes KBD_INSERTQUICK int Value 0xF48 FCodes KBD_WRAPQUICK int Value 0x...

Page 319: ...0 FCodes KBD_VERIFYCONTEXT int Value 0xF61 FCodes KBD_SAVEASDBRE int Value 0xF70 FCodes KBD_TEST_MODAL int Value 0xF71 FCodes KBD_TEST_MODELESS int Value 0xF72 FCodes KBD_STUFF_ITEM int Value 0xF73 FC...

Page 320: ...KBD_TABLE_CUSTRS int Value 0xF86 FCodes KBD_TABLE_ADDRC int Value 0xF87 FCodes KBD_TABLE_RESIZECOL int Value 0xF88 FCodes KBD_TABLE_STRADDLE int Value 0xF89 FCodes KBD_TABLE_CONVERT int Value 0xF8A FC...

Page 321: ...EFORE int Value 0xF99 FCodes KBD_TBL_DLG_PASTE_AFTER int Value 0xF9A FCodes KBD_TABLEWIN int Value 0xFBB FCodes TBL_APPLY_CAT_TO_SEL int Value 0xFBC FCodes KBD_CLOSE_TABLE_CATALOG int Value 0xFBD FCod...

Page 322: ...xAAA FCodes CHAR_DESIGNKIT_APPLY int Value 0xAAB FCodes TBL_DESIGNKIT_APPLY int Value 0xAAC FCodes PGF_DESIGNKIT_UPDATEALL int Value 0xAAD FCodes CHAR_DESIGNKIT_UPDATEALL int Value 0xAAE FCodes TBL_DE...

Page 323: ...D int Value 0xB15 FCodes PGF_DESIGNKIT_RESET int Value 0xABA FCodes CHAR_DESIGNKIT_RESET int Value 0xABB FCodes TBL_DESIGNKIT_RESET int Value 0xABC FCodes CONDTEXT_KIT_APPLY int Value 0xB09 FCodes ALT...

Page 324: ...BLIP_RIGHTMOST int Value 0xFB6 FCodes KBD_TBLIP_NEXT int Value 0xFB7 FCodes KBD_TBLIP_PREV int Value 0xFB8 FCodes KBD_TBLIP_TOP int Value 0xFB9 FCodes KBD_TBLIP_BOTTOM int Value 0xFBA FCodes PGF_KBD_S...

Page 325: ...2 FCodes ELEM_INSERT_CUSTOM_3 int Value 0xA23 FCodes ELEM_INSERT_CUSTOM_4 int Value 0xA24 FCodes ELEM_INSERT_CUSTOM_5 int Value 0xA25 FCodes ELEM_INSERT_CUSTOM_6 int Value 0xA26 FCodes ELEM_INSERT_CUS...

Page 326: ...int Value 0xFD7 FCodes KBD_SETELCATSTRICT int Value 0xFD8 FCodes KBD_SETELCATLOOSE int Value 0xFD9 FCodes KBD_SETELCATCHILD int Value 0xFDA FCodes KBD_SETELCATALL int Value 0xFDB FCodes KBD_SETELCATF...

Page 327: ...int Value 0xFE9 FCodes SW_CSR_RIGHT int Value 0xFEA FCodes SW_CSR_LEFT int Value 0xFEB FCodes KBD_ATTRIBUTE_EDIT int Value 0xFEC FCodes KBD_ATTR_CONFIG_FILE_MAKER int Value 0xFFA FCodes KBD_ATTR_DISP_...

Page 328: ...Value 0xFFF FCodes FM_RPT_CMDS_BY_TAG int Value 0xD00 FCodes FM_RPT_CMDS_BY_SHORTCUT int Value 0xD01 FCodes KBD_PASTESPECIAL int Value 0xD10 FCodes KBD_CLOSE_TOP_PALETTE int Value 0xD20 FCodes KBD_CL...

Page 329: ...ODELESSDIALOG int Value 0xD52 FCodes KBD_Item1stLogical int Value 0xD60 FCodes KBD_ItemNextLogical int Value 0xD61 FCodes KBD_ItemPrevLogical int Value 0xD62 FCodes KBD_ItemNextPhysical int Value 0xD6...

Page 330: ...t Value 0x908 FCodes KBD_TAB_DECIMAL int Value 0x909 FCodes KBD_PRINTSETUP int Value 0x90A FCodes KBD_MINIMIZE int Value 0x90F FCodes KBD_MAXIMIZE int Value 0x910 FCodes KBD_RESTORE int Value 0x911 FC...

Page 331: ...Value 0x92A FCodes KBD_EMBEDDED10 int Value 0x92B FCodes KBD_EMBEDDED11 int Value 0x92C FCodes KBD_EMBEDDED12 int Value 0x92D FCodes KBD_EMBEDDED13 int Value 0x92E FCodes KBD_EMBEDDED14 int Value 0x9...

Page 332: ...e 0x97B FCodes KBD_UI_PREFERENCE int Value 0x980 FCodes KBD_UIALERTSTRINGS_PREF int Value 0x981 FCodes KBD_TOOLBAR_SHOWALL int Value 0x989 FCodes KBD_TOOLBAR_HIDEALL int Value 0x98A FCodes KBD_TOOLBAR...

Page 333: ...EL_EXTEND_ELEMENT int Value 0x0800 FCodes TEXTSEL_ELEMENT int Value 0x1000 FCodes TEXTSEL_DRAGGING int Value 0x2000 FCodes EXTEND_SEL int Value 0x0002 0x0004 0x0008 0x0010 0x0800 FCodes MIF_SAVE_TEXT...

Page 334: ...VE_TABLECATS int Value 0x004000 FCodes MIF_SAVE_TABLES int Value 0x008000 FCodes MIF_SAVE_ECAT int Value 0x010000 FCodes MIF_SAVE_ELEMENTS int Value 0x020000 FCodes MIF_SAVE_COLORCAT int Value 0x04000...

Page 335: ...ered incoming format outformat string The registered output format binname string The name of the filter client file args Strings Currently NULL Property name Data Type Description FlowIsAutoConnect i...

Page 336: ...definition as part of the text format rules Name string The name of the format change list if it is in the Format Change List Catalog NextFmtChangeListInDoc FmtChangeList The next format change list...

Page 337: ...rmat for the automatic numbering string specified by AutoNumString if the default character format is used AutoNumString string Autonumber format string for example n n NumAtEnd int True if the number...

Page 338: ...the space above SpaceBelow int Indicates the space below the paragraph SpaceBelowChange int Amount by which to increase or decrease the space below Tabs Tabs An array of tab descriptions that specify...

Page 339: ...nts FV_LANG_SPANISH 0x07 Constants FV_LANG_SWEDISH 0x11 Constants FV_LANG_SWISS_GERMAN 0x04 Constants FV_LANG_JAPANESE 0x12 Constants FV_LANG_TRADITIONAL_CHINESE 0x13 Constants FV_LANG_SIMPLIFIED_CHIN...

Page 340: ...by which to increase or decrease the character stretch Strikethrough int True if Strikethrough is enabled False otherwise Underlining int Type of underlining The value is one of Constants FV_CB_NO_UN...

Page 341: ...ded to default left margin of table cell CellLeftMarginChange int Amount by which to increase or decrease the cell left margin CellLeftMarginFixed int True if the cell left margin is fixed False other...

Page 342: ...ule s type The value is one of Constants FV_CONTEXT_RULE 0 Constants FV_LEVEL_RULE 1 StopCountingAt string Denotes the the tag of the element at which to stop counting elements if the the format rule...

Page 343: ...seType int The type of rule clause The value is one of Constants FV_RC_TAG 0 Constants FV_RC_SUB_FMTRUL 1 Constants FV_RC_CHANGELIST 2 Constants FV_RC_CHANGELIST_TAG 3 Specification string The format...

Page 344: ...he text frame FO_Fn ID Overflowed int True if the text in the footnote overflows False otherwise PrevFn Fn Previous footnote in the text frame FO_Fn ID TextLoc TextLoc Text location of the footnote sy...

Page 345: ...le in degrees ArrowType int Arrowhead style The value is one of Constants FV_ARROW_STICK 0x1 Constants FV_ARROW_HOLLOW 0x2 Constants FV_ARROW_FILLED 0x3 BorderWidth int Denotes the border width 0 015...

Page 346: ...ou cannot set LocY for anchored frames NextGraphicInDoc FMObject Next graphic object in the document NextGraphicInFrame FMObject Next graphic object in the frame NextGraphicInGroup FMObject Next graph...

Page 347: ...one of Constants FV_TR_NONE 0x01 Constants FV_TR_CONTOUR 0x02 Constants FV_TR_BBOX 0x03 RunaroundGap int Denotes the the width of the runaround gapfor a runaround object TailArrow int True if arrowhea...

Page 348: ...rue if scaling of bitmap file is inhibited False otherwise InsetIsFlippedSideways int True if inset is flipped about the vertical axis False otherwise InsetUpdater string Not currently implemented Pag...

Page 349: ...t FO_AFrame or FO_UnanchoredFrame ID GraphicCantBeSelected int True if the graphic object cannot be selected False otherwise GraphicIsSelected int True if the graphic object is selected False otherwis...

Page 350: ...overprint settings for the object The value is one of Constants FV_KNOCKOUT 0x00 Constants FV_OVERPRINT 0x01 Constants FV_FROMCOLOR 0x02 Pen int The pen pattern numbers between 0 and 7 The ESTK provid...

Page 351: ...eFactor int Specifies the factor by which arrowhead is scaled as line width changes always rounded down to nearest 1 16 point It is not used if the ArrowScaleHead property is set to False ArrowScaleHe...

Page 352: ...e the distance is calculated from the left side of the page frame You cannot set LocX for anchored frames LocY int Distance from the top of the parent frame 216 inches to 216inches Ifthegraphicobjecti...

Page 353: ...onstants FV_TR_BBOX 0x03 RunaroundGap int Denotes the the width of the runaround gapfor a runaround object TailArrow int True if arrowhead is present at the beginning of the line False otherwise TintP...

Page 354: ...same as Name However this can differ from Name if the user interface is in another language Public bool True if the marker type should appear in the user interface The default is True Transient bool...

Page 355: ...3 Angle int Specifies the angle of the object s rotation ArrowBaseAngle int Indicates the arrowhead base angle in degrees ArrowLength int Denotes the arrowhead length always rounded down to the neares...

Page 356: ...nanchored frames do not have this property HeadArrow int Set to True if line has an arrowhead set to False otherwise Height int Specifies the height of the object in points The permissible range is fr...

Page 357: ...dicates the pen pattern denoted by numbers between 0 and 7 Constants are provided for some of the fill patterns Constants FV_FILL_BLACK 0 Constants FV_FILL_WHITE 7 Constants FV_FILL_CLEAR 15 PrevGraph...

Page 358: ...enabled False if it is disabled Name string The command menu or menu item separator name The names for the default predefined separators are Separator Separator1 Separator2 Separator3 Separator4 and S...

Page 359: ...ype Description length number The length of the array Property name Data Type Description MinJRomSpace int Minimum Asian Roman space OptJRomSpace int Optimum Asian Roman space MaxJRomSpace int Maximum...

Page 360: ...s encoding FontFamily int Font family specifies an index into the array of font families provided by the session property FontFamilyNames FontPlatformName string Name that uniquely identifies a font o...

Page 361: ...into it Constants FV_PGF_FIXED_L_MARGIN 0x01 the left margin is fixed Constants FV_PGF_FIXED_B_MARGIN 0x02 the bottom margin is fixed Constants FV_PGF_FIXED_R_MARGIN 0x04 the right margin is fixed Co...

Page 362: ...spell checking language to use The value is one of Constants FV_LANG_NOLANGUAGE 0x00 Constants FV_LANG_ENGLISH 0x01 Constants FV_LANG_BRITISH 0x02 Constants FV_LANG_GERMAN 0x03 Constants FV_LANG_SWISS...

Page 363: ...G 0x02 largest ascender in line BlockLines int The number of Widow Orphan lines KeepWithNext int True if Keep With Next Paragraph is enabled KeepWithPrev int True if Keep With Previous Paragraph is en...

Page 364: ...ottomSeparator string Name of frame to put below paragraph TopSeparator string Name of frame to put above paragraph NumTabs int Number of tabs in the paragraph Tabs Tabs Array of tab descriptions that...

Page 365: ...m Asian Roman space MinJLetSpace int Minimum Asian letter space OptJLetSpace int Optimum Asian letter space MaxJLetSpace int Maximum Asian letter space YakumonoType int The Yakumono rules to handle pu...

Page 366: ...erning expressed as a percentage of an em metric 100 to 1000 A positive valuemovesacharacterrightandanegativevaluemoves a character left KernY int Vertical kern value for manual kerning expressed as a...

Page 367: ...onstants FV_LANG_CATALAN 0x08 Constants FV_LANG_ITALIAN 0x09 Constants FV_LANG_FINNISH 0x10 Constants FV_LANG_SWEDISH 0x11 Constants FV_LANG_JAPANESE 0x12 Constants FV_LANG_TRADITIONAL_CHINESE 0x13 Co...

Page 368: ...T 0x02 Constants FV_PGF_CENTER 0x03 Constants FV_PGF_JUSTIFIED 0x04 Placement int Paragraph placement The value is one of Constants FV_PGF_SIDEBODY 0 Constants FV_PGF_SIDEHEAD_TOP 1 Constants FV_PGF_S...

Page 369: ...ED_B_MARGIN 0x02 the bottom margin is fixed Constants FV_PGF_FIXED_R_MARGIN 0x04 the right margin is fixed Constants FV_PGF_FIXED_T_MARGIN 0x08 the top margin is fixed If the margin for a cell is fixe...

Page 370: ...extTag int True if Next Paragraph Tag is enabled LetterSpace int True if Word Spacing is enabled MaxSpace int Maximum word spacing percentage of an em space in current font MinSpace int Minimum word s...

Page 371: ...the style of the arrowhead Possible values are Constants FV_ARROW_STICK 0x1 Constants FV_ARROW_HOLLOW 0x2 Constants FV_ARROW_FILLED 0x3 BorderWidth int Indicates the border width specified in points T...

Page 372: ...e in inches The permissible range is 216 inches to 216 inches If the graphic object is an anchored frame the distance is automatically calculated from the top of the page frame You cannot set this val...

Page 373: ...ts FV_TR_CONTOUR 0x02 Constants FV_TR_BBOX 0x03 RunaroundGap int Denotes the width of the runaround gap if the object is a runaround object TailArrow int Set to True if the arrowhead is enabled at the...

Page 374: ...stored in a MetricsT structure The 0th element of the MetricsT MetricsT_val array stores the length of the first dash the 1st element stores the following space the 2nd element stores the next dash a...

Page 375: ...t Denotes the next graphic object in the frame NextGraphicInGroup FMObject Denotes the next graphic object in the group NextSelectedGraphicInDoc FMObject Denotes the next selected graphic object in th...

Page 376: ...OX 0x03 RunaroundGap int Denotes the width of the runaround gap if the object is a runaround object TailArrow int Set to True if the arrowhead is enabled at the begining of the line Set to False other...

Page 377: ...changes always rounded down to nearest 1 16 point It is not used if the ArrowScaleHead property is False ArrowScaleHead int Set to True if arrowhead is scaled as the line width changes Set to False o...

Page 378: ...the end of the line The possible values are Constants FV_CAP_BUTT 0x00 Constants FV_CAP_ROUND 0x01 Constants FV_CAP_SQUARE 0x02 LocX int Specifies the distance of the object from the left side of the...

Page 379: ...erns 0 7 and 15 as follows Constants FV_FILL_BLACK 0 Constants FV_FILL_WHITE 7 Constants FV_FILL_CLEAR 15 PrevGraphicInFrame FMObject Denotes the previous graphic object in the frame PrevGraphicInGrou...

Page 380: ...otation of the graphic object ArrowBaseAngle int Denotes the arrowhead base angle in degrees ArrowLength int Denotes the arrowhead length always rounded down to the nearest 1 256 point ArrowScaleFacto...

Page 381: ...Set to True if the line has an arrow head Set to False otherwise Height int Denotes the height of the object denoted in points The permissible range is from 0 125 points to 3600 points LineCap int Spe...

Page 382: ...n 0 and 7 Constants are provided for pen patterns 0 7 and 15 as follows Constants FV_FILL_BLACK 0 Constants FV_FILL_WHITE 7 Constants FV_FILL_CLEAR 15 PrevGraphicInFrame FMObject Denotes the previous...

Page 383: ...in the table PrevRowInTbl Row Previous row FO_Row ID in the table RowIsShown int True if the conditional row is shown RowKeepWithNext int True if Keep With Next Row is enabled RowKeepWithPrev int Tru...

Page 384: ...UseSepOverride int TrueiftheSepOverride propertyoverridesdefaultfrom the table Width int Width of the row Property name Data Type Description Element Element The object handle of the associated FO_El...

Page 385: ...llows Constants FV_FILL_BLACK 0 Constants FV_FILL_WHITE 7 Constants FV_FILL_CLEAR 15 RulingGap int Gap between double ruling lines 0 015 pt to 360 pt RulingLines int Number of ruling lines 0 to 2 line...

Page 386: ...stFn Fn Last footnote in the column FO_Fn ID LastPgf Pgf Last paragraph in the column FO_Pgf ID LocX int Offset from left side of the text frame that contains the column LocY int Offset from top of te...

Page 387: ...0x3 Right tab Constants FV_TAB_DECIMAL 0x4 Decimal tab Constants FV_TAB_RELATIVE_LEFT 0x5 Relative left tab allowed only for format change lists Constants FV_TAB_RELATIVE_CENTER 0x6 Relative center ta...

Page 388: ...the table TblCellRightMargin int Default right cell margin for the table TblCellTopMargin int Default top cell margin for the table TblLeftIndent int Left indent for the table TblInLockedTi bool True...

Page 389: ...ling applied to table columns specified by TblColRulingPeriod FO_RulingFmt ID TblColRulingPeriod int TheperiodicityoftherulingspecifiedbyTblColRuling For example if TblColRulingPeriod is set to 2 the...

Page 390: ...umber of columns or body rows to which the exception fill pattern specified by TblBodyNextFill is applied TblBodyShadeBy int True if Shade By is set to Columns False if Shade By is set to Rows TblHFCo...

Page 391: ...lignment int Horizontal placement of table The value is one of Constants FV_ALIGN_TBL_LEFT 0 Constants FV_ALIGN_TBL_CENTER 1 Constants FV_ALIGN_TBL_RIGHT 2 TblCellBottomMargin int Bottom margin of tab...

Page 392: ...nt Number of heading rows for new table TblBodyRowRuling RulingFmt Ruling for body rows that are not specified by TblBodyRowRulingPeriod FO_RulingFmt ID TblBodyRowRulingPeriod int The periodicity of t...

Page 393: ...TblBodyNextFill int Exception fill pattern for table body TblBodyNextPeriod int Number of columns or body rows to which the exception fill pattern specified by TblBodyNextFill is applied TblBodyShadeB...

Page 394: ...DE 0x02 Constants FV_SH_OUTSIDE 0x03 SideHeadWidth int Width of side head area for the text frame 0 to 50 inches Angle int Indicates the angle of rotation of the graphic object ArrowBaseAngle int Deno...

Page 395: ...Set to True if the line has an arrow head Set to False otherwise Height int Denotes the height of the object denoted in points The permissible range is from 0 125 points to 3600 points LineCap int Spe...

Page 396: ...tween 0 and 7 Constants are provided for pen patterns 0 7 and 15 as follows Constants FV_FILL_BLACK 0 Constants FV_FILL_WHITE 7 Constants FV_FILL_CLEAR 15 PrevGraphicInFrame FMObject Denotes the previ...

Page 397: ...of a line FTI_LineEnd The end of a line and the line end type If the line end is a normal line end the value is 0 if it is a forced line end the FTI_HardLineEnd flag is set if it is a hyphen line end...

Page 398: ...Rubi FTI_RubiTextBegin The beginning of rubi text and the end of oyamoji text FO_Rubi FTI_RubiTextEnd The end of rubi text FO_Rubi Flags Meaning FTF_ALL OR of all the flags FTF_ANGLE The font angle ha...

Page 399: ...d FTF_SIZE The font size has changed FTF_SPREAD The font spread has changed FTF_STRETCH The font stretch value has changed FTF_STRIKETHROUGH The strikethrough characteristic has changed FTF_TSUME The...

Page 400: ...nts FV_LANG_CANADIAN_FRENCH 0x06 Constants FV_LANG_SPANISH 0x07 Constants FV_LANG_CATALAN 0x08 Constants FV_LANG_ITALIAN 0x09 Constants FV_LANG_FINNISH 0x10 Constants FV_LANG_SWEDISH 0x11 Constants FV...

Page 401: ...a dash pattern that is repeated for the length of an object s border The pattern is stored in a MetricsT structure The 0th element of the MetricsT MetricsT_val array stores the length of the first das...

Page 402: ...t Denotes the next graphic object in the frame NextGraphicInGroup FMObject Denotes the next graphic object in the group NextSelectedGraphicInDoc FMObject Denotes the next selected graphic object in th...

Page 403: ...aroundGap int Denotes the width of the runaround gap if the object is a runaround object TailArrow int Set to True if the arrowhead is enabled at the begining of the line Set to False otherwise TintPe...

Page 404: ...es this record to find the filter to use when updating the inset TiLocked int True if the inset is locked To change an inset s contents you must unlock it Always relock an inset after you have finishe...

Page 405: ...int True if format overrides are removed from the text when TiFormat is set to Constants FV_EnclosingDoc 1 ImportHint string Record identifying the filter used to import the text The FrameMaker produc...

Page 406: ...e when updating the inset TiLocked int True if the inset is locked To change an inset s contents you must unlock it Always relock an inset after you have finished changing its contents Name string A n...

Page 407: ...ng rows in the table TiTextEncoding string The ImportHintString for the text inset If this property is not set to Constants FO_TiText 62 or Constants FO_TiTextTable 63 the string is null ImportHint st...

Page 408: ...in seconds since 1 January 1970 Unique int The text inset s UID Property name Data Type Description valType int The type of value See the following table sval string String value ssval Strings Set of...

Page 409: ...ength number The length of the array Property name Data Type Description length number The length of the array Property name Data Type Description Name string The name of the frame PageFramePage FMObj...

Page 410: ...he length of an object s border The pattern is stored in a MetricsT structure The 0th element of the MetricsT MetricsT_val array stores the length of the first dash the 1st element stores the followin...

Page 411: ...t Denotes the next graphic object in the frame NextGraphicInGroup FMObject Denotes the next graphic object in the group NextSelectedGraphicInDoc FMObject Denotes the next selected graphic object in th...

Page 412: ...the line Set to False otherwise TintPercent int Specifies the tint percentage Unique int Indicates the graphic object s internal unique number Width int Denotes the width of the object The permissibl...

Page 413: ...ble formats Constants FV_VAR_CURRENT_PAGE_NUM 1 Constants FV_VAR_PAGE_COUNT 2 Constants FV_VAR_CURRENT_DATE_LONG 3 Constants FV_VAR_CURRENT_DATE_SHORT 4 Constants FV_VAR_MODIFICATION_DATE_LONG 5 Const...

Page 414: ...Changes to the document in and of themselves do not affect this property XRefSrcText string If XRefSrcIsElem is False the XRefSrcTex property is a string specifying UID pgf_tag text where UID represen...

Page 415: ...o add to the standard list of marker types Use SetString to set a marker type name to this property of the Constants FV_SessionId 0 AutoBackup int True if Automatic Backup is enabled AutoSave int True...

Page 416: ...ow order bits indicate attributes for the font family The flags their mask values and their meaning follow Constants FV_FAMILY_VISIBLE 0x00000001 Family is visible in menu Constants FV_FAMILY_SELECTAB...

Page 417: ...0x11 Constants FV_LANG_JAPANESE 0x12 Constants FV_LANG_TRADITIONAL_CHINESE 0x13 Constants FV_LANG_SIMPLIFIED_CHINESE 0x14 Constants FV_LANG_KOREAN 0x15 MarkerNames Strings List of standard marker typ...

Page 418: ...off the screen that value is ignored and the old value is retained ScreenY int The offset of the FrameMaker product window in pixels from the top of the screen If you set a value that would result in...

Page 419: ...EnableAutoSpellCheck bool When True Auto Spell Check is enabled AllowNewFileURL bool When True allows usage of file and file URLs for referring to a file DoPostXSLTValidationOnExport bool When True d...

Page 420: ...specified object The GetProps method takes no arguments The method returns a PropVals object that contains an array of property value pairs on success If the GetProps method fails it sets the len fie...

Page 421: ...er is invalid Constants FE_BadPropType 5 Incorrect property type for this function Constants FE_BadRange 36 Specified text range is invalid Constants FE_CantSmooth 38 Object cannot be smoothed Constan...

Page 422: ...d value must be a graphic object group FO_Group Constants FE_NotTextFrame 39 The specified value must be a text column FO_TextFrame Constants FE_NotTextObject 41 The specified object must be a text ob...

Page 423: ...on The GetProps method retrieves the properties of the Arc object See SetProps under the AFrame class for more information Returns PropVals Syntax GetProps SetProps Description The SetProps method set...

Page 424: ...ression Description ApplyAttributeExpression is the method to apply the attribute expression to the document The method returns FE_Success on success Returns int Syntax ApplyAttributeExpression GetPro...

Page 425: ...ctValid Description Returns True if the attribute expression is valid else returns False See ObjectValid under the AFrame class for more information Returns int Syntax ObjectValid Attribute Attribute...

Page 426: ...No Validation error flags allow uint No Allow error as special case Parameter name Data Type Optional Description name string No Attribute name required int No True if the attribute is required False...

Page 427: ...y arbitrary text string Constants FV_AT_STRINGS 1 One or more arbitrary text strings Constants FV_AT_CHOICES 2 A value from a list of choices Constants FV_AT_INTEGER 3 A signed whole number optionally...

Page 428: ...tion The original array is unchanged If an array is provided as a parameter to concat each of its elements are appended as separate array elements at the end of the new array Returns a new array the r...

Page 429: ...buteEx objects with integer indexing and a length property concat Description The original array is unchanged If an array is provided as a parameter to concat each of its elements are appended as sepa...

Page 430: ...Returns the new length of the array Returns number Syntax push value Parameters BodyPage Delete Description Deletes the specified Body Page See Delete under the AFrame class for more information Retu...

Page 431: ...tax GetProps SetProps Description The SetProps method sets the properties of the specified Body Page See SetProps under the AFrame class for more information Returns Void Syntax SetProps setVal Parame...

Page 432: ...te results documents Error Reason Constants FE_WrongProduct 60 Current FrameMaker version does not support this operation or fmbatch is running Constants FE_BadOperation 27 Parameters specified an inv...

Page 433: ...FrameMaker version does not support the operation Parameter name Data Type Optional Description newerDoc Doc No The newer version of the document or book flags int No Bit flags that specify how to gen...

Page 434: ...PrintDoc SimpleGenerate Description The SimpleGenerate method generates files for a book The method performs the same operation as choosing Update Book from the book Edit menu You must set up the book...

Page 435: ...a duplicate file in the book all files in the book are generated files Constants FE_BadParameter 43 Not a valid book Constants FE_SystemError 42 Could not allocate memory or could not open or save one...

Page 436: ...tants FF_UFF_TABLE 0x0008 Table Catalog formats Constants FF_UFF_VAR 0x0040 Variable formats Constants FF_UFF_XREF 0x0080 Cross reference formats Error Reason Constants FE_WrongProduct 60 Current Fram...

Page 437: ...niqueObject objType unique Constants FF_IED_DO_NOT_IMPORT_EDD 0x0004 If the source document is an EDD setting this value does NOT treat it as an EDD instead the method just imports its element catalog...

Page 438: ...book s current name for saveAsName FrameMaker saves the book under its current name If you specify another filename for saveAsName FrameMaker saves the book to that filename If you specify an empty st...

Page 439: ...lock Constants FV_CancelSaveModDateChanged 52 The file has changed since the last time it was opened or saved in the current session Constants FV_LockCouldntBeReset 2 File lock could not be reset Cons...

Page 440: ...series at which to add the new object See the NewSeriesObject method for more information Error Reason Constants FE_BadDocId 2 Invalid book Constants FE_BadNew 23 Object cannot be created Constants F...

Page 441: ...The property list for the saveParams parameter is as follows Parameter name Data Type Optional Description previous Object No The location of the object in the series after which to add the new Book...

Page 442: ...inue 7 but FrameMaker could not reset the lock Constants FV_CancelSaveModDateChanged 52 The file has changed since the last time it was opened or saved in the current session Constants FV_LockCouldntB...

Page 443: ...and other conditions Use GetSaveDefaultParams or AllocatePropVals to create and allocate memory for this property list To use the default list specify null saveReturnParams PropVals No A property lis...

Page 444: ...ke newly generated files lists and indexes visible Takes the value True or False True Make visible False Do not make visible Constants FS_ShowBookErrorLog 4 Display the book error log for this update...

Page 445: ...or page count continually changes for this operation Constants FV_DuplicateFileInBook 1 One or more files in the book is a duplicate of another file Constants FV_NoNonGeneratedFilesInBook 2 The only...

Page 446: ...etting the Constants FS_FitGraphicInSelectedRect 14 property to False If the graphic has no default resolution it is imported at 72 dpi To get a property list to specify for the importParamsp paramete...

Page 447: ...stants FS_DisallowPlainText 12 Disallow importing Text Only files Set to either True or False True Do not allow importing Text Only files False Allow importing Text Only files Constants FS_DisallowSgm...

Page 448: ...nary file Constants FV_TYPE_MIF 0x02 A MIF file Constants FV_TYPE_TEXT 0x03 A file containing plain text Constants FV_TYPE_SGML 0x04 An SGML file Constants FV_TYPE_XML 0x05 An XML file Constants FV_TY...

Page 449: ...The following table lists the possible codes format_id is a code specifying the format that the filter translates The code is a string of four characters The following are the possible codes Code Mea...

Page 450: ...cification CAD files IMG4 Image to CCITT Group 4 UNIX MooV QuickTime Movie OLE Object Linking and Embedding Client Microsoft PCX PC Paintbrush PICT QuickDraw PICT PNTG MacPaint SNRF Sun Raster File SR...

Page 451: ...eaks False Do not remove manual page breaks Constants FS_RemoveOverrides 24 Remove format overrides if Constants FS_FormatImportedTest TBD is set to Constants FV_EnclosingDoc 1 Set to either True or F...

Page 452: ...nts FS_FileIsText 16 File is a Text Only file The possible values are Constants FV_TextFile_EOLisEOP 12 Import the file and convert each end of line into a paragraph break Constants FV_TextFile_EOLisN...

Page 453: ...row of table cells and use Constants FS_CellSeparator 29 and Constants FS_NumCellSeparators 30 to determine how to divide the line into separate cells if Constants FS_FileIsText 16 is set to Constant...

Page 454: ...edImportType 21 Source file s type is disallowed by script Constants FV_NoMainFlow 22 Ascriptwasspecifiedtoimportthemainflow but the source file does not have a main flow Constants FV_NoFlowWithSpecif...

Page 455: ...ile is a MIF file so the user or the script canceled the Import operation Constants FV_CancelFileFilterable 35 The source file is a filterable file so the user or the script canceled the Import operat...

Page 456: ...value of the specified property of the Book See SetProps on page 413 under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters ObjectValid Description Indicates whethe...

Page 457: ...oves a particular book component up and down in the book components sequence In addition you can promote and demote operations of a component in a hierarchy using this method Returns Void Syntax MoveC...

Page 458: ...information Returns int Syntax ObjectValid Cell StraddleCells Description The StraddleCells method straddles the specified cells in a table The cells you straddle must all be from the same type of row...

Page 459: ...tables Constants FE_BadOperation 27 Parameters specify an action that is invalid Constants FE_BadDocId 2 Invalid document Constants FE_BadParameter 43 Parameter has an invalid value Constants FE_BadO...

Page 460: ...to deallocate the memory used by the TextItems structure returned by GetText when you have finished using it To get specific types of text items OR the constants that represent them for example use a...

Page 461: ...ine end the FTI_HardLineEnd flag is set if it is a hyphen line end the FTI_HyphenLineEnd flag is set FTI_MarkerAnchor A Marker FO_Marker FTI_PageBegin The beginning of a page FO_Page FTI_PageEnd The e...

Page 462: ...nd processor is controlling that text and you should not modify the associated text item FTF_KERNX The kern x characteristic has changed FTF_KERNY The kern x characteristic has changed FTF_LANGUAGE Ch...

Page 463: ...s from the beginning to the end of the variable Constants FV_FO_XREF 3 All the text items from the beginning to the end of the cross reference Constants FV_FO_FOOTNOTE 5 All the text items from the be...

Page 464: ...Description Indicates whether a cell object is valid Returns True if the cell object is valid else returns False See ObjectValid on page 414 under the AFrame class for more information Returns int Syn...

Page 465: ...erty for the specified CharFmt object See SetProps on page 413 under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters ObjectValid Description Indicates whether the...

Page 466: ...n Retrieves the properties of the specified color object See GetProps on page 412 under the AFrame class for more information Returns PropVals Syntax GetProps SetProps Description Sets the value of th...

Page 467: ...pecifies a set of font characteristics for a combined font The combinedFont field specifies a CombinedFont object From this object you can get information about the combined font such as the base and...

Page 468: ...ts object that provides a list of the permutations of angles variations and weights available for the specified combined font definition Returns CombinedFonts Syntax CombinedFamilyFonts Delete Descrip...

Page 469: ...rns False See ObjectValid on page 414 under the AFrame class for more information Returns int Syntax ObjectValid CombinedFonts An Array of CombinedFont objects with integer indexing and a length prope...

Page 470: ...ption Returns the new length of the array Returns number Syntax push value Parameters Command Delete Description Deletes the specified Command object See Delete on page 412 under the AFrame class for...

Page 471: ...cription Sets the value of the specified Command property See SetProps on page 413 under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters ObjectValid Description Id...

Page 472: ...ethod directly on the object to be deleted Returns int Syntax Delete CompareRet CompareRet Description CompareRet provides the results of a call to the Compare method The method returns a CompareRet o...

Page 473: ...on Retrieves the properties of the specified CondFmt object See GetProps on page 412 under the AFrame class for more information Returns PropVals Syntax GetProps SetProps Description Sets the value of...

Page 474: ...cess On failure it sets one of the following error numbers to FA_errno Returns TextLoc Special Character Hexadecimal Representation Octal Representation x3e 76 straight double quotation mark x22 42 le...

Page 475: ...table cells empty and deletes hidden text You can OR the following values into flags Parameter name Data Type Optional Description textLoc TextLoc No The text location at which to add the text text s...

Page 476: ...eturns one of the following values to FA_errno Constants FF_CUT_TBL_CELLS 0x0002 Remove cleared table cells Constants FF_VISIBLE_ONLY 0x0010 Clear only the visible portion of the selection Constants F...

Page 477: ...reshold Flags Meaning Constants FF_CMP_SUMMARY_ONLY 0x01 Generate a summary document but not a composite document Constants FF_CMP_CHANGE_BARS 0x02 Turn on change bars in the composite document Consta...

Page 478: ...string No The condition tag to apply to deletions shown in the composite document For no delete condition tag specify null replaceText string No Text to appear in place of the deleted text For no repl...

Page 479: ...llowing values to FA_errno Returns int Syntax Cut flags Parameter name Data Type Optional Description flags int No Bit field that specifies how to copy the text and how to handle interactive alerts Fo...

Page 480: ...FA_errno Parameter name Data Type Optional Description flags int No Bit field that specifies how to cut the text and how to handle interactive alerts For default settings specify 0 Error Reason Const...

Page 481: ...ollowing table Constants FTI_ElementBegin 0x00080000 The beginning of a container structural element FO_Element Constants FTI_ElementEnd 0x00100000 The end of a container structural element FO_Element...

Page 482: ...bColBegin 0x00000200 The beginning of a column FO_SubCol Constants FTI_SubColEnd 0x00000400 The end of a column FO_SubCol Constants FTI_TblAnchor 0x00002000 A Table FO_Tbl Constants FTI_TextFrameBegin...

Page 483: ...at text and you should not modify the associated text item Constants FTF_KERNX 0x00080000 The kern x characteristic has changed Constants FTF_KERNY 0x00040000 The kern x characteristic has changed Con...

Page 484: ...rray of text items of the requested types Constants FTF_UNDERLINING 0x08000000 The underlining has changed Constants FTF_VARIATION 0x40000000 The font variation has changed Constants FTF_WEIGHT 0x2000...

Page 485: ...turned PropVals structure to 0 and returns one of the following values to FA_errno Error Reason Constants FE_BadDocId 2 Invalid document Constants FE_BadObjId 3 Invalid Object Constants FE_NotTextObje...

Page 486: ...fied for the text range is not an object that contains text Constants FE_OffsetNotFound 21 Offset specified for the text location could not be found in the specified paragraph or text line Constants F...

Page 487: ...ter to the right of this location propNum int No The property to query Specify a constant such as FontFamily Error Reason Constants FE_BadDocId 2 Invalid document Constants FE_BadObjId 3 Invalid Objec...

Page 488: ...wo structural elements must be selected in the document before calling the MergeIntoFirst method On success the method does not return any value On failure the method returns one of the following valu...

Page 489: ...8 the NumCols property of the new table is set to 8 With the NewTable method you can use the Table Catalog format properties as defaults for the number of rows and columns in a new table or you can pr...

Page 490: ...text line Constants FE_BadOperation 27 Function call specified an illegal operation Constants FE_BadNew 23 Table cannot be created the format specified by format may not exist or the text location sp...

Page 491: ...ACTIVE 0x0001 flag takes precedence over other flags If you specify Constants FF_INTERACTIVE 0x0001 Constants FF_DONT_DELETE_HIDDEN_TEXT 0x0004 and the selection contains hidden text FrameMaker prompt...

Page 492: ...a and displays a prompt and the first string in a specified list of strings The user can display a string in the Tag area by typing the first few letters of the string The user can also scroll through...

Page 493: ...yntax Redisplay Reformat Description Reformats the specified document If you have disabled and subsequently re enabled reformatting by setting the session property Reformatting to True you should call...

Page 494: ...sets the document equation settings to the default settings The method returns FE_Success on success On failure the method returns one of the following values to FA_errno Returns int Syntax ResetEqnSe...

Page 495: ...s On failure the method returns one of the following values to FA_errno Returns int Syntax RestartPgfNumbering ScrollToText Description Scrolls the document window to a specified text range The method...

Page 496: ...son Constants FE_BadDocId 2 Invalid document Constants FE_BadName 33 Specified name is illegal Constants FE_BadRange 36 Specified text range is invalid Constants FE_GenRuleAmbiguous 55 General rule in...

Page 497: ...stants FE_BadPropType 5 Incorrect property type for this function Constants FE_BadPropNum 4 Specified property number is invalid Constants FE_BadRange 36 Specified text range is invalid Constants FE_G...

Page 498: ...pe 5 Incorrect property type for this function Constants FE_BadPropNum 4 Specified property number is invalid Constants FE_BadRange 36 Specified text range is invalid Constants FE_GenRuleAmbiguous 55...

Page 499: ...n within the same session any changes you make to a document s print settings except PrintStartPage and PrintEndPage appears the next time the user displays the Print dialog box for the document The m...

Page 500: ...ENT_PROPS 0x0400 Document Properties Constants FF_UFF_FONT 0x0002 Character Catalog Formats Constants FF_UFF_MATH 0x0200 Equation Settings Constants FF_UFF_PAGE 0x0004 Page Layouts Constants FF_UFF_PG...

Page 501: ...0 Import combined fonts Constants FF_UFF_COND 0x0010 Import conditions Constants FF_UFF_DOCUMENT_PROPS 0x0400 Import document properties Constants FF_UFF_FONT 0x0002 Import Character Catalog formats C...

Page 502: ...es the top level elements Note At least one structural element must be selected before calling the UnWrapElement method Note The UnWrapElement method has no effect on object elements The method does n...

Page 503: ...aker document or book Flags Meaning Constants FF_XRUI_FORCE_UPDATE 0x08 Updates all cross references regardless of whether the source document has changed Constants FF_XRUI_INTERNAL 0x01 Only update i...

Page 504: ...ker changes the UID This also happens when you hide and show conditional text The method returns the object on success On failure the method returns one of the following values to FA_errno Flag Meanin...

Page 505: ...ollowing value to FA_errno Returns int Syntax Close flags Parameters Error Reason Constants FE_BadDocId 2 Invalid document Constants FE_TypeUnNamed 19 Objects of the specifies type are not identified...

Page 506: ...The file s operating system ID was bad Constants FV_CancelSaveFileIsInUse 50 The file is in use and the user did not or could not reset the lock Or the file is in use and the Constants FS_FileIsInUse...

Page 507: ...the front of the back to front draw order The method automatically takes care of updating the object s PrevGraphicInFrame and NextGraphicInFrame properties The NewGraphicObject method gives the new AP...

Page 508: ...e NewGraphicObject for more information Constants FE_NotFrame 12 Specified parent object is not a frame Constants FE_BadNew 23 Object cannot be created Parameter name Data Type Optional Description ob...

Page 509: ...ow Syntax NewFlow parent Parameters NewGroup Description Creates a group object See NewGraphicObject for more information Returns Group Syntax NewGroup parent Parameter name Data Type Optional Descrip...

Page 510: ...aphicObject for more information Returns Line Syntax NewLine parent Parameters Parameter name Data Type Optional Description parent Any FrameMaker Graphic Object No The parent frame in which to create...

Page 511: ...ee NewGraphicObject for more information Returns Polyline Syntax NewPolyline parent Parameters NewPolygon Description Creates a polygon object See NewGraphicObject for more information Parameter name...

Page 512: ...NewRectangle parent Parameters NewRoundRect Description Creates a round rectangle object See NewGraphicObject for more information Returns RoundRect Syntax NewRoundRect parent Parameter name Data Typ...

Page 513: ...phicObject for more information Returns TextLine Syntax NewTextLine parent Parameters Parameter name Data Type Optional Description parent Any FrameMaker Graphic Object No The parent frame in which to...

Page 514: ...the default Table Catalog format for a new table set the format to Null To specify the number of rows and columns when you create a table use NewTable NewAnchoredFormattedObject returns the created a...

Page 515: ...c class for more information Returns XRef Parameter name Data Type Optional Description objType int No The type of object to create for example FO_XRef format string No The string that specifies the o...

Page 516: ...perties for the new object Tables created by NewAnchoredObject have a single column and a single body row It is usually easier to use NewTable to create tables Parameter name Data Type Optional Descri...

Page 517: ...document Constants FE_BadNew 23 Object cannot be created Constants FE_BadObjId 3 Invalid object Constants FE_BadOperation 27 Method call specified a bad operation Constants FE_NotTextObject 41 Object...

Page 518: ...AnchoredObject under the Doc class for more information Returns Marker Syntax NewAnchoredMarker textloc Parameters NewAnchoredTiApiClient Description Creates an anchored TiApiClient object See NewAnch...

Page 519: ...in the series at which to add the new object The method returns the created series object on success On failure the method assigns one of the following values to FA_errno Parameter name Data Type Opti...

Page 520: ...specify a paragraph Constants FE_NotBookComponent 26 The prevId parameter must specify a book component Parameter name Data Type Optional Description objType int No The type of object to create for e...

Page 521: ...ElementDef FmtChangeList Menu MenuItemSeparator MasterPage PgfFmt RefPage RulingFmt TblFmt UnanchoredFrame reference frame VarFmt XRefFmt MarkerType The method returns the object on success On failure...

Page 522: ...mat object See GetNamedObject under the Doc class for more information Returns CharFmt Error Reason Constants FE_BadDocId 2 Invalid document Constants FE_TypeUnNamed 19 Objects of the specified type d...

Page 523: ...ion Gets a Combined Font Definition object See GetNamedObject under the Doc class for more information Returns CombinedFontDefn Syntax GetNamedCombinedFontDefn name Parameters Parameter name Data Type...

Page 524: ...inition object See GetNamedObject under the Doc class for more information Returns ElementDef Syntax GetNamedElementDef name Parameters GetNamedFmtChangeList Description Gets a Format Change List obje...

Page 525: ...tNamedPgfFmt Description Gets a Paragraph Format object See GetNamedObject under the Doc class for more information Returns PgfFmt Syntax GetNamedPgfFmt name Parameters Parameter name Data Type Option...

Page 526: ...Ruling Format object See GetNamedObject under the Doc class for more information Returns RulingFmt Syntax GetNamedRulingFmt name Parameters GetNamedTblFmt Description Gets a Table Format object See Ge...

Page 527: ...s GetNamedVarFmt Description Gets a Variable Format object See GetNamedObject under the Doc class for more information Returns VarFmt Syntax GetNamedVarFmt name Parameters Parameter name Data Type Opt...

Page 528: ...a Marker Type object See GetNamedObject under the Doc class for more information Returns MarkerType Syntax GetNamedMarkerType name Parameters NewNamedObject Description Creates the following named ob...

Page 529: ...ok pass an empty string for the name argument NewNamedObject returns the created named object on success If this method fails the API assigns one of the following values to FA_errno Returns Objectof t...

Page 530: ...r Format See NewNamedObject under the Doc class for more information Returns CharFmt Syntax NewNamedCharFmt name Parameters NewNamedCombinedFontDefn Description Creates a named Combined Font Definitio...

Page 531: ...ption Creates a named Conditional Format See NewNamedObject under the Doc class for more information Returns CondFmt Syntax NewNamedCondFmt name Parameters Parameter name Data Type Optional Descriptio...

Page 532: ...at Change List See NewNamedObject under the Doc class for more information Returns FmtChangeList Syntax NewNamedFmtChangeList name Parameters NewNamedMasterPage Description Creates a named Master Page...

Page 533: ...ge Description Creates a named Reference Page See NewNamedObject under the Doc class for more information Returns RefPage Syntax NewNamedRefPage name Parameters Parameter name Data Type Optional Descr...

Page 534: ...named Table Format See NewNamedObject under the Doc class for more information Returns TblFmt Syntax NewNamedTblFmt name Parameters NewNamedVarFmt Description Creates a named Variable Format See NewNa...

Page 535: ...e Description Creates a named Marker Type See NewNamedObject under the Doc class for more information Returns MarkerType Syntax NewNamedMarkerType name Parameters Parameter name Data Type Optional Des...

Page 536: ...leteUnusedCharFmt Description Deletes the unused Character Formats See DeleteUnusedFmts under the Doc class for more information Returns int Syntax DeleteUnusedCharFmt DeleteUnusedPgfFmt Description D...

Page 537: ...dialog box to search a document for text or other types of content The properties you can assign to findParamsp are as follows Property Meaning and Possible Values Constants FS_FindText 1 The text to...

Page 538: ...ties should be specified to tailor the search FontFamily CombinedFont FontSize FontAngle FontWeight FontVariation Color Spread Stretch Language Underline Overline Strikethrough ChangeBar Capitalizatio...

Page 539: ..._FindMarkerOfType 9 Marker type Constants FS_FindMarkerText 10 Marker text Constants FS_FindXRefWithFormat 11 Format string Constants FS_FindNamedVariable 12 Variable name Constants FS_FindCondTextInC...

Page 540: ...cludes the root element set beg parentId to 0 beg childId to the root element and end childId to 0 The method does not return anything on success On failure the method sets FA_errno to one of the foll...

Page 541: ...nt The method performs the same operation as clicking Update in the Variable dialog box The method returns FE_Success on success On failure the method sets FA_errno to one of the following values Para...

Page 542: ...s not in Preview Off state Returns int Syntax TrackChangesAcceptAll TrackChangesRejectAll Description Rejects all the track changes in the specified document The method returns FE_Success on success a...

Page 543: ...NAL 0x01 Updates only internal cross references Constants FF_XRUI_OPEN_DOCS 0x02 Updates only cross references whose sources are in open documents Constants FF_XRUI_CLOSED_DOCS 0x04 Updates only cross...

Page 544: ...A property list that tells FrameMaker how to save the file and how to respond to errors and other conditions Use GetSaveDefaultParams or AllocatePropVals to create and allocate memory for this proper...

Page 545: ..._BadDocId 2 Invalid document Constants FE_ReadOnly 6 Document is read only Constants FE_BadName 33 Boolean conditional expression string is invalid Parameter name Data Type Optional Description exprNa...

Page 546: ...On failure the method returns the following value to FA_errno Returns string Syntax GetActiveBuildExpr GetBuildExpr Description Returns the Boolean conditional expression in the document with the giv...

Page 547: ...Returns Strings Syntax GetBuildExprCatalog GetProps Description The GetProps method retrieves the properties of the Doc object See GetProps under the AFrame class for more information Returns PropVal...

Page 548: ...n Gets an elements attributes The Attributes structure returned by GetAttributes includes the attributes in the following order Attributes defined in the element definition in the same order in which...

Page 549: ...e allowed choices Constants FV_AV_INVALID_FORMAT 3 The attribute value is of the wrong type for the attribute Constants FV_AV_IDREF_UNRESOLVED 4 The attribute refers to an undefined ID value Constants...

Page 550: ...GetProps SetProps Description Sets the properties of the element object See SetProps under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters ObjectValid Description...

Page 551: ...rray is unchanged If an array is provided as a parameter to concat each of its elements are appended as separate array elements at the end of the new array Returns a new array the result of concatenat...

Page 552: ...s The value of the flags field can be one of the following constants Parameter name Data Type Optional Description value ElementCata logEntry No The value to be pushed Parameter name Data Type Optiona...

Page 553: ...following values to FA_errno Returns FmtRule Syntax NewTextFmtRules NewObjectFmtRules Description Creates a ObjectFmtRules object The following table shows the parent object and the type of the object...

Page 554: ...Rules object Error Reason Constants FE_BadDocId 2 Invalid document Constants FE_BadObjId 3 Invalid object Constants FE_BadNew 23 Object cannot be created Constants FE_BadPropNum 4 The property number...

Page 555: ...values to FA_errno Returns FmtRule Parent Type of Object Number of Instances That Can be Created ElementDef FmtRule Multiple Error Reason Constants FE_BadDocId 2 Invalid document Constants FE_BadObjI...

Page 556: ...ded in it the ranges of text that surround the cross reference element are treated as elements themselves These elements are called text nodes The ElementDefIsText method checks the value of an elemen...

Page 557: ...ult Constants FV_FO_XREF 3 Cross Reference Undefined XRef Constants FV_FO_EQN 7 Equation Medium Constants FV_FO_MARKER 4 Marker Type 11 Constants FV_FO_TBL 8 Tablewiththeformatspecifiedbythetable form...

Page 558: ...following values to FA_errno Returns Element Syntax NewElementInHierarchy elemLoc Parameters Object Type Object Inserted Format Used By Default Constants FV_FO_XREF 3 Cross Reference Undefined XRef Co...

Page 559: ...ute value s type It can specify one of the following constants Error Reason Constants FE_WrongProduct 60 Current product interface is not Structured FrameMaker Constants FE_BadDocId 2 Invalid document...

Page 560: ...formation Returns int Syntax Delete GetProps Description The GetProps method retrieves the properties of an element definition See GetProps under the AFrame class for more information Returns PropVals...

Page 561: ...rue if the element definition is valid else returns False See ObjectValid under the AFrame class for more information Returns int Syntax ObjectValid ElementLoc ElementLoc Description Contains a struct...

Page 562: ...ipse Delete Description Deletes an ellipse See Delete under the AFrame class for more information Returns int Syntax Delete Parameter name Data Type Optional Description parent Element No Parent eleme...

Page 563: ...tProps SetProps Description Sets the properties of an ellipse See SetProps under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters ObjectValid Description Returns Tr...

Page 564: ...me informat outformat binname args Parameters Flow Delete Description Deletes a flow See Delete under the AFrame class for more information Returns int Syntax Delete Parameter name Data Type Optional...

Page 565: ...ers GetProps Description Retrieves the properties of the flow See GetProps under the AFrame class for more information Returns PropVals Syntax GetProps SetProps Description Sets the properties of the...

Page 566: ...on Returns int Syntax ObjectValid FmtChangeList Delete Description Deletes a format change list See Delete under the AFrame class for more information Returns int Syntax Delete GetProps Description Re...

Page 567: ...jectValid under the AFrame class for more information Returns int Syntax ObjectValid FmtRule NewFmtRuleClauses Description Creates a FmtRuleClauses object The following table shows the parent object a...

Page 568: ...ormat rule See GetProps under the AFrame class for more information Returns PropVals Syntax GetProps SetProps Description Sets the properties of a format rule See SetProps under the AFrame class for m...

Page 569: ...lowing table shows the parent object and the type of the object created by the method The method returns the created object on success On failure the method assigns one of the following values to FA_e...

Page 570: ...ntax NewFmtChangeList Delete Description Deletes a format rule clause See Delete under the AFrame class for more information Returns int Constants FE_WrongProduct 60 Current product interface is not S...

Page 571: ...GetProps SetProps Description Sets the properties of a format rule clause See SetProps under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters ObjectValid Descriptio...

Page 572: ...on Gets the text from the footnote See GetText under the Cell class for more information Returns TextItems Syntax GetText flags Parameters GetProps Description Retrieves the properties of a footnote S...

Page 573: ...for more information Returns int Syntax ObjectValid Font Font Description Font specifies a combination of font characteristics Each field specifies an index into a list of names in the FrameMaker prod...

Page 574: ...elements at the end of the new array Returns a new array as the result of concatenation with the given values to the end of the original array Returns Fonts Syntax concat value Parameters pop Descript...

Page 575: ...Group object represents a set of grouped objects Group objects have the following methods Delete Description Deletes a group See Delete under the AFrame class for more information Returns int Syntax D...

Page 576: ...rameters ObjectValid Description Returns True if the group is valid else returns False See ObjectValid under the AFrame class for more information Returns int Syntax ObjectValid HiddenPage GetProps De...

Page 577: ...PageLayout Description Applies the layout of a page to another page PageObject is any Page object i e BodyPage MasterPage HiddenPage The method returns FE_Success on success On failure the method retu...

Page 578: ...y value or an error check FA_errno Returns the specified facet value on success On failure the method returns one of the following values to FA_errno Returns int Syntax GetIntByName propName Parameter...

Page 579: ...ts If a facet contains a large amount of data GetUBytesByName only gets a portion of the data each time you call it To query a facet that contains a large amount of data call GetUBytesByName repeatedl...

Page 580: ...method returns one of the following values to FA_errno Returns Void Syntax SetIntByName propName setVal Error Reason Constants FE_BadDocId 2 Invalid document Constants FE_BadObjId 3 Invalid object Co...

Page 581: ...ameImage are examples of unsigned bytes facets Parameter name Data Type Optional Description propName string No The name of the facet to set setVal int No The value to which the facet must be set Erro...

Page 582: ...you may overload your platform s interapplication communication mechanism 2 Call SetUBytesByName with propName set to an empty string This lets the ESTK know that you have finshed setting up the face...

Page 583: ...propName Parameters GetProps Description Retrieves the properties of the inset See GetProps under the AFrame class for more information Returns PropVals Syntax GetProps SetProps Description Sets the...

Page 584: ...ger indexing and a length property concat Description The original array is unchanged If an array is provided as a parameter to concat each of its elements are appended as separate array elements at t...

Page 585: ...from the array Returns int Syntax pop push Description Returns the new length of the array Returns number Syntax push value Parameters Line Delete Description Deletes a line See Delete under the AFram...

Page 586: ...GetProps SetProps Description Sets the properties of the line See SetProps under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters ObjectValid Description Returns Tr...

Page 587: ...ete GetProps Description Retrieves the properties of the marker See GetProps under the AFrame class for more information Returns PropVals Syntax GetProps SetProps Description Sets the properties of th...

Page 588: ...r more information Returns int Syntax ObjectValid MarkerType Delete Description Deletes a marker type See Delete under the AFrame class for more information Returns int Syntax Delete GetProps Descript...

Page 589: ...if the marker type is valid else returns False See ObjectValid under the AFrame class for more information Returns int Syntax ObjectValid MasterPage Delete Description Deletes a master page See Delete...

Page 590: ...d Syntax SetProps setVal Parameters ObjectValid Description Returns True if the master page is valid else returns False See ObjectValid under the AFrame class for more information Returns int Syntax O...

Page 591: ...formation Returns int Syntax Delete GetProps Description Retrieves the properties of the math object See GetProps under the AFrame class for more information Returns PropVals Syntax GetProps SetProps...

Page 592: ...Returns int Syntax ObjectValid Menu DefineAndAddCommand Description Defines a command FO_Command object and adds it to a menu or menu bar The following table lists some FrameMaker product menus and th...

Page 593: ...FA_errno Returns Command Syntax DefineAndAddCommand cmdNum name label shortcut Parameters Error Reason Constants FE_WrongProduct 60 Current FrameMaker product does not support this operation or fmbat...

Page 594: ...bar To add a menu to one of FrameMaker menus or menu bars you must get the menu or menu bar s object To get its object call GetNamedObject with the objectName parameter set to its name Note Your menu...

Page 595: ...d by an exclamation mark cannot be removed by the user Type of menu or menu bar you are adding a menu to How FrameMaker implements the added menu FrameMaker product adds the menu Menu bar Pull down me...

Page 596: ...ents quick menus QuickMakerMainMenu Menu bar for documents custom menus CustomMakerMainMenu Menu bar for books complete menus BookMainMenu Menu bar for books quick menus QuickBookMainMenu Structure me...

Page 597: ...Description name string No A unique name for the new menu If the user or an ESTK client has already defined a command or menu with this name the new menu replaces it label string No The title of the...

Page 598: ...PropVals Syntax GetProps SetProps Description Sets the properties of the menu or menu item See SetProps under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters Objec...

Page 599: ...re information Returns int Syntax Delete MenuItemSeparator GetProps Description Retrieves the properties of the menu item separator See GetProps under the AFrame class for more information Returns Pro...

Page 600: ...e under the AFrame class for more information Returns int Syntax Delete Metrics An Array of objects with integer indexing and a length property concat Description The original array is unchanged If an...

Page 601: ...ntax pop push Description Returns the new length of the array Returns number Syntax push value Parameters Pgf Delete Description Deletes a paragraph See Delete under the AFrame class for more informat...

Page 602: ...GetText flags Parameters GetProps Description Retrieves the properties of the paragraph See GetProps under the AFrame class for more information Returns PropVals Syntax GetProps SetProps Description...

Page 603: ...ame class for more information Returns int Syntax ObjectValid PgfFmt Delete Description Deletes a paragraph format See Delete under the AFrame class for more information Returns int Syntax Delete GetP...

Page 604: ...setVal Parameters ObjectValid Description Returns True if the paragraph format is valid else returns False See ObjectValid under the AFrame class for more information Returns int Syntax ObjectValid Po...

Page 605: ...ach of its elements are appended as separate array elements at the end of the new array Returns a new array the result of concatenation the given values to the end of the original array Returns Points...

Page 606: ...s Polygon Delete Description Deletes a polygon See Delete under the AFrame class for more information Returns int Syntax Delete GetProps Description Retrieves the properties of the polygon See GetProp...

Page 607: ...SetProps setVal Parameters ObjectValid Description Returns True if the polygon is valid else returns False See ObjectValid under the AFrame class for more information Returns int Syntax ObjectValid P...

Page 608: ...tProps SetProps Description Sets the properties of the polyline See SetProps under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters ObjectValid Description Returns...

Page 609: ...y names If a property is identified by a name PropIdent num is set to 0 If a property is identified by a number PropIdent name is set to a null string Returns PropIdent Syntax PropIdent num name Param...

Page 610: ...ements are appended as separate array elements at the end of the new array Returns a new array the result of concatenation the given values to the end of the original array Returns PropVals Syntax con...

Page 611: ...x Delete GetProps Description Retrieves the properties of the rectangle See GetProps under the AFrame class for more information Returns PropVals Syntax GetProps SetProps Description Sets the properti...

Page 612: ...information Returns int Syntax ObjectValid RefPage Delete Description Deletes a reference page See Delete under the AFrame class for more information Returns int Syntax Delete GetProps Description Re...

Page 613: ...Valid Description Returns True if the reference page is valid else returns False See ObjectValid under the AFrame class for more information Returns int Syntax ObjectValid ApplyPageLayout Description...

Page 614: ...rops Description Retrieves the properties of the round rectangle See GetProps under the AFrame class for more information Returns PropVals Syntax GetProps SetProps Description Sets the properties of t...

Page 615: ...rno Parameter name Data Type Optional Description setVal PropVals No The property list Direction Meaning Constants FV_Above 1240 Add rows above the current reference row Constants FV_Below 1241 Add ro...

Page 616: ...Delete GetProps Description Retrieves the properties of the row See GetProps under the AFrame class for more information Returns PropVals Syntax GetProps SetProps Description Sets the properties of th...

Page 617: ...s ObjectValid Description Returns True if the row is valid else returns False See ObjectValid under the AFrame class for more information Returns int Syntax ObjectValid Rubi Delete Description Deletes...

Page 618: ...ject for the rubi composite that contains the rubi text Constants FTI2_RubiTextEnd 0x80000002 The end of rubi text The FO_Rubi object for the rubi composite that contains the rubi text Constants FTI2_...

Page 619: ...Void Syntax SetProps setVal Parameters ObjectValid Description Returns True if the rubi object is valid else returns False See ObjectValid under the AFrame class for more information Returns int Synt...

Page 620: ...x GetProps SetProps Description Sets the properties of the ruling format See SetProps under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters ObjectValid Description...

Page 621: ...nts are appended as separate array elements at the end of the new array Returns a new array the result of concatenation the given values to the end of the original array Returns Strings Syntax concat...

Page 622: ...ubcol object See GetText under the Cell class for more information Returns TextItems Syntax GetText flags Parameters GetProps Description Retrieves the properties of the subcol object See GetProps und...

Page 623: ...etVal Parameters ObjectValid Description Returns True if the subcol object is valid else returns False See ObjectValid under the AFrame class for more information Returns int Syntax ObjectValid Tab Ta...

Page 624: ...e Constants FV_TAB_LEFT 0x1 Left tab Constants FV_TAB_CENTER 0x2 Center tab Constants FV_TAB_RIGHT 0x3 Right tab Constants FV_TAB_DECIMAL 0x4 Decimal tab Constants FV_TAB_RELATIVE_LEFT 0x5 Relative le...

Page 625: ...of the array Returns number Syntax push value Parameters Tbl AddCols Description Adds columns to a table The method returns FE_Success on success On failure the method sets FA_errno to one of the fol...

Page 626: ...Operation 27 The method specified an invalid operation Parameter name Data Type Optional Description refColNum int No The column at which to start adding columns The columns are numbered from left to...

Page 627: ...nge of cells in a table Parameter name Data Type Optional Description delColNum int No The first column to delete Columns are numbered from left to right starting with 0 numDelCols int No The number o...

Page 628: ...ied table See Delete under the AFrame class for more information Returns int Syntax Delete Error Reason Constants FE_BadDocId 2 invalid document Constants FE_BadObjId 3 Invalid object Constants FE_Bad...

Page 629: ...etProps SetProps Description The SetProps method sets the properties of the specified table See SetProps under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters Obje...

Page 630: ...s GetProps See GetProps on page 412 under the AFrame class SetProps See SetProps on page 413 under the AFrame class ObjectValid See ObjectValid on page 414 under the AFrame class TextFrame Delete Desc...

Page 631: ...tProps method sets the properties of the specified text frame See SetProps under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters ObjectValid Description Returns Tr...

Page 632: ...ameter to concat each of its elements are appended as separate array elements at the end of the new array Returns a new array the result of concatenation the given values to the end of the original ar...

Page 633: ...e information Returns int Syntax Delete GetText Description Gets the text from the text line See GetText under the Cell class for more information Returns TextItems Syntax GetText flags Parameters Par...

Page 634: ...Props SetProps Description The SetProps method sets the properties of the specified text line See SetProps under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters Ob...

Page 635: ...elds of aTextRange object can specify offsets relative to the beginning and end of an object In addition they can use the special value Constants FV_OBJ_END_OFFSET 0x50000000 Note Constants FV_OBJ_END...

Page 636: ...tion This method deletes the text in a text inset You must unlock a text inset before you call this function to delete its contents After you are done you must relock the text inset Call this method o...

Page 637: ...igns one of the following values to FA_errno Returns int Syntax UpdateTextInset ConvertToText Description This method is called upon a text inset Examples TiApiClient TiFlow TiText TiTextTable object...

Page 638: ...esents text imported from a FrameMaker document or a MIF file GetText See GetText on page 452 under the Cell class GetProps See GetProps on page 412 under the AFrame class SetProps See SetProps on pag...

Page 639: ...This method deletes the text inset and removes the locked text range around it without modifying the content Returns Void Syntax ConvertToText Delete See Delete on page 412 under the AFrame class Del...

Page 640: ...letes the text inset and removes the locked text range around it without modifying the content Returns Void Syntax ConvertToText Delete See Delete on page 412 under the AFrame class DeletePropByName S...

Page 641: ...ked text range around it without modifying the content Returns Void Syntax ConvertToText Delete See Delete on page 412 under the AFrame class DeletePropByName See DeletePropByName on page 630 under th...

Page 642: ...teger indexing and a length property concat Description The original array is unchanged If an array is provided as a parameter to concat each of its elements are appended as separate array elements at...

Page 643: ...array Returns uint Syntax pop push Description Returns the new length of the array Returns number Syntax push value Parameters UInts An Array of objects with integer indexing and a length property Pa...

Page 644: ...array the result of concatenation the given values to the end of the original array Returns UInts Syntax concat value Parameters pop Description Removes the last element from the array Returns uint S...

Page 645: ...The GetProps method retrieves the properties of the specified unanchored frame See GetProps under the AFrame class for more information Returns PropVals Syntax GetProps SetProps Description The SetPr...

Page 646: ...ntax ObjectValid Var Delete Description Deletes the specified var object See Delete under the AFrame class for more information Returns int Syntax Delete GetText Description Gets the text from the var...

Page 647: ...Props SetProps Description The SetProps method sets the properties of the specified var object See SetProps under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters O...

Page 648: ...The GetProps method retrieves the properties of the specified varfmt object See GetProps under the AFrame class for more information Returns PropVals Syntax GetProps SetProps Description The SetProps...

Page 649: ...x ObjectValid XRef Delete Description Deletes the specified XRef object See Delete under the AFrame class for more information Returns int Syntax Delete GetText Description Gets the text from the XRef...

Page 650: ...rops SetProps Description The SetProps method sets the properties of the specified XRef object See SetProps under the AFrame class for more information Returns Void Syntax SetProps setVal Parameters O...

Page 651: ...e GetProps method retrieves the properties of the specified XRefFmt object See GetProps under the AFrame class for more information Returns PropVals Syntax GetProps SetProps Description The SetProps m...

Page 652: ...ty and object type If an error occurs this method returns the the object or 0 If this method fails the API assigns one of the following values to FA_errno Returns Object Syntax GetNamedObject objType...

Page 653: ...e API assigns the following value to FA_errno Returns Command Syntax GetNamedCommand name Parameters GetNamedMenu Description Gets a menu object with the specified menu string Error Meaning Constants...

Page 654: ...tor Syntax GetNamedMenuItemSeparator name Parameters NewNamedObject Description Creates a new objects and returns it If this method fails the API assigns one of the following values to FA_errno Error...

Page 655: ...eaning FE_BadName 33 Specified name for the new object is invalid FE_BadNew 23 Object cannot be created FE_DupName 32 Specified name for the new object belongs to an existing object Parameter name Dat...

Page 656: ...ItemSeparator Description Creates a new menu item separator with the specified name and returns it Error Meaning FE_BadName 33 Specified name is invalid FE_BadNew 23 Command cannot be created FE_DupNa...

Page 657: ...parameter the alert displays either the OK and Cancel buttons Yes and No buttons or a Continue button The type parameter takes one of the following values Error Meaning FE_BadName 33 Specified name is...

Page 658: ...is useful for calling FrameMaker clients such as the structure generator and the element catalog manager On success the method returns FE_Success or the value specified by the target client s last cal...

Page 659: ...e following value to FA_errno on failure Error Reason Constants FE_NameNotFound 20 There is no client with the specified name in the current FrameMaker productsession Constants FE_BadParameter 43 For...

Page 660: ...ument template The sidedness parameter can have one of the following values The method returns the new document on success The method assigns the following value to FA_errno on failure Error Reason Co...

Page 661: ...ues Parameter name Data Type Optional Description width int No The document page width height int No The document page height numCols int No The default number of columns columnGap int No The default...

Page 662: ...romSession Err Description Prints the client s name and a message to the console Returns Void Syntax Err message Parameters Constants FE_SystemError 42 System error Parameter name Data Type Optional D...

Page 663: ...are represented by different encodings You should use ApiFamilyFonts to get a list of the variations for the family Then you can use GetEncodingForFont to get the encoding for a specific variation Ret...

Page 664: ...tDefaultParams Description Gets a default property list that you can use to call Import The method returns a PropVals structure containing the properties retreived For more information see Import on p...

Page 665: ...ropNum Parameters GetSaveDefaultParams Description Gets a default property list that you can use to call Save On success the method returns a PropVals list as shown in the following table The first va...

Page 666: ...ts FV_SaveFmtSgml 7 Save in SGML format Constants FV_SaveFmtText 6 Save in Text Only format Constants FV_SaveFmtXml 10 Save in XML format Constants FV_SaveFmtPdf 9 Save as PostScript and then invoke A...

Page 667: ...round the page count The value is one of Constants FV_UseCurrentSetting 0 Use default specified by the document property PageRounding Constants FV_DontChangePageCount 1 Leave pages as is Constants FV...

Page 668: ...racter to write as a cell separator in the text file Constants FV_SaveTextTblRowColumnSeparator TBD The character to write as a row or column separator in the text file SgmlSaveApplication Retained fo...

Page 669: ...for fonts Returns Strings Syntax GetSupportedEncodings GetUpdateBookDefaultParams Description TBD Returns PropVals Syntax GetUpdateBookDefaultParams IsEncodingSupported Description Checks whether the...

Page 670: ...e of a command or move a command from one menu to another The method returns FE_Success on success On failure the method sets FA_errno to one of the following values Returns Void Syntax LoadMenuCustom...

Page 671: ...ile dialog box silent bool No Specifies whether to display the Menu Customization File dialog box and allow the user to choose the file To display the dialog box and allow the user to choose the file...

Page 672: ...s FA_Note_PreFileType 9 Constants FA_Note_PostFileType 10 Constants FA_Note_PreOpenBookMIF 18 Constants FA_Note_PostOpenBookMIF 19 User double clicked to open a document in a book window Before openin...

Page 673: ...ts FA_Note_PreSaveBook 20 Constants FA_Note_PostSaveBook 21 Book saved in MIF format Before saving the MIF file After saving the MIF file Constants FA_Note_PreSaveBookMIF 22 Constants FA_Note_PostSave...

Page 674: ...ked Go To Source in the cross reference dialog box Before the FrameMaker product goes to the cross reference source After the FrameMaker product goes to the cross reference source Constants FA_Note_Pr...

Page 675: ...set Before the attribute value is set After the attribute value is set Constants FA_Note_PreSetAttrValue 62 Constants FA_Note_PreSetAttrValue 63 Element definitions are imported Before the element de...

Page 676: ...e before calling the method and check it once after the method call is completed For example if you call the Notification method and specify an invalid notification constant the method sets FA_errno t...

Page 677: ...eturned by Open It is useful for debugging your clients Returns Void Syntax PrintOpenStatus p Parameters PrintPropVal Description Prints the value of a specified property It is useful for debugging yo...

Page 678: ...ed by Save It is useful for debugging your clients Returns Void Syntax PrintSaveStatus p Parameters PrintTextItem Description Prints the text in a specified text item It is useful for debugging client...

Page 679: ...your clients Returns Void Syntax PrintUpdateBookStatus p Parameters PushClipboard Description Pushes the current Clipboard contents onto the Clipboard stack The method is useful if you want to use Cl...

Page 680: ...nt 48 notifications by calling ReturnValue with retvalue set to Constants FR_CancelOperation 10001 FrameMaker cancels all print operations Your client can also call ReturnValue in a DialogEvent callba...

Page 681: ..._errno Returns int Syntax ReturnValue retvalue Parameters Constants FA_Note_DisplayClientTiDialog 35 Constants FR_DisplayedTiDialog 10002 The client has displayed its version of the Text Inset Propert...

Page 682: ...your client to create a portrait custom or landscape document Note For more information on creating custom documents see CustomDoc on page 652 If SimpleNewDoc fails the API assigns an error code to F...

Page 683: ...Dir as the default path If a warning or error condition arises FrameMaker notifies the user For example if a document uses fonts that are not available FrameMaker displays a dialog box that allows the...

Page 684: ...pecified menu The method returns FE_Success on success On failure the method assigns one of the following values to FA_errno Parameter name Data Type Optional Description fileName string No The absolu...

Page 685: ...er 43 One of tomenu and menu have the same values tomenu is not previously defined tomenu is not a menu Parameter name Data Type Optional Description toMenu string No The menu tag to which the menu is...

Page 686: ...cified command exists The method returns True if the command exists or False if the command does not exist Returns int Syntax ShortcutExists shortcut Parameters GetExportDefaultParams Description Retu...

Page 687: ...me Description Returns the string corresponding to the value of FA_errno Returns string Syntax ErrorName i Parameters PrintErrno Description Prints the value of FA_errno to the console Returns Void Pa...

Page 688: ...roperty list a PropVals data structure The returned PropVals structure references memory that is allocated by the API If AllocatePropVals fails the method sets the len field of the returned structure...

Page 689: ...ts FE_WantsPortrait 48 Constants FE_WantsCustom 46 or Constants FE_WantsLandscape 47 respectively It is up to your client to create a portrait custom or landscape document Note For more information on...

Page 690: ...version but the user or the Open script chose to open it anyway Constants FV_FileStructureStripped 42 The file had FrameMaker features which the user or the Open script chose to strip Constants FV_Fil...

Page 691: ...ate a new book Constants FV_BadScriptValue 70 Open script contained an invalid property value Constants FV_MissingScript 71 Open was called without a script Constants FV_CantForceOpenAsText 72 Open sc...

Page 692: ...en script canceled the Open operation Constants FV_CancelFontsMappedInCatalog 105 The document s Character Catalog or Paragraph Catalog contained fonts that needed to be mapped to other fonts so the u...

Page 693: ...kNotReset 1 File had a lock that was not reset Constants FV_LockCouldntBeReset 2 File had a lock that could not be reset Constants FV_FileWasInUse 3 File was in use Constants FV_FileIsViewOnly 4 File...

Page 694: ...r occurred Parameter name Data Type Optional Description title string No The title that appears on the dialog box stringslist Strings No The list of items to appear in the scroll list _default int No...

Page 695: ...a default value which appears in the entry field when the dialog box appears The dialog box has OK and Cancel buttons Parameter name Data Type Optional Description title string No The message that ap...

Page 696: ...og box appears The dialog box has OK and Cancel buttons Note Do not call PromptString to prompt the user for a pathname If the user enters a pathname as a string the backslash character is interpreted...

Page 697: ...gister for notifications The method returns the number of bits the call to select selected if any Returns int Syntax Service FileScrollBox Description Displays a file scrollbox using the given title a...

Reviews:

No comments