Adobe FrameMaker-12 Object Model JS: Doc

FrameMaker 12.0

Class

Doc

 

QuickLinks

AddNewBuildExpr, AddTableVariables, AddText, CenterOnText, Clear, ClearAllChangebars, Close, Compare, Copy, Cut, DeleteBuildExpr, DeleteText, DeleteUndefinedAttribute, DeleteUnusedCharFmt, DeleteUnusedFmts, DeleteUnusedGraphicsFmt, DeleteUnusedPgfFmt, DeleteUnusedTblFmt, DemoteElement, ElementLocToTextLoc, Export, Find, GetActiveBuildExpr, GetBuildExpr, GetBuildExprCatalog, GetDependencies, GetNamedAttrCondExpr, GetNamedCharFmt, GetNamedColor, GetNamedCombinedFontDefn, GetNamedCondFmt, GetNamedElementDef, GetNamedFmtChangeList, GetNamedGraphicsFmt, GetNamedMarkerType, GetNamedMasterPage, GetNamedObject, GetNamedPgfFmt, GetNamedRefPage, GetNamedRulingFmt, GetNamedTblFmt, GetNamedUnanchoredFrame, GetNamedVarFmt, GetNamedXRefFmt, GetProps, GetTextForRange, GetTextForRange2, GetTextPropVal, GetTextProps, GetTextVal, GetUniqueObject, HypertextCommand, Import, MergeIntoFirst, MergeIntoLast, NewAnchoredAFrame, NewAnchoredFn, NewAnchoredFormattedObject, NewAnchoredFormattedTbl, NewAnchoredFormattedVar, NewAnchoredFormattedXRef, NewAnchoredMarker, NewAnchoredObject, NewAnchoredTbl, NewAnchoredTiApiClient, NewArc, NewEllipse, NewFlow, NewGraphicObject, NewGroup, NewInset, NewIterator, NewLine, NewMath, NewMathML, NewNamedAttrCondExpr, NewNamedCharFmt, NewNamedColor, NewNamedCombinedFontDefn, NewNamedCondFmt, NewNamedElementDef, NewNamedFmtChangeList, NewNamedGraphicsFmt, NewNamedMarkerType, NewNamedMasterPage, NewNamedObject, NewNamedPgfFmt, NewNamedRefPage, NewNamedRulingFmt, NewNamedTblFmt, NewNamedVarFmt, NewNamedXRefFmt, NewPolygon, NewPolyline, NewRectangle, NewRoundRect, NewSeriesBodyPage, NewSeriesObject, NewSeriesPgf, NewTable, NewTextFrame, NewTextLine, NewUnanchoredFrame, ObjectValid, Paste, PromoteElement, QuickSelect, Redisplay, Reformat, Rehyphenate, ResetEqnSettings, ResetReferenceFrames, RestartPgfNumbering, Save, ScrollToText, SetActiveBuildExpr, SetAttributeSimple, SetElementRange, SetProps, SetTextPropVal, SetTextProps, SetTextVal, SilentPrintDoc, SimpleImportElementDefs, SimpleImportFormats, SimpleSave, SplitElement, TextLocToElementLoc, TrackChangesAcceptAll, TrackChangesRejectAll, UnWrapElement, UndoCancel, UndoEndCheckPoint, UndoStartCheckPoint, UpdateDITAReferences, UpdateVariables, UpdateXRef, UpdateXRefs

Properties

