The undo module represents the undo engine of QuarkXPress application. You can interact with application's undo engine to record user actions.
Members
(static, readonly) subUndoTypes :number
Properties:
| Name | Type | Description |
|---|---|---|
NOSUBUNDO |
number | This flag is used to define no sub undo type |
SUBUNDOSPLINEEDIT |
number | This flag is used to define spline edit as a sub undo type |
SUBUNDO_FONT |
number | This flag is used to define font applying as a sub undo type |
SUBUNDO_FONTSIZE |
number | This flag is used to define font size applying as a sub undo type |
SUBUNDO_SCALE |
number | This flag is used to define scale applying as a sub undo type |
SUBUNDO_KERN_TRACKING |
number | This flag is used to define kerning applying as a sub undo type |
SUBUNDO_BASELINE |
number | This flag is used to define baseline applying as a sub undo type |
SUBUNDO_LEADING |
number | This flag is used to define leading applying as a sub undo type |
SUBUNDO_OFFSET |
number | This flag is used to define offset applying as a sub undo type |
SUBUNDO_COLOR_SHADE |
number | This flag is used to define color shade applying as a sub undo type |
SUBUNDO_COLOR_BLEND_ANGLE |
number | This flag is used to define color blend applying as a sub undo type |
SUBUNDO_TYPING_INSERT |
number | This flag is used to define typing insert as a sub undo type |
SUBUNDO_TYPING_DELETE |
number | This flag is used to define typing delete as a sub undo type |
SUBUNDO_FORMAT_PARAGRAPH |
number | This flag is used to define paragraph formatting as a sub undo type |
SUBUNDO_FORMAT_TEXT |
number | This flag is used to define text formatting as a sub undo type |
SUBUNDO_COLOR_OPACITY |
number | This flag is used to define color opacity applying as a sub undo type |
SUBUNDO_DONTCOMBINE |
number | This flag is used to define do not combine as a sub undo type |
SUBUNDO_COMBINABLE |
number | This flag is used to define combine as a sub undo type |
subUndoTypes
Type:
- number
(static, readonly) undoActions :number
Properties:
| Name | Type | Description |
|---|---|---|
UNDO_IGNORED |
number | Undo action is ignored |
UNDO_ADDED |
number | Undo action is successfully done |
undoActions
Type:
- number
(static, readonly) undoTypes :number
Properties:
| Name | Type | Description |
|---|---|---|
CANTUNDO |
number | This flag is used for undo |
UNDO_TYPING |
number | This flag is used for undo typing |
UNDOCUT |
number | This flag is used undo cut |
UNDOPASTE |
number | This flag is used for undo paste |
UNDODELETE |
number | This flag is used for undo deletion |
UNDO_FONT |
number | This flag is used for undo font change |
UNDO_STYLE |
number | This flag is used for undo style change |
UNDO_FORMAT |
number | This flag is used for undo format change |
UNDOITEM |
number | This flag is used for undo item change |
UNDOITEMDEL |
number | This flag is used for undo item deletion |
UNDOGEOMETRYCHANGE |
number | This flag is used for undo geometry change |
UNDODUP |
number | This flag is used for undo duplication |
UNDODRAGMOVE |
number | This flag is used for undo drag move |
UNDODRAGCOPY |
number | This flag is used for undo drag copy |
UNDOTEXT2BOX |
number | This flag is used for undo text to box |
UNDOSPLITBOX |
number | This flag is used for undo split box |
UNDO_TEXT2ANCHOREDBOX |
number | This flag is used for undo text to anchored box |
UNDOZPOS |
number | This flag is used for undo send |
UNDOGETPIC |
number | This flag is used undo import picture |
UNDOGROUP |
number | This flag is used for undo group |
UNDOUNGROUP |
number | This flag is used for undo ungroup |
UNDOCREATEBOX |
number | This flag is used for undo create box |
UNDOLOCKBOX |
number | This flag is used for undo lock box |
UNDOUNLOCKBOX |
number | This flag is used for undo unlock box |
UNDO_TEXTCHANGE |
number | This flag is used for undo text change |
UNDONEWCOLOR |
number | This flag is used for undo create color |
UNDOEDITCOLOR |
number | This flag is used for undo edit color |
UNDODUPCOLOR |
number | This flag is used for undo duplicate color |
UNDODELCOLOR |
number | This flag is used for undo delete color |
UNDOMAKESPOTCOLOR |
number | This flag is used for undo make spot color |
UNDOMAKEPROCESSCOLOR |
number | This flag is used for undo make process color |
UNDONEWSTYLESHEET |
number | This flag is used for undo create style sheet |
UNDOEDITSTYLESHEET |
number | This flag is used for undo edit style sheet |
UNDODUPSTYLESHEET |
number | This flag is used for undo duplicate style sheet |
UNDODELSTYLESHEET |
number | This flag is used for undo delete style sheet |
UNDOINSERTPAGESm |
number | This flag is used for undo insert pages |
UNDODELETEPAGES_FORREFERENCE |
number | This flag is used for undo delete pages |
UNDOMOVEPAGES_FORREFERENCE |
number | This flag is used for undo move pages |
UNDOAPPLYMASTERPAGE |
number | This flag is used for undo apply master page |
UNDODELETEMASTERPAGE |
number | This flag is used for undo delete master page |
UNDOLINK |
number | This flag is used for undo link |
UNDOUNLINK |
number | This flag is used for undo unlink |
UNDODOM |
number | This flag is used for undo DOM change |
UNDOSHAREDITEMADD |
number | This flag is used for undo share |
UNDOSHAREDITEMREMOVE |
number | This flag is used for undo unsynchronization |
UNDOSHAREDITEMCHANGE |
number | This flag is used for undo synchronized item change |
UNDO_DUPLICATE_LAYOUTSPACE_FORREFERENCE |
number | This flag is used for undo duplicate layout |
UNDO_PROPERTIES_LAYOUTSPACE |
number | This flag is used for undo change layout properties |
UNDO_PICTUREVIEW |
number | This flag is used for undo picture change |
UNDO_LOCK |
number | This flag is used for undo lock change |
UNDOSHAREDPICTURECHANGE |
number | This flag is used for undo synchronized picture change |
UNDOSHAREDTEXTCHANGE |
number | This flag is used for undo synchronized text change |
UNDOSHAREDTABLECHANGE |
number | This flag is used for undo synchronized table change |
UNDOREPLICATE |
number | This flag is used for undo replicate box |
UNDOGROUPELEMENTADD |
number | This flag is used for undo element addition |
UNDOGROUPELEMENTREMOVE |
number | This flag is used for undo element deletion |
UNDOEDITFONTSET |
number | This flag is used for undo edit font set |
UNDOGUIDECHANGE |
number | This flag is used for undo guide change |
UNDO_STORYDIRECTION |
number | This flag is used for undo story direction |
UNDODRAGNDROP |
number | This flag is used for undo drop content |
UNDOHANGINGCHARCLASSCREATE |
number | This flag is used for undo create hanging character class |
UNDOHANGINGCHARCLASSMODIFY |
number | This flag is used for undo modify hanging character class |
UNDOHANGINGCHARSETCREATE |
number | This flag is used for undo create hanging character set |
UNDOHANGINGCHARSETMODIFY |
number | This flag is used for undo modify hanging character set |
UNDONEWCONDITIONALSTYLE |
number | This flag is used for undo create conditional style |
UNDOEDITCONDITIONALSTYLE |
number | This flag is used for undo edit conditional style |
UNDODUPCONDITIONALSTYLE |
number | This flag is used for undo duplicate conditional style |
UNDODELCONDITIONALSTYLE |
number | This flag is used for undo delete conditional style |
UNDOEDITBNOSTYLE |
number | This flag is used for undo edit bullet, number and outline style |
UNDOCONDITONALSTYLECHANGE |
number | This flag is used for undo conditional style change |
UNDONEWTABLESTYLE |
number | This flag is used for undo create table style |
UNDOEDITTABLESTYLE |
number | This flag is used for undo edit table style |
UNDODUPTABLESTYLE |
number | This flag is used for undo duplicate table style |
UNDODELTABLESTYLE |
number | This flag is used for undo delete table style |
UNDOTABLESTYLECHANGE |
number | This flag is used for undo table style change |
UNDOSDONEW |
number | This flag is used for undo create structured data object |
UNDOSDOEDIT |
number | This flag is used for undo edit structured data object |
UNDOSDOUPDATE |
number | This flag is used for undo update structured data object |
UNDOSDSETEXECUTE |
number | This flag is used for undo execute structured data object |
UNDOSDODELETE |
number | This flag is used for undo delete structured data object |
UNDOEDITSDSET |
number | This flag is used for undo edit structured data set |
UNDONEWFOOTNOTESTYLE |
number | This flag is used for undo create footnote style |
UNDOEDITFOOTNOTESTYLE |
number | This flag is used for undo edit footnote style |
UNDODUPFOOTNOTESTYLE |
number | This flag is used for undo duplicate footnote style |
UNDODELFOOTNOTESTYLE |
number | This flag is used for undo delete footnote style |
UNDOFOOTNOTESTYLECHANGE |
number | This flag is used for undo footnote style change |
UNDOINSERTFOOTNOTE |
number | This flag is used for undo insert footnote |
UNDOEDITFOOTNOTE |
number | This flag is used for undo edit footnote |
UNDONEWFOOTNOTECONTAINERSTYLE |
number | This flag is used for undo create footnote separator style |
UNDOEDITFOOTNOTCONTAINERESTYLE |
number | This flag is used for undo edit footnote separator style |
UNDODUPFOOTNOTECONTAINERSTYLE |
number | This flag is used for undo duplicate footnote separator style |
UNDODELFOOTNOTECONTAINERSTYLE |
number | This flag is used for undo delete footnote separator style |
UNDOFOOTNOTECONTAINERSTYLECHANGE |
number | This flag is used for undo footnote separator style change |
UNDOINSERTCONTENTVARIABLE |
number | This flag is used for undo new content variable |
UNDODUPCONTENTVARIABLE |
number | This flag is used for undo duplicate content variable |
UNDOEDITCONTENTVARIABLE |
number | This flag is used for undo edit content variable |
UNDODELETECONTENTVARIABLE |
number | This flag is used for undo delete content variable |
UNDOINSERTENDNOTE |
number | This flag is used for undo insert endnote |
UNDOEDITENDNOTE |
number | This flag is used for undo edit endnote |
UNDOOVERRIDEANCHNOTE |
number | This flag is used for undo override anchorednote |
UNDOINSERTCROSSREFERENCE |
number | This flag is used for undo insert cross reference |
UNDOSYNCHCROSSREFERENCE |
number | This flag is used for undo synchronize cross reference |
UNDOCONVERTTONATIVEOBJECTS |
number | This flag is used for undo convert to native objects |
UNDOPASTEASNATIVEOBJECTS |
number | This flag is used for undo paste as native objects |
UNDONEWTEXTBACKGROUNDSTYLE |
number | This flag is used for undo create text shading style |
UNDOEDITTEXTBACKGROUNDSTYLE |
number | This flag is used for undo edit text shading style |
UNDODUPTEXTBACKGROUNDSTYLE |
number | This flag is used for undo duplicate text shading style |
UNDODELTEXTBACKGROUNDSTYLE |
number | This flag is used for undo delete text shading style |
UNDOTEXTBACKGROUNDSTYLECHANGE |
number | This flag is used for undo text shading style change |
UNDO_ALTERNATETEXT |
number | This flag is used for undo alternate text change |
undoTypes
Type:
- number
Methods
(static) beginCompoundUndo(undoTypeopt, subUndoTypeopt) → {app.undo.undoActions|app.APIError}
You can use this function in the case that you want the undo engine to record multiple changes to boxes (or multiple beginUndo()/endUndo() pairs), and treat them as one undo action.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
undoType |
app.undo.undoTypes |
<optional> |
app.undo.undoTypes.UNDODOM
|
See undoTypes for all available undo types. |
subUndoType |
app.undo.subUndoTypes |
<optional> |
app.undo.subUndoTypes.NOSUBUNDO
|
See subUndoTypes for all available sub undo types. |
Returns:
Layout object if success else APIError.
- Type
- app.undo.undoActions | app.APIError
(static) endCompoundUndo()
You can use this function to end a compound undo action.
(static) isInCompoundUndo() → {boolean}
You can use this function to check if compound undo is already running.
Returns:
TRUE if compound undo is running else FALSE
- Type
- boolean
(static) isUndoFrozen() → {boolean}
You can use this function to check if undo is already running.
Returns:
TRUE if undo is running else FALSE
- Type
- boolean