PropertyTypeAccessDescription
AcrobatBookmarkDisplayTagsint readwrite
AutoChangeBarsint readwrite
BannerTextDisplaybool readwrite
BooleanConditionExpressionstring readwrite
BooleanConditionExpressionTagstring readwrite
BooleanConditionStateint readwrite
BottomMarginint readwrite
Capitalizationint readwrite
ChangeBarint readwrite
ChangeBarColorColor readwrite
ChangeBarDistanceint readwrite
ChangeBarPositionint readwrite
ChangeBarThicknessint readwrite
ChapNumComputeMethodint readwrite
ChapterNumStyleint readwrite
ChapterNumTextstring readwrite
ChapterNumberint readwrite
CharTagstring readwrite
ColGapint readwrite
ColorColor readwrite
CombinedFontFamilyCombinedFontDefn readwrite
CondFmtIsShownint readwrite
CurrentPageFMObject readwrite
CustomElementListStrings String readwrite
DefaultExclusionsStrings String readwrite
DefaultInclusionsStrings String readwrite
DictionaryStrings String readwrite
DocAcrobatColumnArticleThreadsint readwrite
DocAcrobatDefaultsChangedint readwrite
DocAcrobatElementListStrings String readwrite
DocAcrobatElementsint readwrite
DocAcrobatNoArticleThreadsint readwrite
DocFluidFlowFlow readwrite
DocIsDoubleSidedint readwrite
DocIsModifiedint readonly
DocIsViewOnlyint readwrite
DocOpenTypeint readonly
DocSaveTypeint readonly
DontUpdateTextInsetsint readwrite
DontUpdateXRefsint readwrite
DownloadFontsint readwrite
ElementBoundaryDisplayint readwrite
ElementCatalogElementCatalogEntries ElementCatalogEntry readonly
ElementCatalogDisplayint readwrite
ElementSelectionElementRange readwrite
EqnIntegralSizeLargeint readwrite
EqnIntegralSizeMedint readwrite
EqnIntegralSizeSmallint readwrite
EqnLevel1SizeLargeint readwrite
EqnLevel1SizeMedint readwrite
EqnLevel1SizeSmallint readwrite
EqnLevel2SizeLargeint readwrite
EqnLevel2SizeMedint readwrite
EqnLevel2SizeSmallint readwrite
EqnLevel3SizeLargeint readwrite
EqnLevel3SizeMedint readwrite
EqnLevel3SizeSmallint readwrite
EqnSigmaSizeLargeint readwrite
EqnSigmaSizeMedint readwrite
EqnSigmaSizeSmallint readwrite
FirstAttrCondExprInDocAttrCondExpr readonly
FirstBodyPageInDocBodyPage readonly
FirstCharFmtInDocCharFmt readonly
FirstColorInDocColor readonly
FirstCombinedFontDefnInDocCombinedFontDefn readonly
FirstCondFmtInDocCondFmt readonly
FirstDITAConrefElementInDocElement readonly
FirstDITALinkElementInDocElement readonly
FirstDITATopicrefElementInDocElement readonly
FirstDITATopicsetrefElementInDocElement readonly
FirstDITAXrefElementInDocElement readonly
FirstElementDefInDocElementDef readonly
FirstFlowInDocFlow readonly
FirstFmtChangeListInDocFmtChangeList readwrite
FirstFnInDocFn readonly
FirstGraphicInDocFMObject readonly
FirstGraphicsFmtInDocGraphicsFmt readonly
FirstMarkerInDocMarker readonly
FirstMarkerTypeInDocMarkerType readonly
FirstMasterPageInDocMasterPage readonly
FirstPageNumint readwrite
FirstPageVersoint readwrite
FirstPgfFmtInDocPgfFmt readonly
FirstPgfInDocPgf readonly
FirstRefPageInDocRefPage readonly
FirstRubiInDocRubi readonly
FirstRulingFmtInDocRulingFmt readonly
FirstSelectedGraphicInDocFMObject readonly
FirstSelectedTiInDocFMObject readonly
FirstTblFmtInDocTblFmt readonly
FirstTblInDocTbl readonly
FirstTiInDocFMObject readonly
FirstVarFmtInDocVarFmt readonly
FirstVarInDocVar readonly
FirstXRefFmtInDocXRefFmt readonly
FirstXRefInDocXRef readonly
FnCustNumStringstring readwrite
FnFirstNumint readwrite
FnFmtstring readwrite
FnHeightPerColint readwrite
FnInstancePositionint readwrite
FnInstancePrefixstring readwrite
FnInstanceSuffixstring readwrite
FnNumComputeMethodint readwrite
FnNumStyleint readwrite
FnNumberingPerPageint readwrite
FnRefPositionint readwrite
FnRefPrefixstring readwrite
FnRefSuffixstring readwrite
FontAngleint readwrite
FontEncodingNamestring readonly
FontFamilyint readwrite
FontPlatformNamestring readwrite
FontPostScriptNamestring readwrite
FontSizeint readwrite
FontVariationint readwrite
FontWeightint readwrite
FormatOverrideint readwrite
Functionsstring readwrite
GenerateAcrobatInfoint readwrite
HiddenPageHiddenPage readonly
HypertextCommandTextstring readwrite
HypertextDoValidatebool readwrite
HypertextParseBadParamint readonly
HypertextParseErrint readonly
HypertextParseErrMsgstring readonly
HypertextParsedClientNamestring readonly
HypertextParsedCmdCodeint readonly
HypertextParsedCmdDestint readonly
HypertextParsedCmdDestObjIDint readonly
HypertextParsedCmdDestObjTypeint readonly
HypertextParsedCmdMatrixColumnsint readonly
HypertextParsedCmdMatrixRowsint readonly
HypertextParsedDIFileNamestring readonly
HypertextParsedFlowNamestring readonly
HypertextParsedLinkNamestring readonly
HypertextParsedMessagestring readonly
HypertextParsedPageNamestring readonly
HypertextParsedTitlestring readonly
HypertextValidateErrint readonly
InCondObjects readwrite
IsIconifiedint readwrite
IsInFrontint readwrite
IsOnScreenint readwrite
KernXint readwrite
KernYint readwrite
KeyCatalogKeyCatalog readonly
KeyCatalogTypeint readwrite
Labelstring readwrite
LastBodyPageInDocBodyPage readonly
LastMasterPageInDocMasterPage readonly
LastRefPageInDocRefPage readonly
LeftMarginint readwrite
LeftMasterPageMasterPage readonly
LineBreakAfterstring readwrite
LineNumDistanceint readwrite
LineNumRestartbool readwrite
LineNumShowbool readwrite
MainFlowInDocFlow readonly
MarkerTypeNamesStrings String readonly
MaxBottomMarginint readwrite
MaxFirstIndentint readwrite
MaxFontSizeint readwrite
MaxLeadingint readwrite
MaxLeftIndentint readwrite
MaxLeftMarginint readwrite
MaxRightIndentint readwrite
MaxRightMarginint readwrite
MaxSpaceAboveint readwrite
MaxSpaceBelowint readwrite
MaxSpreadint readwrite
MaxStretchint readwrite
MaxTabPositionint readwrite
MaxTopMarginint readwrite
MenuBarMenu readwrite
MinBottomMarginint readwrite
MinFirstIndentint readwrite
MinFontSizeint readwrite
MinLeadingint readwrite
MinLeftIndentint readwrite
MinLeftMarginint readwrite
MinRightIndentint readwrite
MinRightMarginint readwrite
MinSpaceAboveint readwrite
MinSpaceBelowint readwrite
MinSpreadint readwrite
MinStretchint readwrite
MinTabPositionint readwrite
MinTopMarginint readwrite
Namestring readonly
NarrowRubiSpaceForOtherint readwrite
NewElemAttrDisplayint readwrite
NewElemAttrEditingint readwrite
NextOpenDocInSessionDoc readonly
NumColsint readonly
Numbersstring readwrite
Overlineint readwrite
PDFAllNamedDestinationsint readwrite
PDFBookmarkbool readwrite
PDFBookmarksOpenLevelint readwrite
PDFConvertCMYKtoRGBint readwrite
PDFDestsMarkedint readwrite
PDFDistillerAbsentint readonly
PDFDocInfoStrings String readwrite
PDFEndPagestring readwrite
PDFGenerateForReviewint readwrite
PDFJobOptionstring readwrite
PDFJobOptionsAbsentint readonly
PDFOpenPagestring readwrite
PDFPageHeightint readwrite
PDFPageWidthint readwrite
PDFPrintPageRangeint readwrite
PDFRegistrationMarksint readwrite
PDFSeparateFilesint readwrite
PDFStartPagestring readwrite
PDFStructureint readwrite
PDFViewPDFint readwrite
PDFZoomFactorint readwrite
PDFZoomTypeint readwrite
PageHeightint readwrite
PageNumComputeMethodint readwrite
PageNumStyleint readwrite
PageRoundingint readwrite
PageWidthint readwrite
PairKernint readwrite
PgfNumComputeMethodint readwrite
PointPageNumStyleint readwrite
Positionint readwrite
PreviewStateint readwrite
PrintBlankPagesint readwrite
PrintCollatedint readwrite
PrintColsint readwrite
PrintDitavalFileNamestring readwrite
PrintEmulsionint readwrite
PrintEndPageint readwrite
PrintEndPageNameint readwrite
PrintEndPointint readwrite
PrintEvenPagesint readwrite
PrintFileNamestring readwrite
PrintImagingint readwrite
PrintLastSheetFirstint readwrite
PrintLowResint readwrite
PrintManualFeedint readwrite
PrintNumCopiesint readwrite
PrintOddPagesint readwrite
PrintPaperHeightint readwrite
PrintPaperWidthint readwrite
PrintRegistrationMarksint readwrite
PrintRowsint readwrite
PrintScaleint readwrite
PrintScopeint readwrite
PrintSepsint readwrite
PrintStartPageint readwrite
PrintStartPageNameint readwrite
PrintStartPointint readwrite
PrintThumbnailsint readwrite
PrintToFileint readwrite
PrinterNamestring readwrite
ReviewerNamestring readwrite
ReviewerNameListStrings String readonly
RightMarginint readwrite
RightMasterPageMasterPage readonly
RubiFixedSizeint readwrite
RubiOverhangint readwrite
RubiSizeint readwrite
ScreenHeightint readwrite
ScreenWidthint readwrite
ScreenXint readwrite
ScreenYint readwrite
SecNumComputeMethodint readwrite
SectionNumStyleint readwrite
SectionNumTextstring readwrite
SectionNumberint readwrite
SelectedTblTbl readonly
SepOverrideColor readwrite
SeparateInclusionsint readwrite
ShowAllint readwrite
ShowCondIndicatorsint readwrite
ShowElementDescriptiveNamesbool readwrite
SkipBlankSepsint readwrite
SmallCapsSizeint readwrite
SmallCapsStretchint readwrite
SmartQuotesint readwrite
SmartSpacesint readwrite
SnapAngleint readwrite
SnapGridUnitsint readwrite
SpecifiedKeyCatalogKeyCatalog readwrite
SpotColorViewint readwrite
Spreadint readwrite
StatusLinestring readwrite
Stretchint readwrite
Strikethroughint readwrite
Stringsstring readwrite
StructuredApplicationstring readwrite
StructuredApplicationForOpenstring readwrite
StyleOverridesint readonly
SubScriptShiftint readwrite
SubScriptSizeint readwrite
SubScriptStretchint readwrite
SubsecNumComputeMethodint readwrite
SubsectionNumStyleint readwrite
SubsectionNumTextstring readwrite
SubsectionNumberint readwrite
SuperScriptShiftint readwrite
SuperScriptSizeint readwrite
SuperScriptStretchint readwrite
Symbolsstring readwrite
SymbolsListStrings String readonly
TblFnCellPositionint readwrite
TblFnCellPrefixstring readwrite
TblFnCellSuffixstring readwrite
TblFnCustNumStringstring readwrite
TblFnFmtstring readwrite
TblFnNumStyleint readwrite
TblFnPositionint readwrite
TblFnPrefixstring readwrite
TblFnSuffixstring readwrite
TextSelectionTextRange readwrite
TopMarginint readwrite
TrackChangesAddedColorColor readwrite
TrackChangesDeletedColorColor readwrite
TrackChangesOnbool readwrite
TrapwiseCompatibilitybool readwrite
Underliningint readwrite
Untouchableint readwrite
UseInitialStructureint readwrite
UseInitialStructureOfAutoInsertedElementsbool readwrite
UseSepOverrideint readwrite
UserStringstring readwrite
Variablesstring readwrite
ViewBordersint readwrite
ViewDisplayUnitsint readwrite
ViewFontSizeUnitsint readwrite
ViewGridint readwrite
ViewGridUnitsint readwrite
ViewHotspotIndicatorsint readwrite
ViewNoGraphicsint readwrite
ViewOnlyDeadCodesUInts readwrite
ViewOnlyMenuBarMenu readwrite
ViewOnlySelectint readwrite
ViewOnlyWinBordersint readwrite
ViewOnlyWinMenubarint readwrite
ViewOnlyWinPaletteint readwrite
ViewOnlyWinPopupint readwrite
ViewOnlyXRefint readwrite
ViewPageScrollingint readwrite
ViewRulerUnitsint readwrite
ViewRulersint readwrite
ViewTextSymbolsint readwrite
VolNumComputeMethodint readwrite
VolumeNumStyleint readwrite
VolumeNumTextstring readwrite
VolumeNumberint readwrite
WideRubiSpaceForOtherint readwrite
XmlDocTypestring readwrite
XmlEncodingstring readwrite
XmlFileEncodingstring readwrite
XmlPublicIdstring readwrite
XmlStandAloneint readwrite
XmlStyleSheetstring readwrite
XmlStyleSheetListStrings String readwrite
XmlSystemIdstring readwrite
XmlUseBOMint readwrite
XmlVersionstring readwrite
XmlWellFormedint readwrite
Zoomint readwrite

Methods

Instances

int AddNewBuildExpr (exprName: string, exprCondition: string)

ParameterTypeDescription
exprNamestring
exprConditionstring

int AddTableVariables (tblFormatOrTblId: Object, allTables: bool, insertContVariable: bool, insertSheetVariable: bool)

ParameterTypeDescription
tblFormatOrTblIdObject
allTablesbool
insertContVariablebool
insertSheetVariablebool

TextLoc AddText (textLoc: TextLoc, text: string)

ParameterTypeDescription
textLocTextLoc
textstring

int CenterOnText (textRange: TextRange)

ParameterTypeDescription
textRangeTextRange

int Clear (flags: int)

ParameterTypeDescription
flagsint

int ClearAllChangebars ()

int Close (flags: int)

ParameterTypeDescription
flagsint

CompareRet Compare (newerDoc: Doc, flags: int, insertCondTag: string, deleteCondTag: string, replaceText: string, compareThreshold: int)

ParameterTypeDescription
newerDocDoc
flagsint
insertCondTagstring
deleteCondTagstring
replaceTextstring
compareThresholdint

int Copy (flags: int)

ParameterTypeDescription
flagsint

int Cut (flags: int)

ParameterTypeDescription
flagsint

int DeleteBuildExpr (exprName: string)

ParameterTypeDescription
exprNamestring

int DeleteText (textRange: TextRange)

ParameterTypeDescription
textRangeTextRange

int DeleteUndefinedAttribute (attrName: string, scope: int, objId: Object)

ParameterTypeDescription
attrNamestring
scopeint
objIdObject

int DeleteUnusedCharFmt ()

int DeleteUnusedFmts (objType: int)

ParameterTypeDescription
objTypeint

int DeleteUnusedGraphicsFmt ()

int DeleteUnusedPgfFmt ()

int DeleteUnusedTblFmt ()

void DemoteElement ()

TextLoc ElementLocToTextLoc (eloc: ElementLoc)

ParameterTypeDescription
elocElementLoc

int Export (fileName: string, exportParams: PropVals, exportReturnParams: PropVals)

ParameterTypeDescription
fileNamestring
exportParamsPropVals
exportReturnParamsPropVals

TextRange Find (textLoc: TextLoc, findParams: PropVals)

ParameterTypeDescription
textLocTextLoc
findParamsPropVals

string GetActiveBuildExpr ()

string GetBuildExpr (exprName: string)

ParameterTypeDescription
exprNamestring

Strings GetBuildExprCatalog ()

TypedVals GetDependencies (depMode: int)

ParameterTypeDescription
depModeint

AttrCondExpr GetNamedAttrCondExpr (name: string)

ParameterTypeDescription
namestring

CharFmt GetNamedCharFmt (name: string)

ParameterTypeDescription
namestring

Color GetNamedColor (name: string)

ParameterTypeDescription
namestring

CombinedFontDefn GetNamedCombinedFontDefn (name: string)

ParameterTypeDescription
namestring

CondFmt GetNamedCondFmt (name: string)

ParameterTypeDescription
namestring

ElementDef GetNamedElementDef (name: string)

ParameterTypeDescription
namestring

FmtChangeList GetNamedFmtChangeList (name: string)

ParameterTypeDescription
namestring

GraphicsFmt GetNamedGraphicsFmt (name: string)

ParameterTypeDescription
namestring

MarkerType GetNamedMarkerType (name: string)

ParameterTypeDescription
namestring

MasterPage GetNamedMasterPage (name: string)

ParameterTypeDescription
namestring

Object GetNamedObject (objType: int, name: string)

ParameterTypeDescription
objTypeint
namestring

PgfFmt GetNamedPgfFmt (name: string)

ParameterTypeDescription
namestring

RefPage GetNamedRefPage (name: string)

ParameterTypeDescription
namestring

RulingFmt GetNamedRulingFmt (name: string)

ParameterTypeDescription
namestring

TblFmt GetNamedTblFmt (name: string)

ParameterTypeDescription
namestring

UnanchoredFrame GetNamedUnanchoredFrame (name: string)

ParameterTypeDescription
namestring

VarFmt GetNamedVarFmt (name: string)

ParameterTypeDescription
namestring

XRefFmt GetNamedXRefFmt (name: string)

ParameterTypeDescription
namestring

PropVals GetProps ()

TextItems GetTextForRange (tr: TextRange, flags: int)

ParameterTypeDescription
trTextRange
flagsint

TextItems GetTextForRange2 (tr: TextRange, flags: int, flags2: int)

ParameterTypeDescription
trTextRange
flagsint
flags2int

PropVal GetTextPropVal (textLoc: TextLoc, propNum: int)

ParameterTypeDescription
textLocTextLoc
propNumint

PropVals GetTextProps (textLoc: TextLoc)

ParameterTypeDescription
textLocTextLoc

TypedVal GetTextVal (textLoc: TextLoc, propNum: int)

ParameterTypeDescription
textLocTextLoc
propNumint

Object GetUniqueObject (objType: int, unique: int)

ParameterTypeDescription
objTypeint
uniqueint

int HypertextCommand (hypertext: string)

ParameterTypeDescription
hypertextstring

Object Import (textLocP: TextLoc, filename: string, importParams: PropVals, importReturnParams: PropVals)

ParameterTypeDescription
textLocPTextLoc
filenamestring
importParamsPropVals
importReturnParamsPropVals

void MergeIntoFirst ()

void MergeIntoLast ()

AFrame NewAnchoredAFrame (textloc: TextLoc)

ParameterTypeDescription
textlocTextLoc

Fn NewAnchoredFn (textloc: TextLoc)

ParameterTypeDescription
textlocTextLoc

Object NewAnchoredFormattedObject (objType: int, format: string, textLoc: TextLoc)

ParameterTypeDescription
objTypeint
formatstring
textLocTextLoc

Tbl NewAnchoredFormattedTbl (format: string, textLoc: TextLoc)

ParameterTypeDescription
formatstring
textLocTextLoc

Var NewAnchoredFormattedVar (format: string, textLoc: TextLoc)

ParameterTypeDescription
formatstring
textLocTextLoc

XRef NewAnchoredFormattedXRef (format: string, textLoc: TextLoc)

ParameterTypeDescription
formatstring
textLocTextLoc

Marker NewAnchoredMarker (textloc: TextLoc)

ParameterTypeDescription
textlocTextLoc

Object NewAnchoredObject (objType: int, textloc: TextLoc)

ParameterTypeDescription
objTypeint
textlocTextLoc

Tbl NewAnchoredTbl (textloc: TextLoc)

ParameterTypeDescription
textlocTextLoc

TiApiClient NewAnchoredTiApiClient (textloc: TextLoc)

ParameterTypeDescription
textlocTextLoc

Arc NewArc (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

Ellipse NewEllipse (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

Flow NewFlow (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

Object NewGraphicObject (objType: int, parent: FrameObject) GraphicObject could be any FM graphic object, i.e, AFrame ,UnanchoredFrame

ParameterTypeDescription
objTypeint
parentFrameObject

Group NewGroup (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

Inset NewInset (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

Object NewIterator (paramsp: PropVals)

ParameterTypeDescription
paramspPropVals

Line NewLine (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

Math NewMath (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

MathML NewMathML (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

AttrCondExpr NewNamedAttrCondExpr (name: string)

ParameterTypeDescription
namestring

CharFmt NewNamedCharFmt (name: string)

ParameterTypeDescription
namestring

Color NewNamedColor (name: string)

ParameterTypeDescription
namestring

CombinedFontDefn NewNamedCombinedFontDefn (name: string)

ParameterTypeDescription
namestring

CondFmt NewNamedCondFmt (name: string)

ParameterTypeDescription
namestring

ElementDef NewNamedElementDef (name: string)

ParameterTypeDescription
namestring

FmtChangeList NewNamedFmtChangeList (name: string)

ParameterTypeDescription
namestring

GraphicsFmt NewNamedGraphicsFmt (name: string)

ParameterTypeDescription
namestring

MarkerType NewNamedMarkerType (name: string)

ParameterTypeDescription
namestring

MasterPage NewNamedMasterPage (name: string)

ParameterTypeDescription
namestring

Object NewNamedObject (objType: int, name: string)

ParameterTypeDescription
objTypeint
namestring

PgfFmt NewNamedPgfFmt (name: string)

ParameterTypeDescription
namestring

RefPage NewNamedRefPage (name: string)

ParameterTypeDescription
namestring

RulingFmt NewNamedRulingFmt (name: string)

ParameterTypeDescription
namestring

TblFmt NewNamedTblFmt (name: string)

ParameterTypeDescription
namestring

VarFmt NewNamedVarFmt (name: string)

ParameterTypeDescription
namestring

XRefFmt NewNamedXRefFmt (name: string)

ParameterTypeDescription
namestring

Polygon NewPolygon (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

Polyline NewPolyline (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

Rectangle NewRectangle (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

RoundRect NewRoundRect (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

BodyPage NewSeriesBodyPage (previous: Object)

ParameterTypeDescription
previousObject

Object NewSeriesObject (objType: int, previous: Object)

ParameterTypeDescription
objTypeint
previousObject

Pgf NewSeriesPgf (previous: Object)

ParameterTypeDescription
previousObject

Tbl NewTable (format: string, numCols: int, numBodyRows: int, numHeaderRows: int, numFooterRows: int, textLoc: TextLoc)

ParameterTypeDescription
formatstring
numColsint
numBodyRowsint
numHeaderRowsint
numFooterRowsint
textLocTextLoc

TextFrame NewTextFrame (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

TextLine NewTextLine (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

UnanchoredFrame NewUnanchoredFrame (parent: FrameObject)

ParameterTypeDescription
parentFrameObject

int ObjectValid ()

int Paste (flags: int)

ParameterTypeDescription
flagsint

void PromoteElement ()

int QuickSelect (prompt: string, stringlist: Strings)

ParameterTypeDescription
promptstring
stringlistStrings

int Redisplay ()

int Reformat ()

int Rehyphenate ()

int ResetEqnSettings ()

int ResetReferenceFrames ()

int RestartPgfNumbering ()

Object Save (saveAsName: string, saveParams: PropVals, saveReturnParams: PropVals)

ParameterTypeDescription
saveAsNamestring
saveParamsPropVals
saveReturnParamsPropVals

int ScrollToText (textRange: TextRange)

ParameterTypeDescription
textRangeTextRange

int SetActiveBuildExpr (exprName: string)

ParameterTypeDescription
exprNamestring

int SetAttributeSimple (attrName: string, attrValStr: string, scope: int, objId: Object)

ParameterTypeDescription
attrNamestring
attrValStrstring
scopeint
objIdObject

void SetElementRange (propNum: int, setVal: ElementRange)

ParameterTypeDescription
propNumint
setValElementRange

void SetProps (setVal: PropVals)

ParameterTypeDescription
setValPropVals

void SetTextPropVal (textRange: TextRange, setVal: PropVal)

ParameterTypeDescription
textRangeTextRange
setValPropVal

void SetTextProps (textRange: TextRange, setVal: PropVals)

ParameterTypeDescription
textRangeTextRange
setValPropVals

void SetTextVal (textRange: TextRange, propNum: int, setVal: TypedVal)

ParameterTypeDescription
textRangeTextRange
propNumint
setValTypedVal

int SilentPrintDoc ()

int SimpleImportElementDefs (fromDocOrBook: Doc|Book, importFlags: int)

ParameterTypeDescription
fromDocOrBookDoc|Book
importFlagsint

int SimpleImportFormats (fromDoc: Doc, formatFlags: int)

ParameterTypeDescription
fromDocDoc
formatFlagsint

Doc SimpleSave (saveAsName: string, interactive: int)

ParameterTypeDescription
saveAsNamestring
interactiveint

void SplitElement ()

ElementLoc TextLocToElementLoc (tloc: TextLoc)

ParameterTypeDescription
tlocTextLoc

int TrackChangesAcceptAll ()

int TrackChangesRejectAll ()

void UnWrapElement ()

void UndoCancel ()

void UndoEndCheckPoint ()

void UndoStartCheckPoint (description: string)

ParameterTypeDescription
descriptionstring

void UpdateDITAReferences (flag: int)

ParameterTypeDescription
flagint

int UpdateVariables ()

int UpdateXRef (srcDoc: Doc, xref: XRef)

ParameterTypeDescription
srcDocDoc
xrefXRef

int UpdateXRefs (updateXRefFlags: int)

ParameterTypeDescription
updateXRefFlagsint

Element of

CompareRet.comp

CompareRet.sum

Doc.NextOpenDocInSession

app.ActiveDoc

app.FirstOpenDoc

Used in:

CompareRet Book.Compare (newerDoc: Doc, flags: int, insertCondTag: string, deleteCondTag: string, replaceText: string, compareThreshold: int)

int Book.SimpleImportFormats (fromDoc: Doc, formatFlags: int)

CompareRet CompareRet.CompareRet (sum: Doc, comp: Doc)

CompareRet Doc.Compare (newerDoc: Doc, flags: int, insertCondTag: string, deleteCondTag: string, replaceText: string, compareThreshold: int)

int Doc.SimpleImportFormats (fromDoc: Doc, formatFlags: int)

int Doc.UpdateXRef (srcDoc: Doc, xref: XRef)

Return

Doc Doc.SimpleSave (saveAsName: string, interactive: int)

Doc Globals.CustomDoc (width: int, height: int, numCols: int, columnGap: int, topMargin: int, botMargin: int, leftinsideMargin: int, rightoutsideMargin: int, sidedness: int, makeVisible: bool)

Doc Globals.SimpleNewDoc (templateName: string, interactive: int)

Jongware, 18-Jan-2015 v1.0Contents :: Index